feat: Import javascript libraries by arunvjn · Pull Request #17895 · appsmithorg/appsmith

arunvjn · 2022-10-27T06:33:33Z

Description

Copy and paste the URL of a library of your choice into Appsmith to have the library downloaded and ready to use. This statement comes with some limitation though, and is listed below
- The library URL that you paste should point to a valid UMD build of the library. Libraries bundled in other module definitions are disallowed.
- Evaluations that power Appsmith, run on web worker, and the APIs on the worker are a subset of the ones you find on the main thread. Here's the list of APIs that web workers support.
- Libraries that use APIs that are not on web worker are unsupported.
- Additionally, libraries that rely on XMLHttpRequest are unsupported.
Installed libraries get autocomplete support.
Additionally, this comes with Appsmith's recommended libraries, which are chosen based on community feedback and popularity

Code Refactor

Eval worker now has 2 message handlers, one to handle async request and one that handles synchronous request.
completePromise now resides in the async message handler and not the evaluateAsync call.
GracefulWorkerService is refactored to send request and respond to a message if required.
Added a new interface Message, that determines the contract for main thread and worker comms.
Every GracefulWorkerService now comes with one channel to listen for requests from the worker, thereby reducing the number of channels from 2 to 1.

Note

This feature is behind a feature flag.
Pending items include libraries support in git connected apps and the cypress tests around it.

Fixes #2430
Fixes #17310
Fixes #17966
Fixes #17309

Type of change

New feature (non-breaking change which adds functionality)
This change requires a documentation update

How Has This Been Tested?

Manual
Jest
Cypress
- Install/uninstall JS Libraries.
- References to an uninstalled library should show lint error.
- Autocomplete for installed libraries.
- Code completion should not show up with results for uninstalled libraries.
- Detect name collision
- Library should be copied over to duplicated application
- Import application should reinstall libraries.

Test Plan

Issues raised during DP testing

feat: Import javascript libraries #17895 (comment)
Dev response feat: Import javascript libraries #17895 (comment)
QA is paused as of 15th December since git implementation is pending.

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

Front conversations

…lse.

…override-fetch

* Added installation popover. * Added cards to show recommended library. * Added Input box to paste URLs * Added URL validation

- Queue multiple installation.

* Queued install appear in entity explorer with a spinner. * Renamed JSDependency -> index

- Show spinner for currently queued libraries. - Show trash icon to remove libraries. - Added action creator for uninstall library.

* Added util to generate tern definitions. * Move installed libraries to extraLibraries for eval and linting. * Toast message to show successful/failed installation along with accessor.

- Added save success checkmark icon - Added scroll bar to the body of installation window

* Persist library accessor for display in explorer.

* Added cards to show multiple installation status. * Changed the explorer display order to show the latest installations at the top.

…override-fetch

arunvjn · 2022-12-21T06:22:01Z

/ok-to-test sha=2510284

github-actions · 2022-12-21T06:22:11Z

The following are new failures, please fix them before merging the PR cypress/integration/Smoke_TestSuite/ClientSideTests/IDE/MaintainContext&Focus_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Templates/Fork_Template_To_App_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/WidgetsLayout_spec.js

github-actions · 2022-12-21T06:22:12Z

The following are new failures, please fix them before merging the PR cypress/integration/Smoke_TestSuite_Fat/ClientSideTests/FormLogin/EnableFormLogin_spec.js

github-actions · 2022-12-21T06:22:27Z

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

github-actions · 2022-12-21T07:59:00Z

The following are new failures, please fix them before merging the PR cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/GitBugs_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Onboarding/GuidedTour_spec.js

arunvjn · 2022-12-21T08:37:33Z

/ok-to-test sha=2510284

github-actions · 2022-12-21T08:37:57Z

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

github-actions · 2022-12-21T09:37:24Z

The following are new failures, please fix them before merging the PR cypress/integration/Smoke_TestSuite/ClientSideTests/Templates/Fork_Template_Existing_app_spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/OnLoadTests/JSOnLoad_cyclic_dependency_errors_spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/QueryPane/S3_1_spec.js

arunvjn · 2022-12-21T10:32:22Z

/ok-to-test sha=3af21dc

github-actions · 2022-12-21T10:32:49Z

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

ramsaptami · 2022-12-21T11:20:32Z

Pending fixes from issues raised is mentioned here

Round 2 of QA is complete and the PR can be merged to release with the following caveats:

Git flow hasn't been tested since there's a conflict when merging branches. This also causes issues during git import hence git flow needs a thorough check once backend changes are merged
App and page cloning is failing on a few workspaces due to this issue. But works on other new and old workspaces and custom JS functionality has been verified on new and old apps.

CC: @arunvjn @satbir121

github-actions · 2022-12-21T11:27:03Z

The following are new failures, please fix them before merging the PR cypress/integration/Smoke_TestSuite/ClientSideTests/Templates/Fork_Template_Existing_app_spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/OnLoadTests/JSOnLoad_cyclic_dependency_errors_spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/QueryPane/S3_1_spec.js

github-actions · 2022-12-21T11:50:26Z

The following are new failures, please fix them before merging the PR cypress/integration/Smoke_TestSuite/ClientSideTests/BugTests/Autocomplete_JS_spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitImport/ImportEmptyRepo_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/Connection_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/Deploy_spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/DisconnectGit_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/GitBugs_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/Merge_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/JSEditorIndent_spec.js

…avascript-libraries

arunvjn · 2022-12-21T12:24:26Z

/ok-to-test sha=3c33d5f

github-actions · 2022-12-21T12:24:54Z

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

github-actions · 2022-12-21T12:42:08Z

