Skip to content
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.

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

feat: implement legacy imports deprecation #8747

Merged
merged 7 commits into from
Jul 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
67 changes: 11 additions & 56 deletions packages/-ember-data/addon/-private/index.ts
Original file line number Diff line number Diff line change
@@ -1,70 +1,25 @@
// public
import ArrayProxy from '@ember/array/proxy';
import { deprecate } from '@ember/debug';
import PromiseProxyMixin from '@ember/object/promise-proxy-mixin';
import ObjectProxy from '@ember/object/proxy';

import { graphFor } from '@ember-data/graph/-private';
import JSONAPICache from '@ember-data/json-api';
import { LegacyNetworkHandler } from '@ember-data/legacy-compat';
import { FetchManager } from '@ember-data/legacy-compat/-private';
import type Model from '@ember-data/model';
import type { ModelStore } from '@ember-data/model/-private/model';
import { buildSchema, instantiateRecord, modelFor, teardownRecord } from '@ember-data/model/hooks';
import RequestManager from '@ember-data/request';
import Fetch from '@ember-data/request/fetch';
import BaseStore, { CacheHandler, recordIdentifierFor } from '@ember-data/store';
import type { Cache } from '@ember-data/types/cache/cache';
import type { CacheCapabilitiesManager } from '@ember-data/types/q/cache-store-wrapper';
import type { ModelSchema } from '@ember-data/types/q/ds-model';
import type { StableRecordIdentifier } from '@ember-data/types/q/identifier';
import type { RecordInstance } from '@ember-data/types/q/record-instance';
deprecate('Importing from `ember-data/-private` is deprecated without replacement.', false, {
id: 'ember-data:deprecate-legacy-imports',
for: 'ember-data',
until: '6.0',
since: {
enabled: '5.2',
available: '5.2',
},
});

export class Store extends BaseStore {
constructor(args: Record<string, unknown>) {
super(args);
this.requestManager = new RequestManager();
this.requestManager.use([LegacyNetworkHandler, Fetch]);
this.requestManager.useCache(CacheHandler);
this.registerSchema(buildSchema(this));
graphFor(this);
}

createCache(storeWrapper: CacheCapabilitiesManager): Cache {
return new JSONAPICache(storeWrapper);
}

instantiateRecord(
this: ModelStore,
identifier: StableRecordIdentifier,
createRecordArgs: Record<string, unknown>
): Model {
return instantiateRecord.call(this, identifier, createRecordArgs);
}

teardownRecord(record: RecordInstance): void {
teardownRecord.call(this, record as Model);
}

modelFor(type: string): ModelSchema {
return modelFor.call(this, type) || super.modelFor(type);
}

// TODO @runspired @deprecate records should implement their own serialization if desired
serializeRecord(record: RecordInstance, options?: Record<string, unknown>): unknown {
// TODO we used to check if the record was destroyed here
if (!this._fetchManager) {
this._fetchManager = new FetchManager(this);
}

return this._fetchManager.createSnapshot(recordIdentifierFor(record)).serialize(options);
}
}
export { default as Store } from '../store';

export { default as DS } from './core';
export { Errors } from '@ember-data/model/-private';
export { Snapshot } from '@ember-data/legacy-compat/-private';

// `ember-data-model-fragments' and `ember-data-change-tracker` rely on `normalizeModelName`
export { RecordArrayManager, coerceId } from '@ember-data/store/-private';
export { ManyArray, PromiseManyArray } from '@ember-data/model/-private';
export { SnapshotRecordArray } from '@ember-data/legacy-compat/-private';
Expand Down
16 changes: 16 additions & 0 deletions packages/-ember-data/addon/adapter.ts
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
import { deprecate } from '@ember/debug';

export { default } from '@ember-data/adapter';

deprecate(
'Importing from `ember-data/adapter` is deprecated. Please import from `@ember-data/adapter` instead.',
false,
{
id: 'ember-data:deprecate-legacy-imports',
for: 'ember-data',
until: '6.0',
since: {
enabled: '5.2',
available: '5.2',
},
}
);
16 changes: 16 additions & 0 deletions packages/-ember-data/addon/adapters/errors.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { deprecate } from '@ember/debug';

