houdini 1.0.0-next.3 → 1.0.0-next.5

package/build/runtime-cjs/cache/cache.js

@@ -22,12 +22,14 @@ __export(cache_exports, {
   rootID: () => rootID
 });
 module.exports = __toCommonJS(cache_exports);
+var import_lib = require("../lib");
 var import_config = require("../lib/config");
 var import_deepEquals = require("../lib/deepEquals");
 var import_selection = require("../lib/selection");
 var import_gc = require("./gc");
 var import_lists = require("./lists");
 var import_schema = require("./schema");
+var import_staleManager = require("./staleManager");
 var import_storage = require("./storage");
 var import_stuff = require("./stuff");
 var import_subscription = require("./subscription");
@@ -40,6 +42,7 @@ class Cache {
       subscriptions: new import_subscription.InMemorySubscriptions(this),
       lists: new import_lists.ListManager(this, rootID),
       lifetimes: new import_gc.GarbageCollector(this),
+      staleManager: new import_staleManager.StaleManager(this),
       schema: new import_schema.SchemaManager(this)
     });
     if (config) {
@@ -69,13 +72,14 @@ class Cache {
     return subscribers;
   }
   read(...args) {
-    const { data, partial, hasData } = this._internal_unstable.getSelection(...args);
+    const { data, partial, stale, hasData } = this._internal_unstable.getSelection(...args);
     if (!hasData) {
-      return { data: null, partial: false };
+      return { data: null, partial: false, stale: false };
     }
     return {
       data,
-      partial
+      partial,
+      stale
     };
   }
   subscribe(spec, variables = {}) {
@@ -111,6 +115,30 @@ class Cache {
   setConfig(config) {
     this._internal_unstable.setConfig(config);
   }
+  markTypeStale(type, options = {}) {
+    if (!type) {
+      this._internal_unstable.staleManager.markAllStale();
+    } else if (!options.field) {
+      this._internal_unstable.staleManager.markTypeStale(type);
+    } else {
+      this._internal_unstable.staleManager.markTypeFieldStale(
+        type,
+        options.field,
+        options.when
+      );
+    }
+  }
+  markRecordStale(id, options) {
+    if (options.field) {
+      const key = (0, import_lib.computeKey)({ field: options.field, args: options.when ?? {} });
+      this._internal_unstable.staleManager.markFieldStale(id, key);
+    } else {
+      this._internal_unstable.staleManager.markRecordStale(id);
+    }
+  }
+  getFieldTime(id, field) {
+    return this._internal_unstable.staleManager.getFieldTime(id, field);
+  }
 }
 class CacheInternal {
   _disabled = false;
@@ -126,6 +154,7 @@ class CacheInternal {
   lists;
   cache;
   lifetimes;
+  staleManager;
   schema;
   constructor({
     storage,
@@ -133,6 +162,7 @@ class CacheInternal {
     lists,
     cache,
     lifetimes,
+    staleManager,
     schema
   }) {
     this.storage = storage;
@@ -140,6 +170,7 @@ class CacheInternal {
     this.lists = lists;
     this.cache = cache;
     this.lifetimes = lifetimes;
+    this.staleManager = staleManager;
     this.schema = schema;
     this._disabled = typeof globalThis.window === "undefined";
     try {
@@ -157,10 +188,11 @@ class CacheInternal {
     selection,
     variables = {},
     parent = rootID,
-    applyUpdates = false,
+    applyUpdates,
     layer,
     toNotify = [],
-    forceNotify
+    forceNotify,
+    forceStale
   }) {
     if (this._disabled) {
       return [];
@@ -178,7 +210,7 @@ class CacheInternal {
         selection: fieldSelection,
         operations,
         abstract: isAbstract,
-        update,
+        updates,
         nullable
       } = targetSelection[field];
       const key = (0, import_stuff.evaluateKey)(keyRaw, variables);
@@ -195,16 +227,31 @@ class CacheInternal {
       const displayLayer = layer.isDisplayLayer(displayLayers);
       if (displayLayer) {
         this.lifetimes.resetLifetime(parent, key);
+        if (forceStale) {
+          this.staleManager.markFieldStale(parent, key);
+        } else {
+          this.staleManager.setFieldTimeToNow(parent, key);
+        }
       }
       if (!fieldSelection) {
         let newValue = value;
-        if (Array.isArray(value) && applyUpdates && update) {
-          if (update === "append") {
-            newValue = (previousValue || []).concat(value);
-          } else if (update === "prepend") {
-            newValue = value.concat(previousValue || []);
+        if (updates && applyUpdates && Array.isArray(value)) {
+          for (const update of applyUpdates) {
+            if (!updates.includes(update)) {
+              continue;
+            }
+            if (update === "append") {
+              newValue = (previousValue || []).concat(value);
+            } else if (update === "prepend") {
+              newValue = value.concat(previousValue || []);
+            }
           }
         }
+        if (updates && applyUpdates?.includes("prepend") && ["endCursor", "hasNextPage"].includes(key)) {
+          newValue = previousValue;
+        } else if (updates && applyUpdates?.includes("append") && ["startCursor", "hasPreviousPage"].includes(key)) {
+          newValue = previousValue;
+        }
         const valueChanged = !(0, import_deepEquals.deepEquals)(newValue, previousValue);
         if (displayLayer && (valueChanged || forceNotify)) {
           toNotify.push(...currentSubscribers);
@@ -264,7 +311,7 @@ class CacheInternal {
         }
       } else if (Array.isArray(value) && (typeof previousValue === "undefined" || Array.isArray(previousValue))) {
         let oldIDs = [...previousValue || []];
-        const emptyEdges = !update ? [] : oldIDs.map((id) => {
+        const emptyEdges = !updates ? [] : oldIDs.map((id) => {
           if (!id) {
             return "";
           }
@@ -292,7 +339,7 @@ class CacheInternal {
           layer,
           forceNotify
         });
-        if (applyUpdates && update) {
+        if (applyUpdates && updates) {
           if (key === "edges") {
             const newNodeIDs = [];
             for (const id of newIDs) {
@@ -320,12 +367,17 @@ class CacheInternal {
               return true;
             });
           }
-          if (update === "prepend") {
-            linkedIDs = newIDs.concat(oldIDs);
-          } else if (update === "append") {
-            linkedIDs = oldIDs.concat(newIDs);
-          } else if (update === "replace") {
-            linkedIDs = newIDs;
+          for (const update of applyUpdates) {
+            if (update !== "replace" && !updates.includes(update)) {
+              continue;
+            }
+            if (update === "prepend") {
+              linkedIDs = newIDs.concat(oldIDs);
+            } else if (update === "append") {
+              linkedIDs = oldIDs.concat(newIDs);
+            } else if (update === "replace") {
+              linkedIDs = newIDs;
+            }
           }
         } else {
           linkedIDs = nestedIDs;
@@ -411,12 +463,13 @@ class CacheInternal {
     stepsFromConnection = null
   }) {
     if (parent === null) {
-      return { data: null, partial: false, hasData: true };
+      return { data: null, partial: false, stale: false, hasData: true };
     }
     const target = {};
     let hasData = false;
     let partial = false;
     let cascadeNull = false;
+    let stale = false;
     const typename = this.storage.get(parent, "__typename").value;
     let targetSelection = (0, import_selection.getFieldsForType)(selection, typename);
     for (const [
@@ -425,6 +478,10 @@ class CacheInternal {
     ] of Object.entries(targetSelection)) {
       const key = (0, import_stuff.evaluateKey)(keyRaw, variables);
       const { value } = this.storage.get(parent, key);
+      const dt_field = this.staleManager.getFieldTime(parent, key);
+      if (dt_field === null) {
+        stale = true;
+      }
       let nextStep = stepsFromConnection;
       if (nextStep !== null) {
         if (nextStep >= 2) {
@@ -464,6 +521,9 @@ class CacheInternal {
         if (listValue.partial) {
           partial = true;
         }
+        if (listValue.stale) {
+          stale = true;
+        }
         if (listValue.hasData || value.length === 0) {
           hasData = true;
         }
@@ -478,6 +538,9 @@ class CacheInternal {
         if (objectFields.partial) {
           partial = true;
         }
+        if (objectFields.stale) {
+          stale = true;
+        }
         if (objectFields.hasData) {
           hasData = true;
         }
@@ -489,6 +552,7 @@ class CacheInternal {
     return {
       data: cascadeNull ? null : target,
       partial: hasData && partial,
+      stale: hasData && stale,
       hasData
     };
   }
@@ -516,6 +580,7 @@ class CacheInternal {
   }) {
     const result = [];
     let partialData = false;
+    let stale = false;
     let hasValues = false;
     for (const entry of linkedList) {
       if (Array.isArray(entry)) {
@@ -535,7 +600,12 @@ class CacheInternal {
         result.push(entry);
         continue;
       }
-      const { data, partial, hasData } = this.getSelection({
+      const {
+        data,
+        partial,
+        stale: local_stale,
+        hasData
+      } = this.getSelection({
         parent: entry,
         selection: fields,
         variables,
@@ -545,6 +615,9 @@ class CacheInternal {
       if (partial) {
         partialData = true;
       }
+      if (local_stale) {
+        stale = true;
+      }
       if (hasData) {
         hasValues = true;
       }
@@ -552,6 +625,7 @@ class CacheInternal {
     return {
       data: result,
       partial: partialData,
+      stale,
       hasData: hasValues
     };
   }

package/build/runtime-cjs/cache/gc.js

@@ -37,6 +37,8 @@ class GarbageCollector {
     this.lifetimes.get(id).set(field, 0);
   }
   tick() {
+    const dt_tick = Date.now().valueOf();
+    const config_max_time = this.cache._internal_unstable.config.defaultLifetime;
     for (const [id, fieldMap] of this.lifetimes.entries()) {
       for (const [field, lifetime] of fieldMap.entries()) {
         if (this.cache._internal_unstable.subscriptions.get(id, field).length > 0) {
@@ -50,6 +52,13 @@ class GarbageCollector {
           if ([...fieldMap.keys()].length === 0) {
             this.lifetimes.delete(id);
           }
+          this.cache._internal_unstable.staleManager.delete(id, field);
+        }
+        if (config_max_time && config_max_time > 0) {
+          const dt_valueOf = this.cache.getFieldTime(id, field);
+          if (dt_valueOf && dt_tick - dt_valueOf > config_max_time) {
+            this.cache._internal_unstable.staleManager.markFieldStale(id, field);
+          }
         }
       }
     }

package/build/runtime-cjs/cache/lists.js

@@ -176,7 +176,7 @@ class List {
                 edges: {
                   keyRaw: "edges",
                   type: "ConnectionEdge",
-                  update: where === "first" ? "prepend" : "append",
+                  updates: ["append", "prepend"],
                   selection: {
                     fields: {
                       node: {
@@ -212,7 +212,7 @@ class List {
           newEntries: {
             keyRaw: this.key,
             type: listType,
-            update: where === "first" ? "prepend" : "append",
+            updates: ["append", "prepend"],
             selection: {
               ...selection,
               fields: {
@@ -235,7 +235,7 @@ class List {
       data: insertData,
       variables,
       parent: this.recordID,
-      applyUpdates: true
+      applyUpdates: [where === "first" ? "prepend" : "append"]
     });
   }
   removeID(id, variables = {}) {

package/build/runtime-cjs/cache/staleManager.d.ts

@@ -0,0 +1,30 @@
+import type { Cache } from './cache';
+export declare class StaleManager {
+    #private;
+    cache: Cache;
+    private fieldsTime;
+    constructor(cache: Cache);
+    /**
+     * get the FieldTime info
+     * @param id User:1
+     * @param field firstName
+     */
+    getFieldTime(id: string, field: string): number | undefined | null;
+    /**
+     * set the date to a field
+     * @param id User:1
+     * @param field firstName
+     */
+    setFieldTimeToNow(id: string, field: string): void;
+    /**
+     * set null to a field (stale)
+     * @param id User:1
+     * @param field firstName
+     */
+    markFieldStale(id: string, field: string): void;
+    markAllStale(): void;
+    markRecordStale(id: string): void;
+    markTypeStale(type: string): void;
+    markTypeFieldStale(type: string, field: string, when?: {}): void;
+    delete(id: string, field: string): void;
+}

package/build/runtime-cjs/cache/staleManager.js

@@ -0,0 +1,95 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var staleManager_exports = {};
+__export(staleManager_exports, {
+  StaleManager: () => StaleManager
+});
+module.exports = __toCommonJS(staleManager_exports);
+var import_lib = require("../lib");
+class StaleManager {
+  cache;
+  fieldsTime = /* @__PURE__ */ new Map();
+  constructor(cache) {
+    this.cache = cache;
+  }
+  #initMapId = (id) => {
+    if (!this.fieldsTime.get(id)) {
+      this.fieldsTime.set(id, /* @__PURE__ */ new Map());
+    }
+  };
+  getFieldTime(id, field) {
+    return this.fieldsTime.get(id)?.get(field);
+  }
+  setFieldTimeToNow(id, field) {
+    this.#initMapId(id);
+    this.fieldsTime.get(id)?.set(field, new Date().valueOf());
+  }
+  markFieldStale(id, field) {
+    this.#initMapId(id);
+    this.fieldsTime.get(id)?.set(field, null);
+  }
+  markAllStale() {
+    for (const [id, fieldMap] of this.fieldsTime.entries()) {
+      for (const [field] of fieldMap.entries()) {
+        this.markFieldStale(id, field);
+      }
+    }
+  }
+  markRecordStale(id) {
+    const fieldsTimeOfType = this.fieldsTime.get(id);
+    if (fieldsTimeOfType) {
+      for (const [field] of fieldsTimeOfType.entries()) {
+        this.markFieldStale(id, field);
+      }
+    }
+  }
+  markTypeStale(type) {
+    for (const [id, fieldMap] of this.fieldsTime.entries()) {
+      if (id.startsWith(`${type}:`)) {
+        for (const [field] of fieldMap.entries()) {
+          this.markFieldStale(id, field);
+        }
+      }
+    }
+  }
+  markTypeFieldStale(type, field, when) {
+    const key = (0, import_lib.computeKey)({ field, args: when });
+    for (const [id, fieldMap] of this.fieldsTime.entries()) {
+      if (id.startsWith(`${type}:`)) {
+        for (const local_field of fieldMap.keys()) {
+          if (local_field === key) {
+            this.markFieldStale(id, field);
+          }
+        }
+      }
+    }
+  }
+  delete(id, field) {
+    if (this.fieldsTime.has(id)) {
+      this.fieldsTime.get(id)?.delete(field);
+      if (this.fieldsTime.get(id)?.size === 0) {
+        this.fieldsTime.delete(id);
+      }
+    }
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  StaleManager
+});

package/build/runtime-cjs/cache/subscription.d.ts

@@ -19,10 +19,11 @@ export declare class InMemorySubscriptions {
             [key: string]: GraphQLValue;
         };
     }): void;
-    addFieldSubscription({ id, key, selection, }: {
+    addFieldSubscription({ id, key, selection, type, }: {
         id: string;
         key: string;
         selection: FieldSelection;
+        type: string;
     }): void;
     registerList({ list, id, key, parentType, selection, filters, variables, }: {
         list: Required<Required<SubscriptionSelection>['fields'][string]>['list'];

package/build/runtime-cjs/cache/subscription.js

@@ -51,7 +51,8 @@ class InMemorySubscriptions {
       this.addFieldSubscription({
         id: parent,
         key,
-        selection: [spec, targetSelection2]
+        selection: [spec, targetSelection2],
+        type
       });
       if (list) {
         this.registerList({
@@ -88,7 +89,8 @@ class InMemorySubscriptions {
   addFieldSubscription({
     id,
     key,
-    selection
+    selection,
+    type
   }) {
     const spec = selection[0];
     if (!this.subscribers[id]) {
@@ -160,7 +162,8 @@ class InMemorySubscriptions {
         this.addFieldSubscription({
           id: parent,
           key,
-          selection: [spec, fieldSelection]
+          selection: [spec, fieldSelection],
+          type: linkedType
         });
         if (list) {
           this.registerList({

package/build/runtime-cjs/client/documentStore.d.ts

@@ -53,7 +53,7 @@ export type ClientPluginContext = {
         forceNotify?: boolean;
         disableWrite?: boolean;
         disableRead?: boolean;
-        applyUpdates?: boolean;
+        applyUpdates?: string[];
     };
     stuff: App.Stuff;
 };

package/build/runtime-cjs/client/documentStore.js

@@ -54,6 +54,7 @@ class DocumentStore extends import_store.Writable {
       data: initialValue ?? null,
       errors: null,
       partial: false,
+      stale: false,
       source: null,
       fetching,
       variables: null

package/build/runtime-cjs/client/plugins/cache.js

@@ -52,7 +52,8 @@ const cachePolicyPlugin = ({
               data: value.data,
               errors: null,
               source: import_types.DataSource.Cache,
-              partial: value.partial
+              partial: value.partial,
+              stale: value.stale
             });
           }
           useCache = !!(value.data !== null && allowed);
@@ -63,10 +64,11 @@ const cachePolicyPlugin = ({
               data: value.data,
               errors: null,
               source: import_types.DataSource.Cache,
-              partial: value.partial
+              partial: value.partial,
+              stale: value.stale
             });
           }
-          if (useCache && !value.partial) {
+          if (useCache && !value.partial && !value.stale) {
             return;
           }
         }

package/build/runtime-cjs/client/plugins/fetch.js

@@ -57,6 +57,7 @@ const fetchPlugin = (target) => {
           data: result.data,
           errors: !result.errors || result.errors.length === 0 ? null : result.errors,
           partial: false,
+          stale: false,
           source: import_types.DataSource.Network
         });
       }

package/build/runtime-cjs/client/plugins/fetchParams.d.ts

@@ -5,5 +5,5 @@ export declare const fetchParamsPlugin: (fn?: FetchParamFn) => ClientPlugin;
 export type FetchParamsInput = Pick<ClientPluginContext, 'config' | 'policy' | 'variables' | 'metadata' | 'session' | 'stuff'> & {
     text: string;
     hash: string;
-    artifact: DocumentArtifact;
+    document: DocumentArtifact;
 };

package/build/runtime-cjs/client/plugins/fetchParams.js

@@ -26,7 +26,12 @@ const fetchParamsPlugin = (fn = () => ({})) => () => ({
     next({
       ...ctx,
       fetchParams: fn({
-        ...ctx,
+        config: ctx.config,
+        policy: ctx.policy,
+        metadata: ctx.metadata,
+        session: ctx.session,
+        stuff: ctx.stuff,
+        document: ctx.artifact,
         variables: marshalVariables(ctx),
         text: ctx.artifact.raw,
         hash: ctx.artifact.hash

package/build/runtime-cjs/client/plugins/query.js

@@ -54,12 +54,12 @@ const queryPlugin = (0, import_utils.documentPlugin)(import_types.ArtifactKind.Q
           selection: ctx.artifact.selection,
           variables: () => lastVariables,
           set: (newValue) => {
-            console.log("setting from cache update");
             resolve(ctx, {
               data: newValue,
               errors: null,
               fetching: false,
               partial: false,
+              stale: false,
               source: import_types.DataSource.Cache,
               variables: ctx.variables ?? null
             });

package/build/runtime-cjs/client/plugins/subscription.d.ts

@@ -1,4 +1,3 @@
-import type { GraphQLObject } from '../../lib/types';
 import type { ClientPluginContext } from '../documentStore';
 export declare function subscriptionPlugin(factory: SubscriptionHandler): import("../documentStore").ClientPlugin;
 export type SubscriptionHandler = (ctx: ClientPluginContext) => {
@@ -7,7 +6,7 @@ export type SubscriptionHandler = (ctx: ClientPluginContext) => {
         variables?: {};
     }, handlers: {
         next: (payload: {
-            data?: GraphQLObject;
+            data?: {} | null;
             errors?: readonly {
                 message: string;
             }[];

package/build/runtime-cjs/client/plugins/subscription.js

@@ -66,6 +66,7 @@ function subscriptionPlugin(factory) {
                 errors: [...errors ?? []],
                 fetching: false,
                 partial: true,
+                stale: false,
                 source: import_types.DataSource.Network,
                 variables: ctx.variables ?? null
               });
@@ -74,6 +75,7 @@ function subscriptionPlugin(factory) {
               clearSubscription?.();
               resolve(ctx, {
                 partial: true,
+                stale: false,
                 source: import_types.DataSource.Network,
                 data: null,
                 errors: [data],

package/build/runtime-cjs/lib/config.d.ts

@@ -55,6 +55,10 @@ export type ConfigFile = {
      * Specifies whether or not the cache should always use partial data. For more information: https://www.houdinigraphql.com/guides/caching-data#partial-data
      */
     defaultPartial?: boolean;
+    /**
+     * Specifies after how long a data goes stale in miliseconds. (default: `undefined`)
+     */
+    defaultLifetime?: number;
     /**
      * Specifies whether mutations should append or prepend list. For more information: https://www.houdinigraphql.com/api/graphql (default: `append`)
      */

package/build/runtime-cjs/lib/index.d.ts

@@ -5,3 +5,4 @@ export * from './log';
 export * from './scalars';
 export * from './types';
 export * from './store';
+export * from './key';

package/build/runtime-cjs/lib/index.js

@@ -22,3 +22,4 @@ __reExport(lib_exports, require("./log"), module.exports);
 __reExport(lib_exports, require("./scalars"), module.exports);
 __reExport(lib_exports, require("./types"), module.exports);
 __reExport(lib_exports, require("./store"), module.exports);
+__reExport(lib_exports, require("./key"), module.exports);

package/build/runtime-cjs/lib/key.d.ts

@@ -0,0 +1,6 @@
+export declare const computeKey: ({ field, args }: {
+    field: string;
+    args?: {
+        [key: string]: any;
+    } | undefined;
+}) => string;