@stlite/desktop 0.35.1 → 0.36.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/dump_artifacts.js +5 -5
- package/build/electron/main.js +24 -7
- package/package.json +4 -4
package/bin/dump_artifacts.js
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
var j=Object.create;var w=Object.defineProperty;var S=Object.getOwnPropertyDescriptor;var F=Object.getOwnPropertyNames;var x=Object.getPrototypeOf,K=Object.prototype.hasOwnProperty;var k=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var W=(e,t,i,
|
|
3
|
-
`).filter(t=>!t.startsWith("#")).map(t=>t.trim()).filter(t=>t!=="")}f.parseRequirementsTxt=I});var P=k(d=>{"use strict";var
|
|
2
|
+
var j=Object.create;var w=Object.defineProperty;var S=Object.getOwnPropertyDescriptor;var F=Object.getOwnPropertyNames;var x=Object.getPrototypeOf,K=Object.prototype.hasOwnProperty;var k=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var W=(e,t,i,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let a of F(t))!K.call(e,a)&&a!==i&&w(e,a,{get:()=>t[a],enumerable:!(o=S(t,a))||o.enumerable});return e};var p=(e,t,i)=>(i=e!=null?j(x(e)):{},W(t||!e||!e.__esModule?w(i,"default",{value:e,enumerable:!0}):i,e));var v=k(f=>{"use strict";Object.defineProperty(f,"__esModule",{value:!0});f.parseRequirementsTxt=void 0;function I(e){return e.split(`
|
|
3
|
+
`).filter(t=>!t.startsWith("#")).map(t=>t.trim()).filter(t=>t!=="")}f.parseRequirementsTxt=I});var P=k(d=>{"use strict";var M=d&&d.__createBinding||(Object.create?function(e,t,i,o){o===void 0&&(o=i);var a=Object.getOwnPropertyDescriptor(t,i);(!a||("get"in a?!t.__esModule:a.writable||a.configurable))&&(a={enumerable:!0,get:function(){return t[i]}}),Object.defineProperty(e,o,a)}:function(e,t,i,o){o===void 0&&(o=i),e[o]=t[i]}),R=d&&d.__exportStar||function(e,t){for(var i in e)i!=="default"&&!Object.prototype.hasOwnProperty.call(t,i)&&M(t,e,i)};Object.defineProperty(d,"__esModule",{value:!0});R(v(),d)});var b=p(require("yargs")),_=require("yargs/helpers"),s=p(require("path")),n=p(require("fs/promises")),y=p(require("fs-extra")),u=p(require("node-fetch")),m=require("pyodide"),q=p(P());global.fetch=u.default;function $(e){return`https://cdn.jsdelivr.net/pyodide/v${m.version}/full/${e}`}async function C(e){console.info("Copy the build directory (the bare built app files) to this directory...");let t=s.default.resolve(__dirname,"../build");if(!(await n.default.stat(t)).isDirectory())throw new Error(`The source ${t} does not exist.`);if(t===e.copyTo){console.warn(`sourceDir == destDir (${t}). Are you in the development environment? Skip copying the directory.`);return}if(e.keepOld)try{await n.default.access(e.copyTo),console.info(`${e.copyTo} already exists. Use it and skip copying.`);return}catch{throw new Error(`${e.copyTo} does not exist even though the \`keepOld\` option is specified`)}console.log(`Copy ${t} to ${e.copyTo}`),await n.default.rm(e.copyTo,{recursive:!0,force:!0}),await y.default.copy(t,e.copyTo)}async function E(e){if(e.requirements.length===0)return[];let t=await(0,m.loadPyodide)();await t.loadPackage("micropip");let i=t.pyimport("micropip");return i.add_mock_package("streamlit","1.24.0"),await i.install(e.requirements),Object.entries(t.loadedPackages).filter(([,o])=>o==="default channel").map(([o])=>o)}async function T(){let e=$("repodata.json");return console.log(`Load the Pyodide repodata.json from ${e}`),(await(await(0,u.default)(e)).json()).packages}async function D(e,t){console.log(`Install the local wheel ${t}`);let i=await n.default.readFile(t),o="/tmp/"+s.default.basename(t);e.FS.writeFile(o,i);let a=e.pyimport("micropip"),c=`emfs:${o}`;console.log(`Install ${c}`),await a.install.callKwargs(c,{keep_going:!0})}async function J(e){console.info("Create the site-packages snapshot file...");let t=await(0,m.loadPyodide)();if(await t.loadPackage(["micropip"]),e.useLocalKernelWheels){let l=s.default.dirname(require.resolve("@stlite/kernel")),r=s.default.resolve(l,"../py");await D(t,s.default.join(r,"stlite-server/dist/stlite_server-0.1.0-py3-none-any.whl")),await D(t,s.default.join(r,"streamlit/lib/dist/streamlit-1.24.0-py2.py3-none-any.whl"))}else{let r=require(s.default.resolve(__dirname,"../package.json")).version,O=`https://data.jsdelivr.com/v1/package/npm/@stlite/kernel@${r}/flat`,h=(await(await(0,u.default)(O)).json()).files.filter(g=>g.name.endsWith(".whl")).map(g=>`https://cdn.jsdelivr.net/npm/@stlite/kernel@${r}${g.name}`),B=t.pyimport("micropip");console.log("Install",h),await B.install.callKwargs(h,{keep_going:!0})}let i=t.pyimport("micropip"),o=await T();e.usedBuiltinPackages.length>0&&(console.log("Mocking builtin packages so that they will not be included in the site-packages snapshot because these will be installed from the vendored wheel files at runtime..."),e.usedBuiltinPackages.forEach(l=>{let r=o[l];if(r==null)throw new Error(`Package ${l} is not found in the lock file.`);console.log(`Mock ${r.name} ${r.version}`),i.add_mock_package(r.name,r.version)})),console.log(`Install the requirements ${JSON.stringify(e.requirements)}`),await i.install.callKwargs(e.requirements,{keep_going:!0}),console.log("Archive the site-packages director(y|ies)");let a="/tmp/site-packages-snapshot.tar.gz";await t.runPythonAsync(`
|
|
4
4
|
import tarfile
|
|
5
5
|
import site
|
|
6
6
|
|
|
7
7
|
site_packages_dirs = site.getsitepackages()
|
|
8
8
|
|
|
9
|
-
tar_file_name = '${
|
|
9
|
+
tar_file_name = '${a}'
|
|
10
10
|
with tarfile.open(tar_file_name, mode='w:gz') as gzf:
|
|
11
11
|
for site_packages in site_packages_dirs:
|
|
12
12
|
gzf.add(site_packages)
|
|
13
|
-
`),console.log("Extract the archive file from EMFS");let
|
|
14
|
-
`);await n.default.writeFile(e,i,{encoding:"utf-8"})}function
|
|
13
|
+
`),console.log("Extract the archive file from EMFS");let c=t.FS.readFile(a);console.log(`Save the archive file (${e.saveTo})`),await n.default.writeFile(e.saveTo,c)}async function L(e){console.info("Copy the Streamlit app directory..."),console.log(`Copy ${e.sourceDir} to ${e.copyTo}`),await n.default.rm(e.copyTo,{recursive:!0,force:!0}),await y.default.copy(e.sourceDir,e.copyTo)}async function H(e){let t=await n.default.readFile(e,{encoding:"utf-8"});return(0,q.parseRequirementsTxt)(t)}async function U(e,t){let i=t.join(`
|
|
14
|
+
`);await n.default.writeFile(e,i,{encoding:"utf-8"})}function A(e){e.forEach(t=>{let i;try{i=new URL(t)}catch{return}if(i.protocol==="emfs:"||i.protocol==="file:")throw new Error(`"emfs:" and "file:" protocols are not allowed for the requirement (${t})`)})}async function z(e){let t=await T(),o=e.packages.map(a=>t[a]).map(a=>$(a.file_name));console.log("Downloading the used built-in packages..."),await Promise.all(o.map(async a=>{let c=s.default.resolve(e.destDir,"./pyodide",s.default.basename(a));console.log(`Download ${a} to ${c}`);let l=await(0,u.default)(a);if(!l.ok)throw new Error(`Failed to download ${a}: ${l.status} ${l.statusText}`);let r=await l.arrayBuffer();await n.default.writeFile(c,Buffer.from(r))}))}async function N(){let i={embed:(require(s.default.resolve(__dirname,"../package.json")).stlite?.desktop||{}).embed||!1},o=s.default.resolve(__dirname,"../build/stlite-manifest.json"),a=JSON.stringify(i,null,2);console.log(`Dump the manifest file -> ${o}`),console.log(a),await n.default.writeFile(o,a,{encoding:"utf-8"})}(0,b.default)((0,_.hideBin)(process.argv)).command("* <appHomeDirSource> [packages..]","Put the user code and data and the snapshot of the required packages into the build artifact.",()=>{},e=>{console.info(e)}).positional("appHomeDirSource",{describe:"The source directory of the user code and data that will be mounted in the Pyodide file system at app runtime",type:"string",demandOption:!0}).positional("packages",{describe:"Package names to install.",type:"string",array:!0}).options("requirement",{describe:"Install from the given requirements file. This option can be used multiple times.",array:!0,type:"string",alias:"r",default:[]}).options("localKernelWheels",{describe:"Use the locally installed kernel wheels",type:"boolean",alias:"l",default:!1}).options("keepOldBuild",{type:"boolean",default:!1,alias:"k",describe:"Keep the existing build directory contents except appHomeDir."}).parseAsync().then(async e=>{let t=s.default.resolve(process.cwd(),"./build");try{await n.default.access(e.appHomeDirSource)}catch{throw new Error(`${e.appHomeDirSource} does not exist.`)}let i=e.packages;for(let a of e.requirement)i=i.concat(await H(a));A(i);let o=await E({requirements:i,useLocalKernelWheels:e.localKernelWheels});console.log("The built-in packages loaded for the given requirements:"),console.log(o),await C({copyTo:t,keepOld:e.keepOldBuild}),await J({useLocalKernelWheels:e.localKernelWheels,requirements:i,usedBuiltinPackages:o,saveTo:s.default.resolve(t,"./site-packages-snapshot.tar.gz")}),await U(s.default.resolve(t,"./requirements.txt"),i),await L({sourceDir:e.appHomeDirSource,copyTo:s.default.resolve(t,"./streamlit_app")}),await z({packages:o,destDir:t}),await N()});
|
package/build/electron/main.js
CHANGED
|
@@ -12,7 +12,18 @@ if (process.env.NODE_ENV === "development") {
|
|
|
12
12
|
: "../../node_modules/.bin/electron"),
|
|
13
13
|
});
|
|
14
14
|
}
|
|
15
|
-
|
|
15
|
+
async function readManifest() {
|
|
16
|
+
const manifestPath = path.resolve(__dirname, "../stlite-manifest.json");
|
|
17
|
+
const manifestText = await fsPromises.readFile(manifestPath, {
|
|
18
|
+
encoding: "utf-8",
|
|
19
|
+
});
|
|
20
|
+
const maybeManifestData = JSON.parse(manifestText);
|
|
21
|
+
return {
|
|
22
|
+
embed: maybeManifestData.embed ?? false,
|
|
23
|
+
};
|
|
24
|
+
}
|
|
25
|
+
const createWindow = async () => {
|
|
26
|
+
const manifest = await readManifest();
|
|
16
27
|
const mainWindow = new electron_1.BrowserWindow({
|
|
17
28
|
width: 1280,
|
|
18
29
|
height: 720,
|
|
@@ -21,9 +32,15 @@ const createWindow = () => {
|
|
|
21
32
|
sandbox: true, // https://www.electronjs.org/docs/latest/tutorial/security#4-enable-process-sandboxing
|
|
22
33
|
},
|
|
23
34
|
});
|
|
24
|
-
const
|
|
35
|
+
const indexUrlObj = new URL(electron_1.app.isPackaged || process.env.NODE_ENV === "production"
|
|
25
36
|
? "file:///index.html"
|
|
26
|
-
: "http://localhost:3000/";
|
|
37
|
+
: "http://localhost:3000/");
|
|
38
|
+
const indexUrlParams = new URLSearchParams();
|
|
39
|
+
if (manifest.embed) {
|
|
40
|
+
indexUrlParams.set("embed", "true");
|
|
41
|
+
}
|
|
42
|
+
indexUrlObj.search = indexUrlParams.toString();
|
|
43
|
+
const indexUrl = indexUrlObj.toString();
|
|
27
44
|
// Check the IPC sender in every callback below,
|
|
28
45
|
// following the security best practice, "17. Validate the sender of all IPC messages."
|
|
29
46
|
// https://www.electronjs.org/docs/latest/tutorial/security#17-validate-the-sender-of-all-ipc-messages
|
|
@@ -88,13 +105,13 @@ electron_1.app.whenReady().then(() => {
|
|
|
88
105
|
// Ref: https://github.com/electron/electron/issues/4612#issuecomment-189116655
|
|
89
106
|
const bundleBasePath = path.resolve(__dirname, "..");
|
|
90
107
|
electron_1.protocol.interceptFileProtocol("file", function (req, callback) {
|
|
91
|
-
const
|
|
92
|
-
if (path.isAbsolute(
|
|
93
|
-
const resolvedFilePath = path.join(bundleBasePath,
|
|
108
|
+
const filePath = new URL(req.url).pathname; // `file://<absolute_path>?<query>#<hash>` -> `<absolute_path>`
|
|
109
|
+
if (path.isAbsolute(filePath)) {
|
|
110
|
+
const resolvedFilePath = path.join(bundleBasePath, filePath);
|
|
94
111
|
callback(path.normalize(resolvedFilePath));
|
|
95
112
|
}
|
|
96
113
|
else {
|
|
97
|
-
callback(
|
|
114
|
+
callback(filePath);
|
|
98
115
|
}
|
|
99
116
|
});
|
|
100
117
|
createWindow();
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stlite/desktop",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.36.0",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"homepage": "/",
|
|
6
6
|
"main": "./build/electron/main.js",
|
|
@@ -58,9 +58,9 @@
|
|
|
58
58
|
},
|
|
59
59
|
"devDependencies": {
|
|
60
60
|
"@craco/craco": "^7.0.0",
|
|
61
|
-
"@stlite/common": "^0.
|
|
62
|
-
"@stlite/common-react": "^0.
|
|
63
|
-
"@stlite/kernel": "^0.
|
|
61
|
+
"@stlite/common": "^0.36.0",
|
|
62
|
+
"@stlite/common-react": "^0.36.0",
|
|
63
|
+
"@stlite/kernel": "^0.36.0",
|
|
64
64
|
"@testing-library/react": "^12.1.4",
|
|
65
65
|
"@testing-library/user-event": "^14.0.0",
|
|
66
66
|
"@types/jest": "^27.4.3",
|