feat: Adding Embedding Apps Functionality
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=<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=<pageId>
- API Method: GET
- API JSON Response: https://jsonblob.com/1047234433199128576
Checklist:
Dev activity
- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [x] 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
- [x] 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
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) |
/ok-to-test sha=7934ec3dfe0be9a8ea4d2c4ef3828c0b0fa6e0ae
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
/ok-to-test sha=6580480614573558a6e41e61c9b8225c0aa476b8
/ok-to-test sha=6580480614573558a6e41e61c9b8225c0aa476b8
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
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
/ok-to-test sha=26abea8e0bf267c5fbb6e6f74d7395b99ce6adc2
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