enhance: Add garbage collection based on expiry time (#3343)

Author: ntucker

.changeset/rare-hairs-enjoy.md

@@ -0,0 +1,5 @@
+---
+'@data-client/core': patch
+---
+
+Add initManager()

.changeset/silly-hotels-shout.md

@@ -0,0 +1,5 @@
+---
+'@data-client/react': patch
+---
+
+Add gcPolicy option to DataProvider and prepareStore

.changeset/strange-buckets-clean.md

@@ -0,0 +1,6 @@
+---
+'@data-client/react': patch
+'@data-client/core': patch
+---
+
+Add GCPolicy

.circleci/config.yml

@@ -239,7 +239,7 @@ jobs:
 
 workflows:
   version: 2
-  all-tests:
+  validation:
     jobs:
       - setup
       - unit_tests:

.vscode/settings.json

@@ -48,6 +48,7 @@
     "packages/**/index.d.ts": true,
     "packages/*/lib": true,
     "packages/*/legacy": true,
+    "packages/*/native": true,
     "yarn.lock": true,
     "**/versioned_docs": true,
     "**/*_versioned_docs": true,

package.json

@@ -66,6 +66,8 @@
     "@react-navigation/native": "^7.0.0",
     "@react-navigation/native-stack": "^7.0.0",
     "@testing-library/dom": "^10.4.0",
+    "@testing-library/jest-dom": "^6.6.3",
+    "@testing-library/jest-native": "^5.4.3",
     "@testing-library/react": "16.1.0",
     "@testing-library/react-hooks": "8.0.1",
     "@testing-library/react-native": "13.0.0",

packages/core/src/actions.ts

@@ -1,6 +1,7 @@
 import type {
   Denormalize,
   EndpointInterface,
+  EntityPath,
   Queryable,
   ResolveType,
   UnknownError,
@@ -148,7 +149,7 @@ export interface ResetAction {
 /* GC */
 export interface GCAction {
   type: typeof GC;
-  entities: [string, string][];
+  entities: EntityPath[];
   endpoints: string[];
 }
 

packages/core/src/controller/Controller.ts

@@ -35,6 +35,8 @@ import {
 } from './actions/index.js';
 import ensurePojo from './ensurePojo.js';
 import type { EndpointUpdateFunction } from './types.js';
+import type { GCInterface } from '../state/GCPolicy.js';
+import { ImmortalGCPolicy } from '../state/GCPolicy.js';
 import { initialState } from '../state/reducer/createReducer.js';
 import selectMeta from '../state/selectMeta.js';
 import type { ActionTypes, State } from '../types.js';
@@ -46,6 +48,7 @@ interface ConstructorProps<D extends GenericDispatch = DataClientDispatch> {
   dispatch?: D;
   getState?: () => State<unknown>;
   memo?: Pick<MemoCache, 'denormalize' | 'query' | 'buildQueryKey'>;
+  gcPolicy?: GCInterface;
 }
 
 const unsetDispatch = (action: unknown): Promise<void> => {
@@ -89,14 +92,21 @@ export default class Controller<
     'denormalize' | 'query' | 'buildQueryKey'
   >;
 
+  /**
+   * Handles garbage collection
+   */
+  declare readonly gcPolicy: GCInterface;
+
   constructor({
     dispatch = unsetDispatch as any,
     getState = unsetState,
     memo = new MemoCache(),
+    gcPolicy = new ImmortalGCPolicy(),
   }: ConstructorProps<D> = {}) {
     this.dispatch = dispatch;
     this.getState = getState;
     this.memo = memo;
+    this.gcPolicy = gcPolicy;
   }
 
   /*************** Action Dispatchers ***************/
@@ -389,6 +399,7 @@ export default class Controller<
     data: DenormalizeNullable<E['schema']>;
     expiryStatus: ExpiryStatus;
     expiresAt: number;
+    countRef: () => () => void;
   };
 
   getResponse<
@@ -403,6 +414,7 @@ export default class Controller<
     data: DenormalizeNullable<E['schema']>;
     expiryStatus: ExpiryStatus;
     expiresAt: number;
+    countRef: () => () => void;
   };
 
   getResponse(
@@ -412,6 +424,7 @@ export default class Controller<
     data: unknown;
     expiryStatus: ExpiryStatus;
     expiresAt: number;
+    countRef: () => () => void;
   } {
     const state = rest[rest.length - 1] as State<unknown>;
     // this is typescript generics breaking
@@ -446,12 +459,14 @@ export default class Controller<
         data: input as any,
         expiryStatus: ExpiryStatus.Valid,
         expiresAt: Infinity,
+        countRef: () => () => undefined,
       };
     }
 
     let isInvalid = false;
     if (shouldQuery) {
       isInvalid = !validateQueryKey(input);
+      // endpoint without entities
     } else if (!schema || !schemaHasEntity(schema)) {
       return {
         data: cacheEndpoints,
@@ -460,6 +475,7 @@ export default class Controller<
           : cacheEndpoints && !endpoint.invalidIfStale ? ExpiryStatus.Valid
           : ExpiryStatus.InvalidIfStale,
         expiresAt: expiresAt || 0,
+        countRef: this.gcPolicy.createCountRef({ key }),
       };
     }
 
@@ -477,6 +493,7 @@ export default class Controller<
 
     return this.getSchemaResponse(
       data,
+      key,
       paths,
       state.entityMeta,
       expiresAt,
@@ -507,6 +524,7 @@ export default class Controller<
 
   private getSchemaResponse<T>(
     data: T,
+    key: string,
     paths: EntityPath[],
     entityMeta: State<unknown>['entityMeta'],
     expiresAt: number,
@@ -516,6 +534,7 @@ export default class Controller<
     data: T;
     expiryStatus: ExpiryStatus;
     expiresAt: number;
+    countRef: () => () => void;
   } {
     const invalidDenormalize = typeof data === 'symbol';
 
@@ -533,7 +552,12 @@ export default class Controller<
       : invalidDenormalize || invalidIfStale ? ExpiryStatus.InvalidIfStale
       : ExpiryStatus.Valid;
 
-    return { data, expiryStatus, expiresAt };
+    return {
+      data,
+      expiryStatus,
+      expiresAt,
+      countRef: this.gcPolicy.createCountRef({ key, paths }),
+    };
   }
 }
 

packages/core/src/index.ts

@@ -29,11 +29,13 @@ export {
   default as NetworkManager,
   ResetError,
 } from './manager/NetworkManager.js';
+export * from './state/GCPolicy.js';
 export {
   default as createReducer,
   initialState,
 } from './state/reducer/createReducer.js';
 export { default as applyManager } from './manager/applyManager.js';
+export { default as initManager } from './manager/initManager.js';
 
 export { default as Controller } from './controller/Controller.js';
 export type {

packages/core/src/manager/SubscriptionManager.ts

@@ -2,7 +2,6 @@ import { SUBSCRIBE, UNSUBSCRIBE } from '../actionTypes.js';
 import Controller from '../controller/Controller.js';
 import type {
   Manager,
-  MiddlewareAPI,
   Middleware,
   UnsubscribeAction,
   SubscribeAction,