@credo-ts/openid4vc 0.5.3 → 0.5.4

package/build/tenants/src/TenantsModuleConfig.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TenantsModuleConfig = void 0;
+class TenantsModuleConfig {
+    constructor(options) {
+        this.options = options !== null && options !== void 0 ? options : {};
+    }
+    /** See {@link TenantsModuleConfigOptions.sessionLimit} */
+    get sessionLimit() {
+        var _a;
+        return (_a = this.options.sessionLimit) !== null && _a !== void 0 ? _a : 100;
+    }
+    /** See {@link TenantsModuleConfigOptions.sessionAcquireTimeout} */
+    get sessionAcquireTimeout() {
+        var _a;
+        return (_a = this.options.sessionAcquireTimeout) !== null && _a !== void 0 ? _a : 1000;
+    }
+}
+exports.TenantsModuleConfig = TenantsModuleConfig;
+//# sourceMappingURL=TenantsModuleConfig.js.map

package/build/tenants/src/TenantsModuleConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TenantsModuleConfig.js","sourceRoot":"","sources":["../../../../tenants/src/TenantsModuleConfig.ts"],"names":[],"mappings":";;;AAyBA,MAAa,mBAAmB;IAG9B,YAAmB,OAAoC;QACrD,IAAI,CAAC,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAA;IAC9B,CAAC;IAED,0DAA0D;IAC1D,IAAW,YAAY;;QACrB,OAAO,MAAA,IAAI,CAAC,OAAO,CAAC,YAAY,mCAAI,GAAG,CAAA;IACzC,CAAC;IAED,mEAAmE;IACnE,IAAW,qBAAqB;;QAC9B,OAAO,MAAA,IAAI,CAAC,OAAO,CAAC,qBAAqB,mCAAI,IAAI,CAAA;IACnD,CAAC;CACF;AAhBD,kDAgBC"}

package/build/tenants/src/context/TenantAgentContextProvider.d.ts

@@ -0,0 +1,40 @@
+import type { TenantRecord } from '../repository';
+import type { AgentContextProvider, UpdateAssistantUpdateOptions } from '@credo-ts/core';
+import { AgentContext, EventEmitter, Logger } from '@credo-ts/core';
+import { TenantRecordService } from '../services';
+import { TenantSessionCoordinator } from './TenantSessionCoordinator';
+export declare class TenantAgentContextProvider implements AgentContextProvider {
+    private tenantRecordService;
+    private rootAgentContext;
+    private eventEmitter;
+    private logger;
+    private tenantSessionCoordinator;
+    constructor(tenantRecordService: TenantRecordService, rootAgentContext: AgentContext, eventEmitter: EventEmitter, tenantSessionCoordinator: TenantSessionCoordinator, logger: Logger);
+    getAgentContextForContextCorrelationId(contextCorrelationId: string): Promise<AgentContext>;
+    getContextForInboundMessage(inboundMessage: unknown, options?: {
+        contextCorrelationId?: string;
+    }): Promise<AgentContext>;
+    endSessionForAgentContext(agentContext: AgentContext): Promise<void>;
+    private getRecipientKeysFromEncryptedMessage;
+    private registerRecipientKeyForTenant;
+    private listenForRoutingKeyCreatedEvents;
+    /**
+     * Method to allow updating the tenant storage, this method can be called from the TenantsApi
+     * to update the storage for a tenant manually
+     */
+    updateTenantStorage(tenantRecord: TenantRecord, updateOptions?: UpdateAssistantUpdateOptions): Promise<void>;
+    /**
+     * Handle the case where the tenant storage is outdated. If auto-update is disabled we will throw an error
+     * and not update the storage. If auto-update is enabled we will update the storage.
+     *
+     * When this method is called we can be sure that we are in the mutex runExclusive lock and thus other sessions
+     * will not be able to open a session for this tenant until we're done.
+     *
+     * NOTE: We don't support multi-instance locking for now. That means you can only have a single instance open and
+     * it will prevent multiple processes from updating the tenant storage at the same time. However if multi-instances
+     * are used, we can't prevent multiple instances from updating the tenant storage at the same time.
+     * In the future we can make the tenantSessionCoordinator an interface and allowing a instance-tenant-lock as well
+     * as an tenant-lock (across all instances)
+     */
+    private _updateTenantStorage;
+}

package/build/tenants/src/context/TenantAgentContextProvider.js

