add a pyodide-based "sandbox" flavor #437
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds a new `GRIST_SANDBOX_FLAVOR=pyodide` option where the version of Python used for the data engine is wasm, and so can be run by node like the rest of the back end. It still runs as a separate process. There are a few small version changes made to packages to avoid various awkwardnesses present in the current versions. All existing tests pass. This is very experimental. To use, you'll need something with a bash shell and make. First do: ``` cd sandbox/pyodide make setup # README.md and Makefile have details cd .. ``` Then running Grist as: ``` GRIST_SANDBOX_FLAVOR=pyodide yarn start ``` should work. Adding a formula with content: ``` import sys; return sys.version ``` should return a different Python version than other sandboxes. The motivation for this work is to have a form of sandboxing that will work on Windows for Grist Electron (for Linux we have gvisor/runsc, for Mac we have sandbox-exec, but I haven't found anything comparable for Windows). It also brings a back-end-free version of Grist a bit closer, for use-cases where that would make sense - such as serving a report (in the form of a Grist document) on a static site.
|
(@georgegevoian I added two commits based on tests on using this on Windows) |
|
@georgegevoian I've been using this branch quite a bit in follow up work. The python changes work well for pyodide-from-a-web-worker also. For the web, it is proving more practical to package up the date engine code as a wheel than to try and mount it. That means in follow-up I could rip out the mounting code which got a little ugly because of the Windows directory copy wrinkle (which is maybe related to some nuance of user id / permission handling?). |
georgegevoian
approved these changes
Mar 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a new
GRIST_SANDBOX_FLAVOR=pyodideoption where the version of Python used for the data engine is compiled to wasm, and so can be run by node like the rest of the back end. It still runs as a separate process.There are a few small version changes made to packages to avoid various awkwardness present in the current versions.
This is very experimental. To use, you'll need something with a bash shell and make. First do:
Then running Grist as:
should work. Adding a formula with content:
should return a different Python version than other sandboxes.
I haven't done much in the way of benchmarking. The sandbox has an extra startup time somewhat comparable to runsc. It feels usable on moderate sized docs on my Linux machine. Felt maybe a little sluggish on an older Mac?
The motivation for this work is to have a form of sandboxing that will work on Windows for Grist Electron (for Linux we have gvisor/runsc, for Mac we have sandbox-exec, but I haven't found anything comparable for Windows). Pyodide doesn't actually make any security promises I've found when running on node so I'm not making any claims either at this time.
It also brings a back-end-free version of Grist a bit closer, for use-cases where that would make sense - such as serving a report (in the form of a Grist document) on a static site.
The Pyodide version I used currently offers Python 3.10, which is different from our current standard of 3.9. I haven't added any automated tests for this sandbox flavor yet.