-
Notifications
You must be signed in to change notification settings - Fork 4k
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.
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
Replace __OXIDE__
at build time to prevent @tailwindcss/oxide
leaks in the stable engine
#10988
Merged
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
876b6e2
to
fea35dc
Compare
This will allow us to replace the `__OXIDE__` at build time, and fully remove the branches from the final code so that there is not even any reference to `@tailwindcss/oxide` on the stable engine.
fea35dc
to
290176a
Compare
This is currently a redirect to the same file, so doesn't hurt.
596f27f
to
34b6b74
Compare
Fix indentation
# Conflicts: # CHANGELOG.md
thecrypticace
approved these changes
Apr 17, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This was referenced May 19, 2024
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.
This PR will ensure that the oxide engine doesn't leak in the current stable version.
The oxide engine is currently behind a runtime feature flag:
But some build tools that use the commonjs plugin (often used in Vite / Rollup) will hoist that
require
part out of the guard... this typically results in a static import instead. But since the stable engine doesn't have any idea what@tailwindcss/oxide
even is, it crashes.If you would inspect the generated code, then it will look something like this:
... which kind of defeats the whole purpose of the feature flag in the first place. In a project where
OXIDE
is defined this all works fine, but in other places it won't.This PR will switch the runtime feature flag, to a build time feature flag. This will ensure that the code is not even there in the final built code but that should be fine since you can switch between the engines if you install a different version (
insiders
vsoxide-insiders
).We will replace
__OXIDE__
at build time. This also means that some parts of the code will now look something likeif (false) { require('@tailwindcss/oxide') }
. This means that the block will never be reachable, but luckily SWCs optimizer will get rid of the dead code entirely.