@@ -0,0 +1,175 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TenantAgentContextProvider = void 0;
+const core_1 = require("@credo-ts/core");
+const TenantAgent_1 = require("../TenantAgent");
+const services_1 = require("../services");
+const TenantSessionCoordinator_1 = require("./TenantSessionCoordinator");
+let TenantAgentContextProvider = class TenantAgentContextProvider {
+    constructor(tenantRecordService, rootAgentContext, eventEmitter, tenantSessionCoordinator, logger) {
+        this.tenantRecordService = tenantRecordService;
+        this.rootAgentContext = rootAgentContext;
+        this.eventEmitter = eventEmitter;
+        this.tenantSessionCoordinator = tenantSessionCoordinator;
+        this.logger = logger;
+        // Start listener for newly created routing keys, so we can register a mapping for each new key for the tenant
+        this.listenForRoutingKeyCreatedEvents();
+    }
+    async getAgentContextForContextCorrelationId(contextCorrelationId) {
+        // It could be that the root agent context is requested, in that case we return the root agent context
+        if (contextCorrelationId === this.rootAgentContext.contextCorrelationId) {
+            return this.rootAgentContext;
+        }
+        // TODO: maybe we can look at not having to retrieve the tenant record if there's already a context available.
+        const tenantRecord = await this.tenantRecordService.getTenantById(this.rootAgentContext, contextCorrelationId);
+        const shouldUpdate = !(0, core_1.isStorageUpToDate)(tenantRecord.storageVersion);
+        // If the tenant storage is not up to date, and autoUpdate is disabled we throw an error
+        if (shouldUpdate && !this.rootAgentContext.config.autoUpdateStorageOnStartup) {
+            throw new core_1.CredoError(`Current agent storage for tenant ${tenantRecord.id} is not up to date. ` +
+                `To prevent the tenant state from getting corrupted the tenant initialization is aborted. ` +
+                `Make sure to update the tenant storage (currently at ${tenantRecord.storageVersion}) to the latest version (${core_1.UpdateAssistant.frameworkStorageVersion}). ` +
+                `You can also downgrade your version of Credo.`);
+        }
+        const agentContext = await this.tenantSessionCoordinator.getContextForSession(tenantRecord, {
+            runInMutex: shouldUpdate ? (agentContext) => this._updateTenantStorage(tenantRecord, agentContext) : undefined,
+        });
+        this.logger.debug(`Created tenant agent context for tenant '${contextCorrelationId}'`);
+        return agentContext;
+    }
+    async getContextForInboundMessage(inboundMessage, options) {
+        this.logger.debug('Getting context for inbound message in tenant agent context provider', {
+            contextCorrelationId: options === null || options === void 0 ? void 0 : options.contextCorrelationId,
+        });
+        let tenantId = options === null || options === void 0 ? void 0 : options.contextCorrelationId;
+        let recipientKeys = [];
+        if (!tenantId && (0, core_1.isValidJweStructure)(inboundMessage)) {
+            this.logger.trace("Inbound message is a JWE, extracting tenant id from JWE's protected header");
+            recipientKeys = this.getRecipientKeysFromEncryptedMessage(inboundMessage);
+            this.logger.trace(`Found ${recipientKeys.length} recipient keys in JWE's protected header`);
+            // FIXME: what if there are multiple recipients in the same agent? If we receive the messages twice we will process it for
+            // the first found recipient multiple times. This is however a case I've never seen before and will add quite some complexity
+            // to resolve. I think we're fine to ignore this case for now.
+            for (const recipientKey of recipientKeys) {
+                const tenantRoutingRecord = await this.tenantRecordService.findTenantRoutingRecordByRecipientKey(this.rootAgentContext, recipientKey);
+                if (tenantRoutingRecord) {
+                    this.logger.debug(`Found tenant routing record for recipient key ${recipientKeys[0].fingerprint}`, {
+                        tenantId: tenantRoutingRecord.tenantId,
+                    });
+                    tenantId = tenantRoutingRecord.tenantId;
+                    break;
+                }
+            }
+        }
+        if (!tenantId) {
+            this.logger.error("Couldn't determine tenant id for inbound message. Unable to create context", {
+                inboundMessage,
+                recipientKeys: recipientKeys.map((key) => key.fingerprint),
+            });
+            throw new core_1.CredoError("Couldn't determine tenant id for inbound message. Unable to create context");
+        }
+        const agentContext = await this.getAgentContextForContextCorrelationId(tenantId);
+        return agentContext;
+    }
+    async endSessionForAgentContext(agentContext) {
+        await this.tenantSessionCoordinator.endAgentContextSession(agentContext);
+    }
+    getRecipientKeysFromEncryptedMessage(jwe) {
+        const jweProtected = core_1.JsonEncoder.fromBase64(jwe.protected);
+        if (!Array.isArray(jweProtected.recipients))
+            return [];
+        const recipientKeys = [];
+        for (const recipient of jweProtected.recipients) {
+            // Check if recipient.header.kid is a string
+            if ((0, core_1.isJsonObject)(recipient) && (0, core_1.isJsonObject)(recipient.header) && typeof recipient.header.kid === 'string') {
+                // This won't work with other key types, we should detect what the encoding is of kid, and based on that
+                // determine how we extract the key from the message
+                const key = core_1.Key.fromPublicKeyBase58(recipient.header.kid, core_1.KeyType.Ed25519);
+                recipientKeys.push(key);
+            }
+        }
+        return recipientKeys;
+    }
+    async registerRecipientKeyForTenant(tenantId, recipientKey) {
+        this.logger.debug(`Registering recipient key ${recipientKey.fingerprint} for tenant ${tenantId}`);
+        const tenantRecord = await this.tenantRecordService.getTenantById(this.rootAgentContext, tenantId);
+        await this.tenantRecordService.addTenantRoutingRecord(this.rootAgentContext, tenantRecord.id, recipientKey);
+    }
+    listenForRoutingKeyCreatedEvents() {
+        this.logger.debug('Listening for routing key created events in tenant agent context provider');
+        this.eventEmitter.on(core_1.RoutingEventTypes.RoutingCreatedEvent, async (event) => {
+            const contextCorrelationId = event.metadata.contextCorrelationId;
+            const recipientKey = event.payload.routing.recipientKey;
+            // We don't want to register the key if it's for the root agent context
+            if (contextCorrelationId === this.rootAgentContext.contextCorrelationId)
+                return;
+            this.logger.debug(`Received routing key created event for tenant ${contextCorrelationId}, registering recipient key ${recipientKey.fingerprint} in base wallet`);
+            await this.registerRecipientKeyForTenant(contextCorrelationId, recipientKey);
+        });
+    }
+    /**
+     * Method to allow updating the tenant storage, this method can be called from the TenantsApi
+     * to update the storage for a tenant manually
+     */
+    async updateTenantStorage(tenantRecord, updateOptions) {
+        const agentContext = await this.tenantSessionCoordinator.getContextForSession(tenantRecord, {
+            // runInMutex allows us to run the updateTenantStorage method in a mutex lock
+            // prevent other sessions from being started while the update is in progress
+            runInMutex: (agentContext) => this._updateTenantStorage(tenantRecord, agentContext, updateOptions),
+        });
+        // End sesion afterwards
+        await agentContext.endSession();
+    }
+    /**
+     * Handle the case where the tenant storage is outdated. If auto-update is disabled we will throw an error
+     * and not update the storage. If auto-update is enabled we will update the storage.
+     *
+     * When this method is called we can be sure that we are in the mutex runExclusive lock and thus other sessions
+     * will not be able to open a session for this tenant until we're done.
+     *
+     * NOTE: We don't support multi-instance locking for now. That means you can only have a single instance open and
+     * it will prevent multiple processes from updating the tenant storage at the same time. However if multi-instances
+     * are used, we can't prevent multiple instances from updating the tenant storage at the same time.
+     * In the future we can make the tenantSessionCoordinator an interface and allowing a instance-tenant-lock as well
+     * as an tenant-lock (across all instances)
+     */
+    async _updateTenantStorage(tenantRecord, agentContext, updateOptions) {
+        var _a;
+        try {
+            // Update the tenant storage
+            const tenantAgent = new TenantAgent_1.TenantAgent(agentContext);
+            const updateAssistant = new core_1.UpdateAssistant(tenantAgent);
+            await updateAssistant.initialize();
+            await updateAssistant.update(Object.assign(Object.assign({}, updateOptions), { backupBeforeStorageUpdate: (_a = updateOptions === null || updateOptions === void 0 ? void 0 : updateOptions.backupBeforeStorageUpdate) !== null && _a !== void 0 ? _a : agentContext.config.backupBeforeStorageUpdate }));
+            // Update the storage version in the tenant record
+            tenantRecord.storageVersion = await updateAssistant.getCurrentAgentStorageVersion();
+            const tenantRecordService = this.rootAgentContext.dependencyManager.resolve(services_1.TenantRecordService);
+            await tenantRecordService.updateTenant(this.rootAgentContext, tenantRecord);
+        }
+        catch (error) {
+            this.logger.error(`Error occurred while updating tenant storage for tenant ${tenantRecord.id}`, error);
+            throw error;
+        }
+    }
+};
+exports.TenantAgentContextProvider = TenantAgentContextProvider;
+exports.TenantAgentContextProvider = TenantAgentContextProvider = __decorate([
+    (0, core_1.injectable)(),
+    __param(4, (0, core_1.inject)(core_1.InjectionSymbols.Logger)),
+    __metadata("design:paramtypes", [services_1.TenantRecordService,
+        core_1.AgentContext,
+        core_1.EventEmitter,
+        TenantSessionCoordinator_1.TenantSessionCoordinator, Object])
+], TenantAgentContextProvider);
+//# sourceMappingURL=TenantAgentContextProvider.js.map

