serverless-spy 0.0.60 → 0.0.62

package/.jsii

@@ -29,6 +29,7 @@
     "caporal": "^1.4.0",
     "json-format-highlight": "^1.0.4",
     "open": "^8.4.0",
+    "serialize-error": "^11.0.0",
     "ws": "^8.9.0"
   },
   "dependencies": {
@@ -3177,7 +3178,7 @@
   },
   "name": "serverless-spy",
   "readme": {
-    "markdown": "![ServerlessSpy](./logo/full_logo.svg)\n\nCDK-based library for writing elegant, fast-executing integration tests on AWS serverless architecture and an additional web console to monitor events in real time.\n\n# How it works\n\n**ServerlessSpy CDK construct creates infrastructure to intercept events in Lambda, SNS, SQS, EventBridge, DynamoDB, S3... and sends it to a testing library or your local web console via API Gateway WebSocket. The testing library subscribes to events so tests can be executed fast without checking/retrying if the process has finished. The testing library is integrated with Jest but can also be used with any other testing library. The web console can be used to see and inspect events in real time.**\n\n[![Concept](./doc/concept.svg)](https://serverlessspy.com/)\n\n**Your test for the example above would look something like this:**\n```typescript\n(\n  await serverlessSpyListener.waitForEventBridgeMyEventBus<TestData>({\n    condition: (d) => d.detail.id === id,\n  })\n).toMatchObject(...);\n\n(\n  await serverlessSpyListener.waitForSnsTopicMyTopic<TestData>({\n    condition: (d) => d.message.id === id,\n  })\n).toMatchObject(...);\n\n(\n  await serverlessSpyListener.waitForSqsMyQueue<TestData>({\n    condition: (d) => d.body.id === id,\n  })\n).toMatchObject(...);\n\n(\n  await (\n    await serverlessSpyListener.waitForFunctionMyLambdaRequest<TestData>({\n      condition: (d) => d.request.id === id,\n    })\n  ).followedByResponse();\n).toMatchObject(...);\n\n(\n  await serverlessSpyListener.waitForDynamoDBMyTable<TestData>({\n    condition: (d) => d.keys.pk === id,\n  })\n).toMatchObject({\n  eventName: 'INSERT',\n  newImage: ...,\n});\n```\n\n**You can see all the events in the local web console:**\n![Web console](./doc/web_console.gif)\n\n# Key benefits\n - **Easy** to write tests that are strongly typed thanks to TypeScript ❤️.\n - **Tests are executed much FASTER** 🏎️💨 No need to write tests in a way to periodically check if the process has finished because all events are pushed to the testing library.\n - **Tests can run in parallel** if you use conditions and filter events specific to your test. This drastically reduces the execution time of the CI/CD process.\n - **Web console** enables you to see all events in real time. Debugging 🕵 has never been easier. Search is supported (with regular expression).\n\n# What ServerlessSpy is not\n - ServerlessSpy can not be used if your infrastructure is not created with CDK.\n - The solution is meant only for the development and (automatic) testing environment. You should **EXCLUDE** ServerlessSpy CDK construct in any other environment, especially a production or a high-load environment. ServerlessSpy is not meant for those; it just induces costs and could contribute to hitting AWS quotas (Lambda concurrent executions, ...).\n - Only Node.js stack is supported. There are no plans to support Python or any other. Use of TypeScript is deeply encouraged.\n - Web console only runs on your local computer. No cloud hosting of any kind (for now).\n\n# Documentation\n - [Quick Start](doc/quick_start.md)\n - [CDK Construct](doc/CDK_construct.md)\n - [Writing tests](doc/writing_tests.md)\n   - [Lambda](doc/Lambda.md)\n   - [SQS](doc/SQS.md)\n   - [SNS](doc/SNS.md)\n   - [EventBridge](doc/EventBridge.md)\n   - [DynamoDB](doc/DynamoDB.md)\n   - [S3](doc/S3.md)\n   - Kinesis (work in progress)\n   - Step Functions (work in progress)\n - [Web Console](doc/web_console.md)\n - [Frequently Asked Questions (FAQ)](doc/FAQ.md)\n - [Sample Application](doc/sample_app.md)\n - [Roadmap](doc/roadmap.md)\n - [Code of Conduct](doc/CODE_OF_CONDUCT.md)\n - [Contributing Guide](doc/CONTRIBUTING.md)\n - [Contributors](doc/Contributors.md)\n - [License](./LICENSE.md)"
+    "markdown": "![ServerlessSpy](./logo/full_logo.svg)\n\nCDK-based library for writing elegant, fast-executing integration tests on AWS serverless architecture and an additional web console to monitor events in real time.\n\n# How it works\n\n**ServerlessSpy CDK construct creates infrastructure to intercept events in Lambda, SNS, SQS, EventBridge, DynamoDB, S3... and sends it to a testing library or your local web console via API Gateway WebSocket. The testing library subscribes to events so tests can be executed fast without checking/retrying if the process has finished. The testing library is integrated with Jest but can also be used with any other testing library. The web console can be used to see and inspect events in real time.**\n\n[![Concept](./doc/concept.svg)](https://serverlessspy.com/)\n\n**Your test for the example above would look something like this:**\n```typescript\n(\n  await serverlessSpyListener.waitForEventBridgeMyEventBus<TestData>({\n    condition: (d) => d.detail.id === id,\n  })\n).toMatchObject(...);\n\n(\n  await serverlessSpyListener.waitForSnsTopicMyTopic<TestData>({\n    condition: (d) => d.message.id === id,\n  })\n).toMatchObject(...);\n\n(\n  await serverlessSpyListener.waitForSqsMyQueue<TestData>({\n    condition: (d) => d.body.id === id,\n  })\n).toMatchObject(...);\n\n(\n  await (\n    await serverlessSpyListener.waitForFunctionMyLambdaRequest<TestData>({\n      condition: (d) => d.request.id === id,\n    })\n  ).followedByResponse();\n).toMatchObject(...);\n\n(\n  await serverlessSpyListener.waitForDynamoDBMyTable<TestData>({\n    condition: (d) => d.keys.pk === id,\n  })\n).toMatchObject({\n  eventName: 'INSERT',\n  newImage: ...,\n});\n```\n\n**You can see all the events in the local web console:**\n![Web console](./doc/web_console.gif)\n\n# Key benefits\n - **Easy** to write tests that are strongly typed thanks to TypeScript ❤️.\n - **Tests are executed much FASTER** 🏎️💨 No need to write tests in a way to periodically check if the process has finished because all events are pushed to the testing library.\n - **Tests can run in parallel** if you use conditions and filter events specific to your test. This drastically reduces the execution time of the CI/CD process.\n - **Web console** enables you to see all events in real time. Debugging 🕵 has never been easier. Search is supported (with regular expression).\n\n# What ServerlessSpy is not\n - ServerlessSpy can not be used if your infrastructure is not created with CDK.\n - The solution is meant only for the development and (automatic) testing environment. You should **EXCLUDE** ServerlessSpy CDK construct in any other environment, especially a production or a high-load environment. ServerlessSpy is not meant for those; it just induces costs and could contribute to hitting AWS quotas (Lambda concurrent executions, ...).\n - Only Node.js stack is supported. There are no plans to support Python or any other. Use of TypeScript is deeply encouraged.\n - Web console only runs on your local computer. No cloud hosting of any kind (for now).\n\n# Documentation\n - [Quick Start](doc/quick_start.md)\n - [CDK Construct](doc/CDK_construct.md)\n - [Writing tests](doc/writing_tests.md)\n   - [Lambda](doc/Lambda.md)\n   - [SQS](doc/SQS.md)\n   - [SNS](doc/SNS.md)\n   - [EventBridge](doc/EventBridge.md)\n   - [DynamoDB](doc/DynamoDB.md)\n   - [S3](doc/S3.md)\n   - Kinesis (work in progress)\n   - Step Functions (work in progress)\n - [Web Console](doc/web_console.md)\n - [Frequently Asked Questions (FAQ)](doc/FAQ.md)\n - [Sample Application](https://github.com/ServerlessLife/serverless-spy-example){:target=\"_blank\"}\n - [Roadmap](doc/roadmap.md)\n - [Code of Conduct](doc/CODE_OF_CONDUCT.md)\n - [Contributing Guide](doc/CONTRIBUTING.md)\n - [Contributors](doc/Contributors.md)\n - [License](./LICENSE.md)"
   },
   "repository": {
     "type": "git",
@@ -3554,6 +3555,6 @@
       "symbolId": "src/ServerlessSpy:SpyFilter"
     }
   },
