@boostercloud/framework-provider-azure 2.17.0 → 2.18.0

package/dist/helpers/query-helper.d.ts

@@ -1,3 +1,4 @@
-import { CosmosClient } from '@azure/cosmos';
+import { CosmosClient, ItemDefinition } from '@azure/cosmos';
 import { BoosterConfig, FilterFor, ProjectionFor, ReadModelListResult, SortFor } from '@boostercloud/framework-types';
+export declare function replaceOrDeleteItem(cosmosDb: CosmosClient, container: string, config: BoosterConfig, id: string, partitionKey: string, newValue?: ItemDefinition): Promise<void>;
 export declare function search<TResult>(cosmosDb: CosmosClient, config: BoosterConfig, containerName: string, filters: FilterFor<unknown>, limit?: number | undefined, afterCursor?: Record<string, string> | undefined, paginatedVersion?: boolean, order?: SortFor<unknown>, projections?: ProjectionFor<unknown> | string): Promise<Array<TResult> | ReadModelListResult<TResult>>;

package/dist/helpers/query-helper.js

@@ -1,8 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.search = void 0;
+exports.search = exports.replaceOrDeleteItem = void 0;
 const framework_types_1 = require("@boostercloud/framework-types");
 const framework_common_helpers_1 = require("@boostercloud/framework-common-helpers");
