feat: parent message listener

[eco-monk]

trafficstars

Important: Moving to EE

Description

When appsmith is embedded as an iframe, listen to messages from parent window.

Fixes #15538

Global methods added

• (Note: "*" subscribes or unsubscribes all domains)

• Subscriptions are unsubscribed automatically on page change or when switching/exiting the app

  • On page change, because the callback can have references to entities from that page
  • On app switch/exit, because we want to restrict listening to app's only.

• subscribeParentMessages

subscribeParentMessages(
	"https://eco-monk.github.io", 
	(message) => { showAlert(message) }
)

• unsubscribeParentMessages

unsubscribeParentMessages("https://eco-monk.github.io")

Misc

• Moved routeChanged dispatch to app level. (previously it was only for editor)
  • Added conditions in NavigationSagas -> handleRouteChange, so previous logic is only executed for editor based navigations.

Type of change

• New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Manual:

• Test by calling multiple subscribes and unsubscribes for same website (error message shown)
• Test with different origins (messages received only for subscribed origins)

Checklist:

• [ ] My code follows the style guidelines of this project
• [ ] I have performed a self-review of my own code
• [ ] I have commented my code, particularly in hard-to-understand areas
• [ ] I have made corresponding changes to the documentation
• [ ] My changes generate no new warnings
• [ ] I have added tests that prove my fix is effective or that my feature works
• [ ] New and existing unit tests pass locally with my changes

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
appsmith	✅ Ready (Inspect)	Visit Preview	Jan 3, 2023 at 11:33AM (UTC)

[eco-monk]

/ok-to-test sha=5060c49

[github-actions[bot]]

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/3729939130. Workflow: Appsmith External Integration Test Workflow. Commit: 5060c49. PR: 19024. Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-638dd7cd2913ba43778b915e?pr=19024&runId=3729939130_1

[github-actions[bot]]

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/3729939130. Workflow: Appsmith External Integration Test Workflow. Commit: 5060c49. PR: 19024. Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-638dd7cd2913ba43778b915e?pr=19024&runId=3729939130_3

[github-actions[bot]]

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/3729939130. Workflow: Appsmith External Integration Test Workflow. Commit: 5060c49. PR: 19024. Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-638dd7cd2913ba43778b915e?pr=19024&runId=3729939130_5

[github-actions[bot]]

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/3729939130. Workflow: Appsmith External Integration Test Workflow. Commit: 5060c49. PR: 19024. Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-638dd7cd2913ba43778b915e?pr=19024&runId=3729939130_6

[github-actions[bot]]

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/3729939130. Workflow: Appsmith External Integration Test Workflow. Commit: 5060c49. PR: 19024. Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-638dd7cd2913ba43778b915e?pr=19024&runId=3729939130_7

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.
  • @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 as 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.

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

CodeRabbit Configuration 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.