serverless-spy 0.0.34 → 0.0.36

package/.jsii

@@ -3149,7 +3149,7 @@
         },
         "locationInModule": {
           "filename": "src/ServerlessSpy.ts",
-          "line": 37
+          "line": 53
         },
         "parameters": [
           {
@@ -3176,7 +3176,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/ServerlessSpy.ts",
-        "line": 25
+        "line": 40
       },
       "methods": [
         {
@@ -3185,7 +3185,7 @@
           },
           "locationInModule": {
             "filename": "src/ServerlessSpy.ts",
-            "line": 493
+            "line": 697
           },
           "name": "getConstructName",
           "parameters": [
@@ -3201,6 +3201,56 @@
               "primitive": "string"
             }
           }
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Initalize spying on resources."
+          },
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 181
+          },
+          "name": "spy",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "Limit which resources to spy on."
+              },
+              "name": "filter",
+              "optional": true,
+              "type": {
+                "fqn": "serverless-spy.SpyFilter"
+              }
+            }
+          ]
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Initalize spying on resources given as parameter."
+          },
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 168
+          },
+          "name": "spyNodes",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "Which reources and their children to spy on."
+              },
+              "name": "nodes",
+              "type": {
+                "collection": {
+                  "elementtype": {
+                    "fqn": "constructs.IConstruct"
+                  },
+                  "kind": "array"
+                }
+              }
+            }
+          ]
         }
       ],
       "name": "ServerlessSpy",
@@ -3211,7 +3261,7 @@
           },
           "locationInModule": {
             "filename": "src/ServerlessSpy.ts",
-            "line": 34
+            "line": 49
           },
           "name": "serviceKeys",
           "type": {
@@ -3229,7 +3279,7 @@
           },
           "locationInModule": {
             "filename": "src/ServerlessSpy.ts",
-            "line": 35
+            "line": 51
           },
           "name": "wsUrl",
           "type": {
@@ -3249,7 +3299,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/ServerlessSpy.ts",
-        "line": 21
+        "line": 23
       },
       "name": "ServerlessSpyProps",
       "properties": [
@@ -3261,18 +3311,195 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/ServerlessSpy.ts",
-            "line": 22
+            "line": 26
+          },
+          "name": "debugMode",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 24
           },
           "name": "generateSpyEventsFileLocation",
           "optional": true,
           "type": {
             "primitive": "string"
           }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 25
+          },
+          "name": "spySqsWithNoSubscriptionAndDropAllMessages",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
         }
       ],
       "symbolId": "src/ServerlessSpy:ServerlessSpyProps"
+    },
+    "serverless-spy.SpyFilter": {
+      "assembly": "serverless-spy",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "serverless-spy.SpyFilter",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/ServerlessSpy.ts",
+        "line": 29
+      },
+      "name": "SpyFilter",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 37
+          },
+          "name": "spyDynamoDB",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 34
+          },
+          "name": "spyEventBridge",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 35
+          },
+          "name": "spyEventBridgeRule",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 30
+          },
+          "name": "spyLambda",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 36
+          },
+          "name": "spyS3",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 33
+          },
+          "name": "spySnsSubsription",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 32
+          },
+          "name": "spySnsTopic",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 31
+          },
+          "name": "spySqs",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        }
+      ],
+      "symbolId": "src/ServerlessSpy:SpyFilter"
     }
   },
-  "version": "0.0.34",
-  "fingerprint": "VlGyOqTBqt3S7lh687Y1De02BbMROvvJmMqb0uEIX00="
+  "version": "0.0.36",
+  "fingerprint": "Ar9LJKLO1bTD6oiUzz0OAkPg9EPRzEfMSQhNhT1BRjs="
 }

package/API.md

@@ -44,6 +44,8 @@ new ServerlessSpy(scope: Construct, id: string, props?: ServerlessSpyProps)
 | --- | --- |
 | <code><a href="#serverless-spy.ServerlessSpy.toString">toString</a></code> | Returns a string representation of this construct. |
 | <code><a href="#serverless-spy.ServerlessSpy.getConstructName">getConstructName</a></code> | *No description.* |
+| <code><a href="#serverless-spy.ServerlessSpy.spy">spy</a></code> | Initalize spying on resources. |
+| <code><a href="#serverless-spy.ServerlessSpy.spyNodes">spyNodes</a></code> | Initalize spying on resources given as parameter. |
 
 ---
 