package/build/tenants/src/context/TenantAgentContextProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TenantAgentContextProvider.js","sourceRoot":"","sources":["../../../../../tenants/src/context/TenantAgentContextProvider.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAQA,yCAgBuB;AAEvB,gDAA4C;AAC5C,0CAAiD;AAEjD,yEAAqE;AAG9D,IAAM,0BAA0B,GAAhC,MAAM,0BAA0B;IAOrC,YACE,mBAAwC,EACxC,gBAA8B,EAC9B,YAA0B,EAC1B,wBAAkD,EACjB,MAAc;QAE/C,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAA;QAC9C,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;QACxC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;QAChC,IAAI,CAAC,wBAAwB,GAAG,wBAAwB,CAAA;QACxD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAEpB,8GAA8G;QAC9G,IAAI,CAAC,gCAAgC,EAAE,CAAA;IACzC,CAAC;IAEM,KAAK,CAAC,sCAAsC,CAAC,oBAA4B;QAC9E,sGAAsG;QACtG,IAAI,oBAAoB,KAAK,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,EAAE,CAAC;YACxE,OAAO,IAAI,CAAC,gBAAgB,CAAA;QAC9B,CAAC;QAED,8GAA8G;QAC9G,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,IAAI,CAAC,gBAAgB,EAAE,oBAAoB,CAAC,CAAA;QAC9G,MAAM,YAAY,GAAG,CAAC,IAAA,wBAAiB,EAAC,YAAY,CAAC,cAAc,CAAC,CAAA;QAEpE,wFAAwF;QACxF,IAAI,YAAY,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,0BAA0B,EAAE,CAAC;YAC7E,MAAM,IAAI,iBAAU,CAClB,oCAAoC,YAAY,CAAC,EAAE,sBAAsB;gBACvE,2FAA2F;gBAC3F,wDAAwD,YAAY,CAAC,cAAc,4BAA4B,sBAAe,CAAC,uBAAuB,KAAK;gBAC3J,+CAA+C,CAClD,CAAA;QACH,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,oBAAoB,CAAC,YAAY,EAAE;YAC1F,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS;SAC/G,CAAC,CAAA;QAEF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4CAA4C,oBAAoB,GAAG,CAAC,CAAA;QAEtF,OAAO,YAAY,CAAA;IACrB,CAAC;IAEM,KAAK,CAAC,2BAA2B,CAAC,cAAuB,EAAE,OAA2C;QAC3G,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,sEAAsE,EAAE;YACxF,oBAAoB,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,oBAAoB;SACpD,CAAC,CAAA;QAEF,IAAI,QAAQ,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,oBAAoB,CAAA;QAC5C,IAAI,aAAa,GAAU,EAAE,CAAA;QAE7B,IAAI,CAAC,QAAQ,IAAI,IAAA,0BAAmB,EAAC,cAAc,CAAC,EAAE,CAAC;YACrD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4EAA4E,CAAC,CAAA;YAC/F,aAAa,GAAG,IAAI,CAAC,oCAAoC,CAAC,cAAc,CAAC,CAAA;YAEzE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,aAAa,CAAC,MAAM,2CAA2C,CAAC,CAAA;YAE3F,0HAA0H;YAC1H,6HAA6H;YAC7H,8DAA8D;YAC9D,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;gBACzC,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,qCAAqC,CAC9F,IAAI,CAAC,gBAAgB,EACrB,YAAY,CACb,CAAA;gBAED,IAAI,mBAAmB,EAAE,CAAC;oBACxB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iDAAiD,aAAa,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE;wBACjG,QAAQ,EAAE,mBAAmB,CAAC,QAAQ;qBACvC,CAAC,CAAA;oBACF,QAAQ,GAAG,mBAAmB,CAAC,QAAQ,CAAA;oBACvC,MAAK;gBACP,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4EAA4E,EAAE;gBAC9F,cAAc;gBACd,aAAa,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC;aAC3D,CAAC,CAAA;YACF,MAAM,IAAI,iBAAU,CAAC,4EAA4E,CAAC,CAAA;QACpG,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,sCAAsC,CAAC,QAAQ,CAAC,CAAA;QAEhF,OAAO,YAAY,CAAA;IACrB,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,YAA0B;QAC/D,MAAM,IAAI,CAAC,wBAAwB,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAA;IAC1E,CAAC;IAEO,oCAAoC,CAAC,GAAqB;QAChE,MAAM,YAAY,GAAG,kBAAW,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QAC1D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC;YAAE,OAAO,EAAE,CAAA;QAEtD,MAAM,aAAa,GAAU,EAAE,CAAA;QAE/B,KAAK,MAAM,SAAS,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;YAChD,4CAA4C;YAC5C,IAAI,IAAA,mBAAY,EAAC,SAAS,CAAC,IAAI,IAAA,mBAAY,EAAC,SAAS,CAAC,MAAM,CAAC,IAAI,OAAO,SAAS,CAAC,MAAM,CAAC,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC1G,wGAAwG;gBACxG,oDAAoD;gBACpD,MAAM,GAAG,GAAG,UAAG,CAAC,mBAAmB,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,cAAO,CAAC,OAAO,CAAC,CAAA;gBAC1E,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YACzB,CAAC;QACH,CAAC;QAED,OAAO,aAAa,CAAA;IACtB,CAAC;IAEO,KAAK,CAAC,6BAA6B,CAAC,QAAgB,EAAE,YAAiB;QAC7E,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,YAAY,CAAC,WAAW,eAAe,QAAQ,EAAE,CAAC,CAAA;QACjG,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAA;QAClG,MAAM,IAAI,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,IAAI,CAAC,gBAAgB,EAAE,YAAY,CAAC,EAAE,EAAE,YAAY,CAAC,CAAA;IAC7G,CAAC;IAEO,gCAAgC;QACtC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2EAA2E,CAAC,CAAA;QAC9F,IAAI,CAAC,YAAY,CAAC,EAAE,CAAsB,wBAAiB,CAAC,mBAAmB,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;YAC/F,MAAM,oBAAoB,GAAG,KAAK,CAAC,QAAQ,CAAC,oBAAoB,CAAA;YAChE,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAA;YAEvD,uEAAuE;YACvE,IAAI,oBAAoB,KAAK,IAAI,CAAC,gBAAgB,CAAC,oBAAoB;gBAAE,OAAM;YAE/E,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,iDAAiD,oBAAoB,+BAA+B,YAAY,CAAC,WAAW,iBAAiB,CAC9I,CAAA;YACD,MAAM,IAAI,CAAC,6BAA6B,CAAC,oBAAoB,EAAE,YAAY,CAAC,CAAA;QAC9E,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,mBAAmB,CAAC,YAA0B,EAAE,aAA4C;QACvG,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,oBAAoB,CAAC,YAAY,EAAE;YAC1F,6EAA6E;YAC7E,4EAA4E;YAC5E,UAAU,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,YAAY,EAAE,YAAY,EAAE,aAAa,CAAC;SACnG,CAAC,CAAA;QAEF,wBAAwB;QACxB,MAAM,YAAY,CAAC,UAAU,EAAE,CAAA;IACjC,CAAC;IAED;;;;;;;;;;;;OAYG;IACK,KAAK,CAAC,oBAAoB,CAChC,YAA0B,EAC1B,YAA0B,EAC1B,aAA4C;;QAE5C,IAAI,CAAC;YACH,4BAA4B;YAC5B,MAAM,WAAW,GAAG,IAAI,yBAAW,CAAC,YAAY,CAAC,CAAA;YACjD,MAAM,eAAe,GAAG,IAAI,sBAAe,CAAC,WAAW,CAAC,CAAA;YACxD,MAAM,eAAe,CAAC,UAAU,EAAE,CAAA;YAClC,MAAM,eAAe,CAAC,MAAM,iCACvB,aAAa,KAChB,yBAAyB,EACvB,MAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,yBAAyB,mCAAI,YAAY,CAAC,MAAM,CAAC,yBAAyB,IAC3F,CAAA;YAEF,kDAAkD;YAClD,YAAY,CAAC,cAAc,GAAG,MAAM,eAAe,CAAC,6BAA6B,EAAE,CAAA;YACnF,MAAM,mBAAmB,GAAG,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,OAAO,CAAC,8BAAmB,CAAC,CAAA;YAChG,MAAM,mBAAmB,CAAC,YAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAA;QAC7E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2DAA2D,YAAY,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,CAAA;YACtG,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC;CACF,CAAA;AArMY,gEAA0B;qCAA1B,0BAA0B;IADtC,IAAA,iBAAU,GAAE;IAaR,WAAA,IAAA,aAAM,EAAC,uBAAgB,CAAC,MAAM,CAAC,CAAA;qCAJX,8BAAmB;QACtB,mBAAY;QAChB,mBAAY;QACA,mDAAwB;GAXzC,0BAA0B,CAqMtC"}

