Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add option to retain fetchEvent handler #116

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

add option to retain fetchEvent handler #116

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab1cd04
add option to retain fetchEvent handler
karthik2804 Jun 17, 2024
94a9888
update readme and add fetch-event to features list
karthik2804 Jun 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,10 @@ Setting `disableFeatures: ['random', 'stdio', 'clocks']` will disable all featur

Note that pure components **will not report errors and will instead trap**, so that this should only be enabled after very careful testing.

The features that are not included by default are:
* `'http'` - Support for sending and receiving HTTP requests, depends on `wasi:io`
* `'fetch-event'` - Enables using `fetchEvent` to respond to `wasi:http/[email protected]#handle`. If the target world does note export `wasi:http/[email protected]`, this will be ignored.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just like we automatically merge WASI imports into the target world, perhaps we can automatically merge the wasi:http/[email protected] export into the target world when this feature is used?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually isn't this the default behaviour anyway? Or do we still strip the export if it's not explicitly in the target world?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With this PR we want to only optionally strip the export from the StarlingMonkey engine here based on the value of the feature. My intention with that statement is to make it such that, if the target world does not export the interface but the feature is enabled, we should probably still strip the export.

Copy link
Collaborator

@guybedford guybedford Jun 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't it read "If the target world does export" though? Rather than "does not". Thinking about this further we probably want to make this an explicit error. That is, if you enable this feature and the target world already exports the incoming handler, then we should throw an error that you should either target the incoming handler export, or you should use the fetch event version of it, but not both.

Copy link
Contributor Author

@karthik2804 karthik2804 Jun 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there is a disconnect in what we each mean by the target world. I am talking about the wit definition, not the guest content. As in, consider the following world

package local:hello;

world hello {
  export hello: func(name: string) -> string;
}

and the fetch-event is set, if we do not strip the export from the engine, it will end up in the output component but maybe that is fine?

I also think that there is currently no way to check if a handler is attached to the fetch event but we can check if there is something that targets the incoming handler export so erroring on that would be good, I agree.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe I am misunderstanding here. To verify my understanding - the proposal above is to not retain fetchEvent incase the target world contains the wasi:http/incoming-handler export and only have the feature take effect if it is not explicitly part of the target world.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I see—I had missed that part of it. On that, I agree with you: I think this setting should be usable whether the targeted world includes incoming-handler or not.

@guybedford doing what you proposed would make it substantially harder to use FetchEvent, because now anyone who wants to target an environment that supports wasi:http/proxy has to edit the target world not to include incoming-handler if they want to use FetchEvent. I think that's a requirement we really shouldn't put on people—and it'd be quite hard for us to satisfy using Spin as a development tool.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am happy to update this PR once there is consensus on this discussion.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Guy and I just discussed this further, and came to the realization that there's a cleaner way to do this: with #117, ComponentizeJS will only generate exports for symbols exported at the JS level, too. Based on that, we could simply say "if after treeshaking we still would export the symbol, then we'll do so. Otherwise, we'll leave it alone."

In effect, that'd mean that if the input StarlingMonkey already includes an export, and content doesn't specify that same export, ComponentizeJS will leave the original export alone.

@karthik2804, if that makes sense to you, then changing #117 accordingly should make it so that this issue isn't needed anymore.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I am roughly tracking it. Currently, #117 is purely for imports. I will take a stab at updating it and see if I understand things correctly and report back.


Note that features explicitly imported by the target world cannot be disabled - if you target a component to a world
that imports `wasi:clocks`, then `disableFeatures: ['clocks']` will not be supported.

Expand Down
3 changes: 2 additions & 1 deletion src/componentize.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,10 @@ export async function componentize(jsSource, witWorld, opts) {
worldName,
disableFeatures = [],
enableFeatures = [],
retainFetchEvent = false
} = opts || {};

const retainFetchEvent = enableFeatures.includes('fetch-event')

let { wasm, jsBindings, importWrappers, exports, imports } = spliceBindings(
sourceName,
await readFile(engine),
Expand Down
Loading