@luvio/environments 0.61.0 → 0.62.2

package/dist/es/es2018/environments.js

@@ -246,6 +246,28 @@ function buildStaleWhileRevalidateImplementation(funcs, staleDurationSeconds) {
     };
 }
 
+function buildValidAtImplementation(funcs, basePolicyImplementation, timestamp) {
+    return function validAtImplementation(args) {
+        funcs.validateNotDisposed();
+        // This somewhat convoluted code is used to force the basePolicyImplementation's
+        // TTLStrategy to use the the valid-at cache policy's timestamp. The flow goes:
+        //
+        // Environment.applyCachePolicy => validAtImplementation (this function) =>
+        //    basePolicyImplementation => adapter's buildInMemorySnapshot =>
+        //    basePolicyImplementation's storeLookup => validAtStoreLookup (below) =>
+        //    Environment.applyCachePolicy's storeLookup => Store/Reader code =>
+        //    valid-at TTLStrategy (below) =>
+        //    basePolicyImplementation's TTLStrategy (with valid-at timestamp)
+        const validAtStoreLookup = (sel, refresh, ttlStrategy) => args.storeLookup(sel, refresh, (_readerTimestamp, metadata, valueIsError) => ttlStrategy(timestamp, metadata, valueIsError));
+        // let basePolicy make all the decisions, but have it use our storeLookup
+        // so we can override the timestamp passed to the basePolicy's TTLStrategy
+        return basePolicyImplementation({
+            ...args,
+            storeLookup: validAtStoreLookup,
+        });
+    };
+}
+
 //Durable store error instrumentation key
 const DURABLE_STORE_ERROR = 'durable-store-error';
 /**
@@ -912,13 +934,7 @@ function makeDurable(environment, { durableStore, instrumentation }) {
                 return buildStaleWhileRevalidateImplementation({
                     validateNotDisposed,
                     reviveSnapshotWithCachePolicy,
-                }, 
-                // TODO[@W-10077764]: remove staleDuration once Komaci switches to cache-then-network
-                'staleDurationSeconds' in cachePolicy
-                    ? cachePolicy.staleDurationSeconds
-                    : cachePolicy.staleDuration
-                //cachePolicy.staleDurationSeconds
-                );
+                }, cachePolicy.staleDurationSeconds);
             case 'cache-and-network':
                 return buildCacheAndNetworkImplementation({
                     validateNotDisposed,
@@ -939,6 +955,13 @@ function makeDurable(environment, { durableStore, instrumentation }) {
                     validateNotDisposed,
                     reviveSnapshotWithCachePolicy,
                 });
+            case 'valid-at': {
+                const basePolicy = resolveCachePolicy(cachePolicy.basePolicy);
+                return buildValidAtImplementation({
+                    validateNotDisposed,
+                    reviveSnapshotWithCachePolicy,
+                }, basePolicy, cachePolicy.timestamp);
+            }
             default: {
                 if (process.env.NODE_ENV !== 'production') {
                     throw new Error(`unrecognized cache policy: ${JSON.stringify(cachePolicy)}`);
@@ -947,9 +970,9 @@ function makeDurable(environment, { durableStore, instrumentation }) {
             }
         }
     }
-    const applyCachePolicy = function (cachePolicy, buildSnapshotContext, buildInMemorySnapshot, buildNetworkSnapshot) {
+    const applyCachePolicy = function (adapterRequestContext, buildSnapshotContext, buildInMemorySnapshot, buildNetworkSnapshot) {
         validateNotDisposed();
-        const cachePolicyImpl = resolveCachePolicy(cachePolicy);
+        const cachePolicyImpl = resolveCachePolicy(adapterRequestContext.cachePolicy);
         const storeLookup = (sel, refresh, ttlStrategy) => environment.storeLookup(sel, environment.createSnapshot, refresh, ttlStrategy);
         const applyCachePolicy = () => {
             return cachePolicyImpl({

package/dist/es/es2018/makeDurable/cachepolicies/index.d.ts

@@ -3,3 +3,4 @@ export { buildCacheThenNetworkImplementation } from './cache-then-network';
 export { buildNoCacheImplementation } from './no-cache';
 export { buildOnlyIfCachedImplementation } from './only-if-cached';
 export { buildStaleWhileRevalidateImplementation } from './stale-while-revalidate';
+export { buildValidAtImplementation } from './valid-at';

package/dist/es/es2018/makeDurable/cachepolicies/valid-at.d.ts

@@ -0,0 +1,3 @@
+import { CachePolicyImplementation, CachePolicyImplementationArgs, Snapshot } from '@luvio/engine';
+import { DurableCachePolicyFunctions } from './utils';
+export declare function buildValidAtImplementation<C, D>(funcs: DurableCachePolicyFunctions, basePolicyImplementation: CachePolicyImplementation<C, D>, timestamp: number): (args: CachePolicyImplementationArgs<C, D>) => Snapshot<D> | Promise<Snapshot<D>>;

package/dist/es/es2018/makeDurable.d.ts

@@ -28,7 +28,7 @@ export interface DurableEnvironment extends Environment {
     /**
      * Overload of Environment.handleSuccessResponse that takes in an optional
      * RecordSource to "prime" the ingest staging store with before calling
-     * ingest.  Useful for merge-able record types
+     * ingest. Useful for merge-able record types
      */
     handleSuccessResponse<ResponseType>(ingestAndBroadcastFunc: () => Snapshot<ResponseType>, getResponseCacheKeysFunc: () => CacheKeySet, existingRecords?: RecordSource): Snapshot<ResponseType> | Promise<Snapshot<ResponseType>>;
 }