package/build/tenants/src/context/TenantSessionCoordinator.d.ts

@@ -0,0 +1,54 @@
+import type { TenantRecord } from '../repository';
+import type { MutexInterface } from 'async-mutex';
+import { AgentContext, Logger } from '@credo-ts/core';
+import { TenantsModuleConfig } from '../TenantsModuleConfig';
+/**
+ * Coordinates all agent context instance for tenant sessions.
+ *
+ * This class keeps a mapping of tenant ids (context correlation ids) to agent context sessions mapping. Each mapping contains the agent context,
+ * the current session count and a mutex for making operations against the session mapping (opening / closing an agent context). The mutex ensures
+ * we're not susceptible to race conditions where multiple calls to open/close an agent context are made at the same time. Even though JavaScript is
+ * single threaded, promises can introduce race conditions as one process can stop and another process can be picked up.
+ *
+ * NOTE: the implementation doesn't yet cache agent context objects after they aren't being used for any sessions anymore. This means if a wallet is being used
+ * often in a short time it will be opened/closed very often. This is an improvement to be made in the near future.
+ */
+export declare class TenantSessionCoordinator {
+    private rootAgentContext;
+    private logger;
+    private tenantAgentContextMapping;
+    private sessionMutex;
+    private tenantsModuleConfig;
+    constructor(rootAgentContext: AgentContext, logger: Logger, tenantsModuleConfig: TenantsModuleConfig);
+    getSessionCountForTenant(tenantId: string): number;
+    /**
+     * Get agent context to use for a session. If an agent context for this tenant does not exist yet
+     * it will create it and store it for later use. If the agent context does already exist it will
+     * be returned.
+     *
+     * @parm tenantRecord The tenant record for which to get the agent context
+     */
+    getContextForSession(tenantRecord: TenantRecord, { runInMutex, }?: {
+        /** optional callback that will be run inside the mutex lock */
+        runInMutex?: (agentContext: AgentContext) => Promise<void>;
+    }): Promise<AgentContext>;
+    /**
+     * End a session for the provided agent context. It will decrease the session count for the agent context.
+     * If the number of sessions is zero after the context for this session has been ended, the agent context will be closed.
+     */
+    endAgentContextSession(agentContext: AgentContext): Promise<void>;
+    private hasTenantSessionMapping;
+    private getTenantSessionsMapping;
+    private mutexForTenant;
+    private createAgentContext;
+    private closeAgentContext;
+}
+interface TenantContextSessions {
+    sessionCount: number;
+    agentContext?: AgentContext;
+    mutex: MutexInterface;
+}
+export interface TenantAgentContextMapping {
+    [tenantId: string]: TenantContextSessions | undefined;
+}
+export {};

package/build/tenants/src/context/TenantSessionCoordinator.js

