#105 Add sandbox execution; move JQ to it #4701

fregante · 2022-11-25T06:26:34Z

Closes Move template engine and brick evaluation to Chrome sandbox #105

I'm just running some tests for the sandbox:

I'm tempted to add postMessage support to the Messenger, but I'm afraid to make it even more complicated (including its semi-manual testing). I had done some work in:

src/tinyPages/sandbox.js

webpack.config.js

src/contentScript/sidebarDomControllerLite.ts

twschiller · 2022-11-25T14:36:50Z

Cool! I didn't realize that the sandbox is inserted into a page vs. a single sandbox (similar to the singleton background page)

I'm tempted to add postMessage support to the Messenger, but I'm afraid to make it even more complicated (including its semi-manual testing)

Agree that for now using the Messenger isn't important given that there's only 1-3 message types we'll be using for sandbox (render template, validation JSON Schema form, potentially run jq). The main thing is to be able to wrap in a async interface to simplify calling code

fregante

Messaging also set up, 80%. Current result:

src/sandbox/messenger/api.ts

src/sandbox/messenger/registration.ts

src/utils/postMessage.ts

codecov · 2022-11-26T12:45:28Z

Codecov Report

Merging #4701 (8e763be) into main (b4efabb) will increase coverage by 0.04%.
The diff coverage is 70.73%.

@@            Coverage Diff             @@
##             main    #4701      +/-   ##
==========================================
+ Coverage   53.79%   53.84%   +0.04%     
==========================================
  Files         935      941       +6     
  Lines       27766    27846      +80     
  Branches     5365     5369       +4     
==========================================
+ Hits        14937    14993      +56     
- Misses      12829    12853      +24

Impacted Files	Coverage Δ
src/contentScript/contentScriptCore.ts	`0.00% <0.00%> (ø)`
src/sandbox/messenger/api.ts	`0.00% <0.00%> (ø)`
src/sandbox/messenger/registration.ts	`0.00% <0.00%> (ø)`
src/sandbox/sandbox.ts	`0.00% <0.00%> (ø)`
src/utils/shadowWrap.ts	`0.00% <ø> (ø)`
src/sandbox/messenger/executor.ts	`44.44% <44.44%> (ø)`
src/utils.ts	`66.79% <66.66%> (-0.01%)`	⬇️
src/utils/postMessage.ts	`93.93% <93.93%> (ø)`
src/blocks/transformers/jq.ts	`93.33% <100.00%> (ø)`
src/utils/injectIframe.tsx	`100.00% <100.00%> (ø)`

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

vercel · 2022-12-06T09:50:58Z

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

Name	Status	Preview	Updated
pixiebrix-extension	✅ Ready (Inspect)	Visit Preview	Dec 6, 2022 at 10:49AM (UTC)

fregante

This is ready for a first review and live testing with JQ.

Before merge:

Do extended testing of the JQ brick — it seems to work but does it match the previous expectations?
Update tests

fregante · 2022-12-06T10:51:00Z

src/sandbox/messenger/registration.ts

+      /* webpackChunkName: "jq-web" */ "jq-web"
+    );
+
+    return jq.promised.json(input, filter);


Live testing:

fregante · 2022-12-06T10:51:18Z

src/sandbox/messenger/registration.ts

+    );
+
+    nunjucks.configure({ autoescape });
+    return nunjucks.renderString(template, context);


Untested, blocked by:

Make all code related to Nunjucks asynchronous #4730

It ended up not being necessary

This reverts commit 0e21bd1.

fregante

Status:

implemented safer response mechanism
added tests
added sandbox mock/bypass for non-sandbox tests
sandboxed JQ seems to work in MV2
the JQ brick does not seem to work in MV3 still, due to unsafe-eval, potentially due to nunjucks

What's left?

Do you have any ready-made JQ blueprints that you could run to ensure they actually work (in MV2)?
I may have somehow broken useUndo.test.ts locally. On CI the tests silently fail altogether, Jest may be going in a loop somehow

fregante · 2022-12-11T18:04:12Z

src/utils/postMessage.ts

+ *
+ * Prior art: https://groups.google.com/a/chromium.org/g/chromium-extensions/c/IPJSfjNSgh8/m/Dh35-tZPAgAJ
+ * Relevant discussion: https://github.com/w3c/webextensions/issues/78
+ */


Long comment FYI

github-actions · 2022-12-12T20:52:09Z

No loom links were found in the first post. Please add one there if you'd like to it to appear on Slack.

Do not edit this comment manually.

twschiller · 2022-12-12T20:52:16Z

Barebones sandbox loading test via browserAction

36a70a9

vercel bot deployed to Preview November 25, 2022 06:27 View deployment

fregante commented Nov 25, 2022

View reviewed changes

src/tinyPages/sandbox.js Outdated Show resolved Hide resolved

webpack.config.js Show resolved Hide resolved

src/contentScript/sidebarDomControllerLite.ts Outdated Show resolved Hide resolved

Cleanup first POC, then try Messaging

ec232c6

twschiller assigned fregante and twschiller Nov 25, 2022

Setup Messenger-like communicator for postMessage

94d31de

