feat: Adding Embedding Apps Functionality

[NilanshBansal]

Description

This PR implements the functionality for Embedding Appsmith apps into any other platform.

It reuses the following existing APIs:

• /api/v1/applications/{applicationId} (PUT)
• /api/v1/pages?pageId= (GET)

An additional field embedSetting has been added to the application collection.

Fixes #18292

Job stories

When I build an appsmith app, I want it to embed the app on another platform , so I can add new functionality to existing tools.

When I embed an appsmith app, I want to easily configure the properties for embedding , so I can know all options available to me, and set it up as I please

When I embed an appsmith app, I want it to have a visual interface to configure the embedded app, so I can do it without having to rely on documentation or outside resources

When I embed an app, I want it to communicate with the platform it is embedded in , so I can leverage existing workflows/functionality of other tools, and enhance them using appsmith

Type of change

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

How Has This Been Tested?

• Manual

Testing Results

Postman testing results attached below

Update EmbedSetting API

• API Route: /api/v1/applications/{applicationId}
• API Method: PUT
• API JSON Response: http://jsonblob.com/1047232397061668864

• Database Record

GET EmbedSetting API

• API Route: /api/v1/pages?pageId=
• API Method: GET
• API JSON Response: https://jsonblob.com/1047234433199128576

Checklist:

Dev activity

• 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
• PR is being merged under a feature flag

QA activity:

• Test plan has been approved by relevant developers
• Test plan has been peer reviewed by QA
• Cypress test cases have been added and approved by either SDET or manual QA
• Organized project review call with relevant stakeholders after Round 1/2 of QA
• Added Test Plan Approved label after reviewing all Cypress test

[vercel]

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

Name	Status	Preview	Updated
appsmith	✅ Ready (Inspect)	Visit Preview	Dec 4, 2022 at 2:28PM (UTC)

[NilanshBansal]

/ok-to-test sha=7934ec3dfe0be9a8ea4d2c4ef3828c0b0fa6e0ae

[github-actions]

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/3591903489.
Workflow: Appsmith External Integration Test Workflow.
Commit: 7934ec3dfe0be9a8ea4d2c4ef3828c0b0fa6e0ae.
PR: 18566.
Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-63465d4789020c7ac296d08d?pr=18566&runId=3591903489_1

[NilanshBansal]

/ok-to-test sha=6580480614573558a6e41e61c9b8225c0aa476b8

[NilanshBansal]

/ok-to-test sha=6580480614573558a6e41e61c9b8225c0aa476b8

[github-actions]

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/3600707958.
Workflow: Appsmith External Integration Test Workflow.
Commit: 6580480614573558a6e41e61c9b8225c0aa476b8.
PR: 18566.
Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-63465d4789020c7ac296d08d?pr=18566&runId=3600707958_1

[github-actions]

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/3601171453.
Workflow: Appsmith External Integration Test Workflow.
Commit: 6580480614573558a6e41e61c9b8225c0aa476b8.
PR: 18566.
Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-63465d4789020c7ac296d08d?pr=18566&runId=3601171453_1

[NilanshBansal]

/ok-to-test sha=26abea8e0bf267c5fbb6e6f74d7395b99ce6adc2

[github-actions]

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/3614355555.
Workflow: Appsmith External Integration Test Workflow.
Commit: 26abea8e0bf267c5fbb6e6f74d7395b99ce6adc2.
PR: 18566.
Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-63465d4789020c7ac296d08d?pr=18566&runId=3614355555_1

[coderabbitai]

Warning

Rate limit exceeded

@Nikhil-Nandagopal has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 29 minutes and 55 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 8c6dccb and 26abea8.

---

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.