Upgrade VM `@glimmer/*` packages from 0.84.3 to 0.85.13 #20561

NullVoxPopuli · 2023-10-24T14:02:37Z

This is post-the-major-refactor-that-yehuda-did.

Huge thanks to @wycats and @chancancode for helping me through this upgrade process 🎉

GlimmerVM changes

some cruft / techdebt removed (a few polyfills, etc)
no more enums (which have a runtime cost)
better handling of locals detection:
- Improve lexical scope glimmerjs/glimmer-vm#1421
Various breaking API changes (things got re-organized a bit)

Changes

@glimmer/interfaces no longer provides the Option type. This has been internalized to @ember/-internals/utility-types (renamed to Nullable to match, tho)
@glimmer/util no longer provides a WeakSet polyfill, so ember now uses native WeakSet -- which has been supported by everyone for nearly all of time: https://caniuse.com/?search=WeakSet
ComponentDefinition's capabilities property is now of type CapabilityMask, instead of InternalComponentCapability
@glimmer/validator's setTrackingTransactionEnv is now only accessible via the 'debug' export
Fix some Reference situations, some types to Reference, and some pushing casting down to the last possible place
CurriedType is now in @glimmer/vm, because it's a value, not just a type/interface
programCompilationContext now takes a third argument
Remove https://babeljs.io/docs/babel-plugin-transform-block-scoping
- this is included in @babel/preset-env (so its used if needed, as determined by targets, which our targets don't determine that we need it)

blockers that are no longer

bring back @glimmer/env's DEBUG: Fix the build. Split dev from prod. In dev, convert import.meta.env.DEV to DEBUG from @glimmer/env glimmerjs/glimmer-vm#1472
@glimmer/* needs to move to conditional exports (instead of pushing import.meta.env on consumers)

not good ideas (or not good right now), now abandoned

@glimmer/compiler depends on @glimmer/local-debug-flags, PR: Declare @glimmer/local-debug-flags glimmerjs/glimmer-vm#1461

node_modules/.pnpm/@glimmer+compiler@0.85.3/node_modules/@glimmer/compiler/lib/compiler.ts:7:34
error TS2307: Cannot find module '@glimmer/local-debug-flags' or its corresponding type declarations.

7 import { LOCAL_SHOULD_LOG } from '@glimmer/local-debug-flags';

this is a devDependency that should be compiled away during publish.

ember-source needs to support import.meta.env, PR: Add import.meta.env support ember-cli-babel#506
consuming projects need to support import.meta.env (we want to pass this through), PR: Add import.meta.env support ember-cli-babel#506

testem.browserstack.js

packages/@ember/-internals/glimmer/tests/integration/application/debug-render-tree-test.ts

packages/@ember/-internals/glimmer/lib/syntax/outlet.ts

lib/index.js

packages/@ember/-internals/glimmer/lib/helpers/action.ts

packages/@ember/-internals/glimmer/lib/helpers/unique-id.ts

packages/@ember/-internals/glimmer/lib/component-managers/curly.ts

packages/@ember/-internals/glimmer/lib/helpers/action.ts

Upgrade VM @glimmer/* packages Also, @glimmer/vm needed to be added to the root package.json so non-declared dependencies (such as @ember/-internals) may be provided access to @glimmer/vm Upgrade glimmer-vm again

… the type to @ember/-internals/utility-types

This revealed that we don't need @babel/plugin-transform-block-scoping

ships them untranspiled

…uires an 'errors' object so that errors can be reported back to the user if something goes wrong

…t it was likely pre-existing Add disable_local_debug to bin/run-tests

Changing AnyFn to Function in places up until the runloop public API

… now requires an 'errors' object so that errors can be reported back to the user if something goes wrong" This reverts commit 0092ad7.

chancancode · 2023-11-14T18:39:10Z

packages/@ember/-internals/glimmer/lib/helpers/action.ts

@@ -417,7 +417,7 @@ function makeClosureAction(
  return (...args: any[]) => {
    let payload = { target: self, args, label: '@glimmer/closure-action' };
    return flaggedInstrument('interaction.ember-action', payload, () => {
-      return join(self, fn, ...processArgs(args));
+      return join(self, fn as AnyFn, ...processArgs(args));


Yeah I think it's valid to push the cast down to here 👍🏼

packages/@ember/-internals/glimmer/lib/helpers/action.ts

… fix, but it was likely pre-existing" This reverts commit 1856b8c.

packages/@ember/-internals/glimmer/lib/helpers/action.ts

chancancode

Other than fixing that final unchecked type cast I think we are good, can you apply those suggestions (verbatim or spirit of it) and squash when merging?

Co-authored-by: Godfrey Chan <godfreykfc@gmail.com>

packages/@ember/-internals/glimmer/lib/helpers/action.ts

This was referenced Nov 1, 2023

MakePrimitiveRef generic so that UNDEFINED_REFERENCE can be Reference<undefined> rather than Reference<unknown> glimmerjs/glimmer-vm#1481

Merged

Amend browser support policy for Safari emberjs/rfcs#984

Merged

NullVoxPopuli force-pushed the upgrade-glimmer-vm0.85.3 branch 9 times, most recently from 02b2912 to 69abefe Compare November 11, 2023 15:38

NullVoxPopuli mentioned this pull request Nov 11, 2023

[Bug] issue with glimmer-vm revealed by (lack of) flag: disable_local_debug #20573

Open

NullVoxPopuli commented Nov 11, 2023

View reviewed changes

testem.browserstack.js Outdated Show resolved Hide resolved

NullVoxPopuli marked this pull request as ready for review November 11, 2023 15:47

NullVoxPopuli changed the title ~~Bump vm packages~~ Upgrade VM @glimmer/* packages, and update usage based on their API changes Nov 11, 2023

chancancode reviewed Nov 11, 2023

View reviewed changes

packages/@ember/-internals/glimmer/tests/integration/application/debug-render-tree-test.ts Outdated Show resolved Hide resolved

chancancode reviewed Nov 11, 2023

View reviewed changes

packages/@ember/-internals/glimmer/lib/syntax/outlet.ts Outdated Show resolved Hide resolved

chancancode reviewed Nov 11, 2023

View reviewed changes

lib/index.js Show resolved Hide resolved

chancancode reviewed Nov 11, 2023

View reviewed changes

packages/@ember/-internals/glimmer/lib/helpers/action.ts Outdated Show resolved Hide resolved

chancancode reviewed Nov 11, 2023

View reviewed changes

packages/@ember/-internals/glimmer/lib/helpers/unique-id.ts Outdated Show resolved Hide resolved

chancancode reviewed Nov 11, 2023

View reviewed changes

packages/@ember/-internals/glimmer/lib/component-managers/curly.ts Outdated Show resolved Hide resolved

NullVoxPopuli mentioned this pull request Nov 13, 2023

Revert "fix capture render tree fails when errors in args" glimmerjs/glimmer-vm#1493

Merged

chancancode reviewed Nov 14, 2023

View reviewed changes

packages/@ember/-internals/glimmer/lib/helpers/action.ts Outdated Show resolved Hide resolved

NullVoxPopuli force-pushed the upgrade-glimmer-vm0.85.3 branch from 10db7f6 to 4492d05 Compare November 14, 2023 14:10

NullVoxPopuli added 2 commits November 14, 2023 12:40

Bump vm packages

66bb1d2

Upgrade VM @glimmer/* packages Also, @glimmer/vm needed to be added to the root package.json so non-declared dependencies (such as @ember/-internals) may be provided access to @glimmer/vm Upgrade glimmer-vm again

Address removal of Option from '@glimmer/interfaces' by internalizing…

2d78bb5

… the type to @ember/-internals/utility-types

NullVoxPopuli added 9 commits November 14, 2023 12:40

'fix' type of a ref in outlet

65d8cae

Force rollup v4 so we have real errors that we can understand as humans.

7cbcaa5

This revealed that we don't need @babel/plugin-transform-block-scoping

We re-implement babel features for private fields, since glimmer-vm now

2bee515

ships them untranspiled

Internal type checking now passes. the debug render tree args now req…

0092ad7

…uires an 'errors' object so that errors can be reported back to the user if something goes wrong

Add disable_local_debug to qunit, as we have a bug we need to fix, bu…

1856b8c

…t it was likely pre-existing Add disable_local_debug to bin/run-tests

Address incorrect type for stateFor

5a000f8

Update comment to be correct and note an optimization

b270cf0

Fix the type of the refs for closureAction

2120346

Changing AnyFn to Function in places up until the runloop public API

Rename Option to Nullable to align with glimmer-vm terminology

09a7648

NullVoxPopuli force-pushed the upgrade-glimmer-vm0.85.3 branch from 44dfc4a to 09a7648 Compare November 14, 2023 17:40

NullVoxPopuli added 2 commits November 14, 2023 12:52

lockfile maintenance

35a18cf

Revert "Internal type checking now passes. the debug render tree args…

c247d27

… now requires an 'errors' object so that errors can be reported back to the user if something goes wrong" This reverts commit 0092ad7.

NullVoxPopuli requested a review from chancancode November 14, 2023 18:05

chancancode reviewed Nov 14, 2023

View reviewed changes

packages/@ember/-internals/glimmer/lib/helpers/action.ts Outdated Show resolved Hide resolved

Push Reference<unknown> into makeClosureAction

04ca7fe

NullVoxPopuli force-pushed the upgrade-glimmer-vm0.85.3 branch from 1e1c608 to 04ca7fe Compare November 14, 2023 23:17

Revert "Add disable_local_debug to qunit, as we have a bug we need to…

79afa58

… fix, but it was likely pre-existing" This reverts commit 1856b8c.

chancancode reviewed Nov 15, 2023

View reviewed changes

packages/@ember/-internals/glimmer/lib/helpers/action.ts Outdated Show resolved Hide resolved

chancancode reviewed Nov 15, 2023

View reviewed changes

packages/@ember/-internals/glimmer/lib/helpers/action.ts Outdated Show resolved Hide resolved

chancancode approved these changes Nov 15, 2023

View reviewed changes

NullVoxPopuli and others added 2 commits November 15, 2023 07:43

Apply suggestions from code review

7c8247c

Co-authored-by: Godfrey Chan <godfreykfc@gmail.com>

lint:fix

1b91fe4

chancancode reviewed Nov 15, 2023

View reviewed changes

packages/@ember/-internals/glimmer/lib/helpers/action.ts Outdated Show resolved Hide resolved

Update packages/@ember/-internals/glimmer/lib/helpers/action.ts

7bcb233

chancancode changed the title ~~Upgrade VM @glimmer/* packages, and update usage based on their API changes~~ Upgrade VM @glimmer/* packages from 0.84.3 to 0.85.13 Nov 15, 2023

chancancode enabled auto-merge (squash) November 15, 2023 19:02

chancancode merged commit 32c669e into emberjs:main Nov 15, 2023
14 checks passed

NullVoxPopuli deleted the upgrade-glimmer-vm0.85.3 branch November 15, 2023 19:46

NullVoxPopuli mentioned this pull request Apr 19, 2024

Memory leak: Table, TableMeta and TableProperty classes are retained in memory after destruction when using table/column modifiers or column.getValueForRow CrowdStrike/ember-headless-table#266

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade VM `@glimmer/*` packages from 0.84.3 to 0.85.13 #20561

Upgrade VM `@glimmer/*` packages from 0.84.3 to 0.85.13 #20561

NullVoxPopuli commented Oct 24, 2023 •

edited

chancancode Nov 14, 2023

NullVoxPopuli Nov 14, 2023

chancancode left a comment

Upgrade VM @glimmer/* packages from 0.84.3 to 0.85.13 #20561

Upgrade VM @glimmer/* packages from 0.84.3 to 0.85.13 #20561

Conversation

NullVoxPopuli commented Oct 24, 2023 • edited

GlimmerVM changes

Changes

chancancode Nov 14, 2023

Choose a reason for hiding this comment

NullVoxPopuli Nov 14, 2023

Choose a reason for hiding this comment

chancancode left a comment

Choose a reason for hiding this comment

Upgrade VM `@glimmer/*` packages from 0.84.3 to 0.85.13 #20561

Upgrade VM `@glimmer/*` packages from 0.84.3 to 0.85.13 #20561

NullVoxPopuli commented Oct 24, 2023 •

edited