serverless-spy 0.0.36 → 0.0.37

package/listener/SpyHandlers.ts.ts

@@ -1,6 +1,7 @@
 import { DynamoDBSpyEvent } from '../common/spyEvents/DynamoDBSpyEvent';
 import { EventBridgeRuleSpyEvent } from '../common/spyEvents/EventBridgeRuleSpyEvent';
 import { EventBridgeSpyEvent } from '../common/spyEvents/EventBridgeSpyEvent';
+import { FunctionConsole } from '../common/spyEvents/FunctionConsole';
 import { FunctionConsoleSpyEvent } from '../common/spyEvents/FunctionConsoleSpyEvent';
 import { FunctionContext } from '../common/spyEvents/FunctionContext';
 import { FunctionRequestSpyEvent } from '../common/spyEvents/FunctionRequestSpyEvent';
@@ -112,13 +113,26 @@ export interface FunctionBaseSpyHandler<TData = any>
     FunctionRequestSpyEvent<TData>,
     FunctionRequestSpyHandler<TData>
   > {
-  // follwedByConsoleLog: () => Promise<
-  //   FunctionBaseSpyHandler<TData> &
-  //     JestExpectWithSpyMethods<
-  //       FunctionRequestSpyEvent<TData>,
-  //       FunctionRequestSpyHandler<TData>
-  //     >
-  // >;
+  followedByConsole: (
+    // This implementation confuses TypeScript which does not accurately display the type.
+    param?: {
+      condition?: (event: {
+        spyEventType: 'FunctionConsole';
+        request: TData;
+        context: FunctionContext;
+        console: FunctionConsole;
+      }) => boolean;
+      timoutMs?: number;
+    }
+  ) => Promise<
+    FunctionBaseSpyHandler<TData> &
+      FunctionConsoleSpyHandler<TData> &
+      JestExpectWithSpyMethods<
+        FunctionConsoleSpyEvent<TData>,
+        FunctionRequestSpyHandler<TData>
+      >
+  >;
+
   followedByResponse: <TDataResponse = any>(
     // This implementation confuses TypeScript which does not accurately display the type.
     // Leave it for reference!
@@ -137,7 +151,7 @@ export interface FunctionBaseSpyHandler<TData = any>
       timoutMs?: number;
     }
   ) => Promise<
-    FunctionResponseSpyHandler &
+    FunctionResponseSpyHandler<TData> &
       JestExpectWithSpyMethods<
         FunctionRequestSpyEvent<TData>,
         FunctionRequestSpyHandler<TData>
@@ -151,8 +165,55 @@ export interface FunctionRequestSpyHandler<TData = any>
 }
 
 export interface FunctionConsoleSpyHandler<TData = any>
-  extends FunctionBaseSpyHandler<TData> {
+  extends JestExpectWithSpyMethods<
+    FunctionConsoleSpyEvent<TData>,
+    FunctionConsoleSpyHandler<TData>
+  > {
   getData: () => PrettifyForDisplay<FunctionConsoleSpyEvent<TData>>;
+  followedByConsole: (
+    // This implementation confuses TypeScript which does not accurately display the type.
+    param?: {
+      condition?: (event: {
+        spyEventType: 'FunctionConsole';
+        request: TData;
+        context: FunctionContext;
+        console: FunctionConsole;
+      }) => boolean;
+      timoutMs?: number;
+    }
+  ) => Promise<
+    FunctionBaseSpyHandler<TData> &
+      FunctionConsoleSpyHandler<TData> &
+      JestExpectWithSpyMethods<
+        FunctionConsoleSpyEvent<TData>,
+        FunctionRequestSpyHandler<TData>
+      >
+  >;
+
+  followedByResponse: <TDataResponse = any>(
+    // This implementation confuses TypeScript which does not accurately display the type.
+    // Leave it for reference!
+    // param: PrettifyForDisplay<
+    //   WaitForParams<
+    //     PrettifyForDisplay<FunctionResponseSpyEvent<TData, TDataResponse>>
+    //   >
+    // >
+    param?: {
+      condition?: (event: {
+        spyEventType: 'FunctionResponse';
+        request: TData;
+        context: FunctionContext;
+        response: TDataResponse;
+      }) => boolean;
+      timoutMs?: number;
+    }
+  ) => Promise<
+    FunctionResponseSpyHandler<TData> &
+      JestExpectWithSpyMethods<
+        FunctionRequestSpyEvent<TData>,
+        FunctionRequestSpyHandler<TData>
+      >
+  >;
 }
 
 export interface FunctionResponseSpyHandler<TData = any>

package/listener/WsListener.ts

@@ -1,5 +1,5 @@
 import { WebSocket } from 'ws';
-import { getWebSocketUrl } from '../common/getWebSocketUrl';
+import { getSignedWebSocketUrl } from '../common/getWebSocketUrl';
 import { FunctionRequestSpyEvent } from '../common/spyEvents/FunctionRequestSpyEvent';
 import { SpyEvent } from '../common/spyEvents/SpyEvent';
 import { SpyMessage } from '../common/spyEvents/SpyMessage';
@@ -25,7 +25,7 @@ export class WsListener<TSpyEvents> {
       this.connectionOpenResolve = resolve;
     });
 
