chore: Updated doc urls

[sagar-qa007]

Description

Updated third party URLs.

Fixes #36437

Automation

/ok-to-test tags="@tag.DocumentViewer"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11125143689
Commit: 7d19fcc
Cypress dashboard.
Tags: @tag.DocumentViewer
Spec:

---

Tue, 01 Oct 2024 12:45:03 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

• Yes
• No

Summary by CodeRabbit

• Bug Fixes

  • Updated document link URLs for testing to ensure accurate functionality in the DocumentViewer widget.

• Tests

  • Maintained and validated tests for various document types, ensuring correct rendering and handling of different file formats.

[coderabbitai]

Walkthrough

The changes in this pull request focus on updating the DocumentViewer_spec.ts file by modifying document link URLs from external sources to local host URLs for testing purposes. This adjustment ensures that the test cases can effectively validate the functionality of the DocumentViewer widget without relying on external resources. The core logic and functionality of the tests remain unchanged, maintaining their ability to verify document handling and rendering.

Changes

File	Change Summary
app/client/cypress/e2e/Regression/ClientSide/Widgets/DocumentViewer/DocumentViewer_spec.ts	Updated document link URLs from external to local host for testing purposes.

Assessment against linked issues

Objective	Addressed	Explanation
Add the server side skipped test cases in failure list to make re-run with it (#36437)	❌	The changes do not address skipped test cases.

Possibly related PRs

• chore: Replacing ted api call for resources #36472: This PR involves similar changes to the URLs in the Library_spec.ts file, focusing on local host updates for testing.
• chore: exclude test for gitautocommit #36307: This PR relates to excluding a test case, relevant to the overall testing framework context.
• chore: Updated error handling #36288: This PR enhances error handling in the CI workflow, ensuring smoother test execution.

Suggested labels

skip-changelog

Suggested reviewers

• ApekshaBhosale

In the realm of code where tests do play,
URLs shift to a local bay.
DocumentViewer stands tall and bright,
Validations run, all in delight!
A seamless flow, no need for a fuss,
Testing made easy, oh what a plus! 🎉

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 05d3822 and 7d19fcc.

📒 Files selected for processing (1)

• app/client/cypress/e2e/Regression/ClientSide/Widgets/DocumentViewer/DocumentViewer_spec.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

app/client/cypress/e2e/Regression/ClientSide/Widgets/DocumentViewer/DocumentViewer_spec.ts (1)

Pattern app/client/cypress/**/**.*: Review the following e2e test code written using the Cypress test library. Ensure that:

• Follow best practices for Cypress code and e2e automation.
• Avoid using cy.wait in code.
• Avoid using cy.pause in code.
• Avoid using agHelper.sleep().
• Use locator variables for locators and do not use plain strings.
• Use data-* attributes for selectors.
• Avoid Xpaths, Attributes and CSS path.
• Avoid selectors like .btn.submit or button[type=submit].
• Perform logins via API with LoginFromAPI.
• Perform logout via API with LogOutviaAPI.
• Perform signup via API with SignupFromAPI.
• Avoid using it.only.
• Avoid using after and aftereach in test cases.
• Use multiple assertions for expect statements.
• Avoid using strings for assertions.
• Do not use duplicate filenames even with different paths.
• Avoid using agHelper.Sleep, this.Sleep in any file in code.

🔇 Additional comments (4)

app/client/cypress/e2e/Regression/ClientSide/Widgets/DocumentViewer/DocumentViewer_spec.ts (4)

Line range hint 1-300: Attention, class! Let's review our coding guidelines together.

I've noticed a few areas where we can improve our code to better align with our classroom rules:

1. I see some instances of cy.wait and cy.pause in our test code. Remember, we agreed not to use these in our Cypress tests. Let's find alternative ways to handle timing and debugging.

2. Some of our selectors are using CSS paths. In our coding class, we prefer to use data-* attributes for selectors. Let's update these to make our tests more robust and easier to maintain.

3. I don't see any use of LoginFromAPI, LogOutviaAPI, or SignupFromAPI. If we're performing these actions in our tests, let's make sure we're using the API methods as per our guidelines.

For your homework, please review the entire file and make these improvements. Remember, following our coding guidelines helps us write better, more consistent code!

Let's run a quick check to find instances of cy.wait and CSS selectors:

#!/bin/bash
# Check for cy.wait and CSS selectors
echo "Instances of cy.wait:"
grep -n "cy.wait" app/client/cypress/e2e/Regression/ClientSide/Widgets/DocumentViewer/DocumentViewer_spec.ts

echo "\nCSS selectors:"
grep -n "cy.get(" app/client/cypress/e2e/Regression/ClientSide/Widgets/DocumentViewer/DocumentViewer_spec.ts | grep -v "data-"

This will help us identify areas for improvement. Keep up the good work, class!

---

23-23: Now, class, let's turn our attention to this PDF URL change.

Good job on updating this URL as well! However, I have a few points for us to ponder:

1. Consistency is key in coding. I notice that while we're using a specific filename for the PowerPoint file, we're using a generic name for the PDF. Should we aim for consistency here?
2. Just like with our PowerPoint URL, we need to ensure this file is available in all test environments.

Here's a little homework assignment for you:

1. Consider renaming the PDF file to match the naming convention of the PowerPoint file.
2. Ensure both files are consistently available in all test environments.

Let's run a quick check on this URL too:

#!/bin/bash
# Verify the availability of the PDF file
curl -I http://host.docker.internal:4200/sample-pdf-file.pdf

This will help us confirm if the PDF is accessible. Remember, in our coding classroom, we always double-check our work!

---

Line range hint 1-300: Class, let's summarize our review lesson!

Today, we've learned some valuable lessons about updating our DocumentViewer widget tests:

1. We've successfully updated our URLs to use local addresses, which is a step in the right direction. However, we need to ensure these changes work across all our test environments.

2. We've identified some areas where our code doesn't quite meet our classroom coding guidelines. This includes the use of cy.wait, cy.pause, and CSS selectors.

For your homework assignment:

1. Verify that the new URLs work consistently across all test environments.
2. Refactor the test code to remove cy.wait and cy.pause, replacing them with more robust waiting strategies.
3. Update selectors to use data-* attributes instead of CSS paths.
4. If login, logout, or signup actions are performed, ensure they use the API methods as per our guidelines.

Remember, class, attention to detail and following best practices will make you excellent coders! Keep up the good work, and don't hesitate to ask questions if you need help with your homework.

As a final check, let's run a script to ensure we haven't missed any important changes:

#!/bin/bash
# Check for any remaining external URLs and guideline violations
echo "Remaining external URLs:"
grep -n "http" app/client/cypress/e2e/Regression/ClientSide/Widgets/DocumentViewer/DocumentViewer_spec.ts | grep -v "host.docker.internal"

echo "\nRemaining guideline violations:"
grep -n -E "cy.wait|cy.pause|agHelper.sleep|it.only|after\(|afterEach\(" app/client/cypress/e2e/Regression/ClientSide/Widgets/DocumentViewer/DocumentViewer_spec.ts

This will help us ensure we've covered all our bases. Class dismissed!

---

18-18: Class, let's examine this URL change carefully.

I see you've updated the PowerPoint file URL to use a local host address. While this aligns with our lesson plan of updating third-party URLs, we need to consider a few things:

1. The use of host.docker.internal suggests this is designed for a Docker environment. Will this work consistently across all our test environments?
2. Have we ensured that this file is available at the specified location on all machines where tests will run?

Remember, in our coding class, we always strive for portability and reliability. Let's make sure this change doesn't create any unexpected pop quizzes for our test suite!

To double-check our work, let's run a quick test:

This will help us confirm if the file is accessible. If it's not, we might need to revise our approach.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.