fix: only add version mismatch test code in karma #2852

nolanlawson · 2022-05-24T22:07:52Z

Details

Similar to 7e9c5d2, if we're going to be adding globals to the window object for our Karma tests, we should check if we're actually in a Karma environment first.

I realized this was broken because it actually breaks @lwc/engine-server if you run it with NODE_ENV=development. 🤦 (Node doesn't have a window object.)

Does this pull request introduce a breaking change?

✅ No, it does not introduce a breaking change.

Does this pull request introduce an observable change?

⚠️ Yes, it does include an observable change.

The thing that was broken is no longer broken.

nolanlawson · 2022-05-24T22:08:24Z

packages/@lwc/engine-core/src/framework/check-version-mismatch.ts

@@ -14,7 +14,8 @@ import { LightningElementConstructor } from './base-lightning-element';

 let warned = false;

-if (process.env.NODE_ENV === 'development') {
+// @ts-ignore
+if (process.env.NODE_ENV !== 'production' && typeof __karma__ !== 'undefined') {


This is only used here:

lwc/packages/integration-karma/test/rendering/version-mismatch/index.spec.js

Lines 43 to 45 in 90b213b

beforeEach(() => {

window.__lwcResetWarnedOnVersionMismatch();

});

* fix: only remove slot children in synthetic shadow (#2843) * fix: only remove slot children in synthetic shadow * fix: use case block * fix: only add version mismatch test code in karma (#2852) * test(integration-karma): ensure constructable stylesheets are re-used (#2844) * test(integration-karma): ensure constructable stylesheets are re-used * test: add test for shared style * chore(nucleus): remove more downstreams (#2855) * chore(nucleus): remove another downstream (#2857) * docs: fix typo in template compiler readme (#2848) * docs: fix typo in template compiler readme * docs: rewording usage of lwc dynamic directive Co-authored-by: Eugene Kashida <ekashida@gmail.com> Co-authored-by: Eugene Kashida <ekashida@gmail.com> * test(integration-karma): update ACT components (#2862) * fix(engine-core): revert "optimize computation of transitive shadow mode" (#2859) * fix(engine-core): correctly compute shadowMode * fix: fix comment * fix: update packages/integration-karma/test/mixed-shadow-mode/dual-component/index.spec.js Co-authored-by: Eugene Kashida <ekashida@gmail.com> * fix: fix another one * fix: improve tests * fix: improve tests * fix: improve test * fix: revert * Revert "refactor(engine): optimize computation of transitive shadow mode (#2803)" This reverts commit 95ce4c3. Co-authored-by: Eugene Kashida <ekashida@gmail.com> * chore: release v2.14.1 (#2866) Co-authored-by: Nolan Lawson <nolan@nolanlawson.com> Co-authored-by: Mohan Raj Rajamanickam <1509984+mohanraj-r@users.noreply.github.com> Co-authored-by: Eugene Kashida <ekashida@gmail.com> Co-authored-by: Ravi Jayaramappa <ravi.jayaramappa@salesforce.com>

wip: add a static vnode type wip: needs key and patch wip: all tests passing exept a few because of simple things wip: set style tokens for fragments during template evaluation wip: set element shadow token for fragments during template evaluation wip: propagate the shadow resolver key of static fragments wip: do not gen static nodes for text or comments wip: use tagedTemplate expression to replate stylesheetToken wip: use cloneNode from renderer wip: treeWalker to work in ie11 refactor: do not strip empty attr or empty class attr fix: using incorrect key wip: trim value of textNodes and review feedback fix: hydration feat: custom static element serializer wip: remove unessesary import fix: hydration fix: snapshot tests fix: missing karma test fix: test due rebase test: add test for static content needing nodeOwner fix: escape strings in serializer refactor: remove unused apis on generated code refactor: review suggestions fix: support mixed mode wip: fix compilation snapshots fix: increase 0.5kb bundlesize for engine dom fix: flapper wip: helpers.ts review wip: codegen.ts review wip: missing items from pm review wip: review comments fix: respect preserveComments and fuse $1,2 into 3 fix: svg content with the correct namespace feat(template-compiler): add option to disable static content optimizations wip: remove invalid comment chore: bump version to v2.13.0 (#2784) chore: dependencies upgrade (#2785) test: fix Node warning about event emitters (#2789) chore: run karma and integration tests in parallel (#2792) * chore: run karma and integration tests in parallel * fix: remove log lines fix(babel-plugin-component): remove import validation (#2719) test: remove flakey IE integration test (#2796) test: update test to use lwc imports (#2794) chore: Restrict further import order (#2795) chore: bump version to v2.13.1 (#2804) refactor(engine): moving vm references from dom into core (#2801) * refactor(engine): moving vm references from dom into core chore(nucleus): remove salesforcedevs/developer-website (#2807) test(integration-karma): small quality-of-life improvements (#2809) chore(deps): bump ejs from 3.1.6 to 3.1.7 (#2810) chore: weekly dependencies upgrade (#2816) * chore: weekly dependencies upgrade * fix: update yarn.lock` refactor(engine): optimize computation of transitive shadow mode (#2803) chore(deps): bump async from 2.6.3 to 2.6.4 (#2815) Bumps [async](https://github.com/caolan/async) from 2.6.3 to 2.6.4. - [Release notes](https://github.com/caolan/async/releases) - [Changelog](https://github.com/caolan/async/blob/v2.6.4/CHANGELOG.md) - [Commits](caolan/async@v2.6.3...v2.6.4) --- updated-dependencies: - dependency-name: async dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> chore: bump version to v2.13.2 (#2819) chore: retry failed Circle CI tests (#2814) * chore: retry failed Circle CI tests W-10946477 * chore: fix * chore: fix * chore: fix * chore: fix * chore: fix * chore: fix * chore: fix * chore: deliberately fail a test to see what happens * chore: improve retry script * fix: whitespace * Revert "chore: deliberately fail a test to see what happens" This reverts commit 611fc34. * chore: rename to retry_karma fix(engine-core): add shim for old stylesheetTokens internal API (#2821) W-11093934 chore: bump version to v2.13.3 (#2823) fix(build): remove swc, switch back to babel and terser (#2818) feat: add freezeTemplate() API, warn on mutation (#2825) * feat: add freezeTemplate() API, warn on mutation * fix: warn on slots/renderMode as well * fix: add comment * fix: remove duplicate process.env.NODE_ENV check fix(engine-dom): refactor stylesheet API for consistency (#2827) * fix(engine-dom): refactor stylesheet API for consistency * fix: remove useless code comment * test: remove unnecessary test * test: remove unnecessary test * refactor: slight refactor * fix: add code comments * fix: add code comments * fix: add better comment fix: relax static id validation in iterations (#2830) fix(rollup-plugin): emit warnings during compilation (#2833) * fix(rollup-plugin): emit warnings during compilation Fixes #2771 W-10930894 * fix: add code comment fix(engine-dom): make feature flags work (#2812) * fix(engine-dom): make feature flags work Fixes #2811 * fix: license headers * test: fix jest tests * test: fix test * test: fix test * fix: use Eugene's technique instead * Revert "fix: use Eugene's technique instead" This reverts commit 72afdc0. * fix: use Eugene's technique instead * fix: revert unnecessary test change * fix: revert, use the elaborate test instead * fix: fix feature flags in engine-server as well perf(engine-dom): refactor style cache to reduce lookups (#2832) * perf(engine-dom): refactor style cache to reduce lookups * fix: tidy up comments * fix: update packages/@lwc/engine-dom/src/styles.ts Co-authored-by: Pierre-Marie Dartus <p.dartus@salesforce.com> * fix: remove semi * fix: remove "used" flag * fix: refactor * fix: refactor * fix: bring back "used" flag * fix: typo Co-authored-by: Pierre-Marie Dartus <p.dartus@salesforce.com> chore: update deps (#2838) test: run feature flag test code only in karma (#2835) fix: trigger slotchange event on removing slot (#2840) test(integration-karma): silence lwc rollup plugin warnings (#2836) * test(integration-karma): silence lwc rollup plugin warnings * fix: use warn API v2.11.7 (#2842) chore: release v2.14.0 (#2846) fix: only remove slot children in synthetic shadow (#2843) * fix: only remove slot children in synthetic shadow * fix: use case block fix: only add version mismatch test code in karma (#2852) test(integration-karma): ensure constructable stylesheets are re-used (#2844) * test(integration-karma): ensure constructable stylesheets are re-used * test: add test for shared style chore(nucleus): remove more downstreams (#2855) chore(nucleus): remove another downstream (#2857) docs: fix typo in template compiler readme (#2848) * docs: fix typo in template compiler readme * docs: rewording usage of lwc dynamic directive Co-authored-by: Eugene Kashida <ekashida@gmail.com> Co-authored-by: Eugene Kashida <ekashida@gmail.com> chore: fix lint test: refactor test, remove test covered in #2859 test: on second thought, bring test back

* fix: only remove slot children in synthetic shadow (#2843) * fix: only remove slot children in synthetic shadow * fix: use case block * fix: only add version mismatch test code in karma (#2852) * test(integration-karma): ensure constructable stylesheets are re-used (#2844) * test(integration-karma): ensure constructable stylesheets are re-used * test: add test for shared style * chore(nucleus): remove more downstreams (#2855) * chore(nucleus): remove another downstream (#2857) * docs: fix typo in template compiler readme (#2848) * docs: fix typo in template compiler readme * docs: rewording usage of lwc dynamic directive Co-authored-by: Eugene Kashida <ekashida@gmail.com> Co-authored-by: Eugene Kashida <ekashida@gmail.com> * test(integration-karma): update ACT components (#2862) * fix(engine-core): revert "optimize computation of transitive shadow mode" (#2859) * fix(engine-core): correctly compute shadowMode * fix: fix comment * fix: update packages/integration-karma/test/mixed-shadow-mode/dual-component/index.spec.js Co-authored-by: Eugene Kashida <ekashida@gmail.com> * fix: fix another one * fix: improve tests * fix: improve tests * fix: improve test * fix: revert * Revert "refactor(engine): optimize computation of transitive shadow mode (#2803)" This reverts commit 95ce4c3. Co-authored-by: Eugene Kashida <ekashida@gmail.com> * chore: release v2.14.1 (#2866) * refactor(engine-core): encapsulate renderer as an object and allow it to be injectable in vnodes (#2763) * refactor(engine-core): passing the renderer from an import statement in compiled templates Co-authored-by: Ravi Jayaramappa <ravi.jayaramappa@salesforce.com> Co-authored-by: Pierre-Marie Dartus <p.dartus@salesforce.com> Co-authored-by: Nolan Lawson <nolan@nolanlawson.com> * test(integration-karma): more shadow transitivity tests (#2864) * chore: release v.2.14.2 @W-7258582 (#2871) * Revert "chore: release v2.14.1 (#2866) @W-7258582 (#2867)" This reverts commit 518ab2e. Co-authored-by: Nolan Lawson <nolan@nolanlawson.com> Co-authored-by: Mohan Raj Rajamanickam <1509984+mohanraj-r@users.noreply.github.com> Co-authored-by: Eugene Kashida <ekashida@gmail.com> Co-authored-by: Ravi Jayaramappa <ravi.jayaramappa@salesforce.com> Co-authored-by: Caridy Patiño <caridy@gmail.com> Co-authored-by: Pierre-Marie Dartus <p.dartus@salesforce.com>

fix: only add version mismatch test code in karma

8307d9e

nolanlawson commented May 24, 2022

View reviewed changes

pmdartus approved these changes May 25, 2022

View reviewed changes

ekashida approved these changes May 25, 2022

View reviewed changes

nolanlawson merged commit b2beef0 into master May 25, 2022

nolanlawson deleted the nolan/window-reset-version-mismatch branch May 25, 2022 20:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: only add version mismatch test code in karma #2852

fix: only add version mismatch test code in karma #2852

nolanlawson commented May 24, 2022 •

edited

Loading

nolanlawson May 24, 2022

	beforeEach(() => {
	window.__lwcResetWarnedOnVersionMismatch();
	});

fix: only add version mismatch test code in karma #2852

fix: only add version mismatch test code in karma #2852

Conversation

nolanlawson commented May 24, 2022 • edited Loading

Details

Does this pull request introduce a breaking change?

Does this pull request introduce an observable change?

nolanlawson May 24, 2022

Choose a reason for hiding this comment

nolanlawson commented May 24, 2022 •

edited

Loading