-    const urlSigned = await getWebSocketUrl(
+    const urlSigned = await getSignedWebSocketUrl(
       params.serverlessSpyWsUrl,
       params.credentials
     );
@@ -90,27 +90,30 @@ export class WsListener<TSpyEvents> {
           (serviceKeyForFunction.endsWith('Request') ||
             serviceKeyForFunction.endsWith('Console'))
         ) {
-          let serviceKeyForFunctionResponse = serviceKeyForFunction;
-
-          if (serviceKeyForFunctionResponse.endsWith('Request')) {
-            serviceKeyForFunctionResponse =
-              serviceKeyForFunctionResponse.substring(
-                0,
-                serviceKeyForFunctionResponse.length - 'Request'.length
-              );
-          } else if (serviceKeyForFunctionResponse.endsWith('Console')) {
-            serviceKeyForFunctionResponse =
-              serviceKeyForFunctionResponse.substring(
-                0,
-                serviceKeyForFunctionResponse.length - 'Console'.length
-              );
+          let serviceKeyForFunctionChain = serviceKeyForFunction;
+
+          if (serviceKeyForFunctionChain.endsWith('Request')) {
+            serviceKeyForFunctionChain = serviceKeyForFunctionChain.substring(
+              0,
+              serviceKeyForFunctionChain.length - 'Request'.length
+            );
+          } else if (serviceKeyForFunctionChain.endsWith('Console')) {
+            serviceKeyForFunctionChain = serviceKeyForFunctionChain.substring(
+              0,
+              serviceKeyForFunctionChain.length - 'Console'.length
+            );
           }
 
-          serviceKeyForFunctionResponse += 'Response';
+          spyAndJestMatchers.followedByConsole = (paramsW: WaitForParams) => {
+            return this.createWaitForXXXFunc(
+              `${serviceKeyForFunctionChain}Console`,
+              (message.data as FunctionRequestSpyEvent).context.awsRequestId
+            )(paramsW);
+          };
 
           spyAndJestMatchers.followedByResponse = (paramsW: WaitForParams) => {
             return this.createWaitForXXXFunc(
-              serviceKeyForFunctionResponse,
+              `${serviceKeyForFunctionChain}Response`,
               (message.data as FunctionRequestSpyEvent).context.awsRequestId
             )(paramsW);
           };

package/package.json

@@ -32,7 +32,8 @@
     "lint": "eslint **/*.ts",
     "lint-fix": "eslint --fix './**/*.ts'",
     "pretty": "prettier --write '**/*.ts'",
-    "bundle-extension": "scripts/run-task bundle-extension"
+    "bundle-extension": "scripts/run-task bundle-extension",
+    "cli": "scripts/run-task cli"
   },
   "author": {
     "name": "Marko (ServerlessLife.com)",
@@ -78,7 +79,8 @@
   },
   "workspaces": [
     "test",
-    "test/cdk"
+    "test/cdk",
+    "cli"
   ],
   "peerDependencies": {
     "aws-cdk-lib": "^2.37.1",
@@ -116,7 +118,7 @@
     "require": "./lib/index.js"
   },
   "license": "Apache-2.0",
-  "version": "0.0.36",
+  "version": "0.0.37",
   "types": "lib/index.d.ts",
   "stability": "stable",
   "jsii": {

package/cli/serverlessSpy.js

@@ -1,73 +0,0 @@
-function run() {
-  const tableBody = document.getElementById("tableBody");
-  var modal = document.getElementById("myModal");
-  var span = document.getElementsByClassName("close")[0];
-  const modalContent = document.getElementById("modalContent");
-  span.onclick = function () {
-    modal.style.display = "none";
-  };
-  window.onclick = function (event) {
-    if (event.target == modal) {
-      modal.style.display = "none";
-    }
-  };
-
-  tableBody.addEventListener("click", function (e) {
-    const dataJson = JSON.stringify(
-      JSON.parse(e.target.parentElement.children[2].textContent),
-      null,
-      2
-    );
-    modalContent.innerText = dataJson;
-    modal.style.display = "block";
-    //alert();
-  });
-
-  const url = "SERVERLESS_SPY_WS_URL";
-  //"wss://m6g3w6ttdh.execute-api.eu-west-1.amazonaws.com/prod?X-Amz-Security-Token=IQoJb3JpZ2luX2VjELL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMSJGMEQCIDk%2BzQd0RC2DmEgCJEPoRFAkmnhCZl%2BSIlEG4TummRkIAiBIgNG8Yw%2FOAew3XNAE3yrNCK0G0q%2BZI8MwjEa8xoEonirrAQgbEAQaDDA3NjU4NTk2NzA3NSIMxVUxKhwdqGjFOsRtKsgB2eotQMFgl4CrD8uy%2Fe1UE6K4HVc6uWo0gdjgHMPb5C9Mq0wFgHTiDFjFxIFkJpmCiTRXKqNFrx5lpo9C5Ml1bpcv%2BTopT6wvpbFksxChhhnaqUDHiBaGuys8zEy8Bjlu4jF0nKccmUYdieD70%2FXz99OU4wKPxXyWbr0w82y1Xd6ag8g4VNx3EXEdULq7vkM6H2shSAH8EUlZoTD%2BqvIQvyKS8nta3ebhprO%2BsLRQv2YC6k1w46jHuOjtI7hSnmfSKnkUqAxS6g4wgZrFlwY6mQFNSXz7jSF3IRtdcpMEIp%2Bnghf2LhvZKeW6GkZs4DMeuhPjoBehfmXLJIJWgcvLoheQvIt28ddgHU60%2BoRKhZTxQKhpvSOaAbI6M%2B%2FyHvkC2hTR4fEBtESAMnzo8WocfxdaQQ0YVYq2m5NKSXs3QrrsYIIirkFYhB%2BjAwG8bqBAuE9SQNeIthHjT27hB7KUeIIoXtwSVGutv70%3D&X-Amz-Date=20220808T175057Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIARDVHBDXR4QCRLL4O%2F20220808%2Feu-west-1%2Fexecute-api%2Faws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=d58ab2b792a69f20f8e3bf9bf4fb19c8ec8f271bd1b594f8cd25c02d4c85521d";
-  const ws = new WebSocket(url);
-
-  ws.addEventListener("open", function (event) {
-    console.log("connected " + new Date().toISOString());
-  });
-
-  ws.addEventListener("message", function ({ data }) {
-    //debugger;
-    //console.log(`From server: ${data}`);
-
-    let parsed;
-    try {
-      parsed = JSON.parse(data);
-    } catch (err) {
-      console.error("Can not parse " + data);
-    }
-
-    addLog(parsed);
-
-    // if (parsed) {
-    //   console.log(
-    //     `\x1b[47m\x1b[34m${parsed.timestamp} \x1b[31m🍕 ${
-    //       parsed.serviceKey
-    //     }\x1b[0m\x1b[32m\n${JSON.stringify(parsed.data, null, 2)}\x1b[0m`
-    //   );
-    // }
-  });
-  ws.addEventListener("close", function () {
-    console.log("disconnected " + new Date().toISOString());
-  });
-
-  function addLog(data) {
-    const newRow = document.createElement("tr");
-    newRow.innerHTML = `
-    <td>${new Date(data.timestamp).toLocaleTimeString()}</td>
-    <td>${data.serviceKey}</td>
-    <td>${JSON.stringify(data.data)}</td>
-    `;
-    tableBody.append(newRow);
-  }
-}
-
-document.addEventListener("DOMContentLoaded", function () {
-  console.log("RUN");
-  run();
-});

package/cli/ws.ts

@@ -1,79 +0,0 @@
-import * as fs from 'fs';
-import * as readline from 'readline';
-import WebSocket from 'ws';
-import { getWebSocketUrl } from '../common/getWebSocketUrl';
-
-async function run() {
-  // var credentialsProvider = awsCp.fromTemporaryCredentials();
-  // const credentials = await credentialsProvider();
-
-  // const client = new STSClient({});
-  // client.send()
-
-  // const command = new GetSessionTokenCommand({});
-  // const { Credentials: credentials } = await client.send(command);
-  // //const credentials = s.Credentials;
-
-  // console.log("credentials", credentials);
-
-  // const url = process.argv[2];
-  const url = 'wss://preh1xo1xh.execute-api.eu-west-1.amazonaws.com/prod';
-
-  // https://medium.com/@o.bredenberg/iam-sign-your-api-gateway-websocket-connection-request-no-custom-auth-from-your-frontend-65451166757d
-  const url2 = await getWebSocketUrl(url);
-
-  const ws = new WebSocket(url2);
-
-  const fileDescriptor = fs.openSync('spy_log.json', 'w');
-  // 📢📁⚡️💾 💽 💾 💿 📀🛢🪣📑🔊
-
-  ws.on('open', () => console.log(`connected ${new Date().toISOString()}`));
-  ws.on('message', (data: any) => {
-    // console.log(`From server: ${data}`);
-
-    let parsed;
-    try {
-      parsed = JSON.parse(data);
-    } catch (err) {
-      console.error(`Can not parse ${data}`);
-    }
-
-    if (parsed) {
-      console.log(
-        `\x1b[47m\x1b[34m${parsed.timestamp} \x1b[31m🍕 ${
-          parsed.serviceKey
-        }\x1b[0m\x1b[32m\n${JSON.stringify(parsed.data, null, 2)}\x1b[0m`
-      );
-    }
-
-    fs.write(fileDescriptor, data, (error) => {
-      if (!error) {
-        // fs.close(fileDescriptor);
-      } else {
-        console.error(error);
-      }
-    });
-    fs.write(fileDescriptor, '\n', (error) => {
-      if (!error) {
-        // fs.close(fileDescriptor);
-      } else {
-        console.error(error);
-      }
-    });
-  });
-  ws.on('close', () => {
-    console.log(`disconnected ${new Date().toISOString()}`);
-    fs.close(fileDescriptor, () => undefined);
-    process.exit();
-  });
-
-  readline
-    .createInterface({
-      input: process.stdin,
-      output: process.stdout,
-    })
-    .on('line', (data) => {
-      ws.send(data);
-    });
-}
-run().catch(console.error);

package/common/publishSpyEvent.ts

@@ -1,269 +0,0 @@
-import {
-  ApiGatewayManagementApi,
-  PostToConnectionCommand,
-} from '@aws-sdk/client-apigatewaymanagementapi';
-import {
-  AttributeValue,
-  DeleteItemCommand,
-  DynamoDBClient,
-  ScanCommand,
-} from '@aws-sdk/client-dynamodb';
-
-import { unmarshall } from '@aws-sdk/util-dynamodb';
-import {
-  DynamoDBStreamEvent,
-  S3Event,
-  SNSEvent,
-  EventBridgeEvent,
-  SQSEvent,
-} from 'aws-lambda';
-import { envVariableNames } from '../src/common/envVariableNames';
-import { DynamoDBSpyEvent } from './spyEvents/DynamoDBSpyEvent';
-import { EventBridgeRuleSpyEvent } from './spyEvents/EventBridgeRuleSpyEvent';
-import { EventBridgeSpyEvent } from './spyEvents/EventBridgeSpyEvent';
-import { S3SpyEvent } from './spyEvents/S3SpyEvent';
-import { SnsSubscriptionSpyEvent } from './spyEvents/SnsSubscriptionSpyEvent';
-import { SnsTopicSpyEvent } from './spyEvents/SnsTopicSpyEvent';
-import { SpyMessage } from './spyEvents/SpyMessage';
-import { SqsSpyEvent } from './spyEvents/SqsSpyEvent';
-
-const ddb = new DynamoDBClient({
-  region: process.env.AWS_REGION,
-});
-
-const apigwManagementApi = new ApiGatewayManagementApi({
-  apiVersion: '2018-11-29',
-  endpoint: process.env[envVariableNames.SSPY_WS_ENDPOINT]!,
-});
-
-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.SSPY_INFRA_MAPPING]!);
-  console.log('mapping', JSON.stringify(mapping));
-
-  let connectionData;
-
-  const scanParams = new ScanCommand({
-    TableName: process.env[envVariableNames.SSPY_WS_TABLE_NAME] as string,
-    ProjectionExpression: 'connectionId',
-  });
-
-  connectionData = await ddb.send(scanParams);
-
-  connections = connectionData.Items;
-
-  console.log(
-    `connections at ${new Date().toISOString()}`,
-    JSON.stringify(connections)
-  );
-
-  const postDataPromises: Promise<any>[] = [];
-
-  if (event?.Records && event.Records[0]?.Sns) {
-    console.log('*** SNS ***');
-    const eventSns = event as SNSEvent;
-    for (const record of eventSns.Records) {
-      const subscriptionArn = record.EventSubscriptionArn;
-
-      let serviceKey: string;
-      if (mapping[subscriptionArn]) {
-        // subscription event that could contain filter based on existing subscription
-        serviceKey = mapping[subscriptionArn];
-      } else {
-        // catch all subscription
-        const topicArn = record.Sns.TopicArn;
-        serviceKey = mapping[topicArn];
-      }
-
-      let message: string;
-
-      try {
-        message = JSON.parse(record.Sns.Message);
-      } catch {
-        message = record.Sns.Message;
-      }
-
-      const spyEventType = getSpyEventType(serviceKey) as
-        | 'FunctionSnsTopic'
-        | 'FunctionSnsSubscription';
-
-      const data: SnsTopicSpyEvent | SnsSubscriptionSpyEvent = {
-        spyEventType,
-        message,
-        subject: record.Sns.Subject,
-        timestamp: record.Sns.Timestamp,
-        topicArn: record.Sns.TopicArn,
-        messageId: record.Sns.MessageId,
-        messageAttributes: record.Sns.MessageAttributes,
-      };
-
-      const fluentEvent: Omit<SpyMessage, 'timestamp'> = {
-        data,
-        serviceKey,
-      };
-      postDataPromises.push(postData(fluentEvent));
-    }
-  } else if (event?.Records && event.Records[0]?.eventSource === 'aws:sqs') {
-    console.log('*** SQS ***');
-    const eventSqs = event as SQSEvent;
-    for (const record of eventSqs.Records) {
-      const subscriptionArn = record.eventSourceARN;
-
-      const serviceKey = mapping[subscriptionArn];
-      let body: string;
-
-      try {
-        body = JSON.parse(record.body);
-      } catch {
-        body = record.body;
-      }
-
-      const data: SqsSpyEvent = {
-        spyEventType: 'Sqs',
-        body,
-        messageAttributes: record.messageAttributes,
-      };
-
-      const fluentEvent: Omit<SpyMessage, 'timestamp'> = {
-        data,
-        serviceKey,
-      };
-      postDataPromises.push(postData(fluentEvent));
-    }
-  } else if (event?.Records && event.Records[0]?.s3) {
-    console.log('*** S3 ***');
-    const eventS3 = event as S3Event;
-    for (const record of eventS3.Records) {
-      const bucketArn = record.s3.bucket.arn;
-
-      const data: S3SpyEvent = {
-        spyEventType: 'S3',
-        eventName: record.eventName,
-        eventTime: record.eventTime,
-        bucket: record.s3.bucket.name,
-        key: record.s3.object.key,
-      };
-
-      const fluentEvent: Omit<SpyMessage, 'timestamp'> = {
-        data,
-        serviceKey: mapping[bucketArn],
-      };
-      postDataPromises.push(postData(fluentEvent));
-    }
-  } else if (event.Records && event.Records[0]?.dynamodb) {
-    console.log('*** DYNAMODB ***');
-    const eventDynamoDB = event as DynamoDBStreamEvent;
-    for (const record of eventDynamoDB.Records) {
-      let arn = record.eventSourceARN!;
-      arn = arn.substring(0, arn.indexOf('/stream/'));
-
-      const data: DynamoDBSpyEvent = {
-        spyEventType: 'DynamoDB',
-        eventName: record.eventName,
-        newImage: unmarshall(record.dynamodb?.NewImage as any),
-        keys: unmarshall(record.dynamodb?.Keys as any),
-        oldImage: record.dynamodb?.OldImage
-          ? unmarshall(record.dynamodb?.OldImage as any)
-          : undefined,
-      };
-
-      const fluentEvent: Omit<SpyMessage, 'timestamp'> = {
-        data,
-        serviceKey: mapping[arn],
-      };
-      postDataPromises.push(postData(fluentEvent));
-    }
-  } else if (
-    event.detail &&
-    event['detail-type'] &&
-    event.version &&
-    event.source
-  ) {
-    console.log('*** EventBridge ***');
-    const eventEb = event as EventBridgeEvent<any, any>;
-
-    const serviceKey = mapping.eventBridge; // the is new lambda for each subscription
-
-    const spyEventType = getSpyEventType(serviceKey) as
-      | 'EventBridge'
-      | 'EventBridgeRule';
-
-    const message = eventEb.detail;
-
-    const data: EventBridgeSpyEvent | EventBridgeRuleSpyEvent = {
-      spyEventType,
-      detail: message,
-      detailType: eventEb['detail-type'],
-      source: eventEb.source,
-      time: eventEb.time,
-      account: eventEb.account,
-    };
-
-    const fluentEvent: Omit<SpyMessage, 'timestamp'> = {
-      data,
-      serviceKey,
-    };
-    postDataPromises.push(postData(fluentEvent));
-  } else {
-    console.log('*** OTHER ***');
-    const fluentEvent: Omit<SpyMessage, 'timestamp'> = event;
-    postDataPromises.push(postData(fluentEvent));
-  }
-
-  await Promise.all(postDataPromises);
-}
-
-export async function postData(spyMessage: Omit<SpyMessage, 'timestamp'>) {
-  // const postData = JSON.parse(event.body!).data;
-  console.log('postData', JSON.stringify(spyMessage));
-
-  if (!connections) {
-    return;
-  }
-
-  const postCalls = connections.map(async ({ connectionId }) => {
-    console.log(`Sending message to: ${connectionId.S}`);
-
-    try {
-      const postToConnectionCommand = new PostToConnectionCommand({
-        ConnectionId: connectionId.S,
-        Data: JSON.stringify({
-          timestamp: new Date().toISOString(),
-          serviceKey: spyMessage.serviceKey,
-          data: spyMessage.data,
-        }) as any,
-      });
-
-      await apigwManagementApi.send(postToConnectionCommand);
-    } catch (e) {
-      console.error(`Fails sending message to: ${connectionId.S}`, e);
-      console.error(`Status code: ${(e as any).statusCode}`);
-      if ((e as any).$metadata.httpStatusCode === 410) {
-        console.log(`Found stale connection, deleting ${connectionId}`);
-
-        const deleteParams = new DeleteItemCommand({
-          TableName: process.env[envVariableNames.SSPY_WS_TABLE_NAME],
-          Key: { connectionId },
-        });
-
-        await ddb.send(deleteParams);
-      } else {
-        throw e;
-      }
-    }
-  });
-
-  await Promise.all(postCalls);
-  console.log('Send message finish');
-}
-
-export function getSpyEventType(serviceKey: string) {
-  if (!serviceKey) {
-    throw new Error('Missing serviceKey');
-  }
-
-  return serviceKey.substring(0, serviceKey.indexOf('#'));
-}

package/lib/cli/ws.d.ts

@@ -1 +0,0 @@
-export {};