Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: show linting errors on browser API added #32732

Merged
merged 2 commits into from
Apr 18, 2024

Conversation

sneha122
Copy link
Contributor

@sneha122 sneha122 commented Apr 17, 2024

Description

Whenever browser apis like window, navigator, print etc are using in the JSmode bindings, current implementation does not show linting errors and if such JS code is executed, we get error toast message of window.alert is not defined. This is because linting errors are identified inside lint worker and since we are inside the context of worker, it does not understand the browser context or its APIs, thus this PR highlights the linting errors when any of the browser APIs are using in JS bindings.

Before:
Screenshot 2024-04-17 at 3 40 19 PM

After:
Screenshot 2024-04-17 at 3 41 11 PM

Note: Existing cypress test of BasicLint_spec.ts has been modified to assert linting issues in such case.

Fixes #16535

Automation

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

馃攳 Cypress test results

Tip

馃煝 馃煝 馃煝 All cypress tests have passed! 馃帀 馃帀 馃帀
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/8734064205
Commit: 86ad880
Cypress dashboard url: Click here!

Summary by CodeRabbit

  • Tests

    • Updated test case descriptions and added steps for better browser interaction and lint error assertions in the linting functionality.
  • Refactor

    • Modified linting options to improve behavior in browser environments.

Copy link
Contributor

coderabbitai bot commented Apr 17, 2024

Walkthrough

This update involves refining the lint error detection and presentation in a JavaScript context and adjusting linting behavior in browser environments by modifying test cases and constants.

Changes

Files Change Summary
.../Linting/BasicLint_spec.ts Updated test descriptions and added steps for browser interaction and JavaScript context modification.
.../src/plugins/Linting/constants.ts Changed browser option in lintOptions from true to false.

Possibly related issues


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@github-actions github-actions bot added Bug Something isn't working FE Coders Pod Issues related to users writing javascript in appsmith Integrations Pod Issues related to a specific integration Integrations Pod General Issues related to the Integrations Pod that don't fit into other tags. JS Linting & Errors Issues related to JS Linting and errors Medium Issues that frustrate users due to poor UX Needs Triaging Needs attention from maintainers to triage Production labels Apr 17, 2024
@sneha122 sneha122 added the ok-to-test Required label for CI label Apr 17, 2024
@sneha122
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

Copy link

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/8720157792.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 32732.
recreate: .

Copy link

Deploy-Preview-URL: https://ce-32732.dp.appsmith.com

Copy link
Contributor

@rishabhrathod01 rishabhrathod01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sneha122 sneha122 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Apr 17, 2024
@sneha122
Copy link
Contributor Author

This Pr may be delayed due to critical issue here

@sneha122 sneha122 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Apr 18, 2024
@sneha122 sneha122 merged commit d9ce6b3 into release Apr 18, 2024
42 checks passed
@sneha122 sneha122 deleted the fix/show-lint-error-browser-api branch April 18, 2024 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working FE Coders Pod Issues related to users writing javascript in appsmith Integrations Pod General Issues related to the Integrations Pod that don't fit into other tags. Integrations Pod Issues related to a specific integration JS Linting & Errors Issues related to JS Linting and errors Medium Issues that frustrate users due to poor UX Needs Triaging Needs attention from maintainers to triage ok-to-test Required label for CI Production
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Show lint errors for Browser Apis not supported in the worker context
2 participants