Deprecate importing inject from @ember/service

emberjs · Dec 11, 2024 · 3b4db23 · 3b4db23
1 parent cb59342
commit 3b4db23
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 7 deletions.
diff --git a/packages/@ember/-internals/deprecations/index.ts b/packages/@ember/-internals/deprecations/index.ts
@@ -139,6 +139,15 @@ export const DEPRECATIONS = {
       enabled: '5.10.0',
     },
   }),
+  DEPRECATE_IMPORT_INJECT: deprecation({
+    for: 'ember-source',
+    id: 'importing-inject-from-ember-service',
+    since: {
+      available: '6.2.0',
+    },
+    until: '7.0.0',
+    url: 'https://deprecations.emberjs.com/id/importing-inject-from-ember-service',
+  }),
 };
 
 export function deprecateUntil(message: string, deprecation: DeprecationObject) {

diff --git a/packages/@ember/service/index.ts b/packages/@ember/service/index.ts
@@ -1,4 +1,5 @@
 import { FrameworkObject } from '@ember/object/-internals';
+import { DEPRECATIONS, deprecateUntil } from '@ember/-internals/deprecations';
 import type { DecoratorPropertyDescriptor, ElementDescriptor } from '@ember/-internals/metal';
 import { inject as metalInject } from '@ember/-internals/metal';
 
@@ -16,6 +17,7 @@ import { inject as metalInject } from '@ember/-internals/metal';
          the property's name
   @return {ComputedDecorator} injection decorator instance
   @public
+  @deprecated Please import `service` instead.
 */
 export function inject(name: string): PropertyDecorator;
 export function inject(...args: [ElementDescriptor[0], ElementDescriptor[1]]): void;
@@ -24,6 +26,11 @@ export function inject(): PropertyDecorator;
 export function inject(
   ...args: [] | [name: string] | ElementDescriptor
 ): PropertyDecorator | DecoratorPropertyDescriptor | void {
+  deprecateUntil(
+    'Importing `inject` from `@ember/service` is deprecated. Please import `service` instead.',
+    DEPRECATIONS.DEPRECATE_IMPORT_INJECT
+  );
+
   return metalInject('service', ...args);
 }
 

diff --git a/packages/@ember/service/tests/service_test.js b/packages/@ember/service/tests/service_test.js
@@ -1,12 +1,20 @@
 import Service, { inject, service } from '@ember/service';
 import EmberObject from '@ember/object';
 import { buildOwner, runDestroy } from 'internal-test-helpers';
-import { moduleFor, AbstractTestCase } from 'internal-test-helpers';
+import { moduleFor, AbstractTestCase, testUnless } from 'internal-test-helpers';
+import { DEPRECATIONS } from '../../-internals/deprecations';
 
 moduleFor(
   'inject - decorator',
   class extends AbstractTestCase {
-    ['@test works with native decorators'](assert) {
+    [`${testUnless(
+      DEPRECATIONS.DEPRECATE_IMPORT_INJECT.isRemoved
+    )} @test works with native decorators`](assert) {
+      expectDeprecation(
+        /'Importing `inject` from `@ember\/service` is deprecated. Please import `service` instead.'/,
+        DEPRECATIONS.DEPRECATE_IMPORT_INJECT.isEnabled
+      );
+
       let owner = buildOwner();
 
       class MainService extends Service {}
@@ -25,7 +33,14 @@ moduleFor(
       runDestroy(owner);
     }
 
-    ['@test uses the decorated property key if not provided'](assert) {
+    [`${testUnless(
+      DEPRECATIONS.DEPRECATE_IMPORT_INJECT.isRemoved
+    )} @test uses the decorated property key if not provided`](assert) {
+      expectDeprecation(
+        /'Importing `inject` from `@ember\/service` is deprecated. Please import `service` instead.'/,
+        DEPRECATIONS.DEPRECATE_IMPORT_INJECT.isEnabled
+      );
+
       let owner = buildOwner();
 
       class MainService extends Service {}

diff --git a/packages/@ember/service/tests/service_ts_test.ts b/packages/@ember/service/tests/service_ts_test.ts
@@ -1,12 +1,20 @@
 import Service, { inject, service } from '@ember/service';
 import EmberObject from '@ember/object';
 import { buildOwner, runDestroy } from 'internal-test-helpers';
-import { moduleFor, AbstractTestCase } from 'internal-test-helpers';
+import { moduleFor, AbstractTestCase, testUnless } from 'internal-test-helpers';
+import { DEPRECATIONS } from '../../-internals/deprecations';
 
 moduleFor(
   'inject - decorator (TS)',
   class extends AbstractTestCase {
-    ['@test works with native decorators'](assert: QUnit['assert']) {
+    [`${testUnless(
+      DEPRECATIONS.DEPRECATE_IMPORT_INJECT.isRemoved
+    )} @test works with native decorators`](assert: QUnit['assert']) {
+      expectDeprecation(
+        /'Importing `inject` from `@ember\/service` is deprecated. Please import `service` instead.'/,
+        DEPRECATIONS.DEPRECATE_IMPORT_INJECT.isEnabled
+      );
+
       let owner = buildOwner();
 
       class MainService extends Service {}
@@ -25,7 +33,14 @@ moduleFor(
       runDestroy(owner);
     }
 
-    ['@test uses the decorated property key if not provided'](assert: QUnit['assert']) {
+    [`${testUnless(
+      DEPRECATIONS.DEPRECATE_IMPORT_INJECT.isRemoved
+    )} @test uses the decorated property key if not provided`](assert: QUnit['assert']) {
+      expectDeprecation(
+        /'Importing `inject` from `@ember\/service` is deprecated. Please import `service` instead.'/,
+        DEPRECATIONS.DEPRECATE_IMPORT_INJECT.isEnabled
+      );
+
       let owner = buildOwner();
 
       class MainService extends Service {}

diff --git a/type-tests/@ember/routing-test/router.ts b/type-tests/@ember/routing-test/router.ts
@@ -1,5 +1,5 @@
 import Router from '@ember/routing/router';
-import Service, { inject as service } from '@ember/service';
+import Service, { service } from '@ember/service';
 import EmberObject, { get } from '@ember/object';
 import RouterService from '@ember/routing/router-service';
 import RouteInfo, { RouteInfoWithAttributes } from '@ember/routing/route-info';