@luvio/environments 0.154.8 → 0.154.9

package/dist/environments.js

@@ -278,7 +278,7 @@ class DurableTTLStore {
     }
 }
 
-function flushInMemoryStoreValuesToDurableStore(store, durableStore, durableStoreErrorHandler, redirects, additionalDurableStoreOperations = [], enableDurableMetadataRefresh = false) {
+function flushInMemoryStoreValuesToDurableStore(store, durableStore, crossEnvironmentNotifier, durableStoreErrorHandler, redirects, additionalDurableStoreOperations = [], enableDurableMetadataRefresh = false) {
     const durableRecords = create(null);
     const refreshedDurableRecords = create(null);
     const evictedRecords = create(null);
@@ -325,6 +325,14 @@ function flushInMemoryStoreValuesToDurableStore(store, durableStore, durableStor
             entries: refreshedDurableRecords,
             segment: DefaultDurableSegment,
         });
+        if (crossEnvironmentNotifier !== undefined) {
+            crossEnvironmentNotifier.notifyCrossEnvironments({
+                data: {
+                    refreshedDurableRecords,
+                },
+                type: 'Update',
+            });
+        }
     }
     // redirects
     redirects.forEach((value, key) => {
@@ -659,6 +667,15 @@ function makeDurable(environment, { durableStore, instrumentation, useRevivingSt
             }
         }
     });
