Enforce that __DEV__ is polyfilled in every entry point that uses it
#8689
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
benjamn
force-pushed
the
issue-8674-enforce-__DEV__-everywhere
branch
from
2aee938
to
e1f01bf
Compare
benjamn
commented
Aug 23, 2021
Comment on lines
+1
to
+2
| import { checkDEV } from "../../utilities"; | ||
| checkDEV(); |
There was a problem hiding this comment.
It turns out a number of entry points that weren't obviously using __DEV__ actually do need it, because they use invariant or InvariantError, which we transform to an expression containing __DEV__ to enable stripping long error messages in production.
benjamn
commented
Aug 23, 2021
Comment on lines
+7
to
+8
| export function checkDEV() { | ||
| invariant("boolean" === typeof DEV, DEV); |
There was a problem hiding this comment.
This checkDEV function not only checks that the DEV.ts module successfully exported a boolean value (DEV), but also indirectly ensures __DEV__ actually works, because this invariant(...) expression is transformed to __DEV__ ? invariant(...) : invariant(...) during build.
benjamn
added a commit
that referenced
this pull request
Aug 23, 2021
This merge of the still-open PR #8689 into `release-3.5` will allow us to test those changes in an `@apollo/client@beta` release before merging to `main` and releasing in v3.4.x.
benjamn
added a commit
that referenced
this pull request
Aug 23, 2021
This merge of the still-open PR #8689 into `release-3.5` will allow us to test those changes in an `@apollo/client@beta` release before merging to `main` and releasing in v3.4.x.
1 task
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 started out as a quick fix for #8674, but in the process I realized the best way to prevent
ReferenceErrors for__DEV__once and for all is to write a build step that examines compileddist/code for usage of__DEV__, and enforces that the corresponding entry pointindex.jsfile imports and callscheckDEV().To test these changes using a published version of
@apollo/client, I merged this PR branch intorelease-3.5and published@apollo/client@3.5.0-beta.7with this PR included. From my testing, this version works as before with ESM-aware CDNs like esm.run. In particular, the following code works in a browser console:See #8266 for more background on why this matters here.
Related issues and PRs:
__DEV__internally instead ofprocess.env.NODE_ENV. #8347__DEV__from mis-minification / aggressive tree-shaking #8393stringifyCanonuntilcanonicalStringifyused. #8558Uncaught ReferenceError: __DEV__ is not definedafter updating to 3.4.0 #8557