@isograph/react 0.0.0-main-3f26c9c8 → 0.0.0-main-84b67b62

package/src/core/IsographEnvironment.ts

@@ -1,4 +1,5 @@
 import { ParentCache } from '@isograph/react-disposable-state';
+import type { Brand } from './brand';
 import {
   IsographEntrypoint,
   IsographOperation,
@@ -12,10 +13,10 @@ import {
 } from './FragmentReference';
 import type { RetainedQuery } from './garbageCollection';
 import { LogFunction, WrappedLogFunction } from './logging';
+import { type StoreLayer } from './optimisticProxy';
 import { PromiseWrapper, wrapPromise } from './PromiseWrapper';
 import { WithEncounteredRecords } from './read';
 import type { ReaderAst, StartUpdate } from './reader';
-import type { Brand } from './brand';
 
 export type ComponentOrFieldName = string;
 export type StringifiedArgs = string;
@@ -56,7 +57,7 @@ export type Subscriptions = Set<Subscription>;
 export type CacheMap<T> = { [index: string]: ParentCache<T> };
 
 export type IsographEnvironment = {
-  readonly store: IsographStore;
+  store: StoreLayer;
   readonly networkFunction: IsographNetworkFunction;
   readonly missingFieldHandler: MissingFieldHandler | null;
   readonly componentCache: FieldCache<React.FC<any>>;
@@ -125,18 +126,21 @@ export type DataId = string;
 
 export const ROOT_ID: DataId & '__ROOT' = '__ROOT';
 
-export type IsographStore = {
+export type StoreLayerData = {
   [index: TypeName]: {
     [index: DataId]: StoreRecord | null;
   } | null;
+};
+
+export interface BaseStoreLayerData extends StoreLayerData {
   readonly Query: {
     readonly __ROOT: StoreRecord;
   };
-};
+}
 
 const DEFAULT_GC_BUFFER_SIZE = 10;
 export function createIsographEnvironment(
-  store: IsographStore,
+  baseStoreLayerData: BaseStoreLayerData,
   networkFunction: IsographNetworkFunction,
   missingFieldHandler?: MissingFieldHandler | null,
   logFunction?: LogFunction | null,
@@ -144,6 +148,12 @@ export function createIsographEnvironment(
   logFunction?.({
     kind: 'EnvironmentCreated',
   });
+  let store = {
+    kind: 'BaseStoreLayer',
+    data: baseStoreLayerData,
+    parentStoreLayer: null,
+    childStoreLayer: null,
+  } as const;
   return {
     store,
     networkFunction,
@@ -160,7 +170,7 @@ export function createIsographEnvironment(
   };
 }
 
-export function createIsographStore(): IsographStore {
+export function createIsographStore(): BaseStoreLayerData {
   return {
     Query: {
       [ROOT_ID]: {},

package/src/core/cache.ts

@@ -34,6 +34,10 @@ import {
 } from './IsographEnvironment';
 import { logMessage } from './logging';
 import { maybeMakeNetworkRequest } from './makeNetworkRequest';
+import {
+  getMutableStoreRecordProxy,
+  type StoreLayerWithData,
+} from './optimisticProxy';
 import { wrapPromise, wrapResolvedValue } from './PromiseWrapper';
 import { readButDoNotEvaluate, WithEncounteredRecords } from './read';
 import { ReaderLinkedField, ReaderScalarField, type ReaderAst } from './reader';
@@ -154,13 +158,13 @@ export type NetworkResponseObject = {
 
 export function normalizeData(
   environment: IsographEnvironment,
+  storeLayer: StoreLayerWithData,
   normalizationAst: NormalizationAstNodes,
   networkResponse: NetworkResponseObject,
   variables: Variables,
   root: StoreLink,
+  encounteredIds: EncounteredIds,
 ): EncounteredIds {
-  const encounteredIds: EncounteredIds = new Map();
-
   logMessage(environment, () => ({
     kind: 'AboutToNormalize',
     normalizationAst,
@@ -168,11 +172,11 @@ export function normalizeData(
     variables,
   }));
 
-  const recordsById = (environment.store[root.__typename] ??= {});
-  const newStoreRecord = (recordsById[root.__link] ??= {});
+  const newStoreRecord = getMutableStoreRecordProxy(storeLayer, root);
 
   normalizeDataIntoRecord(
     environment,
+    storeLayer,
     normalizationAst,
     networkResponse,
     newStoreRecord,
@@ -181,13 +185,6 @@ export function normalizeData(
     encounteredIds,
   );
 
-  logMessage(environment, () => ({
-    kind: 'AfterNormalization',
-    store: environment.store,
-    encounteredIds,
-  }));
-
-  callSubscriptions(environment, encounteredIds);
   return encounteredIds;
 }
 
@@ -421,6 +418,7 @@ export type EncounteredIds = Map<TypeName, Set<DataId>>;
  */
 function normalizeDataIntoRecord(
   environment: IsographEnvironment,
+  storeLayer: StoreLayerWithData,
   normalizationAst: NormalizationAstNodes,
   networkResponseParentRecord: NetworkResponseObject,
   targetParentRecord: StoreRecord,
@@ -445,6 +443,7 @@ function normalizeDataIntoRecord(
       case 'Linked': {
         const linkedFieldResultedInChange = normalizeLinkedField(
           environment,
+          storeLayer,
           normalizationNode,
           networkResponseParentRecord,
           targetParentRecord,
@@ -459,6 +458,7 @@ function normalizeDataIntoRecord(
       case 'InlineFragment': {
         const inlineFragmentResultedInChange = normalizeInlineFragment(
           environment,
+          storeLayer,
           normalizationNode,
           networkResponseParentRecord,
           targetParentRecord,
@@ -526,6 +526,7 @@ function normalizeScalarField(
  */
 function normalizeLinkedField(
   environment: IsographEnvironment,
+  storeLayer: StoreLayerWithData,
   astNode: NormalizationLinkedField,
   networkResponseParentRecord: NetworkResponseObject,
   targetParentRecord: StoreRecord,
@@ -563,6 +564,7 @@ function normalizeLinkedField(
       }
       const newStoreRecordId = normalizeNetworkResponseObject(
         environment,
+        storeLayer,
         astNode,
         networkResponseObject,
         targetParentRecordLink,
@@ -589,6 +591,7 @@ function normalizeLinkedField(
   } else {
     const newStoreRecordId = normalizeNetworkResponseObject(
       environment,
+      storeLayer,
       astNode,
       networkResponseData,
       targetParentRecordLink,
@@ -622,6 +625,7 @@ function normalizeLinkedField(
  */
 function normalizeInlineFragment(
   environment: IsographEnvironment,
+  storeLayer: StoreLayerWithData,
   astNode: NormalizationInlineFragment,
   networkResponseParentRecord: NetworkResponseObject,
   targetParentRecord: StoreRecord,
@@ -633,6 +637,7 @@ function normalizeInlineFragment(
   if (networkResponseParentRecord[TYPENAME_FIELD_NAME] === typeToRefineTo) {
     const hasBeenModified = normalizeDataIntoRecord(
       environment,
+      storeLayer,
       astNode.selections,
       networkResponseParentRecord,
       targetParentRecord,
@@ -670,6 +675,7 @@ function dataIdsAreTheSame(
 
 function normalizeNetworkResponseObject(
   environment: IsographEnvironment,
+  storeLayer: StoreLayerWithData,
   astNode: NormalizationLinkedField,
   networkResponseData: NetworkResponseObject,
   targetParentRecordLink: StoreLink,
@@ -694,15 +700,16 @@ function normalizeNetworkResponseObject(
     );
   }
 
-  const recordsById = (environment.store[__typename] ??= {});
-  const newStoreRecord = (recordsById[newStoreRecordId] ??= {});
+  const link = { __link: newStoreRecordId, __typename };
+  const newStoreRecord = getMutableStoreRecordProxy(storeLayer, link);
 
   normalizeDataIntoRecord(
     environment,
+    storeLayer,
     astNode.selections,
     networkResponseData,
     newStoreRecord,
-    { __link: newStoreRecordId, __typename: __typename },
+    link,
     variables,
     mutableEncounteredIds,
   );

package/src/core/check.ts

@@ -8,6 +8,7 @@ import {
   StoreRecord,
 } from './IsographEnvironment';
 import { logMessage } from './logging';
+import { getStoreRecordProxy } from './optimisticProxy';
 
 export type ShouldFetch = RequiredShouldFetch | 'IfNecessary';
 export type RequiredShouldFetch = 'Yes' | 'No';
@@ -39,8 +40,14 @@ export function check(
   variables: Variables,
   root: StoreLink,
 ): CheckResult {
-  const recordsById = (environment.store[root.__typename] ??= {});
-  const newStoreRecord = (recordsById[root.__link] ??= {});
+  const newStoreRecord = getStoreRecordProxy(environment.store, root);
+
+  if (newStoreRecord == null) {
+    return {
+      kind: 'MissingData',
+      record: root,
+    };
+  }
 
   const checkResult = checkFromRecord(
     environment,
@@ -107,8 +114,7 @@ function checkFromRecord(
               );
             }
 
-            const linkedRecord =
-              environment.store[link.__typename]?.[link.__link];
+            const linkedRecord = getStoreRecordProxy(environment.store, link);
 
             if (linkedRecord === undefined) {
               return {
@@ -141,8 +147,7 @@ function checkFromRecord(
             );
           }
 
-          const linkedRecord =
-            environment.store[link.__typename]?.[link.__link];
+          const linkedRecord = getStoreRecordProxy(environment.store, link);
 
           if (linkedRecord === undefined) {
             return {

package/src/core/garbageCollection.ts

@@ -5,11 +5,12 @@ import {
   assertLink,
   DataId,
   IsographEnvironment,
-  IsographStore,
   StoreRecord,
+  type StoreLayerData,
   type StoreLink,
   type TypeName,
 } from './IsographEnvironment';
+import type { StoreLayer } from './optimisticProxy';
 import {
   NOT_SET,
   type PromiseWrapper,
@@ -62,8 +63,6 @@ export function retainQuery(
 }
 
 export function garbageCollectEnvironment(environment: IsographEnvironment) {
-  const retainedIds: RetainedIds = {};
-
   const retainedQueries: RetainedQueryWithNormalizationAst[] = [];
   for (const query of environment.retainedQueries) {
     if (!isRetainedQueryWithNormalizationAst(query)) {
@@ -79,18 +78,31 @@ export function garbageCollectEnvironment(environment: IsographEnvironment) {
     retainedQueries.push(query);
   }
 
+  let node: StoreLayer | null = environment.store;
+  while (node !== null) {
+    garbageCollectLayer(retainedQueries, node.data);
+    node = node.parentStoreLayer;
+  }
+}
+
+export function garbageCollectLayer(
+  retainedQueries: RetainedQueryWithNormalizationAst[],
+  dataLayer: StoreLayerData,
+) {
+  const retainedIds: RetainedIds = {};
+
   for (const query of retainedQueries) {
-    recordReachableIds(environment.store, query, retainedIds);
+    recordReachableIds(dataLayer, query, retainedIds);
   }
 
-  for (const typeName in environment.store) {
-    const dataById = environment.store[typeName];
+  for (const typeName in dataLayer) {
+    const dataById = dataLayer[typeName];
     if (dataById == null) continue;
     const retainedTypeIds = retainedIds[typeName];
 
     // delete all objects
     if (retainedTypeIds == undefined || retainedTypeIds.size == 0) {
-      delete environment.store[typeName];
+      delete dataLayer[typeName];
       continue;
     }
 
@@ -101,7 +113,7 @@ export function garbageCollectEnvironment(environment: IsographEnvironment) {
     }
 
     if (Object.keys(dataById).length === 0) {
-      delete environment.store[typeName];
+      delete dataLayer[typeName];
     }
   }
 }
@@ -111,12 +123,12 @@ interface RetainedIds {
 }
 
 function recordReachableIds(
-  store: IsographStore,
+  dataLayer: StoreLayerData,
   retainedQuery: RetainedQueryWithNormalizationAst,
   mutableRetainedIds: RetainedIds,
 ) {
   const record =
-    store[retainedQuery.root.__typename]?.[retainedQuery.root.__link];
+    dataLayer[retainedQuery.root.__typename]?.[retainedQuery.root.__link];
 
   const retainedRecordsIds = (mutableRetainedIds[
     retainedQuery.root.__typename
@@ -125,7 +137,7 @@ function recordReachableIds(
 
   if (record) {
     recordReachableIdsFromRecord(
-      store,
+      dataLayer,
       record,
       mutableRetainedIds,
       retainedQuery.normalizationAst.result.value.selections,
@@ -135,7 +147,7 @@ function recordReachableIds(
 }
 
 function recordReachableIdsFromRecord(
-  store: IsographStore,
+  dataLayer: StoreLayerData,
   currentRecord: StoreRecord,
   mutableRetainedIds: RetainedIds,
   selections: NormalizationAstNodes,
@@ -164,7 +176,7 @@ function recordReachableIdsFromRecord(
 
         let typeStore =
           selection.concreteType !== null
-            ? store[selection.concreteType]
+            ? dataLayer[selection.concreteType]
             : null;
 
         if (typeStore == null && selection.concreteType !== null) {
@@ -174,7 +186,7 @@ function recordReachableIdsFromRecord(
         for (const nextRecordLink of links) {
           let __typename = nextRecordLink.__typename;
 
-          const resolvedTypeStore = typeStore ?? store[__typename];
+          const resolvedTypeStore = typeStore ?? dataLayer[__typename];
 
           if (resolvedTypeStore == null) {
             continue;
@@ -186,7 +198,7 @@ function recordReachableIdsFromRecord(
               new Set());
             retainedRecordsIds.add(nextRecordLink.__link);
             recordReachableIdsFromRecord(
-              store,
+              dataLayer,
               nextRecord,
               mutableRetainedIds,
               selection.selections,

package/src/core/logging.ts

@@ -9,12 +9,12 @@ import {
 import { FragmentReference, Variables } from './FragmentReference';
 import {
   IsographEnvironment,
-  IsographStore,
   StoreRecord,
   type StoreLink,
 } from './IsographEnvironment';
 import { ReadDataResult } from './read';
 import { Arguments } from './util';
+import type { StoreLayer } from './optimisticProxy';
 
 export type LogMessage =
   | {
@@ -25,7 +25,7 @@ export type LogMessage =
     }
   | {
       kind: 'AfterNormalization';
-      store: IsographStore;
+      store: StoreLayer;
       encounteredIds: EncounteredIds;
     }
   | {

package/src/core/makeNetworkRequest.ts

@@ -1,5 +1,5 @@
 import { ItemCleanupPair } from '@isograph/disposable-types';
-import { normalizeData } from './cache';
+import { callSubscriptions, normalizeData, type EncounteredIds } from './cache';
 import { check, DEFAULT_SHOULD_FETCH_VALUE, FetchOptions } from './check';
 import { getOrCreateCachedComponent } from './componentCache';
 import {
@@ -22,6 +22,7 @@ import {
 } from './garbageCollection';
 import { IsographEnvironment, ROOT_ID, StoreLink } from './IsographEnvironment';
 import { logMessage } from './logging';
+import { addNetworkResponseStoreLayer } from './optimisticProxy';
 import {
   AnyError,
   PromiseWrapper,
@@ -201,13 +202,25 @@ export function makeNetworkRequest<
 
       const root = { __link: ROOT_ID, __typename: artifact.concreteType };
       if (status.kind === 'Undisposed') {
+        const encounteredIds: EncounteredIds = new Map();
+        environment.store = addNetworkResponseStoreLayer(environment.store);
         normalizeData(
           environment,
+          environment.store,
           normalizationAst.selections,
           networkResponse.data ?? {},
           variables,
           root,
+          encounteredIds,
         );
+
+        logMessage(environment, () => ({
+          kind: 'AfterNormalization',
+          store: environment.store,
+          encounteredIds: encounteredIds,
+        }));
+
+        callSubscriptions(environment, encounteredIds);
       }
 
       const onComplete = fetchOptions?.onComplete;