package/dist/umd/es2018/environments.js

@@ -249,6 +249,28 @@
         };
     }
 
+    function buildValidAtImplementation(funcs, basePolicyImplementation, timestamp) {
+        return function validAtImplementation(args) {
+            funcs.validateNotDisposed();
+            // This somewhat convoluted code is used to force the basePolicyImplementation's
+            // TTLStrategy to use the the valid-at cache policy's timestamp. The flow goes:
+            //
+            // Environment.applyCachePolicy => validAtImplementation (this function) =>
+            //    basePolicyImplementation => adapter's buildInMemorySnapshot =>
+            //    basePolicyImplementation's storeLookup => validAtStoreLookup (below) =>
+            //    Environment.applyCachePolicy's storeLookup => Store/Reader code =>
+            //    valid-at TTLStrategy (below) =>
+            //    basePolicyImplementation's TTLStrategy (with valid-at timestamp)
+            const validAtStoreLookup = (sel, refresh, ttlStrategy) => args.storeLookup(sel, refresh, (_readerTimestamp, metadata, valueIsError) => ttlStrategy(timestamp, metadata, valueIsError));
+            // let basePolicy make all the decisions, but have it use our storeLookup
+            // so we can override the timestamp passed to the basePolicy's TTLStrategy
+            return basePolicyImplementation({
+                ...args,
+                storeLookup: validAtStoreLookup,
+            });
+        };
+    }
+
     //Durable store error instrumentation key
     const DURABLE_STORE_ERROR = 'durable-store-error';
     /**
@@ -915,13 +937,7 @@
                     return buildStaleWhileRevalidateImplementation({
                         validateNotDisposed,
                         reviveSnapshotWithCachePolicy,
-                    }, 
-                    // TODO[@W-10077764]: remove staleDuration once Komaci switches to cache-then-network
-                    'staleDurationSeconds' in cachePolicy
-                        ? cachePolicy.staleDurationSeconds
-                        : cachePolicy.staleDuration
-                    //cachePolicy.staleDurationSeconds
-                    );
+                    }, cachePolicy.staleDurationSeconds);
                 case 'cache-and-network':
                     return buildCacheAndNetworkImplementation({
                         validateNotDisposed,
@@ -942,6 +958,13 @@
                         validateNotDisposed,
                         reviveSnapshotWithCachePolicy,
                     });
+                case 'valid-at': {
+                    const basePolicy = resolveCachePolicy(cachePolicy.basePolicy);
+                    return buildValidAtImplementation({
+                        validateNotDisposed,
+                        reviveSnapshotWithCachePolicy,
+                    }, basePolicy, cachePolicy.timestamp);
+                }
                 default: {
                     if (process.env.NODE_ENV !== 'production') {
                         throw new Error(`unrecognized cache policy: ${JSON.stringify(cachePolicy)}`);
@@ -950,9 +973,9 @@
                 }
             }
         }
-        const applyCachePolicy = function (cachePolicy, buildSnapshotContext, buildInMemorySnapshot, buildNetworkSnapshot) {
+        const applyCachePolicy = function (adapterRequestContext, buildSnapshotContext, buildInMemorySnapshot, buildNetworkSnapshot) {
             validateNotDisposed();
-            const cachePolicyImpl = resolveCachePolicy(cachePolicy);
+            const cachePolicyImpl = resolveCachePolicy(adapterRequestContext.cachePolicy);
             const storeLookup = (sel, refresh, ttlStrategy) => environment.storeLookup(sel, environment.createSnapshot, refresh, ttlStrategy);
             const applyCachePolicy = () => {
                 return cachePolicyImpl({

package/dist/umd/es2018/makeDurable/cachepolicies/index.d.ts

@@ -3,3 +3,4 @@ export { buildCacheThenNetworkImplementation } from './cache-then-network';
 export { buildNoCacheImplementation } from './no-cache';
 export { buildOnlyIfCachedImplementation } from './only-if-cached';
 export { buildStaleWhileRevalidateImplementation } from './stale-while-revalidate';
+export { buildValidAtImplementation } from './valid-at';

package/dist/umd/es2018/makeDurable/cachepolicies/valid-at.d.ts

@@ -0,0 +1,3 @@
+import { CachePolicyImplementation, CachePolicyImplementationArgs, Snapshot } from '@luvio/engine';
+import { DurableCachePolicyFunctions } from './utils';
+export declare function buildValidAtImplementation<C, D>(funcs: DurableCachePolicyFunctions, basePolicyImplementation: CachePolicyImplementation<C, D>, timestamp: number): (args: CachePolicyImplementationArgs<C, D>) => Snapshot<D> | Promise<Snapshot<D>>;

package/dist/umd/es2018/makeDurable.d.ts

@@ -28,7 +28,7 @@ export interface DurableEnvironment extends Environment {
     /**
      * Overload of Environment.handleSuccessResponse that takes in an optional
      * RecordSource to "prime" the ingest staging store with before calling
-     * ingest.  Useful for merge-able record types
+     * ingest. Useful for merge-able record types
      */
     handleSuccessResponse<ResponseType>(ingestAndBroadcastFunc: () => Snapshot<ResponseType>, getResponseCacheKeysFunc: () => CacheKeySet, existingRecords?: RecordSource): Snapshot<ResponseType> | Promise<Snapshot<ResponseType>>;
 }

