[CHORE]: Extract internalModel access to identifiers for Relationships #7262
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
snewcomer
commented
Aug 2, 2020
| @@ -1580,7 +1580,7 @@ abstract class CoreStore extends Service { | |||
| typeof modelName === 'string' | |||
| ); | |||
|
|
|||
| const resource = constructResource(modelName, ensureStringId(id)); | |||
| const resource: ResourceIdentifierObject = constructResource(modelName, ensureStringId(id)); | |||
There was a problem hiding this comment.
Do we like to type the return value? If no value, I can remove
| } else { | ||
| this.parent = parentIMOrIdentifier.recordReference; | ||
| this.parentInternalModel = parentIMOrIdentifier; | ||
| } |
There was a problem hiding this comment.
If the goal is to remove references to the internal model property as well, I can make this this.parentIdentifier and lookup by identifier in each corresponding spot that needs an internal model. Let me know what you think!
There was a problem hiding this comment.
If we have a path of fully getting away from internal model, we probably want to bundle this up together, landing just the lookup part might be bad for perf in hot paths
| @@ -31,6 +34,10 @@ function isResourceIdentiferWithRelatedLinks( | |||
|
|
|||
| export const INTERNAL_MODELS = new WeakMap<Reference, InternalModel>(); | |||
There was a problem hiding this comment.
Sort of along the same lines as the other question - The API changed for creating References from InternalModel to identifiers. However, do we want to also change our caching layer as well with this refactor? Or does this seem right to keep as is (various places in belongs-to/has-many reference IM specific properties)?
|
Asset Size Report for 84ea514 IE11 Builds The size of the library EmberData has increased by 132.0 B (94.0 B compressed) which exceeds the failure threshold of 75 bytes.WarningsThe uncompressed size of the package @ember-data/store has increased by 132.0 B. Changeset Full Asset Analysis (IE11)Modern Builds The size of the library EmberData has increased by 132.0 B (94.0 B compressed) which exceeds the failure threshold of 75 bytes.WarningsThe uncompressed size of the package @ember-data/store has increased by 132.0 B. Changeset Full Asset Analysis (Modern)Modern Builds (No Rollup) The size of the library EmberData has increased by 509.0 B (132.0 B compressed) which exceeds the failure threshold of 75 bytes.WarningsThe uncompressed size of the package @ember-data/store has increased by 509.0 B. Changeset Full Asset Analysis (Modern) |
|
Performance Report for 84ea514 Relationship Analysis |
snewcomer
commented
Aug 2, 2020
| INTERNAL_MODELS.set(this, internalModel); | ||
| } | ||
| } else { | ||
| INTERNAL_MODELS.set(this, identifierOrInternalModel as InternalModel); |
There was a problem hiding this comment.
Are we ok coercing variables to a specific type?
There was a problem hiding this comment.
Yeah, usually a type guard would be great, but we don't have one in this case.
snewcomer
added
the
🌲 Project Trim 🌲
igorT
reviewed
Aug 8, 2020
| @@ -33,7 +33,6 @@ export interface ExistingResourceIdentifierObject { | |||
| type: string; | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
I thought lid was a part of the JSONAPI spec. But it looks like it is upcoming.
snewcomer
force-pushed
the
sn/relationships-identifiers
branch
from
8021c5a to
a6850fb
Compare
snewcomer
force-pushed
the
sn/relationships-identifiers
branch
2 times, most recently
from
84c4f38 to
420db2a
Compare
snewcomer
force-pushed
the
sn/relationships-identifiers
branch
from
af82efe to
5de23dc
Compare
snewcomer
force-pushed
the
sn/relationships-identifiers
branch
2 times, most recently
from
f3f23f3 to
140b1d8
Compare
igorT
reviewed
Oct 14, 2020
| @@ -144,8 +144,8 @@ module('integration/references/belongs-to', function(hooks) { | |||
| var personReference = store.getReference('person', 1); | |||
| var familyReference = person.belongsTo('family'); | |||
|
|
|||
| assert.ok(personReference); | |||
| assert.equal(familyReference.parent, personReference); | |||
| assert.ok(personReference, 'person reference is present'); | |||
igorT
reviewed
Oct 14, 2020
| @@ -1436,9 +1439,20 @@ abstract class CoreStore extends Service { | |||
| } | |||
| const type = normalizeModelName(modelName); | |||
| const normalizedId = ensureStringId(id); | |||
| const resource = constructResource(type, normalizedId); | |||
| const resource: ResourceIdentifierObject = constructResource(type, normalizedId); | |||
There was a problem hiding this comment.
this type/id should be a recordIdentifer not a resource
There was a problem hiding this comment.
Sounds like we need to adjust the return type of constructResource to ResourceIdentifierObject | RecordIdentifier?
igorT
reviewed
Oct 14, 2020
| const resource: ResourceIdentifierObject = constructResource(type, normalizedId); | ||
|
|
||
| if (RECORD_ARRAY_MANAGER_IDENTIFIERS) { | ||
| const identifier: StableRecordIdentifier = identifierCacheFor(this).getOrCreateRecordIdentifier(resource); |
There was a problem hiding this comment.
We shouldn't getOrCreateRecordIdentifier here
igorT
reviewed
Oct 14, 2020
| @@ -82,7 +88,7 @@ export default class BelongsToReference extends Reference { | |||
| } | |||
|
|
|||
| _resource() { | |||
| return INTERNAL_MODELS.get(this)?._recordData.getBelongsTo(this.key); | |||
| return internalModelForReference(this)?._recordData.getBelongsTo(this.key); | |||
There was a problem hiding this comment.
You should be able to get the record data if you have the identifier right?
igorT
reviewed
Oct 14, 2020
| let resource = this._resource(); | ||
| if (resource && resource.data) { | ||
| let inverseInternalModel = store._internalModelForResource(resource.data); | ||
| let inverseInternalModel = this.store._internalModelForResource(resource.data); |
igorT
reviewed
Oct 14, 2020
|
|
||
| // TODO inverse | ||
| } | ||
|
|
||
| _resource() { | ||
| return INTERNAL_MODELS.get(this)?._recordData.getHasMany(this.key); | ||
| return internalModelForReference(this)?._recordData.getHasMany(this.key); |
There was a problem hiding this comment.
Should be able to get recordData via reference
There was a problem hiding this comment.
Are you suggesting we make a public getter for recordData on the Record instance?
If not, I was assuming here that the only way to get recordData was through the InternalModel. Perhaps there is a better way?
igorT
reviewed
Oct 14, 2020
| @@ -29,7 +32,15 @@ function isResourceIdentiferWithRelatedLinks( | |||
| return value && value.links && value.links.related; | |||
| } | |||
|
|
|||
| export const INTERNAL_MODELS = new WeakMap<Reference, InternalModel>(); | |||
| export const REFERENCE_CACHE = new WeakMap<Reference, InternalModel | StableRecordIdentifier>(); | |||
There was a problem hiding this comment.
Once RECORD_ARRAY_MANAGER_IDENTIFIERS are turned on, lets make sure to simplify this, maybe leave a todo comment and rename to be more descriptive
igorT
reviewed
Oct 14, 2020
|
|
||
| export function internalModelForReference(reference: Reference): InternalModel | null | undefined { | ||
| if (RECORD_ARRAY_MANAGER_IDENTIFIERS) { | ||
| return internalModelFactoryFor(reference.store).peek(REFERENCE_CACHE.get(reference) as StableRecordIdentifier); |
There was a problem hiding this comment.
I am fine with the messy TS as we are turning this FF very soon
igorT
reviewed
Oct 14, 2020
| INTERNAL_MODELS.set(this, internalModel); | ||
| constructor(public store: CoreStore, identifierOrInternalModel: InternalModel | StableRecordIdentifier) { | ||
| if (RECORD_ARRAY_MANAGER_IDENTIFIERS) { | ||
| REFERENCE_CACHE.set(this, identifierOrInternalModel as StableRecordIdentifier); |
snewcomer
force-pushed
the
sn/relationships-identifiers
branch
from
04d8bb0 to
9af131f
Compare
snewcomer
commented
Oct 15, 2020
| return null; | ||
| } else { | ||
| return internalModelForReference(this)!.id; | ||
| } |
There was a problem hiding this comment.
From meeting - an identifier getter probably makes sense. Will discuss in next week's meeting.
snewcomer
force-pushed
the
sn/relationships-identifiers
branch
from
9af131f to
88e9205
Compare
igorT
reviewed
Oct 23, 2020
| @@ -61,6 +61,10 @@ abstract class Reference { | |||
| } | |||
| } | |||
|
|
|||
| get recordData() { | |||
| return internalModelForReference(this)?._recordData; | |||
There was a problem hiding this comment.
Can you get the identifier here as we for when we do have it and use it to lookup the record data
snewcomer
force-pushed
the
sn/relationships-identifiers
branch
from
94209bf to
a1fe59c
Compare
igorT
reviewed
Oct 30, 2020
| @@ -16,6 +16,6 @@ import { dasherize } from '@ember/string'; | |||
| @param {String} modelName | |||
| @return {String} normalizedModelName | |||
| */ | |||
| export default function normalizeModelName(modelName) { | |||
| export default function normalizeModelName(modelName: string): string { | |||
igorT
approved these changes
Oct 30, 2020
This reverts commit 840d265.
…fier might be the argument
snewcomer
force-pushed
the
sn/relationships-identifiers
branch
from
a1fe59c to
84ea514
Compare
|
@snewcomer Have you thought about registering for Github Sponsorships? 😄 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ref #6166
past work #6715