@@ -0,0 +1,195 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TenantSessionCoordinator = void 0;
+const core_1 = require("@credo-ts/core");
+const async_mutex_1 = require("async-mutex");
+const TenantsModuleConfig_1 = require("../TenantsModuleConfig");
+const TenantSessionMutex_1 = require("./TenantSessionMutex");
+/**
+ * Coordinates all agent context instance for tenant sessions.
+ *
+ * This class keeps a mapping of tenant ids (context correlation ids) to agent context sessions mapping. Each mapping contains the agent context,
+ * the current session count and a mutex for making operations against the session mapping (opening / closing an agent context). The mutex ensures
+ * we're not susceptible to race conditions where multiple calls to open/close an agent context are made at the same time. Even though JavaScript is
+ * single threaded, promises can introduce race conditions as one process can stop and another process can be picked up.
+ *
+ * NOTE: the implementation doesn't yet cache agent context objects after they aren't being used for any sessions anymore. This means if a wallet is being used
+ * often in a short time it will be opened/closed very often. This is an improvement to be made in the near future.
+ */
+let TenantSessionCoordinator = class TenantSessionCoordinator {
+    constructor(rootAgentContext, logger, tenantsModuleConfig) {
+        this.tenantAgentContextMapping = {};
+        this.rootAgentContext = rootAgentContext;
+        this.logger = logger;
+        this.tenantsModuleConfig = tenantsModuleConfig;
+        this.sessionMutex = new TenantSessionMutex_1.TenantSessionMutex(this.logger, this.tenantsModuleConfig.sessionLimit, 
+        // TODO: we should probably allow a higher session acquire timeout if the storage is being updated?
+        this.tenantsModuleConfig.sessionAcquireTimeout);
+    }
+    getSessionCountForTenant(tenantId) {
+        var _a, _b;
+        return (_b = (_a = this.tenantAgentContextMapping[tenantId]) === null || _a === void 0 ? void 0 : _a.sessionCount) !== null && _b !== void 0 ? _b : 0;
+    }
+    /**
+     * Get agent context to use for a session. If an agent context for this tenant does not exist yet
+     * it will create it and store it for later use. If the agent context does already exist it will
+     * be returned.
+     *
+     * @parm tenantRecord The tenant record for which to get the agent context
+     */
+    async getContextForSession(tenantRecord, { runInMutex, } = {}) {
+        this.logger.debug(`Getting context for session with tenant '${tenantRecord.id}'`);
+        // Wait for a session to be available
+        await this.sessionMutex.acquireSession();
+        try {
+            return await this.mutexForTenant(tenantRecord.id).runExclusive(async () => {
+                this.logger.debug(`Acquired lock for tenant '${tenantRecord.id}' to get context`);
+                const tenantSessions = this.getTenantSessionsMapping(tenantRecord.id);
+                // If we don't have an agent context already, create one and initialize it
+                if (!tenantSessions.agentContext) {
+                    this.logger.debug(`No agent context has been initialized for tenant '${tenantRecord.id}', creating one`);
+                    tenantSessions.agentContext = await this.createAgentContext(tenantRecord);
+                }
+                // If we already have a context with sessions in place return the context and increment
+                // the session count.
+                tenantSessions.sessionCount++;
+                this.logger.debug(`Increased agent context session count for tenant '${tenantRecord.id}' to ${tenantSessions.sessionCount}`);
+                if (runInMutex) {
+                    try {
+                        await runInMutex(tenantSessions.agentContext);
+                    }
+                    catch (error) {
+                        // If the runInMutex failed we should release the session again
+                        tenantSessions.sessionCount--;
+                        this.logger.debug(`Decreased agent context session count for tenant '${tenantSessions.agentContext.contextCorrelationId}' to ${tenantSessions.sessionCount} due to failure in mutex script`, error);
+                        if (tenantSessions.sessionCount <= 0 && tenantSessions.agentContext) {
+                            await this.closeAgentContext(tenantSessions.agentContext);
+                            delete this.tenantAgentContextMapping[tenantSessions.agentContext.contextCorrelationId];
+                        }
+                        throw error;
+                    }
+                }
+                return tenantSessions.agentContext;
+            });
+        }
+        catch (error) {
+            this.logger.debug(`Releasing session because an error occurred while getting the context for tenant ${tenantRecord.id}`, {
+                errorMessage: error.message,
+            });
+            // If there was an error acquiring the session, we MUST release it, otherwise this will lead to deadlocks over time.
+            this.sessionMutex.releaseSession();
+            // Re-throw error
+            throw error;
+        }
+    }
+    /**
+     * End a session for the provided agent context. It will decrease the session count for the agent context.
+     * If the number of sessions is zero after the context for this session has been ended, the agent context will be closed.
+     */
+    async endAgentContextSession(agentContext) {
+        this.logger.debug(`Ending session for agent context with contextCorrelationId ${agentContext.contextCorrelationId}'`);
+        const hasTenantSessionMapping = this.hasTenantSessionMapping(agentContext.contextCorrelationId);
+        // Custom handling for the root agent context. We don't keep track of the total number of sessions for the root
+        // agent context, and we always keep the dependency manager intact.
+        if (!hasTenantSessionMapping && agentContext.contextCorrelationId === this.rootAgentContext.contextCorrelationId) {
+            this.logger.debug('Ending session for root agent context. Not disposing dependency manager');
+            return;
+        }
+        // This should not happen
+        if (!hasTenantSessionMapping) {
+            this.logger.error(`Unknown agent context with contextCorrelationId '${agentContext.contextCorrelationId}'.  Cannot end session`);
+            throw new core_1.CredoError(`Unknown agent context with contextCorrelationId '${agentContext.contextCorrelationId}'. Cannot end session`);
+        }
+        await this.mutexForTenant(agentContext.contextCorrelationId).runExclusive(async () => {
+            this.logger.debug(`Acquired lock for tenant '${agentContext.contextCorrelationId}' to end session context`);
+            const tenantSessions = this.getTenantSessionsMapping(agentContext.contextCorrelationId);
+            // TODO: check if session count is already 0
+            tenantSessions.sessionCount--;
+            this.logger.debug(`Decreased agent context session count for tenant '${agentContext.contextCorrelationId}' to ${tenantSessions.sessionCount}`);
+            if (tenantSessions.sessionCount <= 0 && tenantSessions.agentContext) {
+                await this.closeAgentContext(tenantSessions.agentContext);
+                delete this.tenantAgentContextMapping[agentContext.contextCorrelationId];
+            }
+        });
+        // Release a session so new sessions can be acquired
+        this.sessionMutex.releaseSession();
+    }
+    hasTenantSessionMapping(tenantId) {
+        return this.tenantAgentContextMapping[tenantId] !== undefined;
+    }
+    getTenantSessionsMapping(tenantId) {
+        let tenantSessionMapping = this.tenantAgentContextMapping[tenantId];
+        if (tenantSessionMapping)
+            return tenantSessionMapping;
+        tenantSessionMapping = {
+            sessionCount: 0,
+            mutex: (0, async_mutex_1.withTimeout)(new async_mutex_1.Mutex(), 
+            // NOTE: It can take a while to create an indy wallet. We're using RAW key derivation which should
+            // be fast enough to not cause a problem. This wil also only be problem when the wallet is being created
+            // for the first time or being acquired while wallet initialization is in progress.
+            this.tenantsModuleConfig.sessionAcquireTimeout, new core_1.CredoError(`Error acquiring lock for tenant ${tenantId}. Wallet initialization or shutdown took too long.`)),
+        };
+        this.tenantAgentContextMapping[tenantId] = tenantSessionMapping;
+        return tenantSessionMapping;
+    }
+    mutexForTenant(tenantId) {
+        const tenantSessions = this.getTenantSessionsMapping(tenantId);
+        return tenantSessions.mutex;
+    }
+    async createAgentContext(tenantRecord) {
+        var _a, _b;
+        const tenantDependencyManager = this.rootAgentContext.dependencyManager.createChild();
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const _c = (_b = (_a = this.rootAgentContext.config) === null || _a === void 0 ? void 0 : _a.walletConfig) !== null && _b !== void 0 ? _b : {}, { id, key, keyDerivationMethod } = _c, strippedWalletConfig = __rest(_c, ["id", "key", "keyDerivationMethod"]);
+        const tenantConfig = this.rootAgentContext.config.extend(Object.assign(Object.assign({}, tenantRecord.config), { walletConfig: Object.assign(Object.assign({}, strippedWalletConfig), tenantRecord.config.walletConfig) }));
+        const agentContext = new core_1.AgentContext({
+            contextCorrelationId: tenantRecord.id,
+            dependencyManager: tenantDependencyManager,
+        });
+        tenantDependencyManager.registerInstance(core_1.AgentContext, agentContext);
+        tenantDependencyManager.registerInstance(core_1.AgentConfig, tenantConfig);
+        // NOTE: we're using the wallet api here because that correctly handle creating if it doesn't exist yet
+        // and will also write the storage version to the storage, which is needed by the update assistant. We either
+        // need to move this out of the module, or just keep using the module here.
+        const walletApi = agentContext.dependencyManager.resolve(core_1.WalletApi);
+        if (!tenantConfig.walletConfig) {
+            throw new core_1.WalletError('Cannot initialize tenant without Wallet config.');
+        }
+        await walletApi.initialize(tenantConfig.walletConfig);
+        return agentContext;
+    }
+    async closeAgentContext(agentContext) {
+        this.logger.debug(`Closing agent context for tenant '${agentContext.contextCorrelationId}'`);
+        await agentContext.dependencyManager.dispose();
+    }
+};
+exports.TenantSessionCoordinator = TenantSessionCoordinator;
+exports.TenantSessionCoordinator = TenantSessionCoordinator = __decorate([
+    (0, core_1.injectable)(),
+    __param(1, (0, core_1.inject)(core_1.InjectionSymbols.Logger)),
+    __metadata("design:paramtypes", [core_1.AgentContext, Object, TenantsModuleConfig_1.TenantsModuleConfig])
+], TenantSessionCoordinator);
+//# sourceMappingURL=TenantSessionCoordinator.js.map

