Skip to content

Commit

Permalink
Cleanup outdated records after model/ouput type resolvers updates
Browse files Browse the repository at this point in the history 
Reviewed By: voideanvalue

Differential Revision: D52547082

fbshipit-source-id: 550bee0c535f98f0ebe8965b1e19ebc49721fa88
  • Loading branch information
@alunyov @facebook-github-bot
alunyov authored and facebook-github-bot committed Jan 17, 2024
1 parent d2a6b7c commit eb0b7fc
Show file tree
Hide file tree
Showing 3 changed files with 132 additions and 60 deletions.
8 changes: 2 additions & 6 deletions packages/react-relay/__tests__/RelayResolverModel-test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -313,11 +313,7 @@ describe.each([
completeTodo('todo-1');
jest.runAllImmediates();
});
// `completeTodo` should publish new update to the record with Todo item
// and it will create a new subscription for the `live_color` field
// without unsubscribing from the previous one. So now we have two active
// subscriptions for the `live_color` field.
expect(LiveColorSubscriptions.activeSubscriptions.length).toBe(2);
expect(LiveColorSubscriptions.activeSubscriptions.length).toBe(1);

expect(renderer.toJSON()).toEqual('Test todo - green');

Expand All @@ -331,7 +327,7 @@ describe.each([
store.scheduleGC();
jest.runAllImmediates();

expect(LiveColorSubscriptions.activeSubscriptions.length).toBe(1);
expect(LiveColorSubscriptions.activeSubscriptions.length).toBe(0);
});