@@ -67,6 +69,38 @@ public getConstructName(construct: IConstruct): string
 
 ---
 
+##### `spy` <a name="spy" id="serverless-spy.ServerlessSpy.spy"></a>
+
+```typescript
+public spy(filter?: SpyFilter): void
+```
+
+Initalize spying on resources.
+
+###### `filter`<sup>Optional</sup> <a name="filter" id="serverless-spy.ServerlessSpy.spy.parameter.filter"></a>
+
+- *Type:* <a href="#serverless-spy.SpyFilter">SpyFilter</a>
+
+Limit which resources to spy on.
+
+---
+
+##### `spyNodes` <a name="spyNodes" id="serverless-spy.ServerlessSpy.spyNodes"></a>
+
+```typescript
+public spyNodes(nodes: IConstruct[]): void
+```
+
+Initalize spying on resources given as parameter.
+
+###### `nodes`<sup>Required</sup> <a name="nodes" id="serverless-spy.ServerlessSpy.spyNodes.parameter.nodes"></a>
+
+- *Type:* constructs.IConstruct[]
+
+Which reources and their children to spy on.
+
+---
+
 #### Static Functions <a name="Static Functions" id="Static Functions"></a>
 
 | **Name** | **Description** |
@@ -152,7 +186,19 @@ const serverlessSpyProps: ServerlessSpyProps = { ... }
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
+| <code><a href="#serverless-spy.ServerlessSpyProps.property.debugMode">debugMode</a></code> | <code>boolean</code> | *No description.* |
 | <code><a href="#serverless-spy.ServerlessSpyProps.property.generateSpyEventsFileLocation">generateSpyEventsFileLocation</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#serverless-spy.ServerlessSpyProps.property.spySqsWithNoSubscriptionAndDropAllMessages">spySqsWithNoSubscriptionAndDropAllMessages</a></code> | <code>boolean</code> | *No description.* |
+
+---
+
+##### `debugMode`<sup>Optional</sup> <a name="debugMode" id="serverless-spy.ServerlessSpyProps.property.debugMode"></a>
+
+```typescript
+public readonly debugMode: boolean;
+```
+
+- *Type:* boolean
 
 ---
 
@@ -166,5 +212,120 @@ public readonly generateSpyEventsFileLocation: string;
 
 ---
 
