fix: add environment variable to disable LWC version mismatch loglines #5187
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
divmain
reviewed
Feb 4, 2025
| if (process?.env?.SKIP_LWC_VERSION_MISMATCH_CHECK === 'true') { | ||
| warned = true; // skip printing out version mismatch errors when env var is set | ||
| return; | ||
| } |
There was a problem hiding this comment.
We'd need a build-time complement to this environment variable. E.g. when we compile @lwc/engine-dom, this code path should turn into if (false) { and be minified away.
There was a problem hiding this comment.
@divmain not super familiar with the lwc codebase, can you point me where to make this change?
wjhsf
approved these changes
Feb 4, 2025
Comment on lines
+64
to
+68
| }).not.toLogErrorDev( | ||
| new RegExp( | ||
| `LWC WARNING: current engine is v${process.env.LWC_VERSION}, but template was compiled with v123.456.789` | ||
| ) | ||
| ); |
There was a problem hiding this comment.
Suggested change
| }).not.toLogErrorDev( | |
| new RegExp( | |
| `LWC WARNING: current engine is v${process.env.LWC_VERSION}, but template was compiled with v123.456.789` | |
| ) | |
| ); | |
| }).not.toLogErrorDev(/v123\.456\.789/); |
Checking that we're not logging such a long message feels easy to get an accidental false positive, if the error text ever changes. We should just check for keywords to be more flexible.
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.
Details
When using LWR local dev for experience sites, every SSR request logs an LWC version mismatch error. This is due to the fact that the engine-server is intentionally reloaded on a per page basis and not cached in memory. Therefore the mechanisms in place to only log a the version mismatch once do not work. The logging noise from this makes observing actual useful errors during SSR more difficult.
My change just introduces a new environment variable that can be set on the LWR side to disable this logging during local development.
Would like to backport this also to spring25
Does this pull request introduce a breaking change?
Does this pull request introduce an observable change?
GUS work item
@W-17740011@