+async function replaceOrDeleteItem(cosmosDb, container, config, id, partitionKey, newValue) {
+    if (newValue) {
+        await cosmosDb
+            .database(config.resourceNames.applicationStack)
+            .container(container)
+            .item(id, partitionKey)
+            .replace(newValue);
+    }
+    else {
+        await cosmosDb.database(config.resourceNames.applicationStack).container(container).item(id, partitionKey).delete();
+    }
+}
+exports.replaceOrDeleteItem = replaceOrDeleteItem;
 async function search(cosmosDb, config, containerName, filters, limit, afterCursor, paginatedVersion = false, order, projections = '*') {
     const logger = (0, framework_common_helpers_1.getLogger)(config, 'query-helper#search');
     const filterExpression = buildFilterExpression(filters);

package/dist/index.js

@@ -19,6 +19,7 @@ const events_stream_producer_adapter_1 = require("./library/events-stream-produc
 const event_hubs_1 = require("@azure/event-hubs");
 const events_stream_consumer_adapter_1 = require("./library/events-stream-consumer-adapter");
 const health_adapter_1 = require("./library/health-adapter");
+const event_delete_adapter_1 = require("./library/event-delete-adapter");
 const events_store_adapter_1 = require("./library/events-store-adapter");
 let cosmosClient;
 if (typeof process.env[constants_1.environmentVarNames.cosmosDbConnectionString] === 'undefined') {
@@ -75,6 +76,10 @@ const Provider = (rockets) => ({
         search: events_searcher_adapter_1.searchEvents.bind(null, cosmosClient),
         searchEntitiesIDs: events_searcher_adapter_1.searchEntitiesIds.bind(null, cosmosClient),
         storeDispatched: events_adapter_1.storeDispatchedEvent.bind(null, cosmosClient),
+        findDeletableEvent: event_delete_adapter_1.findDeletableEvent.bind(null, cosmosClient),
+        findDeletableSnapshot: event_delete_adapter_1.findDeletableSnapshot.bind(null, cosmosClient),
+        deleteEvent: event_delete_adapter_1.deleteEvent.bind(null, cosmosClient),
+        deleteSnapshot: event_delete_adapter_1.deleteSnapshot.bind(null, cosmosClient),
     },
     // ProviderReadModelsLibrary
     readModels: {

package/dist/library/event-delete-adapter.d.ts

@@ -0,0 +1,6 @@
+import { BoosterConfig, EventDeleteParameters, SnapshotDeleteParameters, EventEnvelopeFromDatabase, EntitySnapshotEnvelopeFromDatabase } from '@boostercloud/framework-types';
+import { CosmosClient } from '@azure/cosmos';
+export declare function findDeletableEvent(cosmosDb: CosmosClient, config: BoosterConfig, parameters: EventDeleteParameters): Promise<Array<EventEnvelopeFromDatabase>>;
+export declare function findDeletableSnapshot(cosmosDb: CosmosClient, config: BoosterConfig, parameters: SnapshotDeleteParameters): Promise<Array<EntitySnapshotEnvelopeFromDatabase>>;
+export declare function deleteEvent(cosmosDb: CosmosClient, config: BoosterConfig, events: Array<EventEnvelopeFromDatabase>): Promise<void>;
+export declare function deleteSnapshot(cosmosDb: CosmosClient, config: BoosterConfig, snapshots: Array<EntitySnapshotEnvelopeFromDatabase>): Promise<void>;

package/dist/library/event-delete-adapter.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteSnapshot = exports.deleteEvent = exports.findDeletableSnapshot = exports.findDeletableEvent = void 0;
+const framework_common_helpers_1 = require("@boostercloud/framework-common-helpers");
+const query_helper_1 = require("../helpers/query-helper");
+async function findDeletableEvent(cosmosDb, config, parameters) {
+    const logger = (0, framework_common_helpers_1.getLogger)(config, 'events-delete-adapter#findDeletableEvent');
+    const stringifyParameters = JSON.stringify(parameters);
+    logger.debug(`Initiating a deletable event search for ${stringifyParameters}`);
+    const eventStore = config.resourceNames.eventsStore;
+    const filter = buildDeleteEventFilter(parameters.entityTypeName, parameters.entityID, parameters.createdAt);
+    const result = (await (0, query_helper_1.search)(cosmosDb, config, eventStore, filter));
+    logger.debug(`Finished deletable event search for ${stringifyParameters}`);
+    return result;
+}
+exports.findDeletableEvent = findDeletableEvent;
+async function findDeletableSnapshot(cosmosDb, config, parameters) {
+    const logger = (0, framework_common_helpers_1.getLogger)(config, 'events-delete-adapter#findDeletableSnapshot');
+    const stringifyParameters = JSON.stringify(parameters);
+    logger.debug(`Initiating a deletable snapshot search for ${stringifyParameters}`);
+    const eventStore = config.resourceNames.eventsStore;
+    const filter = buildDeleteEntityFilter(parameters.entityTypeName, parameters.entityID, parameters.createdAt);
+    const result = (await (0, query_helper_1.search)(cosmosDb, config, eventStore, filter));
+    logger.debug(`Finished deletable snapshot search for ${stringifyParameters}`);
+    return result;
+}
+exports.findDeletableSnapshot = findDeletableSnapshot;
+async function deleteEvent(cosmosDb, config, events) {
+    const logger = (0, framework_common_helpers_1.getLogger)(config, 'events-delete-adapter#deleteEvent');
+    const stringifyParameters = JSON.stringify(events);
+    logger.debug(`Initiating an event delete for ${stringifyParameters}`);
+    const eventStore = config.resourceNames.eventsStore;
+    if (!events || events.length === 0) {
+        logger.warn('Could not find events to delete');
+        return;
+    }
+    for (const event of events) {
+        const newEvent = buildNewEvent(event);
+        const partitionKey = partitionKeyBuilder(event.entityTypeName, event.entityID, 'event');
+        await (0, query_helper_1.replaceOrDeleteItem)(cosmosDb, eventStore, config, event.id, partitionKey, newEvent);
+    }
+    logger.debug(`Finished event delete for ${stringifyParameters}`);
+}
+exports.deleteEvent = deleteEvent;
+async function deleteSnapshot(cosmosDb, config, snapshots) {
+    const logger = (0, framework_common_helpers_1.getLogger)(config, 'events-delete-adapter#deleteSnapshot');
+    const stringifyParameters = JSON.stringify(snapshots);
+    logger.debug(`Initiating a snapshot delete for ${stringifyParameters}`);
+    const eventStore = config.resourceNames.eventsStore;
+    if (!snapshots || snapshots.length === 0) {
+        logger.warn('Could not find snapshot to delete');
+        return;
+    }
+    for (const snapshot of snapshots) {
+        const partitionKey = partitionKeyBuilder(snapshot.entityTypeName, snapshot.entityID, 'snapshot');
+        await (0, query_helper_1.replaceOrDeleteItem)(cosmosDb, eventStore, config, snapshot.id, partitionKey);
+    }
+    logger.debug(`Finished snapshot delete for ${stringifyParameters}`);
+}
+exports.deleteSnapshot = deleteSnapshot;
+function buildNewEvent(existingEvent) {
+    return {
+        ...existingEvent,
+        deletedAt: new Date().toISOString(),
+        value: {},
+    };
+}
+function buildDeleteEventFilter(entityTypeName, entityId, createdAt) {
+    const value = `${entityTypeName}-${entityId}-event`;
+    return {
+        entityTypeName_entityID_kind: { eq: value },
+        createdAt: { eq: createdAt },
+        kind: { eq: 'event' },
+        deletedAt: { isDefined: false },
+    };
+}
+function buildDeleteEntityFilter(entityTypeName, entityId, createdAt) {
+    const value = `${entityTypeName}-${entityId}-snapshot`;
+    return {
+        entityTypeName_entityID_kind: { eq: value },
+        kind: { eq: 'snapshot' },
+        createdAt: { eq: createdAt },
+        deletedAt: { isDefined: false },
+    };
+}
+function partitionKeyBuilder(entityTypeName, entityID, kind) {
+    return `${entityTypeName}-${entityID}-${kind}`;
+}

package/dist/library/events-adapter.js

@@ -10,10 +10,13 @@ function rawEventsToEnvelopes(context) {
 }
 exports.rawEventsToEnvelopes = rawEventsToEnvelopes;
 async function readEntityEventsSince(cosmosDb, config, entityTypeName, entityID, since) {
+    const logger = (0, framework_common_helpers_1.getLogger)(config, 'events-adapter#readEntityEventsSince');
     const fromTime = since ? since : originOfTime;
     const querySpec = {
         query: `SELECT * FROM c WHERE c["${constants_1.eventsStoreAttributes.partitionKey}"] = @partitionKey ` +
-            `AND c["${constants_1.eventsStoreAttributes.sortKey}"] > @fromTime ORDER BY c["${constants_1.eventsStoreAttributes.sortKey}"] ASC`,
+            `AND c["${constants_1.eventsStoreAttributes.sortKey}"] > @fromTime ` +
+            'AND NOT IS_DEFINED(c["deletedAt"]) ' +
+            `ORDER BY c["${constants_1.eventsStoreAttributes.sortKey}"] ASC`,
         parameters: [
             {
                 name: '@partitionKey',
@@ -30,6 +33,7 @@ async function readEntityEventsSince(cosmosDb, config, entityTypeName, entityID,
         .container(config.resourceNames.eventsStore)
         .items.query(querySpec)
         .fetchAll();
+    logger.debug(`Loaded events for entity ${entityTypeName} with ID ${entityID} with result:`, resources);
     return resources;
 }
 exports.readEntityEventsSince = readEntityEventsSince;

package/dist/library/events-searcher-adapter.js

@@ -22,7 +22,11 @@ exports.searchEvents = searchEvents;
 async function searchEntitiesIds(cosmosDb, config, limit, afterCursor, entityTypeName) {
     const logger = (0, framework_common_helpers_1.getLogger)(config, 'events-searcher-adapter#searchEntitiesIds');
     logger.debug(`Initiating a paginated events search. limit: ${limit}, afterCursor: ${JSON.stringify(afterCursor)}, entityTypeName: ${entityTypeName}`);
-    const filterQuery = { kind: { eq: 'event' }, entityTypeName: { eq: entityTypeName } };
+    const filterQuery = {
+        kind: { eq: 'event' },
+        entityTypeName: { eq: entityTypeName },
+        deletedAt: { isDefined: false },
+    };
     const eventStore = config.resourceNames.eventsStore;
     const result = (await (0, query_helper_1.search)(cosmosDb, config, eventStore, filterQuery, limit, afterCursor, true, undefined, 'DISTINCT c.entityID'));
     logger.debug('Unique events search result', result);

package/dist/library/events-searcher-builder.js

@@ -47,6 +47,7 @@ function resultToEventSearchResponse(result) {
             user: item.currentUser,
             createdAt: item.createdAt,
             value: item.value,
+            deletedAt: item.deletedAt,
         };
     });
     return eventSearchResult !== null && eventSearchResult !== void 0 ? eventSearchResult : [];

package/dist/library/read-model-adapter.js

@@ -86,13 +86,18 @@ async function storeReadModel(db, config, readModelName, readModel) {
 exports.storeReadModel = storeReadModel;
 async function deleteReadModel(db, config, readModelName, readModel) {
     const logger = (0, framework_common_helpers_1.getLogger)(config, 'read-model-adapter#deleteReadModel');
-    logger.debug(`[ReadModelAdapter#deleteReadModel] Entering to Read model deleted. ID = ${readModel.id}`);
-    await db
-        .database(config.resourceNames.applicationStack)
-        .container(config.resourceNames.forReadModel(readModelName))
-        .item(readModel.id, readModel.id)
-        .delete();
-    logger.debug(`[ReadModelAdapter#deleteReadModel] Read model deleted. ID = ${readModel.id}`);
+    logger.debug(`Entering to Read model deleted. ${readModelName} ID = ${readModel.id}`);
+    try {
+        await db
+            .database(config.resourceNames.applicationStack)
+            .container(config.resourceNames.forReadModel(readModelName))
+            .item(readModel.id, readModel.id)
+            .delete();
+        logger.debug(`Read model deleted. ${readModelName} ID = ${readModel.id}`);
+    }
+    catch (e) {
+        logger.warn(`Read model to delete ${readModelName} ID = ${readModel.id} not found`);
+    }
 }
 exports.deleteReadModel = deleteReadModel;
 async function rawReadModelEventsToEnvelopes(config, rawEvents) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boostercloud/framework-provider-azure",
-  "version": "2.17.0",
+  "version": "2.18.0",
   "description": "Handle Booster's integration with Azure",
   "keywords": [
     "framework-provider-azure"
@@ -27,14 +27,14 @@
     "@azure/functions": "^1.2.2",
     "@azure/identity": "~2.1.0",
     "@azure/event-hubs": "5.11.1",
-    "@boostercloud/framework-common-helpers": "^2.17.0",
-    "@boostercloud/framework-types": "^2.17.0",
+    "@boostercloud/framework-common-helpers": "^2.18.0",
+    "@boostercloud/framework-types": "^2.18.0",
     "tslib": "^2.4.0",
     "@effect-ts/core": "^0.60.4",
     "@azure/web-pubsub": "~1.1.0"
   },
   "devDependencies": {
-    "@boostercloud/eslint-config": "^2.17.0",
+    "@boostercloud/eslint-config": "^2.18.0",
     "@types/chai": "4.2.18",
     "@types/chai-as-promised": "7.1.4",
     "@types/faker": "5.1.5",