test('read a field with arguments', () => {
Expand Down
33 changes: 33 additions & 0 deletions packages/relay-runtime/store/RelayModernRecord.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,20 @@ function getLinkedRecordID(record: Record, storageKey: StorageKey): ?DataID {
return link[REF_KEY];
}

/**
* @public
*
* Checks if a field has a reference to another record.
*/
function hasLinkedRecordID(record: Record, storageKey: StorageKey): boolean {
const maybeLink = record[storageKey];
if (maybeLink == null) {
return false;
}
const link = maybeLink;
return typeof link === 'object' && link && typeof link[REF_KEY] === 'string';
}

/**
* @public
*
Expand Down Expand Up @@ -286,6 +300,23 @@ function getLinkedRecordIDs(
return (links[REFS_KEY]: any);
}

/**
* @public
*
* Checks if a field have references to other records.
*/
function hasLinkedRecordIDs(record: Record, storageKey: StorageKey): boolean {
const links = record[storageKey];
if (links == null) {
return false;
}
return (
typeof links === 'object' &&
Array.isArray(links[REFS_KEY]) &&
links[REFS_KEY].every(link => typeof link === 'string')
);
}

/**
* @public
*
Expand Down Expand Up @@ -677,6 +708,8 @@ module.exports = {
getType,
getValue,
hasValue,
hasLinkedRecordID,
hasLinkedRecordIDs,
merge,
setErrors,
setValue,
Expand Down
151 changes: 97 additions & 54 deletions packages/relay-runtime/store/experimental-live-resolvers/LiveResolverCache.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ class LiveResolverCache implements ResolverCache {
// Clean up any existing subscriptions before creating the new subscription
// to avoid being double subscribed, or having a dangling subscription in
// the event of an error during subscription.
this._maybeUnsubscribeFromLiveState(linkedRecord);
maybeUnsubscribeFromLiveState(linkedRecord);
}
linkedID = linkedID ?? generateClientID(recordID, storageKey);
linkedRecord = RelayModernRecord.create(
Expand Down Expand Up @@ -339,18 +339,6 @@ class LiveResolverCache implements ResolverCache {
});
}

_maybeUnsubscribeFromLiveState(linkedRecord: Record) {
// If there's an existing subscription, unsubscribe.
// $FlowFixMe[incompatible-type] - casting mixed
const previousUnsubscribe: () => void = RelayModernRecord.getValue(
linkedRecord,
RELAY_RESOLVER_LIVE_STATE_SUBSCRIPTION_KEY,
);
if (previousUnsubscribe != null) {
previousUnsubscribe();
}
}

// Register a new Live State object in the store, subscribing to future
// updates.
_setLiveStateValue(
Expand Down Expand Up @@ -674,7 +662,7 @@ class LiveResolverCache implements ResolverCache {
continue;
}
for (const anotherRecordID of recordSet) {
this._markInvalidatedResolverRecord(anotherRecordID, recordSource);
markInvalidatedResolverRecord(anotherRecordID, recordSource);
if (!visited.has(anotherRecordID)) {
recordsToVisit.push(anotherRecordID);
}
Expand All @@ -684,28 +672,6 @@ class LiveResolverCache implements ResolverCache {
}
}

_markInvalidatedResolverRecord(
dataID: DataID,
recordSource: MutableRecordSource, // Written to
) {
const record = recordSource.get(dataID);
if (!record) {
warning(
false,
'Expected a resolver record with ID %s, but it was missing.',
dataID,
);
return;
}
const nextRecord = RelayModernRecord.clone(record);
RelayModernRecord.setValue(
nextRecord,
RELAY_RESOLVER_INVALIDATION_KEY,
true,
);
recordSource.set(dataID, nextRecord);
}

_isInvalid(
record: Record,
getDataForResolverFragment: GetDataForResolverFragmentFn,
Expand Down Expand Up @@ -752,19 +718,10 @@ class LiveResolverCache implements ResolverCache {
}

unsubscribeFromLiveResolverRecords(invalidatedDataIDs: Set<DataID>): void {
if (invalidatedDataIDs.size === 0) {
return;
}

for (const dataID of invalidatedDataIDs) {
const record = this._getRecordSource().get(dataID);
if (
record != null &&
RelayModernRecord.getType(record) === RELAY_RESOLVER_RECORD_TYPENAME
) {
this._maybeUnsubscribeFromLiveState(record);
}
}
return unsubscribeFromLiveResolverRecordsImpl(
this._getRecordSource(),
invalidatedDataIDs,
);
}

// Given the set of possible invalidated DataID
Expand All @@ -778,10 +735,7 @@ class LiveResolverCache implements ResolverCache {

for (const dataID of invalidatedDataIDs) {
const record = this._getRecordSource().get(dataID);
if (
record != null &&
RelayModernRecord.getType(record) === RELAY_RESOLVER_RECORD_TYPENAME
) {
if (record != null && isResolverRecord(record)) {
this._getRecordSource().delete(dataID);
}
}
Expand Down Expand Up @@ -856,7 +810,11 @@ function updateCurrentSource(
const updatedRecord = RelayModernRecord.update(currentRecord, nextRecord);
if (updatedRecord !== currentRecord) {
updatedDataIDs.add(recordID);
currentSource.set(recordID, nextRecord);
currentSource.set(recordID, updatedRecord);
// We also need to mark all linked records from the current record as invalidated,
// so that the next time these records are accessed in RelayReader,
// they will be re-read and re-evaluated by the LiveResolverCache and re-subscribed.
markInvalidatedLinkedResolverRecords(currentRecord, currentSource);
}
} else {
currentSource.set(recordID, nextRecord);
Expand All @@ -866,6 +824,91 @@ function updateCurrentSource(
return updatedDataIDs;
}

function getAllLinkedRecordIds(record: Record): DataIDSet {
const linkedRecordIDs = new Set<DataID>();
RelayModernRecord.getFields(record).forEach(field => {
if (RelayModernRecord.hasLinkedRecordID(record, field)) {
const linkedRecordID = RelayModernRecord.getLinkedRecordID(record, field);
if (linkedRecordID != null) {
linkedRecordIDs.add(linkedRecordID);
}
} else if (RelayModernRecord.hasLinkedRecordIDs(record, field)) {
RelayModernRecord.getLinkedRecordIDs(record, field)?.forEach(
linkedRecordID => {
if (linkedRecordID != null) {
linkedRecordIDs.add(linkedRecordID);
}
},
);
}
});

return linkedRecordIDs;
}

function markInvalidatedResolverRecord(
dataID: DataID,
recordSource: MutableRecordSource, // Written to
) {
const record = recordSource.get(dataID);
if (!record) {
warning(
false,
'Expected a resolver record with ID %s, but it was missing.',
dataID,
);
return;
}
const nextRecord = RelayModernRecord.clone(record);
RelayModernRecord.setValue(nextRecord, RELAY_RESOLVER_INVALIDATION_KEY, true);
recordSource.set(dataID, nextRecord);
}

function markInvalidatedLinkedResolverRecords(
record: Record,
recordSource: MutableRecordSource,
): void {
const currentLinkedDataIDs = getAllLinkedRecordIds(record);
for (const recordID of currentLinkedDataIDs) {
const record = recordSource.get(recordID);
if (record != null && isResolverRecord(record)) {
markInvalidatedResolverRecord(recordID, recordSource);
}
}
}

function unsubscribeFromLiveResolverRecordsImpl(
recordSource: RecordSource,
invalidatedDataIDs: $ReadOnlySet<DataID>,
): void {
if (invalidatedDataIDs.size === 0) {
return;
}

for (const dataID of invalidatedDataIDs) {
const record = recordSource.get(dataID);
if (record != null && isResolverRecord(record)) {
maybeUnsubscribeFromLiveState(record);
}
}
}

function isResolverRecord(record: Record): boolean {
return RelayModernRecord.getType(record) === RELAY_RESOLVER_RECORD_TYPENAME;
}

function maybeUnsubscribeFromLiveState(linkedRecord: Record): void {
// If there's an existing subscription, unsubscribe.
// $FlowFixMe[incompatible-type] - casting mixed
const previousUnsubscribe: () => void = RelayModernRecord.getValue(
linkedRecord,
RELAY_RESOLVER_LIVE_STATE_SUBSCRIPTION_KEY,
);
if (previousUnsubscribe != null) {
previousUnsubscribe();
}
}

function expectRecord(source: RecordSource, recordID: DataID): Record {
const record = source.get(recordID);
invariant(
Expand Down

0 comments on commit eb0b7fc

Please sign in to comment.