@luvio/environments 0.146.0 → 0.146.2

package/dist/environments.js

@@ -275,8 +275,9 @@ class DurableTTLStore {
     }
 }
 
-function flushInMemoryStoreValuesToDurableStore(store, durableStore, durableStoreErrorHandler, redirects, additionalDurableStoreOperations = []) {
+function flushInMemoryStoreValuesToDurableStore(store, durableStore, durableStoreErrorHandler, redirects, additionalDurableStoreOperations = [], enableDurableMetadataRefresh = false) {
     const durableRecords = create(null);
+    const refreshedDurableRecords = create(null);
     const evictedRecords = create(null);
     const { records, metadata: storeMetadata, visitedIds, refreshedIds, } = store.fallbackStringKeyInMemoryStore;
     // TODO: W-8909393 Once metadata is stored in its own segment we need to
@@ -286,32 +287,36 @@ function flushInMemoryStoreValuesToDurableStore(store, durableStore, durableStor
     for (let i = 0, len = keys$1.length; i < len; i += 1) {
         const key = keys$1[i];
         const record = records[key];
+        const wasVisited = visitedIds[key] !== undefined;
         // this record has been evicted, evict from DS
-        if (record === undefined) {
+        if (wasVisited && record === undefined) {
             evictedRecords[key] = true;
             continue;
         }
         const metadata = storeMetadata[key];
-        durableRecords[key] = {
-            data: record,
-        };
-        if (metadata !== undefined) {
-            durableRecords[key].metadata = {
-                ...metadata,
-                metadataVersion: DURABLE_METADATA_VERSION,
-            };
-        }
+        const entries = wasVisited === true || enableDurableMetadataRefresh === false
+            ? durableRecords
+            : refreshedDurableRecords;
+        setRecordTo(entries, key, record, metadata);
     }
     const durableStoreOperations = additionalDurableStoreOperations;
-    // publishes
     const recordKeys = keys(durableRecords);
     if (recordKeys.length > 0) {
+        // publishes with data
         durableStoreOperations.push({
             type: 'setEntries',
             entries: durableRecords,
             segment: DefaultDurableSegment,
         });
     }
+    if (keys(refreshedDurableRecords).length > 0) {
+        // publishes with only metadata updates
+        durableStoreOperations.push({
+            type: 'setMetadata',
+            entries: refreshedDurableRecords,
+            segment: DefaultDurableSegment,
+        });
+    }
     // redirects
     redirects.forEach((value, key) => {
         durableStoreOperations.push({
@@ -338,6 +343,17 @@ function flushInMemoryStoreValuesToDurableStore(store, durableStore, durableStor
     }
     return Promise.resolve();
 }
+function setRecordTo(entries, key, record, metadata) {
+    entries[key] = {
+        data: record,
+    };
+    if (metadata !== undefined) {
+        entries[key].metadata = {
+            ...metadata,
+            metadataVersion: DURABLE_METADATA_VERSION,
+        };
+    }
+}
 
 const DurableEnvironmentEventDiscriminator = 'durable';
 function isDurableEnvironmentEvent(event) {
@@ -484,7 +500,7 @@ function isUnfulfilledSnapshot(cachedSnapshotResult) {
  * @param durableStore A DurableStore implementation
  * @param instrumentation An instrumentation function implementation
  */
-function makeDurable(environment, { durableStore, instrumentation, useRevivingStore }) {
+function makeDurable(environment, { durableStore, instrumentation, useRevivingStore, enableDurableMetadataRefresh = false, }) {
     let stagingStore = null;
     const durableTTLStore = new DurableTTLStore(durableStore);
     const mergeKeysPromiseMap = new Map();
@@ -519,6 +535,7 @@ function makeDurable(environment, { durableStore, instrumentation, useRevivingSt
         const defaultSegmentKeys = [];
         const adapterContextSegmentKeys = [];
         const redirectSegmentKeys = [];
+        const metadataRefreshSegmentKeys = [];
         const messagingSegmentKeys = [];
         let shouldBroadcast = false;
         for (let i = 0, len = changes.length; i < len; i++) {
@@ -526,7 +543,12 @@ function makeDurable(environment, { durableStore, instrumentation, useRevivingSt
             // we only care about changes to the data which is stored in the default
             // segment or the adapter context
             if (change.segment === DefaultDurableSegment) {
-                defaultSegmentKeys.push(...change.ids);
+                if (change.type === 'setMetadata') {
+                    metadataRefreshSegmentKeys.push(...change.ids);
+                }
+                else {
+                    defaultSegmentKeys.push(...change.ids);
+                }
             }
             else if (change.segment === AdapterContextSegment) {
                 adapterContextSegmentKeys.push(...change.ids);
@@ -596,6 +618,20 @@ function makeDurable(environment, { durableStore, instrumentation, useRevivingSt
             }
             shouldBroadcast = true;
         }
+        // process metadata only refreshes
+        if (metadataRefreshSegmentKeys.length > 0) {
+            const entries = await durableStore.getMetadata(metadataRefreshSegmentKeys, DefaultDurableSegment);
+            if (entries !== undefined) {
+                const entryKeys = keys(entries);
+                for (let i = 0, len = entryKeys.length; i < len; i++) {
+                    const entryKey = entryKeys[i];
+                    const { metadata } = entries[entryKey];
+                    if (metadata !== undefined) {
+                        environment.putStoreMetadata(entryKey, metadata, false);
+                    }
+                }
+            }
+        }
         if (shouldBroadcast) {
             await environment.storeBroadcast(rebuildSnapshot, environment.snapshotAvailable);
         }
@@ -666,7 +702,7 @@ function makeDurable(environment, { durableStore, instrumentation, useRevivingSt
         if (stagingStore === null) {
             return Promise.resolve();
         }
-        const promise = flushInMemoryStoreValuesToDurableStore(stagingStore, durableStore, durableStoreErrorHandler, new Map(pendingStoreRedirects), additionalDurableStoreOperations);
+        const promise = flushInMemoryStoreValuesToDurableStore(stagingStore, durableStore, durableStoreErrorHandler, new Map(pendingStoreRedirects), additionalDurableStoreOperations, enableDurableMetadataRefresh);
         pendingStoreRedirects.clear();
         stagingStore = null;
         return promise;

package/dist/types/DurableStore.d.ts

@@ -16,6 +16,9 @@ export interface DurableStoreEntry<T = unknown> {
     data: T;
     metadata?: DurableStoreMetadata;
 }
+export interface DurableStoreMetadataEntry {
+    metadata?: DurableStoreMetadata;
+}
 export declare function isDeprecatedDurableStoreEntry(durableRecord: unknown): boolean;
 export interface DeprecatedDurableStoreEntry1<T = unknown> {
     data: T;
@@ -27,7 +30,10 @@ export interface DeprecatedDurableStoreEntry1<T = unknown> {
 export interface DurableStoreEntries<EntryTypes> {
     [key: string]: DurableStoreEntry<Extract<EntryTypes, unknown>>;
 }
-export type DurableStoreOperationType = 'setEntries' | 'evictEntries';
+export interface DurableStoreMetadataEntries {
+    [key: string]: DurableStoreMetadataEntry;
+}
+export type DurableStoreOperationType = 'setEntries' | 'evictEntries' | 'setMetadata';
 export interface BaseOperation {
     type: DurableStoreOperationType;
     segment: string;
@@ -36,11 +42,15 @@ export interface DurableStoreSetOperation<T> extends BaseOperation {
     type: 'setEntries';
     entries: DurableStoreEntries<T>;
 }
+export interface DurableStoreSetMetadataOperation extends BaseOperation {
+    type: 'setMetadata';
+    entries: DurableStoreMetadataEntries;
+}
 export interface DurableStoreEvictOperation extends BaseOperation {
     type: 'evictEntries';
     ids: string[];
 }
-export type DurableStoreOperation<T> = DurableStoreSetOperation<T> | DurableStoreEvictOperation;
+export type DurableStoreOperation<T> = DurableStoreSetOperation<T> | DurableStoreEvictOperation | DurableStoreSetMetadataOperation;
 export type DefaultDurableSegmentName = 'DEFAULT';
 export type RedirectDurableSegmentName = 'REDIRECT_KEYS';
 export type MessagingDurableSegmentName = 'MESSAGING';
@@ -92,6 +102,17 @@ export interface DurableStore {
      * @returns {Promise<DurableStoreEntries | undefined>}
      */
     getEntries<T>(entryIds: string[], segment: string): Promise<DurableStoreEntries<T> | undefined>;
+    /**
+     * Given alist of cache entryId's this method will asynchronously return only the DurableStoreMetadata
+     * of DurableStoreEntries
+     *
+     * Will return undefined if nothing is found
+     *
+     * @param {string[]} entryIds
+     * @param {string} segment The durable store segment to query
+     * @returns {Promise<DurableStoreMetadataEntries | undefined>}
+     */
+    getMetadata(entryIds: string[], segment: string): Promise<DurableStoreMetadataEntries | undefined>;
     /**
      * This method retrieves all entries in the given store segment.
      *
@@ -111,6 +132,14 @@ export interface DurableStore {
      * @returns {Promise<void>}
      */
     setEntries<T>(entries: DurableStoreEntries<T>, segment: string): Promise<void>;
+    /**
+     * This method saves only the metadata to the durable store in the given store segment
+     *
+     * @param {DurableStoreMetadataEntries} entries A key/value map Object
+     * @param {string} segment The durable store segment in which to set the entries
+     * @returns {Promise<void>}
+     */
+    setMetadata(entries: DurableStoreMetadataEntries, segment: string): Promise<void>;
     /**
      * This method sends a collection of mutation operations to the durable store.
      *

package/dist/types/main.d.ts

@@ -1,4 +1,4 @@
-export { DurableStore, DurableStoreEntries, DurableStoreEntry, DurableStoreChange, OnDurableStoreChangedListener, DefaultDurableSegment, DefaultDurableSegmentName, DurableStoreOperation, DurableStoreOperationType, DURABLE_METADATA_VERSION, } from './DurableStore';
+export { DurableStore, DurableStoreEntries, DurableStoreEntry, DurableStoreMetadataEntry, DurableStoreChange, OnDurableStoreChangedListener, DefaultDurableSegment, DefaultDurableSegmentName, DurableStoreOperation, DurableStoreOperationType, DURABLE_METADATA_VERSION, DurableStoreMetadataEntries, DurableStoreMetadata, } from './DurableStore';
 export { DurableTTLOverride, DefaultDurableTTLOverride } from './DurableTTLStore';
 export { makeDurable, DurableEnvironment } from './makeDurable';
 export { publishDurableStoreEntries } from './makeDurable/revive';

package/dist/types/makeDurable/flush.d.ts

@@ -1,4 +1,4 @@
 import type { InMemoryStore } from '@luvio/engine';
 import type { DurableStore, DurableStoreOperation } from '../DurableStore';
 import type { DurableStoreRejectionHandler } from './error';
-export declare function flushInMemoryStoreValuesToDurableStore(store: InMemoryStore, durableStore: DurableStore, durableStoreErrorHandler: DurableStoreRejectionHandler, redirects: Map<string, string>, additionalDurableStoreOperations?: DurableStoreOperation<unknown>[]): Promise<void>;
+export declare function flushInMemoryStoreValuesToDurableStore(store: InMemoryStore, durableStore: DurableStore, durableStoreErrorHandler: DurableStoreRejectionHandler, redirects: Map<string, string>, additionalDurableStoreOperations?: DurableStoreOperation<unknown>[], enableDurableMetadataRefresh?: boolean): Promise<void>;

package/dist/types/makeDurable.d.ts

@@ -34,6 +34,7 @@ export declare const ADAPTER_CONTEXT_ID_SUFFIX = "__NAMED_CONTEXT";
 interface MakeDurableOptions {
     durableStore: DurableStore;
     instrumentation?: InstrumentationFunction;
+    enableDurableMetadataRefresh?: boolean;
     useRevivingStore?: boolean;
 }
 /**
@@ -45,5 +46,5 @@ interface MakeDurableOptions {
  * @param durableStore A DurableStore implementation
  * @param instrumentation An instrumentation function implementation
  */
-export declare function makeDurable(environment: Environment, { durableStore, instrumentation, useRevivingStore }: MakeDurableOptions): DurableEnvironment;
+export declare function makeDurable(environment: Environment, { durableStore, instrumentation, useRevivingStore, enableDurableMetadataRefresh, }: MakeDurableOptions): DurableEnvironment;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@luvio/environments",
-    "version": "0.146.0",
+    "version": "0.146.2",
     "description": "Luvio Environments",
     "repository": {
         "type": "git",
@@ -27,7 +27,7 @@
         "watch": "yarn build --watch"
     },
     "dependencies": {
-        "@luvio/engine": "^0.146.0"
+        "@luvio/engine": "^0.146.2"
     },
     "volta": {
         "extends": "../../../package.json"
@@ -36,9 +36,9 @@
         {
             "path": "./dist/environments.js",
             "maxSize": {
-                "none": "45.5 kB",
-                "min": "13.0 kB",
-                "compressed": "8.8 kB"
+                "none": "47 kB",
+                "min": "14 kB",
+                "compressed": "9.5 kB"
             }
         }
     ],