aws-classify-server 0.1.4 → 0.1.6

package/README.md

@@ -274,7 +274,7 @@ plugins:
   - serverless-dynamodb-local
   - serverless-offline
 ```
-The provider section details configuration the Serverless Framework handles.  Many of the details are in included files to keep this simple and resiliant to change
+The provider section details configuration the Serverless Framework handles.  Many of the details are in included files to keep this simple and resilient to change
 ```
 provider:
   name: aws
@@ -285,6 +285,7 @@ provider:
     websocket: true
   environment:
     APIG_ENDPOINT: ${file(${self:custom.yml}/apig.yml)}
+    DOMAIN: ${self:custom.domainName}
   iam:
     role:
       statements:

package/lib/cjs/ClassifyServerless.d.ts

@@ -4,7 +4,9 @@ export declare class ClassifyServerless {
     logLevel: Partial<typeof EndPointsLogging>;
     classDefs: Map<any, ClassDef<any, any>>;
     requests: Map<any, any>;
+    expirationMinutes: number;
     log: (_message: string) => void;
+    setExpirationMinutes(minutes: number): void;
     setLogger(log: (_message: string) => void): void;
     setLogLevel(logLevel: Partial<typeof EndPointsLogging>): void;
     registerResponse<T>(responseClass: new () => T, authorizer?: (_endPoint: T, _method: string, _args: IArguments) => Promise<boolean>): void;
@@ -17,9 +19,12 @@ export declare class ClassifyServerless {
     createRequestForSession<T>(sessionId: string, requestClass: new () => T): Promise<T>;
     createResponse<T, R>(responseClass: new () => T, sessionId: string, callback: (_obj: T) => Promise<R>, classes?: any): Promise<R>;
     getSessionsForUserId(userId: string): Promise<any[]>;
+    getSessions(): Promise<any[]>;
+    deleteSessionsForUserId(userId: string): Promise<void>;
+    deleteSessions(): Promise<void>;
 }
 export declare function getSessionData(sessionId: string, interfaceName?: string): Promise<Record<string, any> | undefined>;
-export declare function saveSessionData(sessionId: string, interfaceName?: string, sessionData?: string, connectionId?: string, userId?: string): Promise<string>;
+export declare function saveSessionData(sessionId: string, interfaceName?: string, sessionData?: string, connectionId?: string, userId?: string, expirationMinutes?: number): Promise<string>;
 export declare const EndPointsLogging: {
     create: boolean;
     connect: boolean;

package/lib/cjs/ClassifyServerless.js

@@ -16,13 +16,18 @@ const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
 const client_apigatewaymanagementapi_1 = require("@aws-sdk/client-apigatewaymanagementapi");
 const ddbClient = new client_dynamodb_1.DynamoDBClient({ region: process.env.DD_REGION, endpoint: process.env.DD_ENDPOINT });
 const ddbDocClient = lib_dynamodb_1.DynamoDBDocument.from(ddbClient);
+const updateDebounceInterval = 1000 * 60 * 10; // Don't update session unless 10 minutes have passed or data changed
 class ClassifyServerless {
     constructor() {
         this.logLevel = {};
         this.classDefs = new Map();
         this.requests = new Map();
+        this.expirationMinutes = 60 * 24;
         this.log = msg => console.log(msg);
     }
+    setExpirationMinutes(minutes) {
+        this.expirationMinutes = minutes;
+    }
     setLogger(log) {
         this.log = log;
     }
@@ -54,7 +59,7 @@ class ClassifyServerless {
                 const socketResult = yield getSessionData(sessionId, "");
                 if (!socketResult) {
                     sessionId = context.awsRequestId;
-                    yield saveSessionData(sessionId, undefined, undefined, undefined);
+                    yield saveSessionData(sessionId, undefined, undefined, undefined, undefined, this.expirationMinutes);
                 }
                 const lambdaResponse = {
                     data: process.env.IS_OFFLINE ? 'ws://localhost:3001' : `wss://${process.env.APIG_ENDPOINT}`,
@@ -105,8 +110,8 @@ class ClassifyServerless {
                     return (0, js_freeze_dry_1.serialize)(lambdaResponse, classes);
                 }
                 const updatedSessionData = (0, js_freeze_dry_1.serialize)(obj, classes);
-                if (!result || updatedSessionData !== result.sessionData)
-                    sessionId = yield saveSessionData(sessionId, request.interfaceName, updatedSessionData, undefined, obj.__userId__);
+                if (!result || updatedSessionData !== result.sessionData || (Date.now() > (result.updated + updateDebounceInterval)))
+                    sessionId = yield saveSessionData(sessionId, request.interfaceName, updatedSessionData, undefined, obj.__userId__, this.expirationMinutes);
                 // Formulate response
                 const lambdaResponse = {
                     data: fnResponse,
@@ -174,7 +179,7 @@ class ClassifyServerless {
                     catch (e) {
                         if (expressServer.logLevel.exceptions)
                             expressServer.log(e.message);
-                        throw e;
+                        throw new Error(`Unable to send message via Websocket ${e.message}`);
                     }
                 });
             };
@@ -238,10 +243,10 @@ class ClassifyServerless {
                 this.log(`creating response for ${interfaceName} with sessionId=${sessionId} connectionId= ${obj.__connectionId__} sessionData=${sessionData}`);
             const ret = yield callback(obj);
             const updatedSessionData = (0, js_freeze_dry_1.serialize)(obj, classes);
-            if (updatedSessionData !== result.sessionData) {
+            if (updatedSessionData !== result.sessionData || (Date.now() > (result.updated + updateDebounceInterval))) {
                 if (this.logLevel.calls)
                     this.log(`saving session data for ${interfaceName} with sessionId=${sessionId} connectionId= ${obj.__connectionId__} sessionData=${updatedSessionData}`);
-                yield saveSessionData(sessionId, interfaceName, updatedSessionData, undefined);
+                yield saveSessionData(sessionId, interfaceName, updatedSessionData, undefined, undefined, this.expirationMinutes);
             }
             return ret;
         });
@@ -263,8 +268,54 @@ class ClassifyServerless {
             return [];
         });
     }
+    getSessions() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = yield ddbDocClient.scan({
+                TableName: `classifySessionStore.${process.env.DOMAIN}`,
+                ProjectionExpression: `sessionId`
+            });
+            return data.Items ? data.Items.map(i => i.sessionId) : [];
+        });
+    }
+    deleteSessionsForUserId(userId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (userId) {
+                const data = yield ddbDocClient.query({
+                    TableName: `classifySessionStore.${process.env.DOMAIN}`,
+                    KeyConditionExpression: 'userId = :userId',
+                    IndexName: 'userId',
+                    ExpressionAttributeValues: {
+                        ':userId': userId,
+                    },
+                    ProjectionExpression: `sessionId`
+                });
+                const keys = data.Items ? data.Items.map(i => i.sessionId) : [];
+                yield deleteSessionByKeys(keys);
+            }
+        });
+    }
+    deleteSessions() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = yield ddbDocClient.scan({
+                TableName: `classifySessionStore.${process.env.DOMAIN}`,
+                ProjectionExpression: `sessionId`
+            });
+            const keys = data.Items ? data.Items.map(i => i.sessionId) : [];
+            yield deleteSessionByKeys(keys);
+        });
+    }
 }
 exports.ClassifyServerless = ClassifyServerless;