package/dist/umd/es5/environments.js

@@ -286,6 +286,27 @@
         };
     }
 
+    function buildValidAtImplementation(funcs, basePolicyImplementation, timestamp) {
+        return function validAtImplementation(args) {
+            funcs.validateNotDisposed();
+            // This somewhat convoluted code is used to force the basePolicyImplementation's
+            // TTLStrategy to use the the valid-at cache policy's timestamp. The flow goes:
+            //
+            // Environment.applyCachePolicy => validAtImplementation (this function) =>
+            //    basePolicyImplementation => adapter's buildInMemorySnapshot =>
+            //    basePolicyImplementation's storeLookup => validAtStoreLookup (below) =>
+            //    Environment.applyCachePolicy's storeLookup => Store/Reader code =>
+            //    valid-at TTLStrategy (below) =>
+            //    basePolicyImplementation's TTLStrategy (with valid-at timestamp)
+            var validAtStoreLookup = function (sel, refresh, ttlStrategy) {
+                return args.storeLookup(sel, refresh, function (_readerTimestamp, metadata, valueIsError) { return ttlStrategy(timestamp, metadata, valueIsError); });
+            };
+            // let basePolicy make all the decisions, but have it use our storeLookup
+            // so we can override the timestamp passed to the basePolicy's TTLStrategy
+            return basePolicyImplementation(__assign(__assign({}, args), { storeLookup: validAtStoreLookup }));
+        };
+    }
+
     //Durable store error instrumentation key
     var DURABLE_STORE_ERROR = 'durable-store-error';
     /**
@@ -957,13 +978,7 @@
                     return buildStaleWhileRevalidateImplementation({
                         validateNotDisposed: validateNotDisposed,
                         reviveSnapshotWithCachePolicy: reviveSnapshotWithCachePolicy,
-                    }, 
-                    // TODO[@W-10077764]: remove staleDuration once Komaci switches to cache-then-network
-                    'staleDurationSeconds' in cachePolicy
-                        ? cachePolicy.staleDurationSeconds
-                        : cachePolicy.staleDuration
-                    //cachePolicy.staleDurationSeconds
-                    );
+                    }, cachePolicy.staleDurationSeconds);
                 case 'cache-and-network':
                     return buildCacheAndNetworkImplementation({
                         validateNotDisposed: validateNotDisposed,
@@ -984,6 +999,13 @@
                         validateNotDisposed: validateNotDisposed,
                         reviveSnapshotWithCachePolicy: reviveSnapshotWithCachePolicy,
                     });
+                case 'valid-at': {
+                    var basePolicy = resolveCachePolicy(cachePolicy.basePolicy);
+                    return buildValidAtImplementation({
+                        validateNotDisposed: validateNotDisposed,
+                        reviveSnapshotWithCachePolicy: reviveSnapshotWithCachePolicy,
+                    }, basePolicy, cachePolicy.timestamp);
+                }
                 default: {
                     if (process.env.NODE_ENV !== 'production') {
                         throw new Error("unrecognized cache policy: " + JSON.stringify(cachePolicy));
@@ -992,9 +1014,9 @@
                 }
             }
         }
-        var applyCachePolicy = function (cachePolicy, buildSnapshotContext, buildInMemorySnapshot, buildNetworkSnapshot) {
+        var applyCachePolicy = function (adapterRequestContext, buildSnapshotContext, buildInMemorySnapshot, buildNetworkSnapshot) {
             validateNotDisposed();
-            var cachePolicyImpl = resolveCachePolicy(cachePolicy);
+            var cachePolicyImpl = resolveCachePolicy(adapterRequestContext.cachePolicy);
             var storeLookup = function (sel, refresh, ttlStrategy) { return environment.storeLookup(sel, environment.createSnapshot, refresh, ttlStrategy); };
             var applyCachePolicy = function () {
                 return cachePolicyImpl({

package/dist/umd/es5/makeDurable/cachepolicies/index.d.ts

@@ -3,3 +3,4 @@ export { buildCacheThenNetworkImplementation } from './cache-then-network';
 export { buildNoCacheImplementation } from './no-cache';
 export { buildOnlyIfCachedImplementation } from './only-if-cached';
 export { buildStaleWhileRevalidateImplementation } from './stale-while-revalidate';
+export { buildValidAtImplementation } from './valid-at';

package/dist/umd/es5/makeDurable/cachepolicies/valid-at.d.ts

@@ -0,0 +1,3 @@
+import { CachePolicyImplementation, CachePolicyImplementationArgs, Snapshot } from '@luvio/engine';
+import { DurableCachePolicyFunctions } from './utils';
+export declare function buildValidAtImplementation<C, D>(funcs: DurableCachePolicyFunctions, basePolicyImplementation: CachePolicyImplementation<C, D>, timestamp: number): (args: CachePolicyImplementationArgs<C, D>) => Snapshot<D> | Promise<Snapshot<D>>;

package/dist/umd/es5/makeDurable.d.ts

@@ -28,7 +28,7 @@ export interface DurableEnvironment extends Environment {
     /**
      * Overload of Environment.handleSuccessResponse that takes in an optional
      * RecordSource to "prime" the ingest staging store with before calling
-     * ingest.  Useful for merge-able record types
+     * ingest. Useful for merge-able record types
      */
     handleSuccessResponse<ResponseType>(ingestAndBroadcastFunc: () => Snapshot<ResponseType>, getResponseCacheKeysFunc: () => CacheKeySet, existingRecords?: RecordSource): Snapshot<ResponseType> | Promise<Snapshot<ResponseType>>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@luvio/environments",
-    "version": "0.61.0",
+    "version": "0.62.2",
     "description": "Luvio Environments",
     "main": "dist/umd/es2018/environments.js",
     "module": "dist/es/es2018/environments.js",
@@ -10,12 +10,13 @@
         "clean": "rm -rf dist",
         "build": "rollup --config rollup.config.js",
         "watch": "yarn build --watch",
-        "test": "jest"
+        "test": "jest",
+        "test:debug": "node --inspect-brk ../../../node_modules/jest/bin/jest.js --config ./jest.config.js --runInBand"
     },
     "files": [
         "dist/"
     ],
     "dependencies": {
-        "@luvio/engine": "0.61.0"
+        "@luvio/engine": "0.62.2"
     }
 }