package/build/tenants/src/context/TenantSessionCoordinator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TenantSessionCoordinator.js","sourceRoot":"","sources":["../../../../../tenants/src/context/TenantSessionCoordinator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,yCAUuB;AACvB,6CAAgD;AAEhD,gEAA4D;AAE5D,6DAAyD;AAEzD;;;;;;;;;;GAUG;AAEI,IAAM,wBAAwB,GAA9B,MAAM,wBAAwB;IAOnC,YACE,gBAA8B,EACG,MAAc,EAC/C,mBAAwC;QAPlC,8BAAyB,GAA8B,EAAE,CAAA;QAS/D,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;QACxC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAA;QAE9C,IAAI,CAAC,YAAY,GAAG,IAAI,uCAAkB,CACxC,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,mBAAmB,CAAC,YAAY;QACrC,mGAAmG;QACnG,IAAI,CAAC,mBAAmB,CAAC,qBAAqB,CAC/C,CAAA;IACH,CAAC;IAEM,wBAAwB,CAAC,QAAgB;;QAC9C,OAAO,MAAA,MAAA,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,0CAAE,YAAY,mCAAI,CAAC,CAAA;IACpE,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,oBAAoB,CAC/B,YAA0B,EAC1B,EACE,UAAU,MAIR,EAAE;QAEN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4CAA4C,YAAY,CAAC,EAAE,GAAG,CAAC,CAAA;QAEjF,qCAAqC;QACrC,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,CAAA;QAExC,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;gBACxE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,YAAY,CAAC,EAAE,kBAAkB,CAAC,CAAA;gBACjF,MAAM,cAAc,GAAG,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;gBAErE,0EAA0E;gBAC1E,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC;oBACjC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qDAAqD,YAAY,CAAC,EAAE,iBAAiB,CAAC,CAAA;oBACxG,cAAc,CAAC,YAAY,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAA;gBAC3E,CAAC;gBAED,uFAAuF;gBACvF,qBAAqB;gBACrB,cAAc,CAAC,YAAY,EAAE,CAAA;gBAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,qDAAqD,YAAY,CAAC,EAAE,QAAQ,cAAc,CAAC,YAAY,EAAE,CAC1G,CAAA;gBAED,IAAI,UAAU,EAAE,CAAC;oBACf,IAAI,CAAC;wBACH,MAAM,UAAU,CAAC,cAAc,CAAC,YAAY,CAAC,CAAA;oBAC/C,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,+DAA+D;wBAC/D,cAAc,CAAC,YAAY,EAAE,CAAA;wBAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,qDAAqD,cAAc,CAAC,YAAY,CAAC,oBAAoB,QAAQ,cAAc,CAAC,YAAY,iCAAiC,EACzK,KAAK,CACN,CAAA;wBAED,IAAI,cAAc,CAAC,YAAY,IAAI,CAAC,IAAI,cAAc,CAAC,YAAY,EAAE,CAAC;4BACpE,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,YAAY,CAAC,CAAA;4BACzD,OAAO,IAAI,CAAC,yBAAyB,CAAC,cAAc,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAA;wBACzF,CAAC;wBAED,MAAM,KAAK,CAAA;oBACb,CAAC;gBACH,CAAC;gBAED,OAAO,cAAc,CAAC,YAAY,CAAA;YACpC,CAAC,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,oFAAoF,YAAY,CAAC,EAAE,EAAE,EACrG;gBACE,YAAY,EAAE,KAAK,CAAC,OAAO;aAC5B,CACF,CAAA;YACD,oHAAoH;YACpH,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,CAAA;YAElC,iBAAiB;YACjB,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,sBAAsB,CAAC,YAA0B;QAC5D,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,8DAA8D,YAAY,CAAC,oBAAoB,GAAG,CACnG,CAAA;QACD,MAAM,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAA;QAE/F,+GAA+G;QAC/G,mEAAmE;QACnE,IAAI,CAAC,uBAAuB,IAAI,YAAY,CAAC,oBAAoB,KAAK,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,EAAE,CAAC;YACjH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,yEAAyE,CAAC,CAAA;YAC5F,OAAM;QACR,CAAC;QAED,yBAAyB;QACzB,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,oDAAoD,YAAY,CAAC,oBAAoB,wBAAwB,CAC9G,CAAA;YACD,MAAM,IAAI,iBAAU,CAClB,oDAAoD,YAAY,CAAC,oBAAoB,uBAAuB,CAC7G,CAAA;QACH,CAAC;QAED,MAAM,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YACnF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,YAAY,CAAC,oBAAoB,0BAA0B,CAAC,CAAA;YAC3G,MAAM,cAAc,GAAG,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAA;YAEvF,4CAA4C;YAC5C,cAAc,CAAC,YAAY,EAAE,CAAA;YAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,qDAAqD,YAAY,CAAC,oBAAoB,QAAQ,cAAc,CAAC,YAAY,EAAE,CAC5H,CAAA;YAED,IAAI,cAAc,CAAC,YAAY,IAAI,CAAC,IAAI,cAAc,CAAC,YAAY,EAAE,CAAC;gBACpE,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,YAAY,CAAC,CAAA;gBACzD,OAAO,IAAI,CAAC,yBAAyB,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAA;YAC1E,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,oDAAoD;QACpD,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,CAAA;IACpC,CAAC;IAEO,uBAAuB,CAAmB,QAAW;QAC3D,OAAO,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAA;IAC/D,CAAC;IAEO,wBAAwB,CAAC,QAAgB;QAC/C,IAAI,oBAAoB,GAAG,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAA;QACnE,IAAI,oBAAoB;YAAE,OAAO,oBAAoB,CAAA;QAErD,oBAAoB,GAAG;YACrB,YAAY,EAAE,CAAC;YACf,KAAK,EAAE,IAAA,yBAAW,EAChB,IAAI,mBAAK,EAAE;YACX,kGAAkG;YAClG,wGAAwG;YACxG,mFAAmF;YACnF,IAAI,CAAC,mBAAmB,CAAC,qBAAqB,EAC9C,IAAI,iBAAU,CAAC,mCAAmC,QAAQ,oDAAoD,CAAC,CAChH;SACF,CAAA;QACD,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,GAAG,oBAAoB,CAAA;QAE/D,OAAO,oBAAoB,CAAA;IAC7B,CAAC;IAEO,cAAc,CAAC,QAAgB;QACrC,MAAM,cAAc,GAAG,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAA;QAE9D,OAAO,cAAc,CAAC,KAAK,CAAA;IAC7B,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,YAA0B;;QACzD,MAAM,uBAAuB,GAAG,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,WAAW,EAAE,CAAA;QAErF,6DAA6D;QAC7D,MAAM,KAA4D,MAAA,MAAA,IAAI,CAAC,gBAAgB,CAAC,MAAM,0CAAE,YAAY,mCAAI,EAAE,EAA5G,EAAE,EAAE,EAAE,GAAG,EAAE,mBAAmB,OAA8E,EAAzE,oBAAoB,cAAvD,oCAAyD,CAAmD,CAAA;QAClH,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,iCACnD,YAAY,CAAC,MAAM,KACtB,YAAY,kCACP,oBAAoB,GACpB,YAAY,CAAC,MAAM,CAAC,YAAY,KAErC,CAAA;QAEF,MAAM,YAAY,GAAG,IAAI,mBAAY,CAAC;YACpC,oBAAoB,EAAE,YAAY,CAAC,EAAE;YACrC,iBAAiB,EAAE,uBAAuB;SAC3C,CAAC,CAAA;QAEF,uBAAuB,CAAC,gBAAgB,CAAC,mBAAY,EAAE,YAAY,CAAC,CAAA;QACpE,uBAAuB,CAAC,gBAAgB,CAAC,kBAAW,EAAE,YAAY,CAAC,CAAA;QAEnE,uGAAuG;QACvG,6GAA6G;QAC7G,2EAA2E;QAC3E,MAAM,SAAS,GAAG,YAAY,CAAC,iBAAiB,CAAC,OAAO,CAAC,gBAAS,CAAC,CAAA;QAEnE,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC;YAC/B,MAAM,IAAI,kBAAW,CAAC,iDAAiD,CAAC,CAAA;QAC1E,CAAC;QACD,MAAM,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAA;QAErD,OAAO,YAAY,CAAA;IACrB,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAAC,YAA0B;QACxD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qCAAqC,YAAY,CAAC,oBAAoB,GAAG,CAAC,CAAA;QAC5F,MAAM,YAAY,CAAC,iBAAiB,CAAC,OAAO,EAAE,CAAA;IAChD,CAAC;CACF,CAAA;AA3NY,4DAAwB;mCAAxB,wBAAwB;IADpC,IAAA,iBAAU,GAAE;IAUR,WAAA,IAAA,aAAM,EAAC,uBAAgB,CAAC,MAAM,CAAC,CAAA;qCADd,mBAAY,UAET,yCAAmB;GAV/B,wBAAwB,CA2NpC"}

