Skip to content

[DO NOT MERGE] Trigger CI for #5187: fix: add environment variable to disable LWC version mismatch loglines #5241

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.

Sign up for GitHub

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

Closed
wjhsf wants to merge 5 commits into from
Closed

[DO NOT MERGE] Trigger CI for #5187: fix: add environment variable to disable LWC version mismatch loglines #5241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7397767
fix: local dev logs LWC mismatch warnings on every SSR request
nrkruk Feb 3, 2025
d135dbf
fix: null checks for safety
nrkruk Feb 3, 2025
c451d88
fix: tests
nrkruk Feb 26, 2025
55cb8f5
fix: rollup comments
nrkruk Feb 26, 2025
1ed3c8a
Merge branch 'salesforce:master' into nrkruk/fixVersionMismatchWarning
nrkruk Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/@lwc/engine-core/src/framework/check-version-mismatch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ export function checkVersionMismatch(
) {
const versionMatcher = func.toString().match(LWC_VERSION_COMMENT_REGEX);
if (!isNull(versionMatcher) && !warned) {
if (process?.env?.SKIP_LWC_VERSION_MISMATCH_CHECK === 'true') {
warned = true; // skip printing out version mismatch errors when env var is set
return;
}

const version = versionMatcher[1];
if (version !== LWC_VERSION) {
warned = true; // only warn once to avoid flooding the console
Expand Down
14 changes: 14 additions & 0 deletions packages/@lwc/integration-karma/test/rendering/version-mismatch/index.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,23 @@ describe('compiler version mismatch', () => {
});

afterEach(() => {
process.env.SKIP_LWC_VERSION_MISMATCH_CHECK = 'false';
detachReportingControlDispatcher();
});

it('skip warning during local dev', () => {
process.env.SKIP_LWC_VERSION_MISMATCH_CHECK = 'true';
function tmpl() {
return [];
/*LWC compiler v123.456.789*/
}

expect(() => {
registerTemplate(tmpl);
}).not.toLogErrorDev(new RegExp(`LWC WARNING:`));
expect(dispatcher).not.toHaveBeenCalled();
});

it('template', () => {
function tmpl() {
return [];
Expand Down
3 changes: 3 additions & 0 deletions scripts/rollup/rollup.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@ function sharedPlugins() {
// This is only used inside @lwc/engine-dom and @lwc/engine-server
// Elsewhere, it _not_ be replaced, so that it can be replaced later (e.g. in @lwc/engine-core)
'process.env.IS_BROWSER': packageName === '@lwc/engine-dom' ? 'true' : 'false',
...(packageName === '@lwc/engine-dom'
? { 'process.env.SKIP_LWC_VERSION_MISMATCH_CHECK': 'false' }
: {}),
};

return [
Expand Down
Loading