export {
AbortError,
default as AdapterError,
Expand All @@ -9,3 +11,17 @@ export {
TimeoutError,
UnauthorizedError,
} from '@ember-data/adapter/error';

deprecate(
'Importing from `ember-data/adapters/errors` is deprecated. Please import from `@ember-data/adapter` instead.',
false,
{
id: 'ember-data:deprecate-legacy-imports',
for: 'ember-data',
until: '6.0',
since: {
enabled: '5.2',
available: '5.2',
},
}
);
16 changes: 16 additions & 0 deletions packages/-ember-data/addon/adapters/json-api.ts
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
import { deprecate } from '@ember/debug';

export { default } from '@ember-data/adapter/json-api';

deprecate(
'Importing from `ember-data/adapters/json-api` is deprecated. Please import from `@ember-data/adapter/json-api` instead.',
false,
{
id: 'ember-data:deprecate-legacy-imports',
for: 'ember-data',
until: '6.0',
since: {
enabled: '5.2',
available: '5.2',
},
}
);
16 changes: 16 additions & 0 deletions packages/-ember-data/addon/adapters/rest.ts
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
import { deprecate } from '@ember/debug';

export { default } from '@ember-data/adapter/rest';

deprecate(
'Importing from `ember-data/adapters/rest` is deprecated. Please import from `@ember-data/adapter/rest` instead.',
false,
{
id: 'ember-data:deprecate-legacy-imports',
for: 'ember-data',
until: '6.0',
since: {
enabled: '5.2',
available: '5.2',
},
}
);
12 changes: 12 additions & 0 deletions packages/-ember-data/addon/attr.ts
Original file line number Diff line number Diff line change
@@ -1 +1,13 @@
import { deprecate } from '@ember/debug';

export { attr as default } from '@ember-data/model';

deprecate('Importing from `ember-data/attr` is deprecated. Please import from `@ember-data/model` instead.', false, {
id: 'ember-data:deprecate-legacy-imports',
for: 'ember-data',
until: '6.0',
since: {
enabled: '5.2',
available: '5.2',
},
});
16 changes: 16 additions & 0 deletions packages/-ember-data/addon/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,8 @@ that has not explicitly activated it. To activate it set the appropriate flag to
*/
import 'ember-inflector';

import { deprecate } from '@ember/debug';

import { dependencySatisfies, importSync, macroCondition } from '@embroider/macros';

import Adapter, { BuildURLMixin } from '@ember-data/adapter';
Expand Down Expand Up @@ -199,6 +201,20 @@ import {
} from './-private';
import setupContainer from './setup-container';

deprecate(
'Importing from `ember-data` is deprecated. Please import from the appropriate `@ember-data/*` instead.',
false,
{
id: 'ember-data:deprecate-legacy-imports',
for: 'ember-data',
until: '6.0',
since: {
enabled: '5.2',
available: '5.2',
},
}
);

DS.Store = Store;
DS.PromiseArray = PromiseArray;
DS.PromiseObject = PromiseObject;
Expand Down
12 changes: 12 additions & 0 deletions packages/-ember-data/addon/model.ts
Original file line number Diff line number Diff line change
@@ -1 +1,13 @@
import { deprecate } from '@ember/debug';

export { default } from '@ember-data/model';

deprecate('Importing from `ember-data/model` is deprecated. Please import from `@ember-data/model` instead.', false, {
id: 'ember-data:deprecate-legacy-imports',
for: 'ember-data',
until: '6.0',
since: {
enabled: '5.2',
available: '5.2',
},
});
16 changes: 16 additions & 0 deletions packages/-ember-data/addon/relationships.ts
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
import { deprecate } from '@ember/debug';

export { belongsTo, hasMany } from '@ember-data/model';

deprecate(
'Importing from `ember-data/relationships` is deprecated. Please import from `@ember-data/model` instead.',
false,
{
id: 'ember-data:deprecate-legacy-imports',
for: 'ember-data',
until: '6.0',
since: {
enabled: '5.2',
available: '5.2',
},
}
);
16 changes: 16 additions & 0 deletions packages/-ember-data/addon/serializer.ts
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
import { deprecate } from '@ember/debug';

export { default } from '@ember-data/serializer';

deprecate(
'Importing from `ember-data/serializer` is deprecated. Please import from `@ember-data/serializer` instead.',
false,
{
id: 'ember-data:deprecate-legacy-imports',
for: 'ember-data',
until: '6.0',
since: {
enabled: '5.2',
available: '5.2',
},
}
);
16 changes: 16 additions & 0 deletions packages/-ember-data/addon/serializers/embedded-records-mixin.ts
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
import { deprecate } from '@ember/debug';

export { EmbeddedRecordsMixin as default } from '@ember-data/serializer/rest';

deprecate(
'Importing from `ember-data/serializers/embedded-records-mixin` is deprecated. Please import from `@ember-data/serializer/rest` instead.',
false,
{
id: 'ember-data:deprecate-legacy-imports',
for: 'ember-data',
until: '6.0',
since: {
enabled: '5.2',
available: '5.2',
},
}
);
16 changes: 16 additions & 0 deletions packages/-ember-data/addon/serializers/json-api.ts
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
import { deprecate } from '@ember/debug';

export { default } from '@ember-data/serializer/json-api';

deprecate(
'Importing from `ember-data/serializers/json-api` is deprecated. Please import from `@ember-data/serializer/json-api` instead.',
false,
{
id: 'ember-data:deprecate-legacy-imports',
for: 'ember-data',
until: '6.0',
since: {
enabled: '5.2',
available: '5.2',
},
}
);
16 changes: 16 additions & 0 deletions packages/-ember-data/addon/serializers/json.ts
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
import { deprecate } from '@ember/debug';

export { default } from '@ember-data/serializer/json';

deprecate(
'Importing from `ember-data/serializers/json` is deprecated. Please import from `@ember-data/serializer/json` instead.',
false,
{
id: 'ember-data:deprecate-legacy-imports',
for: 'ember-data',
until: '6.0',
since: {
enabled: '5.2',
available: '5.2',
},
}
);
16 changes: 16 additions & 0 deletions packages/-ember-data/addon/serializers/rest.ts
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
import { deprecate } from '@ember/debug';

export { default } from '@ember-data/serializer/rest';

deprecate(
'Importing from `ember-data/serializers/rest` is deprecated. Please import from `@ember-data/serializer/rest` instead.',
false,
{
id: 'ember-data:deprecate-legacy-imports',
for: 'ember-data',
until: '6.0',
since: {
enabled: '5.2',
available: '5.2',
},
}
);
11 changes: 11 additions & 0 deletions packages/-ember-data/addon/setup-container.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type Application from '@ember/application';
import { deprecate } from '@ember/debug';

function initializeStore(application: Application) {
application.registerOptionsForType('serializer', { singleton: false });
Expand All @@ -8,3 +9,13 @@ function initializeStore(application: Application) {
export default function setupContainer(application: Application) {
initializeStore(application);
}

deprecate('Importing from `ember-data/setup-container` is deprecated without replacement', false, {
id: 'ember-data:deprecate-legacy-imports',
for: 'ember-data',
until: '6.0',
since: {
enabled: '5.2',
available: '5.2',
},
});
Loading