The following are new failures, please fix them before merging the PR cypress/integration/Smoke_TestSuite/ClientSideTests/BugTests/Autocomplete_JS_spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitImport/ImportEmptyRepo_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitImport/ImportEmptyRepo_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/Connection_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/Deploy_spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/Deploy_spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/DisconnectGit_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/GitBugs_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/Merge_spec.js

…avascript-libraries

github-actions · 2022-12-21T14:12:39Z

The following are new failures, please fix them before merging the PR

github-actions · 2022-12-21T15:08:50Z

The following are new failures, please fix them before merging the PR

arunvjn · 2022-12-21T15:09:48Z

/ok-to-test sha=d982f36

github-actions · 2022-12-21T15:10:22Z

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

github-actions · 2022-12-21T16:37:25Z

The following are new failures, please fix them before merging the PR cypress/integration/Smoke_TestSuite/ClientSideTests/ExplorerTests/Entity_Explorer_Widgets_Copy_Paste_Delete_Undo_Keyboard_Event_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/RepoLimitExceededErrorModal_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Templates/Fork_Template_To_App_spec.js

arunvjn added 30 commits October 10, 2022 23:13

Enabled setTimeout

989a834

Added support for console logs inside setTimeout

1d0f2f0

Fixed unit test

d6ab06a

Added autocomplete support

001167a

Fixed jest test

05775cc

Override fetch

88c62b3

override 'credentials' to false

5ac7751

set xhr withCredentials to false and credential option of fetch to fa…

dbf3f38

…lse.

Merge branch 'release' of github.com:appsmithorg/appsmith into chore/…

a7f17aa

…override-fetch

Removes origin check

0f56395

Merge branch 'release' of github.com:appsmithorg/appsmith into chore/…

231effc

…override-fetch

Enabled fetch

cd00a6e

Installation wizard init commit

8fa122e

* Added installation popover. * Added cards to show recommended library. * Added Input box to paste URLs * Added URL validation

Added basic install flow

e22cb66

Added html for progress indicator

d48bde7

- Added installation states.

7f5cd83

- Queue multiple installation.

UI adjustments

649b0b5

* Queued install appear in entity explorer with a spinner. * Renamed JSDependency -> index

Added ui tests

3c5fcef

Added test to assert progress bar

b90b877

Added UI to uninstall library.

86c6e02

- Show spinner for currently queued libraries. - Show trash icon to remove libraries. - Added action creator for uninstall library.

Merge branch 'chore/override-fetch' into feat/javascript-libraries

4aa8e6f

Tern definitions for installed library.

1fb1eda

* Added util to generate tern definitions. * Move installed libraries to extraLibraries for eval and linting. * Toast message to show successful/failed installation along with accessor.

UI Changes

2fbd481

- Added save success checkmark icon - Added scroll bar to the body of installation window

* Clear process installs when wizard is closed.

a7d39c8

* Persist library accessor for display in explorer.

Display 2 lines of install url

e5e7d8b

Added check to prevent duplicate install requests

074edbe

UI Changes

ca34d3e

* Added cards to show multiple installation status. * Changed the explorer display order to show the latest installations at the top.

Minor UI changes

79a75e0

Merge branch 'release' of github.com:appsmithorg/appsmith into chore/…

81b7b7b

…override-fetch

Added cypress test

e6459ae

Changed share link from file url to docs urls

2510284

Modified toggle behavior in explorer

3af21dc

Merge branch 'release' of github.com:appsmithorg/appsmith into feat/j…

3c33d5f

…avascript-libraries

Merge branch 'release' of github.com:appsmithorg/appsmith into feat/j…

d982f36

…avascript-libraries

rishabhrathod01 approved these changes Dec 21, 2022

View reviewed changes

arunvjn mentioned this pull request Dec 21, 2022

[Bug]-[7152]:Download image using action selector doesn't work #16635

Closed

1 task

ramsaptami mentioned this pull request Jan 9, 2023

fix: fix git sync related bugs for Custom JS Lib feature #19352

Merged

14 tasks

arunvjn mentioned this pull request Jan 11, 2023

[Task] Integrate with Github API to request support for a specific library #17313

Closed

arunvjn mentioned this pull request Jan 20, 2023

[Task] Integrate with CRUD Apis for library persistence #17311

Closed

Conversation

arunvjn commented Oct 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Code Refactor

Note

Type of change

How Has This Been Tested?

Test Plan

Issues raised during DP testing

Checklist:

Uh oh!

arunvjn commented Dec 21, 2022

Uh oh!

github-actions bot commented Dec 21, 2022

Uh oh!

github-actions bot commented Dec 21, 2022

Uh oh!

github-actions bot commented Dec 21, 2022

Uh oh!

github-actions bot commented Dec 21, 2022

Uh oh!

arunvjn commented Dec 21, 2022

Uh oh!

github-actions bot commented Dec 21, 2022

Uh oh!

github-actions bot commented Dec 21, 2022

Uh oh!

arunvjn commented Dec 21, 2022

Uh oh!

github-actions bot commented Dec 21, 2022

Uh oh!

ramsaptami commented Dec 21, 2022

Uh oh!

github-actions bot commented Dec 21, 2022

Uh oh!

github-actions bot commented Dec 21, 2022

Uh oh!

arunvjn commented Dec 21, 2022

Uh oh!

github-actions bot commented Dec 21, 2022

Uh oh!

github-actions bot commented Dec 21, 2022

Uh oh!

github-actions bot commented Dec 21, 2022

Uh oh!

github-actions bot commented Dec 21, 2022

Uh oh!

arunvjn commented Dec 21, 2022

Uh oh!

github-actions bot commented Dec 21, 2022

Uh oh!

github-actions bot commented Dec 21, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

arunvjn commented Oct 27, 2022 •

edited

Loading