+##### `spySqsWithNoSubscriptionAndDropAllMessages`<sup>Optional</sup> <a name="spySqsWithNoSubscriptionAndDropAllMessages" id="serverless-spy.ServerlessSpyProps.property.spySqsWithNoSubscriptionAndDropAllMessages"></a>
+
+```typescript
+public readonly spySqsWithNoSubscriptionAndDropAllMessages: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+### SpyFilter <a name="SpyFilter" id="serverless-spy.SpyFilter"></a>
+
+#### Initializer <a name="Initializer" id="serverless-spy.SpyFilter.Initializer"></a>
+
+```typescript
+import { SpyFilter } from 'serverless-spy'
+
+const spyFilter: SpyFilter = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#serverless-spy.SpyFilter.property.spyDynamoDB">spyDynamoDB</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#serverless-spy.SpyFilter.property.spyEventBridge">spyEventBridge</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#serverless-spy.SpyFilter.property.spyEventBridgeRule">spyEventBridgeRule</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#serverless-spy.SpyFilter.property.spyLambda">spyLambda</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#serverless-spy.SpyFilter.property.spyS3">spyS3</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#serverless-spy.SpyFilter.property.spySnsSubsription">spySnsSubsription</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#serverless-spy.SpyFilter.property.spySnsTopic">spySnsTopic</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#serverless-spy.SpyFilter.property.spySqs">spySqs</a></code> | <code>boolean</code> | *No description.* |
+
+---
+
+##### `spyDynamoDB`<sup>Optional</sup> <a name="spyDynamoDB" id="serverless-spy.SpyFilter.property.spyDynamoDB"></a>
+
+```typescript
+public readonly spyDynamoDB: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `spyEventBridge`<sup>Optional</sup> <a name="spyEventBridge" id="serverless-spy.SpyFilter.property.spyEventBridge"></a>
+
+```typescript
+public readonly spyEventBridge: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `spyEventBridgeRule`<sup>Optional</sup> <a name="spyEventBridgeRule" id="serverless-spy.SpyFilter.property.spyEventBridgeRule"></a>
+
+```typescript
+public readonly spyEventBridgeRule: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `spyLambda`<sup>Optional</sup> <a name="spyLambda" id="serverless-spy.SpyFilter.property.spyLambda"></a>
+
+```typescript
+public readonly spyLambda: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `spyS3`<sup>Optional</sup> <a name="spyS3" id="serverless-spy.SpyFilter.property.spyS3"></a>
+
+```typescript
+public readonly spyS3: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `spySnsSubsription`<sup>Optional</sup> <a name="spySnsSubsription" id="serverless-spy.SpyFilter.property.spySnsSubsription"></a>
+
+```typescript
+public readonly spySnsSubsription: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `spySnsTopic`<sup>Optional</sup> <a name="spySnsTopic" id="serverless-spy.SpyFilter.property.spySnsTopic"></a>
+
+```typescript
+public readonly spySnsTopic: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `spySqs`<sup>Optional</sup> <a name="spySqs" id="serverless-spy.SpyFilter.property.spySqs"></a>
+
+```typescript
+public readonly spySqs: boolean;
+```
+
+- *Type:* boolean
+
+---
+
 
 

package/common/publishSpyEvent.ts

@@ -33,7 +33,7 @@ const ddb = new DynamoDBClient({
 
 const apigwManagementApi = new ApiGatewayManagementApi({
   apiVersion: '2018-11-29',
-  endpoint: process.env[envVariableNames.WS_ENDPOINT]!,
+  endpoint: process.env[envVariableNames.SSPY_WS_ENDPOINT]!,
 });
 
 let connections: Record<string, AttributeValue>[] | undefined;
@@ -41,13 +41,13 @@ let connections: Record<string, AttributeValue>[] | undefined;
 export async function publishSpyEvent(event: any) {
   console.log('EVENT', JSON.stringify(event));
 
-  const mapping = JSON.parse(process.env[envVariableNames.INFRA_MAPPING]!);
+  const mapping = JSON.parse(process.env[envVariableNames.SSPY_INFRA_MAPPING]!);
   console.log('mapping', JSON.stringify(mapping));
 
   let connectionData;
 
   const scanParams = new ScanCommand({
-    TableName: process.env[envVariableNames.TABLE_NAME] as string,
+    TableName: process.env[envVariableNames.SSPY_WS_TABLE_NAME] as string,
     ProjectionExpression: 'connectionId',
   });
 
@@ -245,7 +245,7 @@ export async function postData(spyMessage: Omit<SpyMessage, 'timestamp'>) {
         console.log(`Found stale connection, deleting ${connectionId}`);
 
         const deleteParams = new DeleteItemCommand({
-          TableName: process.env[envVariableNames.TABLE_NAME],
+          TableName: process.env[envVariableNames.SSPY_WS_TABLE_NAME],
           Key: { connectionId },
         });
 

package/dist/releasetag.txt

@@ -1 +1 @@
-v0.0.34
+v0.0.36

package/extension/interceptor.ts

@@ -9,12 +9,11 @@ import { envVariableNames } from '../src/common/envVariableNames';
 import { load } from './aws/UserFunction';
 
 const ORIGINAL_HANDLER_KEY = 'ORIGINAL_HANDLER';
-const fluentTestSendFunctionName =
-  process.env[envVariableNames.FLUENT_TEST_SEND_FUNCTION_NAME];
+
 const subscribedToSQS =
-  process.env[envVariableNames.FLUENT_TEST_SUBSCRIBED_TO_SQS] === 'true';
+  process.env[envVariableNames.SSPY_SUBSCRIBED_TO_SQS] === 'true';
 
-const lambdaClient = new LambdaClient({});
+const debugMode = process.env[envVariableNames.SSPY_DEBUG] === 'true';
 
 // Wrap original handler.
 // Handler can be async or non-async:
@@ -24,11 +23,13 @@ export const handler = (
   context: Context,
   callback: Callback
 ): Promise<any> | undefined => {
+  log('Request', JSON.stringify(event));
+
   const promises: Promise<any>[] = [];
 
   if (subscribedToSQS) {
     // send raw message
-    console.log('EXTENSION: Send raw message for SQS');
+    log('Send raw message for SQS');
     const p = sendRawSpyEvent(event);
     promises.push(p);
   }
@@ -40,8 +41,9 @@ export const handler = (
     clientContext: context.clientContext,
   };
 
-  console.log('EXTENSION REQUEST:', JSON.stringify(event));
-  const key = `Function#${process.env[envVariableNames.FUNCTION_NAME]}#Request`;
+  const key = `Function#${
+    process.env[envVariableNames.SSPY_FUNCTION_NAME]
+  }#Request`;
   const p = sendLambdaSpyEvent(key, <FunctionRequestSpyEvent>{
     request: event,
     context: contextSpy,
@@ -51,8 +53,10 @@ export const handler = (
   const originalHandler = getOriginalHandler();
 
   const fail = (error: any) => {
-    console.error('FAIL', error);
-    const key = `Function#${process.env[envVariableNames.FUNCTION_NAME]}#Error`;
+    logError(error);
+    const key = `Function#${
+      process.env[envVariableNames.SSPY_FUNCTION_NAME]
+    }#Error`;
     const p = sendLambdaSpyEvent(key, <FunctionErrorSpyEvent>{
       request: event,
       error,
@@ -63,9 +67,9 @@ export const handler = (
   };
 
   const succeed = (response: any) => {
-    console.log('EXTENSION RESPONSE:', JSON.stringify(response));
+    log('Response', JSON.stringify(response));
     const key = `Function#${
-      process.env[envVariableNames[envVariableNames.FUNCTION_NAME]]
+      process.env[envVariableNames[envVariableNames.SSPY_FUNCTION_NAME]]
     }#Response`;
     const p = sendLambdaSpyEvent(key, <FunctionResponseSpyEvent>{
       request: event,
@@ -133,20 +137,10 @@ async function sendLambdaSpyEvent(
 
 async function sendRawSpyEvent(data: any) {
   await publishSpyEvent(data);
-
-  // console.log('EXTENSION SPY EVENT:', JSON.stringify(data));
-
-  // const command = new InvokeCommand({
-  //   FunctionName: fluentTestSendFunctionName,
-  //   InvocationType: 'RequestResponse',
-  //   LogType: 'Tail',
-  //   Payload: JSON.stringify(data) as any,
-  // });
-  // await lambdaClient.send(command);
 }
 
 function getOriginalHandler(): Handler {
-  console.log('ORIGINAL_HANDLER_KEY', process.env[ORIGINAL_HANDLER_KEY]);
+  log('Original handler', process.env[ORIGINAL_HANDLER_KEY]);
 
   if (process.env[ORIGINAL_HANDLER_KEY] === undefined)
     throw Error('Missing original handler');
@@ -155,3 +149,15 @@ function getOriginalHandler(): Handler {
     process.env[ORIGINAL_HANDLER_KEY]
   ) as Handler;
 }
+
+function log(message: string, ...optionalParams: any[]) {
+  if (debugMode) {
+    console.debug('SSPY EXTENSION', message, ...optionalParams);
+  }
+}
+
+function logError(message: string, ...optionalParams: any[]) {
+  if (debugMode) {
+    console.error('SSPY EXTENSION', message, ...optionalParams);
+  }
+}

package/functions/onConnect.ts

@@ -10,7 +10,7 @@ exports.handler = async (event: APIGatewayEvent) => {
   console.log('EVENT', JSON.stringify(event));
 
   const putParams = new PutItemCommand({
-    TableName: process.env[envVariableNames.TABLE_NAME] as string,
+    TableName: process.env[envVariableNames.SSPY_WS_TABLE_NAME] as string,
     Item: {
       connectionId: { S: event.requestContext.connectionId! },
     },

package/functions/onDisconnect.ts

@@ -9,7 +9,7 @@ export const handler = async (event: APIGatewayEvent) => {
   console.log('EVENT', JSON.stringify(event));
 
   const deleteParams = new DeleteItemCommand({
-    TableName: process.env[envVariableNames.TABLE_NAME],
+    TableName: process.env[envVariableNames.SSPY_WS_TABLE_NAME],
     Key: {
       connectionId: { S: event.requestContext.connectionId! },
     },

package/functions/sqsSubscriptionAndDropAllMessages.ts

@@ -0,0 +1,3 @@
+export const handler = async (event: any) => {
+  return event;
+};