Prevent rerunning scripts already ran in router #12985
Merged
+120
−17
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
In a long session you might navigate between several pages, some contain the script and some not, but nevertheless the script should run a total of 1 time. This also helps with smaller bundled scripts in production, where some are inlined.
🦋 Changeset detectedLatest commit: 222c00a The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
the
pkg: astro
CodSpeed Performance ReportMerging #12985 will not alter performanceComparing Summary
|
martrapp
reviewed
Jan 15, 2025
|
With that change in place, we can also remove astro/packages/astro/src/transitions/swap-functions.ts Lines 9 to 30 in 0968069 and |
|
@martrapp |
|
!preview router-noexec |
|
Snapshots have been released for the following packages:
Publish LogBuild Log |
Ah, right. The job of |
|
@martrapp I created a preview release, can you let the people who encountered the bug to try it out? |
Yes will do! Thanks a lot! Btw: taking |
This was referenced Jan 29, 2025
|
We got 1 confirmation that it fixes their issue. Enough to merge this? |
|
Hi @matthewp, |
|
Looks like that actually broke tests :( |
|
Yes, the code that checks for same src resp. same text re-establishes the previous semantics. &&
// Inline
((!s1.src && s1.textContent === s2.textContent) ||
// External
(s1.src && s1.type === s2.type && s1.src === s2.src))and all should be fine. |
|
@martrapp passing now, would appreciate another review! |
martrapp
approved these changes
Feb 26, 2025
There was a problem hiding this comment.
Apart from the two marked changes, the updates look good to me now. At least they match what was discussed.
I'm still not sure how many sites this will be a breaking change for.
I also have some slight concerns about the size of keys that could accumulate over time, but who really writes huge inline scripts?
I was surprised that we had no tests for data-astro-rerun, so I added one.
But you must explicitly activate it, yet.
| // the old script is in the new document and doesn't have the rerun attribute | ||
| // we mark it as executed to prevent re-execution | ||
| s2.dataset.astroExec = ''; | ||
| break; |
There was a problem hiding this comment.
Seems this is the real cause of what let the tests fail last time. We should definitively visit all scripts, and not break after the first known one ;-)
| @@ -138,6 +139,7 @@ function runScripts() { | |||
| if (script.dataset.astroExec === '') continue; | |||
| const type = script.getAttribute('type'); | |||
| if (type && type !== 'module' && type !== 'text/javascript') continue; | |||
| if (detectScriptExecuted(script)) continue; | |||
There was a problem hiding this comment.
Not quite sure about your last commit but to me it looks as if it would simply prevent all reruns including those with data-astro-rerun
https://docs.astro.build/en/guides/view-transitions/#script-re-execution should be updated. |
Merged
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.
Changes
Testing
Docs
N/A, bug fix.