[WIP sketch] feat: Have injectScript return the result value from the script #1765
Conversation
This file contains hidden or 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
Everything seems to work: the script is executed; onload, onerror handlers do the right thing; document.currentScript invoked by the script returns the detached script element.
It enables the manipulation of the script element just before it is added to the DOM. It can be useful for e.g. passing data to the script via the `dataset` property (which can be accessed by the script via `document.currentScript`).
✅ Deploy Preview for creative-fairy-df92c4 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
The documentation states: > `injectScript` returns a promise, that when resolved, means the script > has been evaluated by the browser and you can start communicating with > it. However, currently `injectScript` returns as soon as the `script` element has been added to the DOM. Make `injectScript` behave according to the documentation.
ion1
force-pushed
the
inject-script-return-value
branch
from
d27a5e8 to
1f9dab4
Compare
ion1
force-pushed
the
inject-script-return-value
branch
from
1f9dab4 to
ca3ca14
Compare
5 tasks
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.
Note
This PR builds on top of #1761, #1762 and #1763 at the moment. In case some of them are not accepted, I will rebase this on top of main.
Overview
A sketch for having
injectScriptreturn the result value from the script. The code works, but it currently has changes to virtual/unlisted-script-entrypoint.ts that only work withinjectScriptwhile being broken with thebrowser.scriptingAPI.I would like to get feedback on how you would like that to be resolved. Some options I can think of:
injectScriptorexecuteScript. I do not know how to achieve that reliably.document.currentScriptcan be overridden by the web page usingObject.defineProperty.injectScriptorexecuteScript.Manual Testing
Use
injectScripton a script which either returns a value or throws an exception; see thatinjectScriptreturns the value or rethrows the exception.Related Issue
#1754 proposes having a way to pass an
UnlistedScriptDefinitionrather than the filename toinjectScript. If something like that was implemented, the type of the return value ofinjectScriptcould be based on the type ofmainwithin theUnlistedScriptDefinition.