+    let notifier;
+    const getCrossEnvironmentNotifier = function () {
+        validateNotDisposed();
+        return notifier;
+    };
+    const setCrossEnvironmentNotifier = function (crossEnvironmentNotifier) {
+        validateNotDisposed();
+        notifier = crossEnvironmentNotifier;
+    };
     const dispose = function () {
         validateNotDisposed();
         disposed = true;
@@ -711,7 +728,7 @@ function makeDurable(environment, { durableStore, instrumentation, useRevivingSt
         if (stagingStore === null) {
             return Promise.resolve();
         }
-        const promise = flushInMemoryStoreValuesToDurableStore(stagingStore, durableStore, durableStoreErrorHandler, new Map(pendingStoreRedirects), additionalDurableStoreOperations, enableDurableMetadataRefresh);
+        const promise = flushInMemoryStoreValuesToDurableStore(stagingStore, durableStore, getCrossEnvironmentNotifier(), durableStoreErrorHandler, new Map(pendingStoreRedirects), additionalDurableStoreOperations, enableDurableMetadataRefresh);
         pendingStoreRedirects.clear();
         stagingStore = null;
         return promise;
@@ -1081,7 +1098,13 @@ function makeDurable(environment, { durableStore, instrumentation, useRevivingSt
         handleErrorResponse: { value: handleErrorResponse },
         getNotifyChangeStoreEntries: { value: getNotifyChangeStoreEntries },
         notifyStoreUpdateAvailable: { value: notifyStoreUpdateAvailable },
+        getCrossEnvironmentNotifier: { value: getCrossEnvironmentNotifier },
+        setCrossEnvironmentNotifier: { value: setCrossEnvironmentNotifier },
     });
 }
 
-export { DURABLE_METADATA_VERSION, DefaultDurableSegment, isDurableEnvironmentEvent, makeDurable, publishDurableStoreEntries };
+function isUpdateNotification(notification) {
+    return notification.type === 'Update';
+}
+
+export { DURABLE_METADATA_VERSION, DefaultDurableSegment, isDurableEnvironmentEvent, isUpdateNotification, makeDurable, publishDurableStoreEntries };

package/dist/types/CrossEnvironmentNotifier.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Currently only Update is used, but other notification types will be added later.
+ */
+type NotificationType = 'Update';
+/**
+ * Base notification definition on changes from one environment that it needs to notify other instances of.
+ *
+ * The environment runtime will define how to handle each EnvironmentChangeNotification when it defines its CrossEnvironmentNotifier.
+ */
+export interface EnvironmentChangeNotification<Data = unknown> {
+    data: Data;
+    type: NotificationType;
+}
+/**
+ * This will be used when Data from one environment is updated and another environment instance needs to be notified of it changes.
+ * Example:
+ * UpdateEnvironmentChangeNotification<DurableStoreEntries>
+ * sends { [key: string]: DurableStoreEntry } which could contain an entry data and or its metadata that was updated.
+ *
+ * We can inform the other environment instances of changes without needing to read from the db
+ * in order to update the data their environment.
+ *
+ */
+export interface UpdateEnvironmentChangeNotification<T> extends EnvironmentChangeNotification<T> {
+    type: 'Update';
+}
+/**
+ * Interface to communicate to another Environment instance about important changes
+ */
+export interface CrossEnvironmentNotifier {
+    /**
+     * function call to unsubscribe from notifications
+     */
+    unsubscribe(): Promise<void>;
+    /**
+     * To notify other environment instances of important changes
+     * @param notification
+     */
+    notifyCrossEnvironments(notification: EnvironmentChangeNotification): Promise<void>;
+}
+export declare function isUpdateNotification<T>(notification: EnvironmentChangeNotification): notification is UpdateEnvironmentChangeNotification<T>;
+export {};

package/dist/types/main.d.ts

@@ -3,3 +3,4 @@ export { DurableTTLOverride, DefaultDurableTTLOverride } from './DurableTTLStore
 export { makeDurable, DurableEnvironment } from './makeDurable';
 export { publishDurableStoreEntries } from './makeDurable/revive';
 export { isDurableEnvironmentEvent } from './events';
+export { CrossEnvironmentNotifier, EnvironmentChangeNotification, UpdateEnvironmentChangeNotification, isUpdateNotification, } from './CrossEnvironmentNotifier';

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

@@ -1,4 +1,5 @@
 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>[], enableDurableMetadataRefresh?: boolean): Promise<void>;
+import type { CrossEnvironmentNotifier } from '../CrossEnvironmentNotifier';
+export declare function flushInMemoryStoreValuesToDurableStore(store: InMemoryStore, durableStore: DurableStore, crossEnvironmentNotifier: CrossEnvironmentNotifier | undefined, durableStoreErrorHandler: DurableStoreRejectionHandler, redirects: Map<string, string>, additionalDurableStoreOperations?: DurableStoreOperation<unknown>[], enableDurableMetadataRefresh?: boolean): Promise<void>;

package/dist/types/makeDurable.d.ts

@@ -2,6 +2,7 @@ import type { Environment, RecordSource, InMemoryStore } from '@luvio/engine';
 import type { DurableStore, DurableStoreOperation } from './DurableStore';
 import type { InstrumentationFunction } from './makeDurable/error';
 import type { TTLOverridesMap } from './DurableTTLStore';
+import type { CrossEnvironmentNotifier } from './CrossEnvironmentNotifier';
 export interface DurableEnvironment extends Environment {
     /**
      * Disposes the environment and detaches the durable store listener
@@ -33,6 +34,15 @@ export interface DurableEnvironment extends Environment {
      * otherwise returns `undefined`.
      */
     getIngestStagingStore(): InMemoryStore['fallbackStringKeyInMemoryStore'] | undefined;
+    /**
+     * Set the environments cross notification.
+     * Must be set due to order of operations.
+     */
+    setCrossEnvironmentNotifier(crossEnvironmentNotifier: CrossEnvironmentNotifier): void;
+    /**
+     * Get the environments cross notification
+     */
+    getCrossEnvironmentNotifier(): Promise<CrossEnvironmentNotifier | undefined>;
 }
 export declare const AdapterContextSegment = "ADAPTER-CONTEXT";
 export declare const ADAPTER_CONTEXT_ID_SUFFIX = "__NAMED_CONTEXT";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@luvio/environments",
-    "version": "0.154.8",
+    "version": "0.154.9",
     "description": "Luvio Environments",
     "repository": {
         "type": "git",
@@ -27,7 +27,7 @@
         "watch": "yarn build --watch"
     },
     "dependencies": {
-        "@luvio/engine": "^0.154.8"
+        "@luvio/engine": "^0.154.9"
     },
     "volta": {
         "extends": "../../../package.json"