vercel bot deployed to Preview November 26, 2022 12:35 View deployment

Cleanup

3025934

vercel bot deployed to Preview November 26, 2022 12:39 View deployment

fregante commented Nov 26, 2022

View reviewed changes

src/sandbox/messenger/api.ts Outdated Show resolved Hide resolved

src/sandbox/messenger/api.ts Outdated Show resolved Hide resolved

src/sandbox/messenger/registration.ts Outdated Show resolved Hide resolved

github-advanced-security bot found potential problems Nov 26, 2022

View reviewed changes

src/utils/postMessage.ts Fixed Show resolved Hide resolved

fregante mentioned this pull request Dec 1, 2022

Make all code related to Nunjucks asynchronous #4730

Closed

fregante added 2 commits December 4, 2022 18:50

Add RENDER_NUNJUCKS

3f7443c

Add APPLY_JQ

c7861c7

vercel bot deployed to Preview December 4, 2022 11:00 View deployment

fregante added 2 commits December 6, 2022 16:10

Basic error handling

7755586

/2

53d0a6c

vercel bot deployed to Preview December 6, 2022 09:52 View deployment

Types

85f0bbe

vercel bot deployed to Preview December 6, 2022 10:34 View deployment

fregante added 2 commits December 6, 2022 18:37

Live-test JQ

6a3b3ea

Merge remote-tracking branch 'origin/main' into F/mv3/sandbox

9af5585

vercel bot deployed to Preview December 6, 2022 10:41 View deployment

Ready for production

081d569

vercel bot deployed to Preview December 6, 2022 10:49 View deployment

fregante commented Dec 6, 2022

View reviewed changes

Refactor to facilitate testing + add 1 test

8cdfef7

vercel bot deployed to Preview December 11, 2022 03:07 View deployment

fregante added 2 commits December 11, 2022 11:54

Use private channel for the response

26f91f5

Cleanup

c8093f7

vercel bot deployed to Preview December 11, 2022 04:09 View deployment

fregante added 7 commits December 11, 2022 17:17

Merge remote-tracking branch 'origin/main' into F/mv3/sandbox

ea1e4ce

Split RequestPacket from ResponsePacket

71f6f6d

Test postMessage

952a5d3

Test addPostMessageListener

a6727aa

Bypass sandbox in other tests

f908216

Mock @/utils/postMessage (unused)

0e21bd1

It ended up not being necessary

Revert "Mock @/utils/postMessage (unused)"

5509174

This reverts commit 0e21bd1.

vercel bot deployed to Preview December 11, 2022 17:54 View deployment

Preload sandbox

b0418c9

fregante commented Dec 11, 2022

View reviewed changes

vercel bot deployed to Preview December 11, 2022 18:08 View deployment

Extract unrelated changes

8902e38

vercel bot deployed to Preview December 11, 2022 18:12 View deployment

Lint

bfa97dc

fregante marked this pull request as ready for review December 11, 2022 18:17

Fix useUndo conflict 🤷‍♂️

b6d6bd9

vercel bot deployed to Preview December 12, 2022 08:29 View deployment

Types

8e763be

vercel bot deployed to Preview December 12, 2022 08:44 View deployment

twschiller approved these changes Dec 12, 2022

View reviewed changes

twschiller merged commit f427bbc into main Dec 12, 2022

twschiller deleted the F/mv3/sandbox branch December 12, 2022 20:52

fregante mentioned this pull request Oct 1, 2023

#4964: Permanently move JQ out of sandbox #6579

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#105 Add sandbox execution; move JQ to it #4701

#105 Add sandbox execution; move JQ to it #4701

fregante commented Nov 25, 2022 •

edited

twschiller commented Nov 25, 2022

fregante left a comment

codecov bot commented Nov 26, 2022 •

edited

vercel bot commented Dec 6, 2022 •

edited

fregante left a comment •

edited

fregante Dec 6, 2022

fregante Dec 6, 2022

fregante left a comment •

edited

fregante Dec 11, 2022 •

edited

github-actions bot commented Dec 12, 2022

twschiller commented Dec 12, 2022

#105 Add sandbox execution; move JQ to it #4701

#105 Add sandbox execution; move JQ to it #4701

Conversation

fregante commented Nov 25, 2022 • edited

twschiller commented Nov 25, 2022

fregante left a comment

Choose a reason for hiding this comment

codecov bot commented Nov 26, 2022 • edited

Codecov Report

vercel bot commented Dec 6, 2022 • edited

fregante left a comment • edited

Choose a reason for hiding this comment

fregante Dec 6, 2022

Choose a reason for hiding this comment

fregante Dec 6, 2022

Choose a reason for hiding this comment

fregante left a comment • edited

Choose a reason for hiding this comment

fregante Dec 11, 2022 • edited

Choose a reason for hiding this comment

github-actions bot commented Dec 12, 2022

twschiller commented Dec 12, 2022

fregante commented Nov 25, 2022 •

edited

codecov bot commented Nov 26, 2022 •

edited

vercel bot commented Dec 6, 2022 •

edited

fregante left a comment •

edited

fregante left a comment •

edited

fregante Dec 11, 2022 •

edited