package/build/tenants/src/context/TenantSessionMutex.d.ts

@@ -0,0 +1,29 @@
+import type { Logger } from '@credo-ts/core';
+/**
+ * Keep track of the total number of tenant sessions currently active. This doesn't actually manage the tenant sessions itself, or have anything to do with
+ * the agent context. It merely counts the current number of sessions, and provides a mutex to lock new sessions from being created once the maximum number
+ * of sessions has been created. Session that can't be required withing the specified sessionsAcquireTimeout will throw an error.
+ */
+export declare class TenantSessionMutex {
+    private _currentSessions;
+    readonly maxSessions: number;
+    private sessionMutex;
+    private logger;
+    constructor(logger: Logger, maxSessions: number | undefined, sessionAcquireTimeout: number);
+    /**
+     * Getter to retrieve the total number of current sessions.
+     */
+    get currentSessions(): number;
+    private set currentSessions(value);
+    /**
+     * Wait to acquire a session. Will use the session semaphore to keep total number of sessions limited.
+     * For each session that is acquired using this method, the sessions MUST be closed by calling `releaseSession`.
+     * Failing to do so can lead to deadlocks over time.
+     */
+    acquireSession(): Promise<void>;
+    /**
+     * Release a session from the session mutex. If the total number of current sessions drops below
+     * the max number of sessions, the session mutex will be released so new sessions can be started.
+     */
+    releaseSession(): void;
+}

