JS SDK Beta #1

mhmd-azeez · 2023-08-21T11:00:16Z

Copied the boilerplate from extism/extism/browswer and replaced the Allocator to use the kernel wasm

npm run build

node --experimental-wasi-unstable-preview1 ./examples/node.js wasm/config.wasm

deno run -A ./examples/deno.js ./wasm/config.wasm

bun run ./examples/node.js wasm/config.wasm

npm run tests
npm run deno-tests

mhmd-azeez · 2023-08-23T13:41:19Z

I am a bit confused about Deno, do we need to bundle it at all? I mean you can just reference it by URL right? But since it's not one file, is it smart enough to also pull other files that are imported by index.deno.ts?

I am asking this because there doesn't seem to be a great bundling mechanism for it. None of the bundlers support it by default and the official deno bundle command is deprecated

mhmd-azeez · 2023-08-23T14:02:02Z

Also, do we need to have two project.jsons (one for Node and one for Browser) for publishing to npm?

mhmd-azeez · 2023-08-23T15:04:55Z

Do we plan to support extism_http_request in Node and Deno?

nilslice · 2023-08-23T16:03:54Z

Do we plan to support extism_http_request in Node and Deno?

Ideally yes -- all APIs that can be implemented in any environment should be.

nilslice · 2023-08-23T16:04:27Z

Also, do we need to have two project.jsons (one for Node and one for Browser) for publishing to npm?

/cc @wikiwong -- do you know?

examples/index.html

mhmd-azeez · 2023-08-23T16:13:18Z

Also, do we need to have two project.jsons (one for Node and one for Browser) for publishing to npm?

Actually, since I changed the browser package from esm to iife, we probably don't need to publish to npm at all. A cdn publish will probably be enough.

In this case we only need to publish a package for node. Should it be esm or cjs? Currently it's csj

bhelx · 2023-08-23T16:50:18Z

In this case we only need to publish a package for node. A cdn publish will probably be enough.

I'm not sure about this. Most people doing frontend development use a bundler of some kind and expect a module on npm. Probably want an ESM module for this. I could be wrong though. Let's just make sure you can still use it in a bundled js app that targets a browser.

Should it be esm or cjs? Currently it's csj

Node uses CJS. I think it does support ESM in most modern LTS versions now but might want to check to be sure. I'd aim for broader compatibility over anything else.

wikiwong

Left a few comments & questions but overall it's looking great!

One additional suggestion I have in terms of directory structure is to create browser, node, and deno directories under src, and have their respective index.ts (mod.ts in the case of deno) within those directories.

src/mod.ts

src/plugin.ts

wikiwong · 2023-09-08T03:23:28Z

src/plugin.ts