+function deleteSessionByKeys(keys) {
+    return __awaiter(this, void 0, void 0, function* () {
+        for (let ix = 0; ix < keys.length; ++ix) {
+            yield ddbDocClient.delete({
+                TableName: `classifySessionStore.${process.env.DOMAIN}`,
+                Key: { sessionId: keys[ix] }
+            });
+        }
+    });
+}
 function getSessionData(sessionId, interfaceName = "") {
     return __awaiter(this, void 0, void 0, function* () {
         if (sessionId) {
@@ -272,7 +323,7 @@ function getSessionData(sessionId, interfaceName = "") {
                 TableName: `classifySessionStore.${process.env.DOMAIN}`,
                 Key: { sessionId },
                 ConsistentRead: true,
-                ProjectionExpression: `interface_${interfaceName}, connectionId, userId, updated`
+                ProjectionExpression: `interface_${interfaceName}, connectionId, userId, updated, expires`
             });
             return data.Item;
         }
@@ -280,10 +331,16 @@ function getSessionData(sessionId, interfaceName = "") {
     });
 }
 exports.getSessionData = getSessionData;
-function saveSessionData(sessionId, interfaceName, sessionData, connectionId, userId) {
+function saveSessionData(sessionId, interfaceName, sessionData, connectionId, userId, expirationMinutes) {
     return __awaiter(this, void 0, void 0, function* () {
         const updateExpressionComponents = ['updated = :time'];
         const expressionAttributeValues = { ':time': new Date().getTime() };
+        if (typeof expirationMinutes === 'number') {
+            const expires = new Date();
+            expires.setMinutes(expires.getMinutes() + expirationMinutes);
+            updateExpressionComponents.push('expires = :expires');
+            expressionAttributeValues[':expires'] = Math.floor(expires.getTime() / 1000);
+        }
         if (sessionData && interfaceName) {
             updateExpressionComponents.push(`interface_${interfaceName} = :data`);
             expressionAttributeValues[`:data`] = sessionData;

package/lib/esm/ClassifyServerless.d.ts

@@ -4,7 +4,9 @@ export declare class ClassifyServerless {
     logLevel: Partial<typeof EndPointsLogging>;
     classDefs: Map<any, ClassDef<any, any>>;
     requests: Map<any, any>;
+    expirationMinutes: number;
     log: (_message: string) => void;
+    setExpirationMinutes(minutes: number): void;
     setLogger(log: (_message: string) => void): void;
     setLogLevel(logLevel: Partial<typeof EndPointsLogging>): void;
     registerResponse<T>(responseClass: new () => T, authorizer?: (_endPoint: T, _method: string, _args: IArguments) => Promise<boolean>): void;
@@ -17,9 +19,12 @@ export declare class ClassifyServerless {
     createRequestForSession<T>(sessionId: string, requestClass: new () => T): Promise<T>;
     createResponse<T, R>(responseClass: new () => T, sessionId: string, callback: (_obj: T) => Promise<R>, classes?: any): Promise<R>;
     getSessionsForUserId(userId: string): Promise<any[]>;
+    getSessions(): Promise<any[]>;
+    deleteSessionsForUserId(userId: string): Promise<void>;
+    deleteSessions(): Promise<void>;
 }
 export declare function getSessionData(sessionId: string, interfaceName?: string): Promise<Record<string, any> | undefined>;
-export declare function saveSessionData(sessionId: string, interfaceName?: string, sessionData?: string, connectionId?: string, userId?: string): Promise<string>;
+export declare function saveSessionData(sessionId: string, interfaceName?: string, sessionData?: string, connectionId?: string, userId?: string, expirationMinutes?: number): Promise<string>;
 export declare const EndPointsLogging: {
     create: boolean;
     connect: boolean;

package/lib/esm/ClassifyServerless.js

@@ -13,13 +13,18 @@ import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
 import { ApiGatewayManagementApiClient, PostToConnectionCommand } from "@aws-sdk/client-apigatewaymanagementapi";
 const ddbClient = new DynamoDBClient({ region: process.env.DD_REGION, endpoint: process.env.DD_ENDPOINT });
 const ddbDocClient = DynamoDBDocument.from(ddbClient);
+const updateDebounceInterval = 1000 * 60 * 10; // Don't update session unless 10 minutes have passed or data changed
 export class ClassifyServerless {
     constructor() {
         this.logLevel = {};
         this.classDefs = new Map();
         this.requests = new Map();
+        this.expirationMinutes = 60 * 24;
         this.log = msg => console.log(msg);
     }
+    setExpirationMinutes(minutes) {
+        this.expirationMinutes = minutes;
+    }
     setLogger(log) {
         this.log = log;
     }
@@ -51,7 +56,7 @@ export class ClassifyServerless {
                 const socketResult = yield getSessionData(sessionId, "");
                 if (!socketResult) {
                     sessionId = context.awsRequestId;
-                    yield saveSessionData(sessionId, undefined, undefined, undefined);
+                    yield saveSessionData(sessionId, undefined, undefined, undefined, undefined, this.expirationMinutes);
                 }
                 const lambdaResponse = {
                     data: process.env.IS_OFFLINE ? 'ws://localhost:3001' : `wss://${process.env.APIG_ENDPOINT}`,
@@ -102,8 +107,8 @@ export class ClassifyServerless {
                     return serialize(lambdaResponse, classes);
                 }
                 const updatedSessionData = serialize(obj, classes);
-                if (!result || updatedSessionData !== result.sessionData)
-                    sessionId = yield saveSessionData(sessionId, request.interfaceName, updatedSessionData, undefined, obj.__userId__);
+                if (!result || updatedSessionData !== result.sessionData || (Date.now() > (result.updated + updateDebounceInterval)))
+                    sessionId = yield saveSessionData(sessionId, request.interfaceName, updatedSessionData, undefined, obj.__userId__, this.expirationMinutes);
                 // Formulate response
                 const lambdaResponse = {
                     data: fnResponse,
@@ -171,7 +176,7 @@ export class ClassifyServerless {
                     catch (e) {
                         if (expressServer.logLevel.exceptions)
                             expressServer.log(e.message);
-                        throw e;
+                        throw new Error(`Unable to send message via Websocket ${e.message}`);
                     }
                 });
             };
@@ -235,10 +240,10 @@ export class ClassifyServerless {
                 this.log(`creating response for ${interfaceName} with sessionId=${sessionId} connectionId= ${obj.__connectionId__} sessionData=${sessionData}`);
             const ret = yield callback(obj);
             const updatedSessionData = serialize(obj, classes);
-            if (updatedSessionData !== result.sessionData) {
+            if (updatedSessionData !== result.sessionData || (Date.now() > (result.updated + updateDebounceInterval))) {
                 if (this.logLevel.calls)
                     this.log(`saving session data for ${interfaceName} with sessionId=${sessionId} connectionId= ${obj.__connectionId__} sessionData=${updatedSessionData}`);
-                yield saveSessionData(sessionId, interfaceName, updatedSessionData, undefined);
+                yield saveSessionData(sessionId, interfaceName, updatedSessionData, undefined, undefined, this.expirationMinutes);
             }
             return ret;
         });
@@ -260,6 +265,52 @@ export class ClassifyServerless {
             return [];
         });
     }
+    getSessions() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = yield ddbDocClient.scan({
+                TableName: `classifySessionStore.${process.env.DOMAIN}`,
+                ProjectionExpression: `sessionId`
+            });
+            return data.Items ? data.Items.map(i => i.sessionId) : [];
+        });
+    }
+    deleteSessionsForUserId(userId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (userId) {
+                const data = yield ddbDocClient.query({
+                    TableName: `classifySessionStore.${process.env.DOMAIN}`,
+                    KeyConditionExpression: 'userId = :userId',
+                    IndexName: 'userId',
+                    ExpressionAttributeValues: {
+                        ':userId': userId,
+                    },
+                    ProjectionExpression: `sessionId`
+                });
+                const keys = data.Items ? data.Items.map(i => i.sessionId) : [];
+                yield deleteSessionByKeys(keys);
+            }
+        });
+    }
+    deleteSessions() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = yield ddbDocClient.scan({
+                TableName: `classifySessionStore.${process.env.DOMAIN}`,
+                ProjectionExpression: `sessionId`
+            });
+            const keys = data.Items ? data.Items.map(i => i.sessionId) : [];
+            yield deleteSessionByKeys(keys);
+        });
+    }
+}
+function deleteSessionByKeys(keys) {
+    return __awaiter(this, void 0, void 0, function* () {
+        for (let ix = 0; ix < keys.length; ++ix) {
+            yield ddbDocClient.delete({
+                TableName: `classifySessionStore.${process.env.DOMAIN}`,
+                Key: { sessionId: keys[ix] }
+            });
+        }
+    });
 }
 export function getSessionData(sessionId, interfaceName = "") {
     return __awaiter(this, void 0, void 0, function* () {
@@ -268,17 +319,23 @@ export function getSessionData(sessionId, interfaceName = "") {
                 TableName: `classifySessionStore.${process.env.DOMAIN}`,
                 Key: { sessionId },
                 ConsistentRead: true,
-                ProjectionExpression: `interface_${interfaceName}, connectionId, userId, updated`
+                ProjectionExpression: `interface_${interfaceName}, connectionId, userId, updated, expires`
             });
             return data.Item;
         }
         return undefined;
     });
 }
-export function saveSessionData(sessionId, interfaceName, sessionData, connectionId, userId) {
+export function saveSessionData(sessionId, interfaceName, sessionData, connectionId, userId, expirationMinutes) {
     return __awaiter(this, void 0, void 0, function* () {
         const updateExpressionComponents = ['updated = :time'];
         const expressionAttributeValues = { ':time': new Date().getTime() };
+        if (typeof expirationMinutes === 'number') {
+            const expires = new Date();
+            expires.setMinutes(expires.getMinutes() + expirationMinutes);
+            updateExpressionComponents.push('expires = :expires');
+            expressionAttributeValues[':expires'] = Math.floor(expires.getTime() / 1000);
+        }
         if (sessionData && interfaceName) {
             updateExpressionComponents.push(`interface_${interfaceName} = :data`);
             expressionAttributeValues[`:data`] = sessionData;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aws-classify-server",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "main": "./lib/cjs/index.js",
   "module": "./lib/esm/index.js",
   "types": "./lib/esm/index.d.ts",