package/build/tenants/src/context/TenantSessionMutex.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TenantSessionMutex = void 0;
+const core_1 = require("@credo-ts/core");
+const async_mutex_1 = require("async-mutex");
+/**
+ * Keep track of the total number of tenant sessions currently active. This doesn't actually manage the tenant sessions itself, or have anything to do with
+ * the agent context. It merely counts the current number of sessions, and provides a mutex to lock new sessions from being created once the maximum number
+ * of sessions has been created. Session that can't be required withing the specified sessionsAcquireTimeout will throw an error.
+ */
+class TenantSessionMutex {
+    constructor(logger, maxSessions = Infinity, sessionAcquireTimeout) {
+        this._currentSessions = 0;
+        this.maxSessions = Infinity;
+        this.logger = logger;
+        this.maxSessions = maxSessions;
+        // Session mutex, it can take at most sessionAcquireTimeout to acquire a session, otherwise it will fail with the error below
+        this.sessionMutex = (0, async_mutex_1.withTimeout)(new async_mutex_1.Mutex(), sessionAcquireTimeout, new core_1.CredoError(`Failed to acquire an agent context session within ${sessionAcquireTimeout}ms`));
+    }
+    /**
+     * Getter to retrieve the total number of current sessions.
+     */
+    get currentSessions() {
+        return this._currentSessions;
+    }
+    set currentSessions(value) {
+        this._currentSessions = value;
+    }
+    /**
+     * Wait to acquire a session. Will use the session semaphore to keep total number of sessions limited.
+     * For each session that is acquired using this method, the sessions MUST be closed by calling `releaseSession`.
+     * Failing to do so can lead to deadlocks over time.
+     */
+    async acquireSession() {
+        // TODO: We should update this to be weighted
+        // This will allow to weight sessions for contexts that already exist lower than sessions
+        // for contexts that need to be created (new injection container, wallet session etc..)
+        // E.g. opening a context could weigh 5, adding sessions to it would be 1 for each
+        this.logger.debug('Acquiring tenant session');
+        // If we're out of sessions, wait for one to be released.
+        if (this.sessionMutex.isLocked()) {
+            this.logger.debug('Session mutex is locked, waiting for it to unlock');
+            // FIXME: waitForUnlock doesn't work with withTimeout but provides a better API (would rather not acquire and lock)
+            // await this.sessionMutex.waitForUnlock()
+            // Workaround https://github.com/MatrixAI/js-async-locks/pull/3/files#diff-4ee6a7d91cb8428765713bc3045e1dda5d43214030657a9c04804e96d68778bfR46-R61
+            await this.sessionMutex.acquire();
+            if (this.currentSessions < this.maxSessions) {
+                this.sessionMutex.release();
+            }
+        }
+        this.logger.debug(`Increasing current session count to ${this.currentSessions + 1} (max: ${this.maxSessions})`);
+        // We have waited for the session to unlock,
+        this.currentSessions++;
+        // If we reached the limit we should lock the session mutex
+        if (this.currentSessions >= this.maxSessions) {
+            this.logger.debug(`Reached max number of sessions ${this.maxSessions}, locking mutex`);
+            await this.sessionMutex.acquire();
+        }
+        this.logger.debug(`Acquired tenant session (${this.currentSessions} / ${this.maxSessions})`);
+    }
+    /**
+     * Release a session from the session mutex. If the total number of current sessions drops below
+     * the max number of sessions, the session mutex will be released so new sessions can be started.
+     */
+    releaseSession() {
+        this.logger.debug('Releasing tenant session');
+        if (this.currentSessions > 0) {
+            this.logger.debug(`Decreasing current sessions to ${this.currentSessions - 1} (max: ${this.maxSessions})`);
+            this.currentSessions--;
+        }
+        else {
+            this.logger.warn('Total sessions is already at 0, and releasing a session should not happen in this case. Not decrementing current session count.');
+        }
+        // If the number of current sessions is lower than the max number of sessions we can release the mutex
+        if (this.sessionMutex.isLocked() && this.currentSessions < this.maxSessions) {
+            this.logger.debug(`Releasing session mutex as number of current sessions ${this.currentSessions} is below max number of sessions ${this.maxSessions}`);
+            // Even though marked as deprecated, it is not actually deprecated and will be kept
+            // https://github.com/DirtyHairy/async-mutex/issues/50#issuecomment-1007785141
+            this.sessionMutex.release();
+        }
+    }
+}
+exports.TenantSessionMutex = TenantSessionMutex;
+//# sourceMappingURL=TenantSessionMutex.js.map

package/build/tenants/src/context/TenantSessionMutex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TenantSessionMutex.js","sourceRoot":"","sources":["../../../../../tenants/src/context/TenantSessionMutex.ts"],"names":[],"mappings":";;;AAGA,yCAA2C;AAC3C,6CAAgD;AAEhD;;;;GAIG;AACH,MAAa,kBAAkB;IAM7B,YAAmB,MAAc,EAAE,WAAW,GAAG,QAAQ,EAAE,qBAA6B;QALhF,qBAAgB,GAAG,CAAC,CAAA;QACZ,gBAAW,GAAG,QAAQ,CAAA;QAKpC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAEpB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,6HAA6H;QAC7H,IAAI,CAAC,YAAY,GAAG,IAAA,yBAAW,EAC7B,IAAI,mBAAK,EAAE,EACX,qBAAqB,EACrB,IAAI,iBAAU,CAAC,qDAAqD,qBAAqB,IAAI,CAAC,CAC/F,CAAA;IACH,CAAC;IAED;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC9B,CAAC;IAED,IAAY,eAAe,CAAC,KAAa;QACvC,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAA;IAC/B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc;QACzB,6CAA6C;QAC7C,yFAAyF;QACzF,uFAAuF;QACvF,kFAAkF;QAClF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAE7C,yDAAyD;QACzD,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC;YACjC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAA;YACtE,mHAAmH;YACnH,0CAA0C;YAC1C,kJAAkJ;YAClJ,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAA;YACjC,IAAI,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;gBAC5C,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAA;YAC7B,CAAC;QACH,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uCAAuC,IAAI,CAAC,eAAe,GAAG,CAAC,UAAU,IAAI,CAAC,WAAW,GAAG,CAAC,CAAA;QAC/G,4CAA4C;QAC5C,IAAI,CAAC,eAAe,EAAE,CAAA;QAEtB,2DAA2D;QAC3D,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC7C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kCAAkC,IAAI,CAAC,WAAW,iBAAiB,CAAC,CAAA;YACtF,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAA;QACnC,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,IAAI,CAAC,eAAe,MAAM,IAAI,CAAC,WAAW,GAAG,CAAC,CAAA;IAC9F,CAAC;IAED;;;OAGG;IACI,cAAc;QACnB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAE7C,IAAI,IAAI,CAAC,eAAe,GAAG,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kCAAkC,IAAI,CAAC,eAAe,GAAG,CAAC,UAAU,IAAI,CAAC,WAAW,GAAG,CAAC,CAAA;YAC1G,IAAI,CAAC,eAAe,EAAE,CAAA;QACxB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,iIAAiI,CAClI,CAAA;QACH,CAAC;QAED,sGAAsG;QACtG,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5E,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,yDAAyD,IAAI,CAAC,eAAe,oCAAoC,IAAI,CAAC,WAAW,EAAE,CACpI,CAAA;YACD,mFAAmF;YACnF,8EAA8E;YAC9E,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAA;QAC7B,CAAC;IACH,CAAC;CACF;AA5FD,gDA4FC"}