From fba9d242fe24bdb3a81ba13dc415f2c480e24a07 Mon Sep 17 00:00:00 2001 From: Chris Thoburn Date: Sun, 27 Apr 2025 13:25:57 -0700 Subject: [PATCH 1/3] Create warp-drive-deprecate-tracking-package.md --- .../warp-drive-deprecate-tracking-package.md | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 content/ember-data/v5/warp-drive-deprecate-tracking-package.md diff --git a/content/ember-data/v5/warp-drive-deprecate-tracking-package.md b/content/ember-data/v5/warp-drive-deprecate-tracking-package.md new file mode 100644 index 00000000..94d1157a --- /dev/null +++ b/content/ember-data/v5/warp-drive-deprecate-tracking-package.md @@ -0,0 +1,46 @@ +--- +title: Legacy Imports +until: '6.0' +since: '5.5' +displayId: warp-drive:deprecate-tracking-package +--- + +Using WarpDrive with EmberJS requires configuring it to use Ember's reactivity system. + +This deprecation removes the use of the package **@ember-data/tracking** which +historically provided the bindings into Ember's reactivity system. + +This package is no longer needed as the configuration is now +provided by the package **@warp-drive/ember**. + +To resolve this deprecation, follow these steps: + +### 1. Remove @ember-data/tracking + +- Remove `@ember-data/tracking` from package.json (if using `ember-data` this may not be present) +- Remove type imports for `@ember-data/tracking` from tsconfig.json +- If using `untracked`, change to using `untrack` from `@glimmer/validator` + +### 2. Add @warp-drive/ember + +- Add `@warp-drive/ember` to package.json - the version to install should match the version of `ember-data` or `@ember-data/store` +- Add `@warp-drive/ember` to tsconfig.json - the types import follows the same pattern (currently this means adding `@warp-drive/ember/unstable-preview-types` to the types array) +- Add `import '@warp-drive/ember/install';` to the top of your `app.js` or `app.ts` file + +### 3. Remove the deprecation + +Once the above steps are complete, the deprecation can be silenced and the automatic fallback +registration of reactivity from `@ember-data/tracking` can be removed by updating your [WarpDrive +build config](https://api.emberjs.com/ember-data/release/modules/@warp-drive%2Fbuild-config%2Fdeprecations) in your `ember-cli-build` file. + +```js +// inside of ember-cli-build.js + +const { setConfig } = await import('@warp-drive/build-config'); + +setConfig(app, __dirname, { + deprecations: { + DEPRECATE_TRACKING_PACKAGE: false + } +}); +``` From 6268c30d4ab5d9f000c2bedf7e4f4c6929898963 Mon Sep 17 00:00:00 2001 From: Chris Thoburn Date: Wed, 30 Apr 2025 23:58:53 -0700 Subject: [PATCH 2/3] Update content/ember-data/v5/warp-drive-deprecate-tracking-package.md Co-authored-by: Katie Gengler --- content/ember-data/v5/warp-drive-deprecate-tracking-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/ember-data/v5/warp-drive-deprecate-tracking-package.md b/content/ember-data/v5/warp-drive-deprecate-tracking-package.md index 94d1157a..443461cd 100644 --- a/content/ember-data/v5/warp-drive-deprecate-tracking-package.md +++ b/content/ember-data/v5/warp-drive-deprecate-tracking-package.md @@ -7,7 +7,7 @@ displayId: warp-drive:deprecate-tracking-package Using WarpDrive with EmberJS requires configuring it to use Ember's reactivity system. -This deprecation removes the use of the package **@ember-data/tracking** which +The use of the package **@ember-data/tracking** is now deprecated. It historically provided the bindings into Ember's reactivity system. This package is no longer needed as the configuration is now From 13463dfbabdf6f43189dc69712772817931090b3 Mon Sep 17 00:00:00 2001 From: Chris Thoburn Date: Wed, 30 Apr 2025 23:58:58 -0700 Subject: [PATCH 3/3] Update content/ember-data/v5/warp-drive-deprecate-tracking-package.md Co-authored-by: Katie Gengler --- content/ember-data/v5/warp-drive-deprecate-tracking-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/ember-data/v5/warp-drive-deprecate-tracking-package.md b/content/ember-data/v5/warp-drive-deprecate-tracking-package.md index 443461cd..ab400850 100644 --- a/content/ember-data/v5/warp-drive-deprecate-tracking-package.md +++ b/content/ember-data/v5/warp-drive-deprecate-tracking-package.md @@ -27,7 +27,7 @@ To resolve this deprecation, follow these steps: - Add `@warp-drive/ember` to tsconfig.json - the types import follows the same pattern (currently this means adding `@warp-drive/ember/unstable-preview-types` to the types array) - Add `import '@warp-drive/ember/install';` to the top of your `app.js` or `app.ts` file -### 3. Remove the deprecation +### 3. Clear the deprecation Once the above steps are complete, the deprecation can be silenced and the automatic fallback registration of reactivity from `@ember-data/tracking` can be removed by updating your [WarpDrive