@boostercloud/framework-provider-azure 1.6.2 → 1.7.1

package/dist/index.js

@@ -32,6 +32,7 @@ const Provider = (rockets) => ({
     events: {
         rawToEnvelopes: events_adapter_1.rawEventsToEnvelopes,
         store: events_adapter_1.storeEvents.bind(null, cosmosClient),
+        storeSnapshot: events_adapter_1.storeSnapshot.bind(null, cosmosClient),
         forEntitySince: events_adapter_1.readEntityEventsSince.bind(null, cosmosClient),
         latestEntitySnapshot: events_adapter_1.readEntityLatestSnapshot.bind(null, cosmosClient),
         search: events_searcher_adapter_1.searchEvents.bind(null, cosmosClient),

package/dist/library/events-adapter.d.ts

@@ -1,7 +1,8 @@
 import { CosmosClient } from '@azure/cosmos';
-import { EventEnvelope, BoosterConfig, UUID } from '@boostercloud/framework-types';
+import { EventEnvelope, BoosterConfig, UUID, EntitySnapshotEnvelope, NonPersistedEventEnvelope, NonPersistedEntitySnapshotEnvelope } from '@boostercloud/framework-types';
 import { Context } from '@azure/functions';
 export declare function rawEventsToEnvelopes(context: Context): Array<EventEnvelope>;
 export declare function readEntityEventsSince(cosmosDb: CosmosClient, config: BoosterConfig, entityTypeName: string, entityID: UUID, since?: string): Promise<Array<EventEnvelope>>;
-export declare function readEntityLatestSnapshot(cosmosDb: CosmosClient, config: BoosterConfig, entityTypeName: string, entityID: UUID): Promise<EventEnvelope | null>;
-export declare function storeEvents(cosmosDb: CosmosClient, eventEnvelopes: Array<EventEnvelope>, config: BoosterConfig): Promise<void>;
+export declare function readEntityLatestSnapshot(cosmosDb: CosmosClient, config: BoosterConfig, entityTypeName: string, entityID: UUID): Promise<EntitySnapshotEnvelope | undefined>;
+export declare function storeEvents(cosmosDb: CosmosClient, eventEnvelopes: Array<NonPersistedEventEnvelope>, config: BoosterConfig): Promise<Array<EventEnvelope>>;
+export declare function storeSnapshot(cosmosDb: CosmosClient, snapshotEnvelope: NonPersistedEntitySnapshotEnvelope, config: BoosterConfig): Promise<EntitySnapshotEnvelope>;

package/dist/library/events-adapter.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.storeEvents = exports.readEntityLatestSnapshot = exports.readEntityEventsSince = exports.rawEventsToEnvelopes = void 0;
+exports.storeSnapshot = exports.storeEvents = exports.readEntityLatestSnapshot = exports.readEntityEventsSince = exports.rawEventsToEnvelopes = void 0;
 const framework_common_helpers_1 = require("@boostercloud/framework-common-helpers");
 const constants_1 = require("../constants");
 const partition_keys_1 = require("./partition-keys");
@@ -45,7 +45,7 @@ async function readEntityLatestSnapshot(cosmosDb, config, entityTypeName, entity
         parameters: [
             {
                 name: '@partitionKey',
-                value: (0, partition_keys_1.partitionKeyForEvent)(entityTypeName, entityID, 'snapshot'),
+                value: (0, partition_keys_1.partitionKeyForSnapshot)(entityTypeName, entityID),
             },
         ],
     })
@@ -57,23 +57,84 @@ async function readEntityLatestSnapshot(cosmosDb, config, entityTypeName, entity
     }
     else {
         logger.debug(`[EventsAdapter#readEntityLatestSnapshot] No snapshot found for entity ${entityTypeName} with ID ${entityID}.`);
-        return null;
+        return undefined;
     }
 }
 exports.readEntityLatestSnapshot = readEntityLatestSnapshot;
 async function storeEvents(cosmosDb, eventEnvelopes, config) {
     const logger = (0, framework_common_helpers_1.getLogger)(config, 'events-adapter#storeEvents');
     logger.debug('[EventsAdapter#storeEvents] Storing EventEnvelopes with eventEnvelopes:', eventEnvelopes);
+    const persistableEvents = [];
     for (const eventEnvelope of eventEnvelopes) {
+        const persistableEvent = {
+            ...eventEnvelope,
+            createdAt: new Date().toISOString(),
+        };
         await cosmosDb
             .database(config.resourceNames.applicationStack)
             .container(config.resourceNames.eventsStore)
             .items.create({
-            ...eventEnvelope,
-            [constants_1.eventsStoreAttributes.partitionKey]: (0, partition_keys_1.partitionKeyForEvent)(eventEnvelope.entityTypeName, eventEnvelope.entityID, eventEnvelope.kind),
-            [constants_1.eventsStoreAttributes.sortKey]: new Date().toISOString(),
+            ...persistableEvent,
+            [constants_1.eventsStoreAttributes.partitionKey]: (0, partition_keys_1.partitionKeyForEvent)(eventEnvelope.entityTypeName, eventEnvelope.entityID),
+            [constants_1.eventsStoreAttributes.sortKey]: persistableEvent.createdAt,
         });
+        persistableEvents.push(persistableEvent);
     }
     logger.debug('[EventsAdapter#storeEvents] EventEnvelope stored');
+    return persistableEvents;
 }
 exports.storeEvents = storeEvents;
+async function storeSnapshot(cosmosDb, snapshotEnvelope, config) {
+    const logger = (0, framework_common_helpers_1.getLogger)(config, 'events-adapter#storeSnapshot');
+    logger.debug('[EventsAdapter#storeSnapshot] Storing snapshot with snapshotEnvelope:', snapshotEnvelope);
+    const partitionKey = (0, partition_keys_1.partitionKeyForSnapshot)(snapshotEnvelope.entityTypeName, snapshotEnvelope.entityID);
+    /**
+     * The sort key of the snapshot matches the sort key of the last event that generated it.
+     * Entity snapshots can be potentially created by competing processes, and this way
+     * of storing the data makes snapshot creation an idempotent operation, allowing us to
+     * aggressively cache snapshots. If the snapshot already exists, it will be silently overwritten.
+     */
+    const sortKey = snapshotEnvelope.snapshottedEventCreatedAt;
+    const container = cosmosDb.database(config.resourceNames.applicationStack).container(config.resourceNames.eventsStore);
+    /* TODO: As the sortKey is not part of an unique key in the table by default, there's no easy way to
+     * ensure that a snapshot is created only once, so we need to check if it exists first.
+     * This is not ideal, but conditional writes doesn't seem to have a simple solution in CosmosDB at
+     * the moment. We should revisit this in the future.
+     *
+     * Notice that while this implementation can potentially fail to prevent an extra snapshot to be created,
+     * the existence of such extra snapshot has no impact on the way Booster works. This check is here
+     * because we want to avoid snapshots to be created out of control in scenarios where a big number
+     * of event handlers are requesting the latest state of the same entity.
+     */
+    const { resources } = await container.items
+        .query({
+        query: 'SELECT * FROM c WHERE c.partitionKey = @partitionKey AND c.sortKey = @sortKey',
+        parameters: [
+            {
+                name: '@partitionKey',
+                value: partitionKey,
+            },
+            {
+                name: '@sortKey',
+                value: sortKey,
+            },
+        ],
+    })
+        .fetchAll();
+    if (resources.length > 0) {
+        throw new Error('Snapshot already exists. skipping...');
+    }
+    const persistableEntitySnapshot = {
+        ...snapshotEnvelope,
+        createdAt: snapshotEnvelope.snapshottedEventCreatedAt,
+        persistedAt: new Date().toISOString(),
+    };
+    await container.items.create({
+        ...persistableEntitySnapshot,
+        [constants_1.eventsStoreAttributes.partitionKey]: partitionKey,
+        [constants_1.eventsStoreAttributes.sortKey]: sortKey,
+    });
+    logger.debug('Snapshot stored', snapshotEnvelope);
+    return persistableEntitySnapshot;
+}
+exports.storeSnapshot = storeSnapshot;

package/dist/library/partition-keys.d.ts

@@ -1,3 +1,3 @@
-import { EventEnvelope, UUID } from '@boostercloud/framework-types';
-export declare function partitionKeyForEvent(entityTypeName: string, entityID: UUID, kind?: EventEnvelope['kind']): string;
-export declare function partitionKeyForIndexByEntity(entityTypeName: string, kind: EventEnvelope['kind']): string;
+import { UUID } from '@boostercloud/framework-types';
+export declare function partitionKeyForEvent(entityTypeName: string, entityID: UUID): string;
+export declare function partitionKeyForSnapshot(entityTypeName: string, entityID: UUID): string;

package/dist/library/partition-keys.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.partitionKeyForIndexByEntity = exports.partitionKeyForEvent = void 0;
-function partitionKeyForEvent(entityTypeName, entityID, kind = 'event') {
-    return `${entityTypeName}-${entityID}-${kind}`;
+exports.partitionKeyForSnapshot = exports.partitionKeyForEvent = void 0;
+function partitionKeyForEvent(entityTypeName, entityID) {
+    return `${entityTypeName}-${entityID}-event`;
 }
 exports.partitionKeyForEvent = partitionKeyForEvent;
-function partitionKeyForIndexByEntity(entityTypeName, kind) {
-    return `${entityTypeName}-${kind}`;
+function partitionKeyForSnapshot(entityTypeName, entityID) {
+    return `${entityTypeName}-${entityID}-snapshot`;
 }
-exports.partitionKeyForIndexByEntity = partitionKeyForIndexByEntity;
+exports.partitionKeyForSnapshot = partitionKeyForSnapshot;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boostercloud/framework-provider-azure",
-  "version": "1.6.2",
+  "version": "1.7.1",
   "description": "Handle Booster's integration with Azure",
   "keywords": [
     "framework-provider-azure"
@@ -23,13 +23,13 @@
     "@azure/cosmos": "^3.17.0",
     "@azure/functions": "^1.2.2",
     "@azure/identity": "~2.1.0",
-    "@boostercloud/framework-common-helpers": "^1.6.2",
-    "@boostercloud/framework-types": "^1.6.2",
+    "@boostercloud/framework-common-helpers": "^1.7.1",
+    "@boostercloud/framework-types": "^1.7.1",
     "tslib": "^2.4.0",
     "@effect-ts/core": "^0.60.4"
   },
   "devDependencies": {
-    "@boostercloud/eslint-config": "^1.6.2",
+    "@boostercloud/eslint-config": "^1.7.1",
     "@types/chai": "4.2.18",
     "@types/chai-as-promised": "7.1.4",
     "@types/faker": "5.1.5",