+
+function wasiRuntime(module: WebAssembly.Instance): GuestRuntime | null {
+  const reactorInit = module.exports._initialize;
+  const commandInit = module.exports.__wasm_call_ctors;


I didn't think it was ever necessary to call __wasm_call_ctors directly. For command modules, shouldn't the _start function do this for us?

I am mirroring the behavior of the Rust SDK: https://github.com/extism/extism/blob/26f70e3a30d6d872572c0f9c8e180b8f2798f71a/runtime/src/plugin.rs#L470

I haven't seen any stacks that export __wasm_call_ctors unless you ask the compiler explicitly, and in this case the user should probably export an _initialize function that calls __wasm_call_ctors instead. Maybe @zshipko can provide a better context

src/index.browser.ts

src/mod.ts

src/index.node.ts

wikiwong · 2023-09-08T03:47:56Z

Also, do we need to have two project.jsons (one for Node and one for Browser) for publishing to npm?

/cc @wikiwong -- do you know?

Sorry I missed this comment. You should be able to specify a browser field in package.json that tells bundlers that are packaging for a browser to use the specified entry point. With that, we should be able to publish a single package to NPM for browser & node. Here is some more info:

https://docs.npmjs.com/cli/v10/configuring-npm/package-json#browser

…er and node

mhmd-azeez · 2023-09-10T12:09:14Z

@wikiwong thank you very much for your feedback, I have addressed all of your points, please take another look and let me know what you think. What's remaining is:

deciding a name for the npm/deno package
deciding on a version

wikiwong · 2023-09-11T16:23:37Z

@wikiwong thank you very much for your feedback, I have addressed all of your points, please take another look and let me know what you think. What's remaining is:

deciding a name for the npm/deno package

deciding on a version

Thanks for addressing @mhmd-azeez ! My suggestions for your two remaining items are:

Continue to use @extism/extism
Upgrade the version to 0.6.0 if there are breaking changes (only because we haven't hit 1.0.0 yet).. or 0.5.1 if there are not breaking changes

deferring to @zshipko @bhelx @nilslice for the final say on package name & version

wikiwong

Looking good! Sorry I didn't think of this in my first round of feedback - were you able to test the browser bundle as well as reactor type modules?

wikiwong · 2023-09-11T16:24:20Z

.vscode/settings.json

+    "deno.lint": true,
+    "deno.unstable": true,
+    "deno.enablePaths": [
+        "./src/deno/mod.ts",


This path may need to change with the latest update to directory structure

sorry, can you elaborate on this? I think the path is correct

build.js

package.json

zshipko · 2023-09-11T18:58:00Z

Agreed, I think using @extism/extism and version 0.6 makes the most sense

bhelx · 2023-09-11T19:27:56Z

How about 1.0.0-rc1? Let's give space to push bug fixes and separate these 2 libraries. I believe npm doesn't pull down rc versions unless you specifically ask for it.

wikiwong · 2023-09-11T20:58:29Z

How about 1.0.0-rc1? Let's give space to push bug fixes and separate these 2 librariesseems like the ABI in . I believe npm doesn't pull down rc versions unless you specifically ask for it.

I believe you are correct regarding NPM. I am ok with 1.0.0-rc1. My only call out is that it's possible the ABI may change significantly from 1.0.0-rc1 -> 1.0.0 . It might be expected that there are only minor changes to the ABI with the same major version.. I don't think it would be that big of a deal though

examples/deno.js

nilslice · 2023-09-11T23:31:24Z

examples/deno.js

+        })
+        .withWasi();
+
+    const plugin = await ExtismPlugin.newPlugin(wasm, options);


is ExtismPlugin.newPlugin a little "stuttery" repeating Plugin? Would ExtismPlugin.new be better?

Kind of on the fence about it. We should think about the interface a little more. I'm not sure if it's different in deno, but people tend to export functions directly in javascript:

import { newPlugin } from 'somepackage'

Let's not let it block this PR though. Will be minor changes we make I think until 1.0

Note to self: I think we should have @chrisdickinson take a look at the interface later. He probably has a good sense of what js developers will expect to see interface wise.

Hi @chrisdickinson, did you have a chance to review this PR?

examples/index.html

package.json

nilslice · 2023-09-11T23:40:55Z

the quick summary is this looks awesome -- tons of work here, and really well done! I still am not fully sure about the plan for embedding / providing the default extism-kernel.wasm runtime imports though. Can you clarify?

mhmd-azeez · 2023-09-12T10:03:49Z

@nilslice

I still am not fully sure about the plan for embedding / providing the default extism-kernel.wasm runtime imports though. Can you clarify?

Yeah, I went with your suggestion of embedding the extism-kernel.wasm as a base64 string. I did it manually though, so no automated process for it yet. It's here: https://github.com/extism/js-sdk/blob/js-sdk-beta/src/plugin.ts#L650

mhmd-azeez · 2023-09-12T10:53:46Z

thank you everyone for your great feedback, I believe what's remaining is publishing the package to npm. @nilslice what's the processes here?

nilslice · 2023-09-12T13:56:44Z

I'll DM you!

chore: update extism kernel

mhmd-azeez added 4 commits August 20, 2023 17:35

feat: bring code over from extism/browser

aa35788

broken

67b1cd7

broken

e36bc5c

nodejs is working

978f6e0

mhmd-azeez self-assigned this Aug 21, 2023

mhmd-azeez added 6 commits August 21, 2023 14:20

browser works too

26960c2

bring back PluginOptions, cleanup

7fadb19

more cleanup

4a1013a

make deno work too

f3d9c2f

add deno to build command

9a9c6b6

moar cleanup

d7bda3a

mhmd-azeez requested review from zshipko, bhelx and nilslice August 23, 2023 09:18

mhmd-azeez added 2 commits August 23, 2023 12:24

moar cleanup x2

fe2c1cb

remove old index.html

182e537

mhmd-azeez marked this pull request as ready for review August 23, 2023 13:38

docs: add bun example

fa5f394

mhmd-azeez added 3 commits August 23, 2023 17:47

use iife pattern for browser

358e022

we don't bundle deno

795b565

moar cleanup

ed7e555

fix deno example

2ab5901

nilslice reviewed Aug 23, 2023

View reviewed changes

examples/index.html Outdated Show resolved Hide resolved

wikiwong reviewed Sep 8, 2023

View reviewed changes

mhmd-azeez added 2 commits September 10, 2023 11:09

fix: return commandInit in wasiRuntime instead of haskellInit

07d839f

feat: restructure the project to have one package.json for both brows…

3ea0980

…er and node

wikiwong reviewed Sep 11, 2023

View reviewed changes

nilslice reviewed Sep 11, 2023

View reviewed changes

examples/deno.js Outdated Show resolved Hide resolved

nilslice reviewed Sep 11, 2023

View reviewed changes

examples/index.html Outdated Show resolved Hide resolved

nilslice reviewed Sep 11, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

fix: address PR feedback

39b4332

mhmd-azeez added 4 commits September 12, 2023 13:28

ci: add an action to build & test on main and PRs

1cd02e7

ci: run npm install before building

4ac0524

ci: fix dir separators

c93b39f

ci: don't use npm cache

6a4b66b

zshipko and others added 5 commits September 18, 2023 17:11

chore: update extism kernel

3a18e1a

Merge pull request #2 from extism/update-kernel

50cb262

chore: update extism kernel

chore: update wasm kernel

4365ff0

fix: make sure we copy the memory before setting it to var

cab26c2

fix: make sure getBytes copies the buffer

4fd8864

bhelx merged commit bd283d0 into main Sep 26, 2023
3 checks passed

mhmd-azeez deleted the js-sdk-beta branch March 14, 2024 16:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JS SDK Beta #1

JS SDK Beta #1

mhmd-azeez commented Aug 21, 2023 •

edited

Loading

mhmd-azeez commented Aug 23, 2023 •

edited

Loading

mhmd-azeez commented Aug 23, 2023

mhmd-azeez commented Aug 23, 2023

nilslice commented Aug 23, 2023

nilslice commented Aug 23, 2023

mhmd-azeez commented Aug 23, 2023 •

edited

Loading

bhelx commented Aug 23, 2023

wikiwong left a comment

wikiwong Sep 8, 2023

mhmd-azeez Sep 10, 2023 •

edited

Loading

wikiwong commented Sep 8, 2023

mhmd-azeez commented Sep 10, 2023

wikiwong commented Sep 11, 2023 •

edited

Loading

wikiwong left a comment

wikiwong Sep 11, 2023

mhmd-azeez Sep 12, 2023

zshipko commented Sep 11, 2023

bhelx commented Sep 11, 2023 •

edited

Loading

wikiwong commented Sep 11, 2023

nilslice Sep 11, 2023

mhmd-azeez Sep 12, 2023

bhelx Sep 12, 2023

bhelx Sep 13, 2023

mhmd-azeez Sep 21, 2023

nilslice commented Sep 11, 2023

mhmd-azeez commented Sep 12, 2023 •

edited

Loading

mhmd-azeez commented Sep 12, 2023

nilslice commented Sep 12, 2023

JS SDK Beta #1

JS SDK Beta #1

Conversation

mhmd-azeez commented Aug 21, 2023 • edited Loading

mhmd-azeez commented Aug 23, 2023 • edited Loading

mhmd-azeez commented Aug 23, 2023

mhmd-azeez commented Aug 23, 2023

nilslice commented Aug 23, 2023

nilslice commented Aug 23, 2023

mhmd-azeez commented Aug 23, 2023 • edited Loading

bhelx commented Aug 23, 2023

wikiwong left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mhmd-azeez Sep 10, 2023 • edited Loading

Choose a reason for hiding this comment

wikiwong commented Sep 8, 2023

mhmd-azeez commented Sep 10, 2023

wikiwong commented Sep 11, 2023 • edited Loading

wikiwong left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zshipko commented Sep 11, 2023

bhelx commented Sep 11, 2023 • edited Loading

wikiwong commented Sep 11, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nilslice commented Sep 11, 2023

mhmd-azeez commented Sep 12, 2023 • edited Loading

mhmd-azeez commented Sep 12, 2023

nilslice commented Sep 12, 2023

mhmd-azeez commented Aug 21, 2023 •

edited

Loading

mhmd-azeez commented Aug 23, 2023 •

edited

Loading

mhmd-azeez commented Aug 23, 2023 •

edited

Loading

mhmd-azeez Sep 10, 2023 •

edited

Loading

wikiwong commented Sep 11, 2023 •

edited

Loading

bhelx commented Sep 11, 2023 •

edited

Loading

mhmd-azeez commented Sep 12, 2023 •

edited

Loading