-  "version": "0.0.60",
-  "fingerprint": "FcEWAH5c5WmM5F9T30IOvIWRsuriEgZRBpQhyTI+NDg="
+  "version": "0.0.62",
+  "fingerprint": "ch9R369njclSIl5fVQ2DpKGxZ9r/81SAEQPXC0yrNPo="
 }

package/README.md

@@ -75,7 +75,7 @@ CDK-based library for writing elegant, fast-executing integration tests on AWS s
    - Step Functions (work in progress)
  - [Web Console](doc/web_console.md)  
  - [Frequently Asked Questions (FAQ)](doc/FAQ.md)  
- - [Sample Application](doc/sample_app.md)   
+ - [Sample Application](https://github.com/ServerlessLife/serverless-spy-example){:target="_blank"}
  - [Roadmap](doc/roadmap.md)   
  - [Code of Conduct](doc/CODE_OF_CONDUCT.md) 
  - [Contributing Guide](doc/CONTRIBUTING.md) 

package/_config.yml

@@ -3,8 +3,11 @@ project: 'ServerlessSpy'
 description: 'CDK-based library for writing elegant integration tests on AWS serverless architecture and an additional web console to monitor events in real time.'
 author: Marko (ServerlessLife)
 email: marko@serverlesslife.com
-image: logo/full_logo.png
+image: https://serverlessspy.com/logo/full_logo.svg
 twitter_username: ServerlessL
+twitter:
+  username: ServerlessL
+og_image: https://serverlessspy.com/logo/full_logo.svg
 github_username: serverlesslife
 show_downloads: false
 encoding: UTF-8
@@ -17,8 +20,8 @@ jailed: false
 gfm_quirks: paragraph_end
 theme: minimal-mistakes-jekyll
 minimal_mistakes_skin: dark
-teaser: /logo/full_logo.svg
-logo: /logo/full_logo.svg
+teaser: https://serverlessspy.com/logo/full_logo.svg
+logo: https://serverlessspy.com/logo/full_logo.svg
 markdown: kramdown
 sass:
   # Where you keep your scss files
@@ -40,3 +43,11 @@ analytics:
   provider: 'google-gtag'
   google:
     tracking_id: 'G-C2PHH6WYPP'
+social:
+  links:
+    - 'https://twitter.com/ServerlessL'
+    - 'https://www.linkedin.com/in/marko-serverlesslife/'
+author:
+  name     : Marko (ServerlessLife)
+  avatar   : "/logo/marko_serverlesslife.jpg"
+  bio      : "Full-stack Software Developer | AWS Certified Professional | Serverless Specialist"

package/dist/releasetag.txt

@@ -1 +1 @@
-v0.0.60
+v0.0.62

package/doc/Lambda.md

@@ -1,5 +1,7 @@
 # Lambda
 
+Under the cover, ServerlessSpy intercepts Lambda events with [Lambda internal extension](https://lumigo.io/blog/aws-lambda-extensions-what-are-they-and-why-do-they-matter/).
+
 Basic example:
 
 ```typescript

package/extension/interceptor.ts

@@ -7,6 +7,7 @@ import { FunctionResponseSpyEvent } from '../common/spyEvents/FunctionResponseSp
 import { SpyEventSender } from '../common/SpyEventSender';
 import { envVariableNames } from '../src/common/envVariableNames';
 import { load } from './aws/UserFunction';
+import { serializeError } from 'serialize-error';
 
 const ORIGINAL_HANDLER_KEY = 'ORIGINAL_HANDLER';
 
@@ -73,12 +74,15 @@ export const handler = (
 
   const fail = (error: any) => {
     logError(error);
+
+    const errorSerialized = serializeError(error);
+
     const key = `Function#${
       process.env[envVariableNames.SSPY_FUNCTION_NAME]
     }#Error`;
     const p = sendLambdaSpyEvent(key, <FunctionErrorSpyEvent>{
       request: event,
-      error,
+      error: errorSerialized,
       context: contextSpy,
     });
     promises.push(p);

package/lib/extension/dist/layer/nodejs/node_modules/interceptor.js

@@ -26199,7 +26199,7 @@ var require_convertToNative = __commonJS({
     };
     var convertString = (stringValue) => stringValue;
     var convertBinary = (binaryValue) => binaryValue;
-    var convertList = (list, options) => list.map((item) => (0, exports.convertToNative)(item, options));
+    var convertList = (list2, options) => list2.map((item) => (0, exports.convertToNative)(item, options));
     var convertMap = (map, options) => Object.entries(map).reduce((acc, [key, value]) => ({
       ...acc,
       [key]: (0, exports.convertToNative)(value, options)
@@ -26605,6 +26605,150 @@ var load = function(appRoot, fullHandlerString) {
   return handlerFunc;
 };
 
+// node_modules/serialize-error/error-constructors.js
+var list = [
+  EvalError,
+  RangeError,
+  ReferenceError,
+  SyntaxError,
+  TypeError,
+  URIError,
+  globalThis.DOMException,
+  globalThis.AssertionError,
+  globalThis.SystemError
+].filter(Boolean).map(
+  (constructor) => [constructor.name, constructor]
+);
+var errorConstructors = new Map(list);
+var error_constructors_default = errorConstructors;
+
+// node_modules/serialize-error/index.js
+var commonProperties = [
+  {
+    property: "name",
+    enumerable: false
+  },
+  {
+    property: "message",
+    enumerable: false
+  },
+  {
+    property: "stack",
+    enumerable: false
+  },
+  {
+    property: "code",
+    enumerable: true
+  },
+  {
+    property: "cause",
+    enumerable: false
+  }
+];
+var toJsonWasCalled = Symbol(".toJSON was called");
+var toJSON = (from) => {
+  from[toJsonWasCalled] = true;
+  const json = from.toJSON();
+  delete from[toJsonWasCalled];
+  return json;
+};
+var getErrorConstructor = (name) => error_constructors_default.get(name) ?? Error;
+var destroyCircular = ({
+  from,
+  seen,
+  to,
+  forceEnumerable,
+  maxDepth,
+  depth,
+  useToJSON,
+  serialize
+}) => {
+  if (!to) {
+    if (Array.isArray(from)) {
+      to = [];
+    } else if (!serialize && isErrorLike(from)) {
+      const Error2 = getErrorConstructor(from.name);
+      to = new Error2();
+    } else {
+      to = {};
+    }
+  }
+  seen.push(from);
+  if (depth >= maxDepth) {
+    return to;
+  }
+  if (useToJSON && typeof from.toJSON === "function" && from[toJsonWasCalled] !== true) {
+    return toJSON(from);
+  }
+  const continueDestroyCircular = (value) => destroyCircular({
+    from: value,
+    seen: [...seen],
+    forceEnumerable,
+    maxDepth,
+    depth,
+    useToJSON,
+    serialize
+  });
+  for (const [key, value] of Object.entries(from)) {
+    if (typeof Buffer === "function" && Buffer.isBuffer(value)) {
+      to[key] = "[object Buffer]";
+      continue;
+    }
+    if (value !== null && typeof value === "object" && typeof value.pipe === "function") {
+      to[key] = "[object Stream]";
+      continue;
+    }
+    if (typeof value === "function") {
+      continue;
+    }
+    if (!value || typeof value !== "object") {
+      to[key] = value;
+      continue;
+    }
+    if (!seen.includes(from[key])) {
+      depth++;
+      to[key] = continueDestroyCircular(from[key]);
+      continue;
+    }
+    to[key] = "[Circular]";
+  }
+  for (const { property, enumerable } of commonProperties) {
+    if (typeof from[property] !== "undefined" && from[property] !== null) {
+      Object.defineProperty(to, property, {
+        value: isErrorLike(from[property]) ? continueDestroyCircular(from[property]) : from[property],
+        enumerable: forceEnumerable ? true : enumerable,
+        configurable: true,
+        writable: true
+      });
+    }
+  }
+  return to;
+};
+function serializeError(value, options = {}) {
+  const {
+    maxDepth = Number.POSITIVE_INFINITY,
+    useToJSON = true
+  } = options;
+  if (typeof value === "object" && value !== null) {
+    return destroyCircular({
+      from: value,
+      seen: [],
+      forceEnumerable: true,
+      maxDepth,
+      depth: 0,
+      useToJSON,
+      serialize: true
+    });
+  }
+  if (typeof value === "function") {
+    return `[Function: ${value.name ?? "anonymous"}]`;
+  }
+  return value;
+}
+function isErrorLike(value) {
+  return Boolean(value) && typeof value === "object" && "name" in value && "message" in value && "stack" in value;
+}
+
 // extension/interceptor.ts
 var ORIGINAL_HANDLER_KEY = "ORIGINAL_HANDLER";
 var subscribedToSQS = process.env["SSPY_SUBSCRIBED_TO_SQS" /* SSPY_SUBSCRIBED_TO_SQS */] === "true";
@@ -26647,10 +26791,11 @@ var handler = (event, context, callback) => {
   const originalHandler = getOriginalHandler();
   const fail = (error) => {
     logError(error);
+    const errorSerialized = serializeError(error);
     const key2 = `Function#${process.env["SSPY_FUNCTION_NAME" /* SSPY_FUNCTION_NAME */]}#Error`;
     const p2 = sendLambdaSpyEvent(key2, {
       request: event,
-      error,
+      error: errorSerialized,
       context: contextSpy
     });
     promises.push(p2);