├── cli
    ├── spy_log.json
    ├── favicon.ico
    ├── favicon-16x16.png
    ├── favicon-32x32.png
    ├── mstile-70x70.png
    ├── apple-touch-icon.png
    ├── mstile-144x144.png
    ├── mstile-150x150.png
    ├── mstile-310x150.png
    ├── mstile-310x310.png
    ├── android-chrome-192x192.png
    ├── android-chrome-512x512.png
    ├── browserconfig.xml
    ├── package.json
    ├── site.webmanifest
    ├── style.css
    └── icons
    │   ├── Arch_AWS-Lambda_16.svg
    │   ├── Arch_Amazon-Simple-Storage-Service_16.svg
    │   └── Arch_Amazon-EventBridge_16.svg
├── extensions
    └── python
    │   ├── __init__.py
    │   ├── requirements.txt
    │   └── spy-wrapper
├── logo
    ├── info.txt
    ├── logo.png
    ├── full_logo.png
    ├── square_logo.png
    ├── favicon
    │   ├── favicon.ico
    │   ├── mstile-70x70.png
    │   ├── favicon-16x16.png
    │   ├── favicon-32x32.png
    │   ├── mstile-144x144.png
    │   ├── mstile-150x150.png
    │   ├── mstile-310x150.png
    │   ├── mstile-310x310.png
    │   ├── apple-touch-icon.png
    │   ├── android-chrome-192x192.png
    │   ├── android-chrome-512x512.png
    │   ├── browserconfig.xml
    │   └── site.webmanifest
    ├── marko_serverlesslife.jpg
    └── serverlesslife_logo_invert.png
├── test
    └── cdk
    │   ├── README.md
    │   ├── .github
    │       ├── pull_request_template.md
    │       └── workflows
    │       │   ├── pull-request-lint.yml
    │       │   ├── build.yml
    │       │   └── upgrade.yml
    │   ├── functions
    │       ├── python
    │       │   ├── dummy.py
    │       │   ├── lambdaFail.py
    │       │   └── lambda.py
    │       ├── dummy.ts
    │       ├── lambdaFail.ts
    │       ├── lambda.ts
    │       ├── toSns.ts
    │       ├── toS3.ts
    │       ├── tsconfig.json
    │       ├── tsconfig.dev.json
    │       ├── toDynamoDb.ts
    │       ├── toSqs.ts
    │       ├── toEventBridge.ts
    │       ├── fromSqsToEventBridge.ts
    │       ├── toSnsAndDynamoDb.ts
    │       └── fromSnsToSqsAndS3.ts
    │   ├── test
    │       ├── TestData.ts
    │       ├── copy.sh
    │       ├── sqs.test.ts
    │       ├── lambdaToSqs.test.ts
    │       ├── lambdaToS3.test.ts
    │       ├── lambdaToSnS.test.ts
    │       ├── lambdaToEventBridge.test.ts
    │       ├── lambdaToDynamoDb.test.ts
    │       ├── lambdaToDynamoDb2.test.ts
    │       ├── snsToSqs.test.ts
    │       ├── defaultEventBridgeToLambda.test.ts
    │       ├── eventBridgeToLambda.test.ts
    │       └── sqsToLambda.test.ts
    │   ├── serverlessSpyEvents
    │       ├── ServerlessSpyEventsSqs.ts
    │       ├── ServerlessSpyEventsLambdaToSqs.ts
    │       ├── ServerlessSpyEventsLambdaToS3.ts
    │       ├── ServerlessSpyEventsLambdaToSns.ts
    │       ├── ServerlessSpyEventsLambdaToDynamoDbStack.ts
    │       ├── ServerlessSpyEventsLambdaToEventBridge.ts
    │       ├── ServerlessSpyEventsSnsToSqs.ts
    │       ├── ServerlessSpyEventsEsmLambda.ts
    │       ├── ServerlessSpyEventsPythonLambda.ts
    │       ├── ServerlessSpyEventsSqsToLambda.ts
    │       ├── ServerlessSpyEventsDefaultEventBridgeToLambda.ts
    │       ├── ServerlessSpyEventsEventBridgeToLambda.ts
    │       ├── ServerlessSpyEventsSnsToLambda.ts
    │       ├── SingletonLambdaFunction.ts
    │       ├── ServerlessSpyEventsLambda.ts
    │       └── ServerlessSpyEventsE2e.ts
    │   ├── src
    │       ├── GenerateSpyEventsFileProps.ts
    │       ├── sqsStack.ts
    │       ├── singletonLambdaFunctionStack.ts
    │       ├── lambdaToSqsStack.ts
    │       ├── lambdaToS3Stack.ts
    │       ├── lambdaToSnsStack.ts
    │       ├── lambdaToEventBridgeStack.ts
    │       ├── lambdaToDynamoDb2Stack.ts
    │       ├── lambdaToDynamoDbStack.ts
    │       ├── snsToSqsStack.ts
    │       ├── defaultEventBridgeToLambdaStack.ts
    │       ├── pythonLambdaStack.ts
    │       ├── snsToLambdaStack.ts
    │       ├── eventBridgeToLambdaStack.ts
    │       ├── sqsToLambdaStack.ts
    │       ├── esmLambdaStack.ts
    │       ├── lambdaStack.ts
    │       └── main.ts
    │   ├── .npmignore
    │   ├── cdk.json
    │   ├── .mergify.yml
    │   ├── .gitattributes
    │   ├── .projenrc.js.bak
    │   ├── .gitignore
    │   ├── tsconfig.esm.json
    │   ├── tsconfig.dev.json
    │   ├── tsconfig.json
    │   └── package.json
├── .github
    ├── pull_request_template.md
    └── workflows
    │   ├── pull-request-lint.yml
    │   ├── pages.yml
    │   ├── build.yml
    │   ├── upgrade-main.yml
    │   └── release.yml
├── .prettierignore
├── src
    ├── index.ts
    ├── tsconfig.esm.json
    └── common
    │   └── envVariableNames.ts
├── index.ts
├── favicon.ico
├── common
    ├── spyEvents
    │   ├── SpyEvent.ts
    │   ├── SpyMessage.ts
    │   ├── FunctionConsole.ts
    │   ├── SnsTopicSpyEvent.ts
    │   ├── S3SpyEvent.ts
    │   ├── SnsSubscriptionSpyEvent.ts
    │   ├── FunctionBaseSpyEvent.ts
    │   ├── FunctionContext.ts
    │   ├── SqsSpyEvent.ts
    │   ├── FunctionResponseSpyEvent.ts
    │   ├── FunctionRequestSpyEvent.ts
    │   ├── EventBridgeSpyEvent.ts
    │   ├── FunctionErrorSpyEvent.ts
    │   ├── FunctionConsoleSpyEvent.ts
    │   ├── EventBridgeRuleSpyEvent.ts
    │   ├── SnsSpyEventBase.ts
    │   ├── EventBridgeBaseSpyEvent.ts
    │   └── DynamoDBSpyEvent.ts
    └── getWebSocketUrl.ts
├── doc
    ├── concept.png
    ├── web_console.gif
    ├── roadmap.md
    ├── github.svg
    ├── S3.md
    ├── SQS.md
    ├── EventBridge.md
    ├── SNS.md
    ├── DynamoDB.md
    ├── web_console.md
    ├── CDK_construct.md
    ├── quick_start.md
    ├── Lambda.md
    └── FAQ.md
├── mstile-70x70.png
├── favicon-16x16.png
├── favicon-32x32.png
├── mstile-144x144.png
├── mstile-150x150.png
├── mstile-310x150.png
├── mstile-310x310.png
├── apple-touch-icon.png
├── .eslintignore
├── listener
    ├── index.ts
    ├── PrettifyForDisplay.ts
    ├── topic.ts
    ├── WaitForParams.ts
    ├── RecursivePartial.ts
    ├── ServerlessSpyListenerParams.ts
    ├── setup.ts
    ├── createServerlessSpyListener.ts
    ├── matchers.ts
    └── iot-connection.ts
├── _layouts
    ├── home.html
    ├── default.html
    └── archive.html
├── android-chrome-192x192.png
├── android-chrome-512x512.png
├── .prettierrc.json
├── .vscode
    └── settings.json
├── assets
    ├── images
    │   └── site-logo.png
    └── css
    │   └── main.scss
├── pages_notes.txt
├── functions
    ├── sqsSubscriptionAndDropAllMessages.ts
    ├── tsconfig.dev.json
    ├── tsconfig.json
    ├── sendMessage.ts
    ├── onConnect.ts
    └── onDisconnect.ts
├── extension
    ├── spy-wrapper
    ├── tsconfig.json
    └── aws
    │   ├── HttpResponseStream.js
    │   ├── VerboseLog.js
    │   └── Errors.js
├── .husky
    └── pre-commit
├── Gemfile
├── browserconfig.xml
├── _includes
    └── head
    │   └── custom.html
├── serverlessSpyEvents
    ├── ServerlessSpyEventsLambdaToSqs.ts
    └── ServerlessSpyEventsE2e.ts
├── .npmignore
├── site.webmanifest
├── tsdown.config.ts
├── .mergify.yml
├── tsconfig.dev.json
├── .gitattributes
├── tsconfig.json
├── .projenrc.js.bak
├── .gitignore
├── tsconfig.npm.json
├── sst-esbuild
    └── esbuild.js
├── _config.yml
└── .eslintrc.yml


/cli/spy_log.json:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/extensions/python/__init__.py:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/logo/info.txt:
--------------------------------------------------------------------------------
1 | Font: Saira Stencil One


--------------------------------------------------------------------------------
/test/cdk/README.md:
--------------------------------------------------------------------------------
1 | # replace this
2 | 


--------------------------------------------------------------------------------
/.github/pull_request_template.md:
--------------------------------------------------------------------------------
1 | Fixes #


--------------------------------------------------------------------------------
/.prettierignore:
--------------------------------------------------------------------------------
1 | 
2 | ServerlessSpyEvents*


--------------------------------------------------------------------------------
/test/cdk/.github/pull_request_template.md:
--------------------------------------------------------------------------------
1 | Fixes #


--------------------------------------------------------------------------------
/src/index.ts:
--------------------------------------------------------------------------------
1 | export * from './ServerlessSpy';
2 | 


--------------------------------------------------------------------------------
/index.ts:
--------------------------------------------------------------------------------
1 | export * from './src/ServerlessSpy';
2 | export * from './listener';
3 | 


--------------------------------------------------------------------------------
/test/cdk/functions/python/dummy.py:
--------------------------------------------------------------------------------
1 | def handler(event, _):
2 |     return event
3 | 


--------------------------------------------------------------------------------
/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/favicon.ico


--------------------------------------------------------------------------------
/logo/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/logo/logo.png


--------------------------------------------------------------------------------
/cli/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/cli/favicon.ico


--------------------------------------------------------------------------------
/common/spyEvents/SpyEvent.ts:
--------------------------------------------------------------------------------
1 | export interface SpyEvent {
2 |   spyEventType: string;
3 | }
4 | 


--------------------------------------------------------------------------------
/doc/concept.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/doc/concept.png


--------------------------------------------------------------------------------
/mstile-70x70.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/mstile-70x70.png


--------------------------------------------------------------------------------
/doc/web_console.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/doc/web_console.gif


--------------------------------------------------------------------------------
/favicon-16x16.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/favicon-16x16.png


--------------------------------------------------------------------------------
/favicon-32x32.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/favicon-32x32.png


--------------------------------------------------------------------------------
/logo/full_logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/logo/full_logo.png


--------------------------------------------------------------------------------
/mstile-144x144.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/mstile-144x144.png


--------------------------------------------------------------------------------
/mstile-150x150.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/mstile-150x150.png


--------------------------------------------------------------------------------
/mstile-310x150.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/mstile-310x150.png


--------------------------------------------------------------------------------
/mstile-310x310.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/mstile-310x310.png


--------------------------------------------------------------------------------
/test/cdk/test/TestData.ts:
--------------------------------------------------------------------------------
1 | export type TestData = {
2 |   id: string;
3 |   message: string;
4 | };
5 | 


--------------------------------------------------------------------------------
/apple-touch-icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/apple-touch-icon.png


--------------------------------------------------------------------------------
/cli/favicon-16x16.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/cli/favicon-16x16.png


--------------------------------------------------------------------------------
/cli/favicon-32x32.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/cli/favicon-32x32.png


--------------------------------------------------------------------------------
/cli/mstile-70x70.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/cli/mstile-70x70.png


--------------------------------------------------------------------------------
/logo/square_logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/logo/square_logo.png


--------------------------------------------------------------------------------
/test/cdk/functions/dummy.ts:
--------------------------------------------------------------------------------
1 | export const handler = async (event: any) => {
2 |   return event;
3 | };
4 | 


--------------------------------------------------------------------------------
/test/cdk/functions/python/lambdaFail.py:
--------------------------------------------------------------------------------
1 | def handler(event, _):
2 |     raise Exception('My test error')
3 | 


--------------------------------------------------------------------------------
/.eslintignore:
--------------------------------------------------------------------------------
1 | .github
2 | .husky
3 | .vscode
4 | cdk.out
5 | coverage
6 | lib
7 | test-reposts
8 | dist
9 | logo


--------------------------------------------------------------------------------
/cli/apple-touch-icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/cli/apple-touch-icon.png


--------------------------------------------------------------------------------
/cli/mstile-144x144.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/cli/mstile-144x144.png


--------------------------------------------------------------------------------
/cli/mstile-150x150.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/cli/mstile-150x150.png


--------------------------------------------------------------------------------
/cli/mstile-310x150.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/cli/mstile-310x150.png


--------------------------------------------------------------------------------
/cli/mstile-310x310.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/cli/mstile-310x310.png


--------------------------------------------------------------------------------
/extensions/python/requirements.txt:
--------------------------------------------------------------------------------
1 | awslambdaric==2.0.8
2 | boto3
3 | awsiotsdk==1.19.0
4 | awscrt==0.19.*
5 | 


--------------------------------------------------------------------------------
/listener/index.ts:
--------------------------------------------------------------------------------
1 | export * from './createServerlessSpyListener';
2 | export * from './ServerlessSpyListener';
3 | 


--------------------------------------------------------------------------------
/logo/favicon/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/logo/favicon/favicon.ico


--------------------------------------------------------------------------------
/_layouts/home.html:
--------------------------------------------------------------------------------
1 | ---
2 | layout: archive
3 | ---
4 | 
5 | {{ content }}
6 | 
7 | 
8 | {% include paginator.html %}


--------------------------------------------------------------------------------
/android-chrome-192x192.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/android-chrome-192x192.png


--------------------------------------------------------------------------------
/android-chrome-512x512.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/android-chrome-512x512.png


--------------------------------------------------------------------------------
/.prettierrc.json:
--------------------------------------------------------------------------------
1 | {
2 |   "useTabs": false,
3 |   "singleQuote": true,
4 |   "tabWidth": 2,
5 |   "overrides": []
6 | }
7 | 


--------------------------------------------------------------------------------
/.vscode/settings.json:
--------------------------------------------------------------------------------
1 | {
2 |   "workbench.editorAssociations": {
3 |     "*.svg": "hediet.vscode-drawio-text"
4 |   }
5 | }


--------------------------------------------------------------------------------
/assets/images/site-logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/assets/images/site-logo.png


--------------------------------------------------------------------------------
/logo/favicon/mstile-70x70.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/logo/favicon/mstile-70x70.png


--------------------------------------------------------------------------------
/logo/marko_serverlesslife.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/logo/marko_serverlesslife.jpg


--------------------------------------------------------------------------------
/pages_notes.txt:
--------------------------------------------------------------------------------
1 | Run Jekyll locally:
2 | bundle exec jekyll serve --watch
3 | https://github.com/mmistakes/minimal-mistakes


--------------------------------------------------------------------------------
/test/cdk/functions/lambdaFail.ts:
--------------------------------------------------------------------------------
1 | export const handler = async () => {
2 |   throw new Error('My test error');
3 | };
4 | 


--------------------------------------------------------------------------------
/cli/android-chrome-192x192.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/cli/android-chrome-192x192.png


--------------------------------------------------------------------------------
/cli/android-chrome-512x512.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/cli/android-chrome-512x512.png


--------------------------------------------------------------------------------
/functions/sqsSubscriptionAndDropAllMessages.ts:
--------------------------------------------------------------------------------
1 | export const handler = async (event: any) => {
2 |   return event;
3 | };
4 | 


--------------------------------------------------------------------------------
/logo/favicon/favicon-16x16.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/logo/favicon/favicon-16x16.png


--------------------------------------------------------------------------------
/logo/favicon/favicon-32x32.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/logo/favicon/favicon-32x32.png


--------------------------------------------------------------------------------
/logo/favicon/mstile-144x144.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/logo/favicon/mstile-144x144.png


--------------------------------------------------------------------------------
/logo/favicon/mstile-150x150.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/logo/favicon/mstile-150x150.png


--------------------------------------------------------------------------------
/logo/favicon/mstile-310x150.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/logo/favicon/mstile-310x150.png


--------------------------------------------------------------------------------
/logo/favicon/mstile-310x310.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/logo/favicon/mstile-310x310.png


--------------------------------------------------------------------------------
/extension/spy-wrapper:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | export ORIGINAL_HANDLER=$_HANDLER
3 | export _HANDLER="interceptor.handler"
4 | exec "$@"
5 | 


--------------------------------------------------------------------------------
/logo/favicon/apple-touch-icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/logo/favicon/apple-touch-icon.png


--------------------------------------------------------------------------------
/logo/serverlesslife_logo_invert.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/logo/serverlesslife_logo_invert.png


--------------------------------------------------------------------------------
/.husky/pre-commit:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 | . "$(dirname -- "$0")/_/husky.sh"
3 | 
4 | npm run typecheck && npm run lint-fix && npm run pretty
5 | 


--------------------------------------------------------------------------------
/extensions/python/spy-wrapper:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | export ORIGINAL_HANDLER=$_HANDLER
3 | export _HANDLER="interceptor.handler"
4 | exec "$@"
5 | 


--------------------------------------------------------------------------------
/logo/favicon/android-chrome-192x192.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/logo/favicon/android-chrome-192x192.png


--------------------------------------------------------------------------------
/logo/favicon/android-chrome-512x512.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ServerlessLife/serverless-spy/HEAD/logo/favicon/android-chrome-512x512.png


--------------------------------------------------------------------------------
/listener/PrettifyForDisplay.ts:
--------------------------------------------------------------------------------
1 | export type PrettifyForDisplay<T> = T extends Function
2 |   ? T
3 |   : {
4 |       [K in keyof T]: T[K];
5 |     };
6 | 


--------------------------------------------------------------------------------
/listener/topic.ts:
--------------------------------------------------------------------------------
1 | export const SSPY_TOPIC = 'sspy';
2 | 
3 | export function getTopic(scope: string) {
4 |   return `${SSPY_TOPIC}/${scope}`;
5 | }
6 | 


--------------------------------------------------------------------------------
/test/cdk/serverlessSpyEvents/ServerlessSpyEventsSqs.ts:
--------------------------------------------------------------------------------
1 | /* eslint-disable */
2 | export class ServerlessSpyEvents {
3 |   SqsMyQueue: 'Sqs#MyQueue' = 'Sqs#MyQueue';
4 | }
5 | 


--------------------------------------------------------------------------------
/test/cdk/functions/python/lambda.py:
--------------------------------------------------------------------------------
1 | def handler(event, _):
2 |     print('My console log message', event)
3 |     return {**event, 'message': f'{event["message"]} ServerlessSpy'}
4 | 


--------------------------------------------------------------------------------
/common/spyEvents/SpyMessage.ts:
--------------------------------------------------------------------------------
1 | import { SpyEvent } from './SpyEvent';
2 | 
3 | export type SpyMessage<T extends SpyEvent = SpyEvent> = {
4 |   timestamp: string;
5 |   serviceKey: string;
6 |   data: T;
7 | };
8 | 


--------------------------------------------------------------------------------
/common/spyEvents/FunctionConsole.ts:
--------------------------------------------------------------------------------
1 | export type FunctionConsole = {
2 |   type: 'log' | 'debug' | 'info' | 'error' | 'warn';
3 |   formattedMessage?: string;
4 |   message?: any;
5 |   optionalParams: any[];
6 | };
7 | 


--------------------------------------------------------------------------------
/test/cdk/src/GenerateSpyEventsFileProps.ts:
--------------------------------------------------------------------------------
1 | import { StackProps } from 'aws-cdk-lib';
2 | 
3 | export interface GenerateSpyEventsFileProps extends StackProps {
4 |   readonly generateSpyEventsFile: boolean;
5 | }
6 | 


--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
1 | source "https://rubygems.org"
2 | 
3 | gem "github-pages", group: :jekyll_plugins
4 | gem "minimal-mistakes-jekyll"
5 | gem "jekyll-include-cache", group: :jekyll_plugins
6 | 
7 | 
8 | gem "webrick", "~> 1.7"
9 | 


--------------------------------------------------------------------------------
/common/spyEvents/SnsTopicSpyEvent.ts:
--------------------------------------------------------------------------------
1 | import { SnsSpyEventBase } from './SnsSpyEventBase';
2 | 
3 | export interface SnsTopicSpyEvent<MessageType = any>
4 |   extends SnsSpyEventBase<MessageType> {
5 |   spyEventType: 'FunctionSnsTopic';
6 | }
7 | 


--------------------------------------------------------------------------------
/listener/WaitForParams.ts:
--------------------------------------------------------------------------------
1 | import { SpyEvent } from '../common/spyEvents/SpyEvent';
2 | 
3 | export interface WaitForParams<TSpyEvent extends SpyEvent = SpyEvent> {
4 |   condition?: (event: TSpyEvent) => boolean;
5 |   timoutMs?: number;
6 | }
7 | 


--------------------------------------------------------------------------------
/common/spyEvents/S3SpyEvent.ts:
--------------------------------------------------------------------------------
 1 | import { SpyEvent } from './SpyEvent';
 2 | 
 3 | export interface S3SpyEvent extends SpyEvent {
 4 |   spyEventType: 'S3';
 5 |   eventName: string;
 6 |   eventTime: string;
 7 |   bucket: string;
 8 |   key: string;
 9 | }
10 | 


--------------------------------------------------------------------------------
/common/spyEvents/SnsSubscriptionSpyEvent.ts:
--------------------------------------------------------------------------------
1 | import { SnsSpyEventBase } from './SnsSpyEventBase';
2 | 
3 | export interface SnsSubscriptionSpyEvent<MessageType = any>
4 |   extends SnsSpyEventBase<MessageType> {
5 |   spyEventType: 'FunctionSnsSubscription';
6 | }
7 | 


--------------------------------------------------------------------------------
/common/spyEvents/FunctionBaseSpyEvent.ts:
--------------------------------------------------------------------------------
1 | import { FunctionContext } from './FunctionContext';
2 | import { SpyEvent } from './SpyEvent';
3 | 
4 | export interface FunctionBaseSpyEvent<TData = any> extends SpyEvent {
5 |   request: TData;
6 |   context: FunctionContext;
7 | }
8 | 


--------------------------------------------------------------------------------
/common/spyEvents/FunctionContext.ts:
--------------------------------------------------------------------------------
1 | import { ClientContext, CognitoIdentity } from 'aws-lambda';
2 | 
3 | export interface FunctionContext {
4 |   functionName: string;
5 |   awsRequestId: string;
6 |   identity?: CognitoIdentity | undefined;
7 |   clientContext?: ClientContext | undefined;
8 | }
9 | 


--------------------------------------------------------------------------------
/browserconfig.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <browserconfig>
 3 |     <msapplication>
 4 |         <tile>
 5 |             <square150x150logo src="/mstile-150x150.png"/>
 6 |             <TileColor>#da532c</TileColor>
 7 |         </tile>
 8 |     </msapplication>
 9 | </browserconfig>
10 | 


--------------------------------------------------------------------------------
/cli/browserconfig.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <browserconfig>
 3 |     <msapplication>
 4 |         <tile>
 5 |             <square150x150logo src="/mstile-150x150.png"/>
 6 |             <TileColor>#da532c</TileColor>
 7 |         </tile>
 8 |     </msapplication>
 9 | </browserconfig>
10 | 


--------------------------------------------------------------------------------
/common/spyEvents/SqsSpyEvent.ts:
--------------------------------------------------------------------------------
1 | import { SQSMessageAttributes } from 'aws-lambda';
2 | import { SpyEvent } from './SpyEvent';
3 | 
4 | export interface SqsSpyEvent<MessageType = any> extends SpyEvent {
5 |   spyEventType: 'Sqs';
6 |   body: MessageType;
7 |   messageAttributes: SQSMessageAttributes;
8 | }
9 | 


--------------------------------------------------------------------------------
/test/cdk/functions/lambda.ts:
--------------------------------------------------------------------------------
 1 | import { TestData } from '../test/TestData';
 2 | export const handler = async (event: TestData) => {
 3 |   console.log('My console log message', event);
 4 | 
 5 |   return <TestData>{
 6 |     ...event,
 7 |     message: `${event.message} ServerlessSpy`,
 8 |   };
 9 | };
10 | 


--------------------------------------------------------------------------------
/common/spyEvents/FunctionResponseSpyEvent.ts:
--------------------------------------------------------------------------------
1 | import { FunctionBaseSpyEvent } from './FunctionBaseSpyEvent';
2 | 
3 | export interface FunctionResponseSpyEvent<TRequest = any, TResponse = any>
4 |   extends FunctionBaseSpyEvent<TRequest> {
5 |   spyEventType: 'FunctionResponse';
6 |   response: TResponse;
7 | }
8 | 


--------------------------------------------------------------------------------
/logo/favicon/browserconfig.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <browserconfig>
 3 |     <msapplication>
 4 |         <tile>
 5 |             <square150x150logo src="/mstile-150x150.png"/>
 6 |             <TileColor>#da532c</TileColor>
 7 |         </tile>
 8 |     </msapplication>
 9 | </browserconfig>
10 | 


--------------------------------------------------------------------------------
/common/spyEvents/FunctionRequestSpyEvent.ts:
--------------------------------------------------------------------------------
1 | import { FunctionContext } from './FunctionContext';
2 | import { SpyEvent } from './SpyEvent';
3 | 
4 | export interface FunctionRequestSpyEvent<TData = any> extends SpyEvent {
5 |   spyEventType: 'FunctionRequest';
6 |   request: TData;
7 |   context: FunctionContext;
8 | }
9 | 


--------------------------------------------------------------------------------
/_includes/head/custom.html:
--------------------------------------------------------------------------------
1 | <!-- start custom head snippets -->
2 | <meta name="keywords" content="serverless-spy, serverlessspy, cdk, aws, integration testing, testing, jest, serverless">
3 | <meta name="theme-color" content="#ffffff">
4 | <!-- insert favicons. use https://realfavicongenerator.net/ -->
5 | 
6 | <!-- end custom head snippets -->


--------------------------------------------------------------------------------
/common/spyEvents/EventBridgeSpyEvent.ts:
--------------------------------------------------------------------------------
1 | import { EventBridgeBaseSpyEvent } from './EventBridgeBaseSpyEvent';
2 | 
3 | export interface EventBridgeSpyEvent<
4 |   MessageType = any,
5 |   EventBridgeDetailType extends string = string
6 | > extends EventBridgeBaseSpyEvent<MessageType, EventBridgeDetailType> {
7 |   spyEventType: 'EventBridge';
8 | }
9 | 


--------------------------------------------------------------------------------
/common/spyEvents/FunctionErrorSpyEvent.ts:
--------------------------------------------------------------------------------
 1 | import { FunctionContext } from './FunctionContext';
 2 | import { SpyEvent } from './SpyEvent';
 3 | 
 4 | export interface FunctionErrorSpyEvent<TRequest = any> extends SpyEvent {
 5 |   spyEventType: 'FunctionError';
 6 |   request: TRequest;
 7 |   context: FunctionContext;
 8 |   error: any;
 9 | }
10 | 


--------------------------------------------------------------------------------
/listener/RecursivePartial.ts:
--------------------------------------------------------------------------------
 1 | import { PrettifyForDisplay } from './PrettifyForDisplay';
 2 | 
 3 | export type RecursivePartial<T> = {
 4 |   [P in keyof T]?: T[P] extends (infer U)[]
 5 |     ? PrettifyForDisplay<RecursivePartial<U>>[]
 6 |     : T[P] extends object
 7 |     ? PrettifyForDisplay<RecursivePartial<T[P]>>
 8 |     : T[P];
 9 | };
10 | 


--------------------------------------------------------------------------------
/common/spyEvents/FunctionConsoleSpyEvent.ts:
--------------------------------------------------------------------------------
1 | import { FunctionBaseSpyEvent } from './FunctionBaseSpyEvent';
2 | import { FunctionConsole } from './FunctionConsole';
3 | 
4 | export interface FunctionConsoleSpyEvent<TRequest = any>
5 |   extends FunctionBaseSpyEvent<TRequest> {
6 |   spyEventType: 'FunctionConsole';
7 |   console: FunctionConsole;
8 | }
9 | 


--------------------------------------------------------------------------------
/common/spyEvents/EventBridgeRuleSpyEvent.ts:
--------------------------------------------------------------------------------
1 | import { EventBridgeBaseSpyEvent } from './EventBridgeBaseSpyEvent';
2 | 
3 | export interface EventBridgeRuleSpyEvent<
4 |   MessageType = any,
5 |   EventBridgeDetailType extends string = string
6 | > extends EventBridgeBaseSpyEvent<MessageType, EventBridgeDetailType> {
7 |   spyEventType: 'EventBridgeRule';
8 | }
9 | 


--------------------------------------------------------------------------------
/listener/ServerlessSpyListenerParams.ts:
--------------------------------------------------------------------------------
 1 | import { Credentials } from '@aws-sdk/types';
 2 | 
 3 | export type ServerlessSpyListenerParams = {
 4 |   credentials?: Credentials;
 5 |   debugMode?: boolean;
 6 |   scope: string;
 7 |   serverlessSpyWsUrl: string;
 8 |   connectionOpenResolve?: () => void;
 9 |   connectionOpenReject?: (reason?: any) => void;
10 | };
11 | 


--------------------------------------------------------------------------------
/test/cdk/.npmignore:
--------------------------------------------------------------------------------
 1 | /.projen/
 2 | /test-reports/
 3 | junit.xml
 4 | /coverage/
 5 | /.mergify.yml
 6 | /test/
 7 | /tsconfig.dev.json
 8 | /src/
 9 | !/lib/
10 | !/lib/**/*.js
11 | !/lib/**/*.d.ts
12 | dist
13 | /tsconfig.json
14 | /.github/
15 | /.vscode/
16 | /.idea/
17 | /.projenrc.js
18 | tsconfig.tsbuildinfo
19 | !/assets/
20 | cdk.out/
21 | .cdk.staging/
22 | 


--------------------------------------------------------------------------------
/test/cdk/test/copy.sh:
--------------------------------------------------------------------------------
1 | cp lambdaToSnS.test.ts eventBridgeToLambda.test.ts
2 | cp lambdaToSnS.test.ts lambdaToDynamoDb.test.ts
3 | cp lambdaToSnS.test.ts lambdaToEventBridge.test.ts
4 | cp lambdaToSnS.test.ts lambdaToS3.test.ts
5 | cp lambdaToSnS.test.ts lambdaToSqs.test.ts
6 | cp lambdaToSnS.test.ts snsToLambda.test.ts
7 | cp lambdaToSnS.test.ts sqsToLambda.test.ts
8 | 


--------------------------------------------------------------------------------
/common/spyEvents/SnsSpyEventBase.ts:
--------------------------------------------------------------------------------
 1 | import { SNSMessageAttributes } from 'aws-lambda';
 2 | import { SpyEvent } from './SpyEvent';
 3 | 
 4 | export interface SnsSpyEventBase<MessageType = any> extends SpyEvent {
 5 |   message: MessageType;
 6 |   subject?: string;
 7 |   timestamp: string;
 8 |   topicArn: string;
 9 |   messageId: string;
10 |   messageAttributes: SNSMessageAttributes;
11 | }
12 | 


--------------------------------------------------------------------------------
/common/spyEvents/EventBridgeBaseSpyEvent.ts:
--------------------------------------------------------------------------------
 1 | import { SpyEvent } from './SpyEvent';
 2 | 
 3 | export interface EventBridgeBaseSpyEvent<
 4 |   MessageType = any,
 5 |   EventBridgeDetailType extends string = string
 6 | > extends SpyEvent {
 7 |   eventBridgeId: string;
 8 |   detail: MessageType;
 9 |   detailType: EventBridgeDetailType;
10 |   source: string;
11 |   time: string;
12 |   account: string;
13 | }
14 | 


--------------------------------------------------------------------------------
/test/cdk/functions/toSns.ts:
--------------------------------------------------------------------------------
 1 | import { PublishCommand, SNSClient } from '@aws-sdk/client-sns';
 2 | 
 3 | const snsClient = new SNSClient({});
 4 | 
 5 | export const handler = async (event: any) => {
 6 |   const params = new PublishCommand({
 7 |     Message: JSON.stringify(event),
 8 |     TopicArn: process.env.SNS_TOPIC_ARN,
 9 |   });
10 | 
11 |   await snsClient.send(params);
12 | 
13 |   return event;
14 | };
15 | 


--------------------------------------------------------------------------------
/doc/roadmap.md:
--------------------------------------------------------------------------------
1 | # Roadmap
2 | 
3 | The following additional features are in development but with no timeframe.
4 |  - Support for Kinesis
5 |  - Support for Step Functions 🌟
6 |  - Support for [Vitest](https://vitest.dev/) in addition to [Jest](https://jestjs.io/) (note: You can already use Vitest or any other testing framework. There is just no deep integration with it.)
7 | 
8 | Let me know what should be [prioritized](https://twitter.com/ServerlessL).
9 | 


--------------------------------------------------------------------------------
/test/cdk/functions/toS3.ts:
--------------------------------------------------------------------------------
 1 | import { PutObjectCommand, S3Client } from '@aws-sdk/client-s3';
 2 | 
 3 | const s3Client = new S3Client({});
 4 | 
 5 | export const handler = async (event: any) => {
 6 |   const bucketParams = {
 7 |     Bucket: process.env.S3_BUCKET_NAME,
 8 |     Key: `${event.id}.json`,
 9 |     Body: JSON.stringify(event),
10 |   };
11 | 
12 |   await s3Client.send(new PutObjectCommand(bucketParams));
13 | 
14 |   return event;
15 | };
16 | 


--------------------------------------------------------------------------------
/common/spyEvents/DynamoDBSpyEvent.ts:
--------------------------------------------------------------------------------
 1 | import { NativeAttributeValue } from '@aws-sdk/util-dynamodb';
 2 | import { DynamoDBRecord } from 'aws-lambda';
 3 | import { SpyEvent } from './SpyEvent';
 4 | 
 5 | // asdasd
 6 | export interface DynamoDBSpyEvent<TData = any> extends SpyEvent {
 7 |   spyEventType: 'DynamoDB';
 8 |   eventName: DynamoDBRecord['eventName'];
 9 |   newImage?: TData;
10 |   keys: Record<string, NativeAttributeValue>;
11 |   oldImage?: TData;
12 | }
13 | 


--------------------------------------------------------------------------------
/serverlessSpyEvents/ServerlessSpyEventsLambdaToSqs.ts:
--------------------------------------------------------------------------------
1 | /* eslint-disable */
2 | export class ServerlessSpyEvents {
3 |   FunctionMyLambdaRequest: 'Function#MyLambda#Request' = 'Function#MyLambda#Request';
4 |   FunctionMyLambdaError: 'Function#MyLambda#Error' = 'Function#MyLambda#Error';
5 |   FunctionMyLambdaConsole: 'Function#MyLambda#Console' = 'Function#MyLambda#Console';
6 |   FunctionMyLambdaResponse: 'Function#MyLambda#Response' = 'Function#MyLambda#Response';
7 | }
8 | 


--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
 1 | /.projen/
 2 | /test-reports/
 3 | junit.xml
 4 | /coverage/
 5 | /dist/changelog.md
 6 | /dist/version.txt
 7 | /.mergify.yml
 8 | /test/
 9 | /tsconfig.dev.json
10 | /src/
11 | !/lib/
12 | !/lib/**/*.js
13 | !/lib/**/*.d.ts
14 | /tsconfig.json
15 | /.github/
16 | /.vscode/
17 | /.idea/
18 | /.projenrc.js
19 | tsconfig.tsbuildinfo
20 | /.eslintrc.json
21 | !.jsii
22 | !/lib/extension/dist/layer/nodejs/node_modules/
23 | /sst-esbuild/
24 | /scripts/
25 | /tsconfig.npm.json


--------------------------------------------------------------------------------
/test/cdk/serverlessSpyEvents/ServerlessSpyEventsLambdaToSqs.ts:
--------------------------------------------------------------------------------
1 | /* eslint-disable */
2 | export class ServerlessSpyEvents {
3 |   FunctionMyLambdaRequest: 'Function#MyLambda#Request' = 'Function#MyLambda#Request';
4 |   FunctionMyLambdaError: 'Function#MyLambda#Error' = 'Function#MyLambda#Error';
5 |   FunctionMyLambdaConsole: 'Function#MyLambda#Console' = 'Function#MyLambda#Console';
6 |   FunctionMyLambdaResponse: 'Function#MyLambda#Response' = 'Function#MyLambda#Response';
7 | }
8 | 


--------------------------------------------------------------------------------
/extension/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "$schema": "https://json.schemastore.org/tsconfig",
 3 |   "display": "Node 16",
 4 |   "compilerOptions": {
 5 |     "lib": ["es2021"],
 6 |     "module": "esnext",
 7 |     "target": "es2017",
 8 |     "strict": true,
 9 |     "allowSyntheticDefaultImports": true,
10 |     "esModuleInterop": true,
11 |     "skipLibCheck": true,
12 |     "forceConsistentCasingInFileNames": true,
13 |     "moduleResolution": "node",
14 |     "resolveJsonModule": true
15 |   }
16 | }
17 | 


--------------------------------------------------------------------------------
/functions/tsconfig.dev.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "$schema": "https://json.schemastore.org/tsconfig",
 3 |   "display": "Node 16",
 4 |   "compilerOptions": {
 5 |     "lib": ["es2021"],
 6 |     "module": "esnext",
 7 |     "target": "es2021",
 8 |     "strict": true,
 9 |     "allowSyntheticDefaultImports": true,
10 |     "esModuleInterop": true,
11 |     "skipLibCheck": true,
12 |     "forceConsistentCasingInFileNames": true,
13 |     "moduleResolution": "node",
14 |     "resolveJsonModule": true
15 |   }
16 | }
17 | 


--------------------------------------------------------------------------------
/functions/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "$schema": "https://json.schemastore.org/tsconfig",
 3 |   "display": "Node 16",
 4 |   "compilerOptions": {
 5 |     "lib": ["es2021"],
 6 |     "module": "esnext",
 7 |     "target": "es2021",
 8 |     "strict": true,
 9 |     "allowSyntheticDefaultImports": true,
10 |     "esModuleInterop": true,
11 |     "skipLibCheck": true,
12 |     "forceConsistentCasingInFileNames": true,
13 |     "moduleResolution": "node",
14 |     "resolveJsonModule": true
15 |   }
16 | }
17 | 


--------------------------------------------------------------------------------
/test/cdk/functions/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "$schema": "https://json.schemastore.org/tsconfig",
 3 |   "display": "Node 16",
 4 |   "compilerOptions": {
 5 |     "lib": ["es2021"],
 6 |     "module": "esnext",
 7 |     "target": "es2021",
 8 |     "strict": true,
 9 |     "allowSyntheticDefaultImports": true,
10 |     "esModuleInterop": true,
11 |     "skipLibCheck": true,
12 |     "forceConsistentCasingInFileNames": true,
13 |     "moduleResolution": "node",
14 |     "resolveJsonModule": true
15 |   }
16 | }
17 | 


--------------------------------------------------------------------------------
/test/cdk/functions/tsconfig.dev.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "$schema": "https://json.schemastore.org/tsconfig",
 3 |   "display": "Node 16",
 4 |   "compilerOptions": {
 5 |     "lib": ["es2021"],
 6 |     "module": "esnext",
 7 |     "target": "es2021",
 8 |     "strict": true,
 9 |     "allowSyntheticDefaultImports": true,
10 |     "esModuleInterop": true,
11 |     "skipLibCheck": true,
12 |     "forceConsistentCasingInFileNames": true,
13 |     "moduleResolution": "node",
14 |     "resolveJsonModule": true
15 |   }
16 | }
17 | 


--------------------------------------------------------------------------------
/test/cdk/cdk.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "app": "npx ts-node -P tsconfig.json --prefer-ts-exts src/main.ts",
 3 |   "output": "cdk.out",
 4 |   "build": "scripts/run-task bundle",
 5 |   "watch": {
 6 |     "include": [
 7 |       "src/**/*.ts",
 8 |       "test/**/*.ts"
 9 |     ],
10 |     "exclude": [
11 |       "README.md",
12 |       "cdk*.json",
13 |       "**/*.d.ts",
14 |       "**/*.js",
15 |       "tsconfig.json",
16 |       "package*.json",
17 |       "yarn.lock",
18 |       "node_modules"
19 |     ]
20 |   }
21 | }
22 | 


--------------------------------------------------------------------------------
/cli/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "cli",
 3 |   "version": "1.0.0",
 4 |   "description": "",
 5 |   "main": "webServerlessSpy.js",
 6 |   "scripts": {
 7 |     "test": "echo \"Error: no test specified\" && exit 1"
 8 |   },
 9 |   "keywords": [],
10 |   "author": "",
11 |   "license": "MPL-2.0",
12 |   "dependencies": {
13 |     "bootstrap": "^5.2.1",
14 |     "bootstrap-icons": "^1.9.1",
15 |     "caporal": "^1.4.0",
16 |     "json-format-highlight": "^1.0.4",
17 |     "open": "^8.4.0"
18 |   },
19 |   "devDependencies": {}
20 | }


--------------------------------------------------------------------------------
/site.webmanifest:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "",
 3 |     "short_name": "",
 4 |     "icons": [
 5 |         {
 6 |             "src": "/android-chrome-192x192.png",
 7 |             "sizes": "192x192",
 8 |             "type": "image/png"
 9 |         },
10 |         {
11 |             "src": "/android-chrome-512x512.png",
12 |             "sizes": "512x512",
13 |             "type": "image/png"
14 |         }
15 |     ],
16 |     "theme_color": "#ffffff",
17 |     "background_color": "#ffffff",
18 |     "display": "standalone"
19 | }
20 | 


--------------------------------------------------------------------------------
/test/cdk/serverlessSpyEvents/ServerlessSpyEventsLambdaToS3.ts:
--------------------------------------------------------------------------------
1 | /* eslint-disable */
2 | export class ServerlessSpyEvents {
3 |   S3MyBucket: 'S3#MyBucket' = 'S3#MyBucket';
4 |   FunctionMyLambdaRequest: 'Function#MyLambda#Request' = 'Function#MyLambda#Request';
5 |   FunctionMyLambdaError: 'Function#MyLambda#Error' = 'Function#MyLambda#Error';
6 |   FunctionMyLambdaConsole: 'Function#MyLambda#Console' = 'Function#MyLambda#Console';
7 |   FunctionMyLambdaResponse: 'Function#MyLambda#Response' = 'Function#MyLambda#Response';
8 | }
9 | 


--------------------------------------------------------------------------------
/cli/site.webmanifest:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "",
 3 |     "short_name": "",
 4 |     "icons": [
 5 |         {
 6 |             "src": "/android-chrome-192x192.png",
 7 |             "sizes": "192x192",
 8 |             "type": "image/png"
 9 |         },
10 |         {
11 |             "src": "/android-chrome-512x512.png",
12 |             "sizes": "512x512",
13 |             "type": "image/png"
14 |         }
15 |     ],
16 |     "theme_color": "#ffffff",
17 |     "background_color": "#ffffff",
18 |     "display": "standalone"
19 | }
20 | 


--------------------------------------------------------------------------------
/logo/favicon/site.webmanifest:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "",
 3 |     "short_name": "",
 4 |     "icons": [
 5 |         {
 6 |             "src": "/android-chrome-192x192.png",
 7 |             "sizes": "192x192",
 8 |             "type": "image/png"
 9 |         },
10 |         {
11 |             "src": "/android-chrome-512x512.png",
12 |             "sizes": "512x512",
13 |             "type": "image/png"
14 |         }
15 |     ],
16 |     "theme_color": "#ffffff",
17 |     "background_color": "#ffffff",
18 |     "display": "standalone"
19 | }
20 | 


--------------------------------------------------------------------------------
/test/cdk/serverlessSpyEvents/ServerlessSpyEventsLambdaToSns.ts:
--------------------------------------------------------------------------------
1 | /* eslint-disable */
2 | export class ServerlessSpyEvents {
3 |   SnsTopicMyTopic: 'SnsTopic#MyTopic' = 'SnsTopic#MyTopic';
4 |   FunctionMyLambdaRequest: 'Function#MyLambda#Request' = 'Function#MyLambda#Request';
5 |   FunctionMyLambdaError: 'Function#MyLambda#Error' = 'Function#MyLambda#Error';
6 |   FunctionMyLambdaConsole: 'Function#MyLambda#Console' = 'Function#MyLambda#Console';
7 |   FunctionMyLambdaResponse: 'Function#MyLambda#Response' = 'Function#MyLambda#Response';
8 | }
9 | 


--------------------------------------------------------------------------------
/test/cdk/serverlessSpyEvents/ServerlessSpyEventsLambdaToDynamoDbStack.ts:
--------------------------------------------------------------------------------
1 | /* eslint-disable */
2 | export class ServerlessSpyEvents {
3 |   DynamoDBMyTable: 'DynamoDB#MyTable' = 'DynamoDB#MyTable';
4 |   FunctionMyLambdaRequest: 'Function#MyLambda#Request' = 'Function#MyLambda#Request';
5 |   FunctionMyLambdaError: 'Function#MyLambda#Error' = 'Function#MyLambda#Error';
6 |   FunctionMyLambdaConsole: 'Function#MyLambda#Console' = 'Function#MyLambda#Console';
7 |   FunctionMyLambdaResponse: 'Function#MyLambda#Response' = 'Function#MyLambda#Response';
8 | }
9 | 


--------------------------------------------------------------------------------
/tsdown.config.ts:
--------------------------------------------------------------------------------
 1 | import { defineConfig } from 'tsdown';
 2 | 
 3 | export default defineConfig({
 4 |   outDir: './lib',
 5 |   entry: [
 6 |     './index.ts',
 7 |     'src/**/*.ts',
 8 |     'common/**/*.ts',
 9 |     'listener/**/*.ts',
10 |     'cli/**/*.ts',
11 |     '!cli/**/webServerlessSpy.ts',
12 |     'functions/**/*.ts',
13 |   ],
14 |   unbundle: true,
15 |   outputOptions: {
16 |     banner: (chunk) =>
17 |       chunk.fileName.endsWith('.mjs')
18 |         ? 'const __dirname = import.meta.dirname;'
19 |         : '',
20 |   },
21 | });
22 | 


--------------------------------------------------------------------------------
/test/cdk/serverlessSpyEvents/ServerlessSpyEventsLambdaToEventBridge.ts:
--------------------------------------------------------------------------------
1 | /* eslint-disable */
2 | export class ServerlessSpyEvents {
3 |   EventBridgeMyEventBus: 'EventBridge#MyEventBus' = 'EventBridge#MyEventBus';
4 |   FunctionMyLambdaRequest: 'Function#MyLambda#Request' = 'Function#MyLambda#Request';
5 |   FunctionMyLambdaError: 'Function#MyLambda#Error' = 'Function#MyLambda#Error';
6 |   FunctionMyLambdaConsole: 'Function#MyLambda#Console' = 'Function#MyLambda#Console';
7 |   FunctionMyLambdaResponse: 'Function#MyLambda#Response' = 'Function#MyLambda#Response';
8 | }
9 | 


--------------------------------------------------------------------------------
/test/cdk/functions/toDynamoDb.ts:
--------------------------------------------------------------------------------
 1 | import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
 2 | import { DynamoDBDocumentClient, PutCommand } from '@aws-sdk/lib-dynamodb';
 3 | 
 4 | const ddbDocClient = DynamoDBDocumentClient.from(new DynamoDBClient({}));
 5 | 
 6 | export const handler = async (event: any) => {
 7 |   const putCommand = new PutCommand({
 8 |     TableName: process.env.DYNAMODB_TABLE_NAME!,
 9 |     Item: {
10 |       pk: event.id,
11 |       ...event,
12 |     },
13 |   });
14 | 
15 |   await ddbDocClient.send(putCommand);
16 | 
17 |   return event;
18 | };
19 | 


--------------------------------------------------------------------------------
/test/cdk/functions/toSqs.ts:
--------------------------------------------------------------------------------
 1 | import { PutObjectCommand, S3Client } from '@aws-sdk/client-s3';
 2 | import { SendMessageCommand, SQSClient } from '@aws-sdk/client-sqs';
 3 | import { SNSEvent } from 'aws-lambda';
 4 | 
 5 | const sqsClient = new SQSClient({});
 6 | 
 7 | export const handler = async (event: any) => {
 8 |   const sendMessageCommand = new SendMessageCommand({
 9 |     DelaySeconds: 10,
10 |     MessageBody: JSON.stringify(event),
11 |     QueueUrl: process.env.SQS_URL,
12 |   });
13 | 
14 |   await sqsClient.send(sendMessageCommand);
15 | 
16 |   return event;
17 | };
18 | 


--------------------------------------------------------------------------------
/test/cdk/functions/toEventBridge.ts:
--------------------------------------------------------------------------------
 1 | import {
 2 |   EventBridgeClient,
 3 |   PutEventsCommand,
 4 | } from '@aws-sdk/client-eventbridge';
 5 | 
 6 | const eventBridgeClient = new EventBridgeClient({});
 7 | 
 8 | export const handler = async (event: any) => {
 9 |   const command = new PutEventsCommand({
10 |     Entries: [
11 |       {
12 |         EventBusName: process.env.EB_NAME,
13 |         Detail: JSON.stringify(event),
14 |         DetailType: 'test',
15 |         Source: 'test-source',
16 |       },
17 |     ],
18 |   });
19 | 
20 |   await eventBridgeClient.send(command);
21 | 
22 |   return event;
23 | };
24 | 


--------------------------------------------------------------------------------
/test/cdk/.mergify.yml:
--------------------------------------------------------------------------------
 1 | 
 2 | queue_rules:
 3 |   - name: default
 4 |     conditions:
 5 |       - "#approved-reviews-by>=1"
 6 |       - -label~=(do-not-merge)
 7 |       - status-success=build
 8 | pull_request_rules:
 9 |   - name: Automatic merge on approval and successful build
10 |     actions:
11 |       delete_head_branch: {}
12 |       queue:
13 |         method: squash
14 |         name: default
15 |         commit_message_template: |-
16 |           {{ title }} (#{{ number }})
17 | 
18 |           {{ body }}
19 |     conditions:
20 |       - "#approved-reviews-by>=1"
21 |       - -label~=(do-not-merge)
22 |       - status-success=build
23 | 


--------------------------------------------------------------------------------
/functions/sendMessage.ts:
--------------------------------------------------------------------------------
 1 | import { SpyEventSender } from '../common/SpyEventSender';
 2 | 
 3 | export const handler = async (event: any) => {
 4 |   const spyEventSender = new SpyEventSender({
 5 |     scope: process.env['SSPY_ROOT_STACK']!,
 6 |     iotEndpoint: process.env['SSPY_IOT_ENDPOINT']!,
 7 |   });
 8 |   try {
 9 |     await spyEventSender.connect();
10 |     await spyEventSender.publishSpyEvent(event);
11 |   } catch (e) {
12 |     console.error(e);
13 |     return { statusCode: 500, body: (e as Error)?.stack };
14 |   } finally {
15 |     await spyEventSender.close();
16 |   }
17 | 
18 |   return { statusCode: 200, body: 'Data sent.' };
19 | };
20 | 


--------------------------------------------------------------------------------
/.github/workflows/pull-request-lint.yml:
--------------------------------------------------------------------------------
 1 | 
 2 | name: pull-request-lint
 3 | on:
 4 |   pull_request_target:
 5 |     types:
 6 |       - labeled
 7 |       - opened
 8 |       - synchronize
 9 |       - reopened
10 |       - ready_for_review
11 |       - edited
12 | jobs:
13 |   validate:
14 |     name: Validate PR title
15 |     runs-on: ubuntu-latest
16 |     permissions:
17 |       pull-requests: write
18 |     steps:
19 |       - uses: amannn/action-semantic-pull-request@v4.5.0
20 |         env:
21 |           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
22 |         with:
23 |           types: |-
24 |             feat
25 |             fix
26 |             chore
27 |           requireScope: false
28 | 


--------------------------------------------------------------------------------
/test/cdk/serverlessSpyEvents/ServerlessSpyEventsSnsToSqs.ts:
--------------------------------------------------------------------------------
 1 | /* eslint-disable */
 2 | export class ServerlessSpyEvents {
 3 |   SnsTopicMyTopic: 'SnsTopic#MyTopic' = 'SnsTopic#MyTopic';
 4 |   SnsSubscriptionMyTopicMyQueue: 'SnsSubscription#MyTopic#MyQueue' = 'SnsSubscription#MyTopic#MyQueue';
 5 |   FunctionMyLambdaRequest: 'Function#MyLambda#Request' = 'Function#MyLambda#Request';
 6 |   FunctionMyLambdaError: 'Function#MyLambda#Error' = 'Function#MyLambda#Error';
 7 |   FunctionMyLambdaConsole: 'Function#MyLambda#Console' = 'Function#MyLambda#Console';
 8 |   FunctionMyLambdaResponse: 'Function#MyLambda#Response' = 'Function#MyLambda#Response';
 9 |   SqsMyQueue: 'Sqs#MyQueue' = 'Sqs#MyQueue';
10 | }
11 | 


--------------------------------------------------------------------------------
/assets/css/main.scss:
--------------------------------------------------------------------------------
 1 | ---
 2 | # Only the main Sass file needs front matter (the dashes are enough)
 3 | search: false
 4 | ---
 5 | 
 6 | @charset "utf-8";
 7 | 
 8 | @import "minimal-mistakes/skins/{{ site.minimal_mistakes_skin | default: 'default' }}"; // skin
 9 | @import "minimal-mistakes"; // main partials
10 | 
11 | html {
12 |   font-size: 16px;
13 | }
14 | 
15 | img[src$="/logo/full_logo.svg"] {
16 |   display: none;
17 | }
18 | 
19 | .logo-serverlesslife {
20 |   width: 7%;
21 |   text-decoration: none !important;
22 | }
23 | 
24 | .link-author
25 | { 
26 |   margin-top: -60px !important;
27 |   text-align: right;  
28 | }
29 | 
30 | .link-author a{
31 |   text-decoration: none !important;
32 | }
33 | 


--------------------------------------------------------------------------------
/test/cdk/.github/workflows/pull-request-lint.yml:
--------------------------------------------------------------------------------
 1 | 
 2 | name: pull-request-lint
 3 | on:
 4 |   pull_request_target:
 5 |     types:
 6 |       - labeled
 7 |       - opened
 8 |       - synchronize
 9 |       - reopened
10 |       - ready_for_review
11 |       - edited
12 | jobs:
13 |   validate:
14 |     name: Validate PR title
15 |     runs-on: ubuntu-latest
16 |     permissions:
17 |       pull-requests: write
18 |     steps:
19 |       - uses: amannn/action-semantic-pull-request@v4.5.0
20 |         env:
21 |           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
22 |         with:
23 |           types: |-
24 |             feat
25 |             fix
26 |             chore
27 |           requireScope: false
28 | 


--------------------------------------------------------------------------------
/.mergify.yml:
--------------------------------------------------------------------------------
 1 | 
 2 | queue_rules:
 3 |   - name: default
 4 |     conditions:
 5 |       - "#approved-reviews-by>=1"
 6 |       - -label~=(do-not-merge)
 7 |       - status-success=build
 8 |       - status-success=package-js
 9 | pull_request_rules:
10 |   - name: Automatic merge on approval and successful build
11 |     actions:
12 |       delete_head_branch: {}
13 |       queue:
14 |         method: squash
15 |         name: default
16 |         commit_message_template: |-
17 |           {{ title }} (#{{ number }})
18 | 
19 |           {{ body }}
20 |     conditions:
21 |       - "#approved-reviews-by>=1"
22 |       - -label~=(do-not-merge)
23 |       - status-success=build
24 |       - status-success=package-js
25 | 


--------------------------------------------------------------------------------
/test/cdk/.gitattributes:
--------------------------------------------------------------------------------
 1 | 
 2 | *.snap linguist-generated
 3 | /.gitattributes linguist-generated
 4 | /.github/pull_request_template.md linguist-generated
 5 | /.github/workflows/build.yml linguist-generated
 6 | /.github/workflows/pull-request-lint.yml linguist-generated
 7 | /.github/workflows/upgrade.yml linguist-generated
 8 | /.gitignore linguist-generated
 9 | /.mergify.yml linguist-generated
10 | /.npmignore linguist-generated
11 | /.projen/** linguist-generated
12 | /.projen/tasks.json linguist-generated
13 | /cdk.json linguist-generated
14 | /LICENSE linguist-generated
15 | /package-lock.json linguist-generated
16 | /package.json linguist-generated
17 | /tsconfig.dev.json linguist-generated
18 | /tsconfig.json linguist-generated


--------------------------------------------------------------------------------
/listener/setup.ts:
--------------------------------------------------------------------------------
 1 | // import * as matchers from './matchers';
 2 | 
 3 | // if (expect !== undefined) {
 4 | //   expect.extend(matchers);
 5 | // } else {
 6 | //   /* eslint-disable no-console */
 7 | //   console.error(
 8 | //     "Unable to find Jest's global expect." +
 9 | //       '\nPlease check you have added jest-extended correctly to your jest configuration.' +
10 | //       '\nSee https://github.com/jest-community/jest-extended#setup for help.'
11 | //   );
12 | //   /* eslint-enable no-console */
13 | // }
14 | 
15 | // declare global {
16 | //   namespace jest {
17 | //     interface Matchers<R> {
18 | //       toReceiveEvent(serviceKey: string, condition?: (data: any) => boolean): R;
19 | //     }
20 | //   }
21 | // }
22 | 


--------------------------------------------------------------------------------
/test/cdk/.github/workflows/build.yml:
--------------------------------------------------------------------------------
 1 | name: build
 2 | on:
 3 |   pull_request: {}
 4 |   workflow_dispatch: {}
 5 | jobs:
 6 |   build:
 7 |     runs-on: ubuntu-latest
 8 |     permissions:
 9 |       contents: write
10 |     outputs:
11 |       self_mutation_happened: ${{ steps.self_mutation.outputs.self_mutation_happened }}
12 |     env:
13 |       CI: 'true'
14 |     steps:
15 |       - name: Checkout
16 |         uses: actions/checkout@v3
17 |         with:
18 |           ref: ${{ github.event.pull_request.head.ref }}
19 |           repository: ${{ github.event.pull_request.head.repo.full_name }}
20 |       - name: Install dependencies
21 |         run: npm install
22 |       - name: build
23 |         run: scripts/run-task build
24 | 


--------------------------------------------------------------------------------
/tsconfig.dev.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "alwaysStrict": true,
 4 |     "declaration": true,
 5 |     "esModuleInterop": true,
 6 |     "experimentalDecorators": true,
 7 |     "inlineSourceMap": true,
 8 |     "inlineSources": true,
 9 |     "lib": [
10 |       "es2019"
11 |     ],
12 |     "module": "CommonJS",
13 |     "noEmitOnError": false,
14 |     "noFallthroughCasesInSwitch": true,
15 |     "noImplicitAny": true,
16 |     "noImplicitReturns": true,
17 |     "noImplicitThis": true,
18 |     "noUnusedLocals": true,
19 |     "noUnusedParameters": true,
20 |     "resolveJsonModule": true,
21 |     "strict": true,
22 |     "strictNullChecks": true,
23 |     "strictPropertyInitialization": true,
24 |     "stripInternal": true,
25 |     "target": "ES2019"
26 |   }
27 | }
28 | 


--------------------------------------------------------------------------------
/test/cdk/functions/fromSqsToEventBridge.ts:
--------------------------------------------------------------------------------
 1 | import {
 2 |   EventBridgeClient,
 3 |   PutEventsCommand,
 4 | } from '@aws-sdk/client-eventbridge';
 5 | import { SQSEvent } from 'aws-lambda';
 6 | 
 7 | const eventBridgeClient = new EventBridgeClient({});
 8 | 
 9 | export const handler = async (event: SQSEvent) => {
10 |   const message = JSON.parse(event.Records[0].body);
11 | 
12 |   const command = new PutEventsCommand({
13 |     Entries: [
14 |       {
15 |         EventBusName: process.env.EB_NAME,
16 |         Detail: JSON.stringify(message),
17 |         DetailType: 'test',
18 |         Source: 'test-source',
19 |       },
20 |     ],
21 |   });
22 | 
23 |   await eventBridgeClient.send(command);
24 | 
25 |   console.log('Send to EventBridge');
26 | 
27 |   return { message: 'Hello ' + message.key1 };
28 | };
29 | 


--------------------------------------------------------------------------------
/doc/github.svg:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="utf-8"?>
2 | <svg   xmlns="http://www.w3.org/2000/svg" height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true">
3 |     <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z" fill="#FFFFFF"></path>
4 | </svg>
5 | 


--------------------------------------------------------------------------------
/.gitattributes:
--------------------------------------------------------------------------------
 1 | 
 2 | *.snap linguist-generated
 3 | /.eslintrc.yml linguist-generated
 4 | /.gitattributes linguist-generated
 5 | /.github/pull_request_template.md linguist-generated
 6 | /.github/workflows/build.yml linguist-generated
 7 | /.github/workflows/pull-request-lint.yml linguist-generated
 8 | /.github/workflows/release.yml linguist-generated
 9 | /.github/workflows/upgrade-main.yml linguist-generated
10 | /.gitignore linguist-generated
11 | /.mergify.yml linguist-generated
12 | /.npmignore linguist-generated
13 | /.prettierignore linguist-generated
14 | /.prettierrc.json linguist-generated
15 | /.projen/** linguist-generated
16 | /.projen/tasks.json linguist-generated
17 | /API.md linguist-generated
18 | /LICENSE linguist-generated
19 | /package-lock.json linguist-generated
20 | /package.json linguist-generated
21 | /tsconfig.dev.json linguist-generated


--------------------------------------------------------------------------------
/test/cdk/.projenrc.js.bak:
--------------------------------------------------------------------------------
 1 | const { awscdk } = require('projen');
 2 | 
 3 | const cdkVersion = '2.37.0';
 4 | 
 5 | const project = new awscdk.AwsCdkTypeScriptApp({
 6 |   cdkVersion,
 7 |   defaultReleaseBranch: 'main',
 8 |   name: 'serverless-spy-test-e2e',
 9 |   eslint: false,
10 |   packageManager: 'npm',
11 |   jestOptions: {
12 |     jestConfig: {
13 |       moduleNameMapper: {
14 |         ['^aws-cdk-lib/.warnings.jsii.js$']: '<rootDir>/node_modules/aws-cdk-lib/.warnings.jsii.js',
15 |       },
16 |     },
17 |   },
18 |   // deps: [],                /* Runtime dependencies of this module. */
19 |   // description: undefined,  /* The description is just a string that helps people understand the purpose of the package. */
20 |   // devDeps: [],             /* Build dependencies for this module. */
21 |   // packageName: undefined,  /* The "name" in package.json. */
22 | });
23 | project.synth();
24 | 


--------------------------------------------------------------------------------
/src/tsconfig.esm.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "module": "ES2022",
 4 |     "target": "ES2022",
 5 |     "lib": ["es2023"],
 6 |     "sourceMap": true,
 7 |     "moduleResolution": "node",
 8 |     "allowJs": true,
 9 |     "noImplicitAny": true,
10 |     "strictNullChecks": true,
11 |     "strict": true,
12 |     "allowSyntheticDefaultImports": true,
13 |     "esModuleInterop": true,
14 |     "declaration": false,
15 |     "emitDeclarationOnly": false,
16 |     "experimentalDecorators": true,
17 |     "strictPropertyInitialization": false,
18 |     "skipLibCheck": true,
19 |     "noEmit": true,
20 |     "baseUrl": ".",
21 |     "paths": {
22 |       "serverless-spy/*": ["../*"],
23 |       "serverless-spy": ["../"]
24 |     }
25 |   },
26 |   "include": ["src/**/*.ts", "test/**/*.ts"],
27 |   "exclude": ["cdk.out"],
28 |   "ts-node": {
29 |     "require": [
30 |       "tsconfig-paths/register"
31 |     ]
32 |   }
33 | }
34 | 


--------------------------------------------------------------------------------
/test/cdk/.gitignore:
--------------------------------------------------------------------------------
 1 | !/.gitattributes
 2 | !/.projen/tasks.json
 3 | !/.github/workflows/pull-request-lint.yml
 4 | !/package.json
 5 | !/LICENSE
 6 | !/.npmignore
 7 | logs
 8 | *.log
 9 | npm-debug.log*
10 | yarn-debug.log*
11 | yarn-error.log*
12 | lerna-debug.log*
13 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
14 | pids
15 | *.pid
16 | *.seed
17 | *.pid.lock
18 | lib-cov
19 | coverage
20 | *.lcov
21 | .nyc_output
22 | build/Release
23 | node_modules/
24 | jspm_packages/
25 | *.tsbuildinfo
26 | .eslintcache
27 | *.tgz
28 | .yarn-integrity
29 | .cache
30 | !/.projenrc.js
31 | /test-reports/
32 | junit.xml
33 | /coverage/
34 | !/.github/workflows/build.yml
35 | !/.mergify.yml
36 | !/.github/workflows/upgrade.yml
37 | !/.github/pull_request_template.md
38 | !/test/
39 | !/tsconfig.json
40 | !/tsconfig.dev.json
41 | !/src/
42 | /lib
43 | /dist/
44 | /assets/
45 | !/cdk.json
46 | /cdk.out/
47 | .cdk.staging/
48 | .parcel-cache/
49 | cdkExports.json


--------------------------------------------------------------------------------
/test/cdk/serverlessSpyEvents/ServerlessSpyEventsEsmLambda.ts:
--------------------------------------------------------------------------------
 1 | /* eslint-disable */
 2 | export class ServerlessSpyEvents {
 3 |   FunctionMyLambdaRequest: 'Function#MyLambda#Request' = 'Function#MyLambda#Request';
 4 |   FunctionMyLambdaError: 'Function#MyLambda#Error' = 'Function#MyLambda#Error';
 5 |   FunctionMyLambdaConsole: 'Function#MyLambda#Console' = 'Function#MyLambda#Console';
 6 |   FunctionMyLambdaResponse: 'Function#MyLambda#Response' = 'Function#MyLambda#Response';
 7 |   FunctionMyLambdaTestName2Request: 'Function#MyLambdaTestName2#Request' = 'Function#MyLambdaTestName2#Request';
 8 |   FunctionMyLambdaTestName2Error: 'Function#MyLambdaTestName2#Error' = 'Function#MyLambdaTestName2#Error';
 9 |   FunctionMyLambdaTestName2Console: 'Function#MyLambdaTestName2#Console' = 'Function#MyLambdaTestName2#Console';
10 |   FunctionMyLambdaTestName2Response: 'Function#MyLambdaTestName2#Response' = 'Function#MyLambdaTestName2#Response';
11 | }
12 | 


--------------------------------------------------------------------------------
/test/cdk/serverlessSpyEvents/ServerlessSpyEventsPythonLambda.ts:
--------------------------------------------------------------------------------
 1 | /* eslint-disable */
 2 | export class ServerlessSpyEvents {
 3 |   FunctionMyLambdaRequest: 'Function#MyLambda#Request' = 'Function#MyLambda#Request';
 4 |   FunctionMyLambdaError: 'Function#MyLambda#Error' = 'Function#MyLambda#Error';
 5 |   FunctionMyLambdaConsole: 'Function#MyLambda#Console' = 'Function#MyLambda#Console';
 6 |   FunctionMyLambdaResponse: 'Function#MyLambda#Response' = 'Function#MyLambda#Response';
 7 |   FunctionMyLambdaThatFailsRequest: 'Function#MyLambdaThatFails#Request' = 'Function#MyLambdaThatFails#Request';
 8 |   FunctionMyLambdaThatFailsError: 'Function#MyLambdaThatFails#Error' = 'Function#MyLambdaThatFails#Error';
 9 |   FunctionMyLambdaThatFailsConsole: 'Function#MyLambdaThatFails#Console' = 'Function#MyLambdaThatFails#Console';
10 |   FunctionMyLambdaThatFailsResponse: 'Function#MyLambdaThatFails#Response' = 'Function#MyLambdaThatFails#Response';
11 | }
12 | 


--------------------------------------------------------------------------------
/test/cdk/tsconfig.esm.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "module": "ES2022",
 4 |     "target": "ES2022",
 5 |     "lib": ["es2023"],
 6 |     "sourceMap": true,
 7 |     "moduleResolution": "node",
 8 |     "allowJs": true,
 9 |     "noImplicitAny": true,
10 |     "strictNullChecks": true,
11 |     "strict": true,
12 |     "allowSyntheticDefaultImports": true,
13 |     "esModuleInterop": true,
14 |     "declaration": false,
15 |     "emitDeclarationOnly": false,
16 |     "experimentalDecorators": true,
17 |     "strictPropertyInitialization": false,
18 |     "skipLibCheck": true,
19 |     "noEmit": true,
20 |     "baseUrl": ".",
21 |     "paths": {
22 |       "serverless-spy/*": ["../../*"],
23 |       "serverless-spy": ["../../"]
24 |     }
25 |   },
26 |   "include": ["src/**/*.ts", "test/**/*.ts"],
27 |   "exclude": ["cdk.out"],
28 |   "ts-node": {
29 |     "require": [
30 |       "tsconfig-paths/register"
31 |     ]
32 |   }
33 | }
34 | 


--------------------------------------------------------------------------------
/functions/onConnect.ts:
--------------------------------------------------------------------------------
 1 | import { DynamoDBClient, PutItemCommand } from '@aws-sdk/client-dynamodb';
 2 | import { APIGatewayEvent } from 'aws-lambda';
 3 | import { envVariableNames } from '../src/common/envVariableNames';
 4 | 
 5 | const ddb = new DynamoDBClient({
 6 |   region: process.env.AWS_REGION,
 7 | });
 8 | 
 9 | exports.handler = async (event: APIGatewayEvent) => {
10 |   console.log('EVENT', JSON.stringify(event));
11 | 
12 |   const putParams = new PutItemCommand({
13 |     TableName: process.env[envVariableNames.SSPY_WS_TABLE_NAME] as string,
14 |     Item: {
15 |       connectionId: { S: event.requestContext.connectionId! },
16 |     },
17 |   });
18 | 
19 |   try {
20 |     await ddb.send(putParams);
21 |   } catch (err) {
22 |     console.error(err);
23 |     return {
24 |       statusCode: 500,
25 |       body: 'Failed to connect: ' + JSON.stringify(err),
26 |     };
27 |   }
28 | 
29 |   return { statusCode: 200, body: 'Connected.' };
30 | };
31 | 


--------------------------------------------------------------------------------
/functions/onDisconnect.ts:
--------------------------------------------------------------------------------
 1 | import { DeleteItemCommand, DynamoDBClient } from '@aws-sdk/client-dynamodb';
 2 | import { APIGatewayEvent } from 'aws-lambda';
 3 | import { envVariableNames } from '../src/common/envVariableNames';
 4 | 
 5 | const ddb = new DynamoDBClient({
 6 |   region: process.env.AWS_REGION,
 7 | });
 8 | export const handler = async (event: APIGatewayEvent) => {
 9 |   console.log('EVENT', JSON.stringify(event));
10 | 
11 |   const deleteParams = new DeleteItemCommand({
12 |     TableName: process.env[envVariableNames.SSPY_WS_TABLE_NAME],
13 |     Key: {
14 |       connectionId: { S: event.requestContext.connectionId! },
15 |     },
16 |   });
17 | 
18 |   try {
19 |     await ddb.send(deleteParams);
20 |   } catch (err) {
21 |     console.error(err);
22 |     return {
23 |       statusCode: 500,
24 |       body: 'Failed to disconnect: ' + JSON.stringify(err),
25 |     };
26 |   }
27 | 
28 |   return { statusCode: 200, body: 'Disconnected.' };
29 | };
30 | 


--------------------------------------------------------------------------------
/test/cdk/serverlessSpyEvents/ServerlessSpyEventsSqsToLambda.ts:
--------------------------------------------------------------------------------
 1 | /* eslint-disable */
 2 | export class ServerlessSpyEvents {
 3 |   FunctionMyLambdaRequest: 'Function#MyLambda#Request' = 'Function#MyLambda#Request';
 4 |   FunctionMyLambdaError: 'Function#MyLambda#Error' = 'Function#MyLambda#Error';
 5 |   FunctionMyLambdaConsole: 'Function#MyLambda#Console' = 'Function#MyLambda#Console';
 6 |   FunctionMyLambdaResponse: 'Function#MyLambda#Response' = 'Function#MyLambda#Response';
 7 |   SqsMyQueue: 'Sqs#MyQueue' = 'Sqs#MyQueue';
 8 |   FunctionMyPythonLambdaRequest: 'Function#MyPythonLambda#Request' = 'Function#MyPythonLambda#Request';
 9 |   FunctionMyPythonLambdaError: 'Function#MyPythonLambda#Error' = 'Function#MyPythonLambda#Error';
10 |   FunctionMyPythonLambdaConsole: 'Function#MyPythonLambda#Console' = 'Function#MyPythonLambda#Console';
11 |   FunctionMyPythonLambdaResponse: 'Function#MyPythonLambda#Response' = 'Function#MyPythonLambda#Response';
12 |   SqsMyQueue2: 'Sqs#MyQueue2' = 'Sqs#MyQueue2';
13 | }
14 | 


--------------------------------------------------------------------------------
/test/cdk/serverlessSpyEvents/ServerlessSpyEventsDefaultEventBridgeToLambda.ts:
--------------------------------------------------------------------------------
 1 | /* eslint-disable */
 2 | export class ServerlessSpyEvents {
 3 |   FunctionMyLambdaRequest: 'Function#MyLambda#Request' = 'Function#MyLambda#Request';
 4 |   FunctionMyLambdaError: 'Function#MyLambda#Error' = 'Function#MyLambda#Error';
 5 |   FunctionMyLambdaConsole: 'Function#MyLambda#Console' = 'Function#MyLambda#Console';
 6 |   FunctionMyLambdaResponse: 'Function#MyLambda#Response' = 'Function#MyLambda#Response';
 7 |   FunctionMyPythonLambdaRequest: 'Function#MyPythonLambda#Request' = 'Function#MyPythonLambda#Request';
 8 |   FunctionMyPythonLambdaError: 'Function#MyPythonLambda#Error' = 'Function#MyPythonLambda#Error';
 9 |   FunctionMyPythonLambdaConsole: 'Function#MyPythonLambda#Console' = 'Function#MyPythonLambda#Console';
10 |   FunctionMyPythonLambdaResponse: 'Function#MyPythonLambda#Response' = 'Function#MyPythonLambda#Response';
11 |   EventBridgeRuleDefaultMyRule: 'EventBridgeRule#Default#MyRule' = 'EventBridgeRule#Default#MyRule';
12 | }
13 | 


--------------------------------------------------------------------------------
/test/cdk/functions/toSnsAndDynamoDb.ts:
--------------------------------------------------------------------------------
 1 | import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
 2 | import {
 3 |   MessageAttributeValue,
 4 |   PublishCommand,
 5 |   SNSClient,
 6 | } from '@aws-sdk/client-sns';
 7 | import { DynamoDBDocumentClient, PutCommand } from '@aws-sdk/lib-dynamodb';
 8 | 
 9 | const snsClient = new SNSClient({});
10 | const ddbDocClient = DynamoDBDocumentClient.from(new DynamoDBClient({}));
11 | 
12 | export const handler = async (event: any) => {
13 |   const params = new PublishCommand({
14 |     Message: JSON.stringify(event),
15 |     TopicArn: process.env.SNS_TOPIC_ARN,
16 |     MessageAttributes: {
17 |       test: <MessageAttributeValue>{ StringValue: 'test', DataType: 'String' },
18 |     },
19 |   });
20 | 
21 |   await snsClient.send(params);
22 | 
23 |   const putCommand = new PutCommand({
24 |     TableName: process.env.DYNAMODB_TABLE_NAME!,
25 |     Item: {
26 |       pk: event.id,
27 |       ...event,
28 |     },
29 |   });
30 | 
31 |   await ddbDocClient.send(putCommand);
32 | 
33 |   return event;
34 | };
35 | 


--------------------------------------------------------------------------------
/test/cdk/src/sqsStack.ts:
--------------------------------------------------------------------------------
 1 | import { Stack, CfnOutput } from 'aws-cdk-lib';
 2 | import * as sqs from 'aws-cdk-lib/aws-sqs';
 3 | import { Construct } from 'constructs';
 4 | import { GenerateSpyEventsFileProps } from './GenerateSpyEventsFileProps';
 5 | import { ServerlessSpy } from '../../../src/ServerlessSpy';
 6 | 
 7 | export class SqsStack extends Stack {
 8 |   constructor(scope: Construct, id: string, props: GenerateSpyEventsFileProps) {
 9 |     super(scope, id, props);
10 | 
11 |     const queue = new sqs.Queue(this, 'MyQueue');
12 | 
13 |     const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
14 |       generateSpyEventsFileLocation: props.generateSpyEventsFile
15 |         ? 'serverlessSpyEvents/ServerlessSpyEventsSqs.ts'
16 |         : undefined,
17 |       debugMode: true,
18 |       spySqsWithNoSubscriptionAndDropAllMessages: true,
19 |     });
20 | 
21 |     serverlessSpy.spy();
22 | 
23 |     new CfnOutput(this, `QueueUrl${serverlessSpy.getConstructName(queue)}`, {
24 |       value: queue.queueUrl,
25 |     });
26 |   }
27 | }
28 | 


--------------------------------------------------------------------------------
/test/cdk/tsconfig.dev.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "alwaysStrict": true,
 4 |     "declaration": true,
 5 |     "esModuleInterop": true,
 6 |     "experimentalDecorators": true,
 7 |     "inlineSourceMap": true,
 8 |     "inlineSources": true,
 9 |     "lib": [
10 |       "es2019"
11 |     ],
12 |     "module": "CommonJS",
13 |     "noEmitOnError": false,
14 |     "noFallthroughCasesInSwitch": true,
15 |     "noImplicitAny": true,
16 |     "noImplicitReturns": true,
17 |     "noImplicitThis": true,
18 |     "noUnusedLocals": true,
19 |     "noUnusedParameters": true,
20 |     "resolveJsonModule": true,
21 |     "strict": true,
22 |     "strictNullChecks": true,
23 |     "strictPropertyInitialization": true,
24 |     "stripInternal": true,
25 |     "target": "ES2019",
26 |     "paths": {
27 |       "serverless-spy/*": ["../../*"],
28 |       "serverless-spy": ["../../"]
29 |     },
30 |   },
31 |   "include": [
32 |     ".projenrc.js",
33 |     "src/**/*.ts",
34 |     "test/**/*.ts"
35 |   ],
36 |   "exclude": [
37 |     "node_modules"
38 |   ]
39 | }
40 | 


--------------------------------------------------------------------------------
/_layouts/default.html:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: home
 3 | ---
 4 | 
 5 | <!doctype html>
 6 | <!--
 7 |   Minimal Mistakes Jekyll Theme 4.24.0 by Michael Rose
 8 |   Copyright 2013-2020 Michael Rose - mademistakes.com | @mmistakes
 9 |   Free for personal and commercial use under the MIT license
10 |   https://github.com/mmistakes/minimal-mistakes/blob/master/LICENSE
11 | -->
12 | <html lang="{{ site.locale | slice: 0,2 | default: " en" }}" class="no-js">
13 | 
14 | <head>
15 |   {% include head.html %}
16 |   {% include head/custom.html %}
17 | </head>
18 | 
19 | <body
20 |   class="layout--{{ page.layout | default: layout.layout }}{% if page.classes or layout.classes %}{{ page.classes | default: layout.classes | join: ' ' | prepend: ' ' }}{% endif %}">
21 |   {% include_cached skip-links.html %}
22 | 
23 |   <div class="initial-content">
24 |     {{ content }}
25 |   </div>
26 | 
27 |   {% if site.search == true %}
28 |   <div class="search-content">
29 |     {% include_cached search/search_form.html %}
30 |   </div>
31 |   {% endif %}
32 | 
33 |   {% include scripts.html %}
34 | 
35 | </body>
36 | 
37 | </html>


--------------------------------------------------------------------------------
/test/cdk/serverlessSpyEvents/ServerlessSpyEventsEventBridgeToLambda.ts:
--------------------------------------------------------------------------------
 1 | /* eslint-disable */
 2 | export class ServerlessSpyEvents {
 3 |   EventBridgeMyEventBus: 'EventBridge#MyEventBus' = 'EventBridge#MyEventBus';
 4 |   FunctionMyLambdaRequest: 'Function#MyLambda#Request' = 'Function#MyLambda#Request';
 5 |   FunctionMyLambdaError: 'Function#MyLambda#Error' = 'Function#MyLambda#Error';
 6 |   FunctionMyLambdaConsole: 'Function#MyLambda#Console' = 'Function#MyLambda#Console';
 7 |   FunctionMyLambdaResponse: 'Function#MyLambda#Response' = 'Function#MyLambda#Response';
 8 |   FunctionMyPythonLambdaRequest: 'Function#MyPythonLambda#Request' = 'Function#MyPythonLambda#Request';
 9 |   FunctionMyPythonLambdaError: 'Function#MyPythonLambda#Error' = 'Function#MyPythonLambda#Error';
10 |   FunctionMyPythonLambdaConsole: 'Function#MyPythonLambda#Console' = 'Function#MyPythonLambda#Console';
11 |   FunctionMyPythonLambdaResponse: 'Function#MyPythonLambda#Response' = 'Function#MyPythonLambda#Response';
12 |   EventBridgeRuleMyEventBusMyRule: 'EventBridgeRule#MyEventBus#MyRule' = 'EventBridgeRule#MyEventBus#MyRule';
13 | }
14 | 


--------------------------------------------------------------------------------
/doc/S3.md:
--------------------------------------------------------------------------------
 1 | # S3
 2 | 
 3 | S3 integration subscribes to S3 notification and intercept events. The event has the following properties:
 4 |  - `eventName` (`s3:ObjectCreated:Put`, `s3:ObjectCreated:Post`, `s3:ObjectRemoved:Delete`, ...) 
 5 |  - `key` - file name
 6 | 
 7 | You can not receive file content (it could be gigabytes 🚚). You have to read it yourself.
 8 | 
 9 | Basic example:
10 | 
11 | ```typescript
12 | await serverlessSpyListener.waitForS3MyBucket()
13 | ```
14 | 
15 | You can use conditions to wait for a particular event.
16 | 
17 | ```typescript
18 | await serverlessSpyListener.waitForS3MyBucket({
19 |   condition: (d) => d.key === `${id}.json`,
20 | })
21 | ```
22 | 
23 | **⚠️Warning: DynamoDB can have only one Lambda subscribed to notification. If your primary stack already uses it, you can not use S3 interception. You should [exclude S3 interception in your CDK stack](./CDK_construct.md):**
24 | ```typescript
25 | serverlessSpy.spy({
26 |   spyS3: false,
27 | });
28 | ```
29 | 
30 | Check [this test](https://github.com/ServerlessLife/serverless-spy/blob/main/test/cdk/test/lambdaToS3.test.ts){:target="_blank"}.


--------------------------------------------------------------------------------
/listener/createServerlessSpyListener.ts:
--------------------------------------------------------------------------------
 1 | import { ServerlessSpyListenerParams } from './ServerlessSpyListenerParams';
 2 | import { WsListener } from './WsListener';
 3 | 
 4 | export async function createServerlessSpyListener<TSpyEvents>(
 5 |   params: Omit<ServerlessSpyListenerParams, 'scope'>
 6 | ) {
 7 |   const wsListener = new WsListener<TSpyEvents>();
 8 |   let resolve, reject: ((value: void | PromiseLike<void>) => void) | undefined;
 9 |   const promise = new Promise<void>((res, rej) => {
10 |     resolve = res;
11 |     reject = rej;
12 |   });
13 |   const [serverlessSpyWsUrl, scope] = params.serverlessSpyWsUrl.split('/');
14 |   if (!scope) {
15 |     throw Error(
16 |       `ServerlessSpyWsUrl was missing rootStack: ${params.serverlessSpyWsUrl}`
17 |     );
18 |   }
19 |   await wsListener.start({
20 |     ...params,
21 |     serverlessSpyWsUrl,
22 |     scope,
23 |     connectionOpenResolve: params.connectionOpenResolve || resolve,
24 |     connectionOpenReject: params.connectionOpenReject || reject,
25 |   });
26 | 
27 |   const proxy = wsListener.createProxy();
28 |   await promise;
29 |   return proxy;
30 | }
31 | 


--------------------------------------------------------------------------------
/doc/SQS.md:
--------------------------------------------------------------------------------
 1 | # SQS
 2 | 
 3 | Basic example:
 4 | 
 5 | ```typescript
 6 | await serverlessSpyListener.waitForSqsMyQueue();
 7 | ```
 8 | 
 9 | You can use conditions to wait for a particular event. You can also use generic (`TestData`) to strongly type the event.
10 | 
11 | ```typescript
12 | await serverlessSpyListener.waitForSqsMyQueue<TestData>({
13 |   condition: (d) => d.body.id === id,
14 | });
15 | ```
16 | 
17 | Interception of SQS events intercepts events when Lambda consumes them. **⚠️If no Lambda is subscribed to SQS, ServerlessSpy can not intercept events.** If you still want to catch them enable `spySqsWithNoSubscriptionAndDropAllMessages` when [creating ServerlessSpy in CDK](./CDK_construct.md). With this flag on, an additional Lambda will be created that will consume messages and throw them away (= lost forever ⛔). Of course, that is undesirable in most cases, but it could be useful for some tests.
18 | 
19 | Check [this](https://github.com/ServerlessLife/serverless-spy/blob/main/test/cdk/test/sqs.test.ts){:target="_blank"} and 
20 | [this](https://github.com/ServerlessLife/serverless-spy/blob/main/test/cdk/test/lambdaToSqs.test.ts){:target="_blank"} test.


--------------------------------------------------------------------------------
/doc/EventBridge.md:
--------------------------------------------------------------------------------
 1 | # EventBridge
 2 | 
 3 | EventBridge integration has two types of methods:
 4 |  - `waitForEventBridgeXxx()` - Intercept all events received by EventBridge.
 5 |  - `waitForEventBridgeRuleXxxYyy` - Intercept only events received by Rule.
 6 | 
 7 | Basic example:
 8 | 
 9 | ```typescript
10 | await serverlessSpyListener.waitForEventBridgeMyEventBus<TestData>();
11 | 
12 | await serverlessSpyListener.waitForEventBridgeRuleMyEventBusMyRule<TestData>();
13 | ```
14 | 
15 | You can use conditions to wait for a particular event. You can also use generic (`TestData`) to strongly type the event.
16 | 
17 | ```typescript     
18 | await serverlessSpyListener.waitForEventBridgeMyEventBus<TestData>({
19 |   condition: (d) => d.detail.id === id,
20 | });
21 | 
22 | await serverlessSpyListener.waitForEventBridgeRuleMyEventBusMyRule<TestData>({
23 |   condition: (d) => d.detail.id === id,
24 | });
25 | ```
26 | Check [this](https://github.com/ServerlessLife/serverless-spy/blob/main/test/cdk/test/eventBridgeToLambda.test.ts){:target="_blank"} and 
27 | [this](https://github.com/ServerlessLife/serverless-spy/blob/main/test/cdk/test/lambdaToEventBridge.test.ts){:target="_blank"} test.


--------------------------------------------------------------------------------
/src/common/envVariableNames.ts:
--------------------------------------------------------------------------------
 1 | //this file is not under root -> common folder because jsii does not allow
 2 | //changing tsconfing.json to remove rootDir property
 3 | 
 4 | export enum envVariableNames {
 5 |   /**
 6 |    * Note that the function is subscribed to SQS, so we need to send spy events as it comes from SQS.
 7 |    */
 8 |   SSPY_SUBSCRIBED_TO_SQS = 'SSPY_SUBSCRIBED_TO_SQS',
 9 | 
10 |   /**
11 |    * Mapping of resource ARNs to service keys
12 |    */
13 |   SSPY_INFRA_MAPPING = 'SSPY_INFRA_MAPPING',
14 | 
15 |   /**
16 |    * Web socket endpoint for sending and receiving spy events.
17 |    */
18 |   SSPY_WS_ENDPOINT = 'SSPY_WS_ENDPOINT',
19 | 
20 |   SSPY_FUNCTION_NAME = 'SSPY_FUNCTION_NAME',
21 | 
22 |   /**
23 |    * DynamoDB table name that stores active websocket connections.
24 |    */
25 |   SSPY_WS_TABLE_NAME = 'SSPY_WS_TABLE_NAME',
26 | 
27 |   /**
28 |    * Log debugging details.
29 |    */
30 |   SSPY_DEBUG = 'SSPY_DEBUG',
31 | 
32 |   /**
33 |    * The root stack
34 |    */
35 |   SSPY_ROOT_STACK = 'SSPY_ROOT_STACK',
36 | 
37 |   /**
38 |    * The endpoint url for AWS IoT for the account
39 |    */
40 |   SSPY_IOT_ENDPOINT = 'SSPY_IOT_ENDPOINT',
41 | }
42 | 


--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "outDir": "lib",
 4 |     "rootDir": "src",
 5 |     "declarationMap": false,
 6 |     "inlineSourceMap": true,
 7 |     "inlineSources": true,
 8 |     "alwaysStrict": true,
 9 |     "declaration": true,
10 |     "experimentalDecorators": true,
11 |     "incremental": true,
12 |     "lib": [
13 |       "es2020"
14 |     ],
15 |     "module": "commonjs",
16 |     "noEmitOnError": true,
17 |     "noFallthroughCasesInSwitch": true,
18 |     "noImplicitAny": true,
19 |     "noImplicitReturns": true,
20 |     "noImplicitThis": true,
21 |     "noUnusedLocals": true,
22 |     "noUnusedParameters": true,
23 |     "resolveJsonModule": true,
24 |     "skipLibCheck": true,
25 |     "strict": true,
26 |     "strictNullChecks": true,
27 |     "strictPropertyInitialization": true,
28 |     "stripInternal": false,
29 |     "target": "es2020",
30 |     "composite": false,
31 |     "tsBuildInfoFile": "lib/tsconfig.tsbuildinfo"
32 |   },
33 |   "include": [
34 |     "src/**/*.ts"
35 |   ],
36 |   "exclude": [
37 |     "node_modules"
38 |   ],
39 |   "_generated_by_jsii_": "Generated by jsii - safe to delete, and ideally should be in .gitignore"
40 | }


--------------------------------------------------------------------------------
/doc/SNS.md:
--------------------------------------------------------------------------------
 1 | # SNS
 2 | 
 3 | SNS integration has two types of methods:
 4 |  - `waitForSnsTopicXxx()` - Intercept all events received by SNS.
 5 |  - `waitForSnsSubscriptionXxxYyy` - Intercept all events received by SNS subscription. If the subscription has no filters, it is the same as the previous method.
 6 | 
 7 | Basic example:
 8 | 
 9 | ```typescript
10 | await serverlessSpyListener.waitForSnsTopicMyTopic();
11 | 
12 | await serverlessSpyListener.waitForSnsSubscriptionMyTopicMyLambda();    
13 | ```
14 | 
15 | You can use conditions to wait for a particular event. You can also use generic (`TestData`) to strongly type the event.
16 | 
17 | ```typescript    
18 | await serverlessSpyListener.waitForSnsTopicMyTopic<TestData>({
19 |   condition: (d) => d.message.id === id,
20 | });
21 | 
22 | await serverlessSpyListener.waitForSnsSubscriptionMyTopicMyLambda<TestData>({
23 |     condition: (d) => d.message.id === id,
24 | });    
25 | ```
26 | Check [this](https://github.com/ServerlessLife/serverless-spy/blob/main/test/cdk/test/lambdaToSnS.test.ts){:target="_blank"} and 
27 | [this](https://github.com/ServerlessLife/serverless-spy/blob/main/test/cdk/test/snsToLambda.test.ts){:target="_blank"} test.


--------------------------------------------------------------------------------
/test/cdk/serverlessSpyEvents/ServerlessSpyEventsSnsToLambda.ts:
--------------------------------------------------------------------------------
 1 | /* eslint-disable */
 2 | export class ServerlessSpyEvents {
 3 |   SnsTopicMyTopic: 'SnsTopic#MyTopic' = 'SnsTopic#MyTopic';
 4 |   FunctionMyLambdaRequest: 'Function#MyLambda#Request' = 'Function#MyLambda#Request';
 5 |   FunctionMyLambdaError: 'Function#MyLambda#Error' = 'Function#MyLambda#Error';
 6 |   FunctionMyLambdaConsole: 'Function#MyLambda#Console' = 'Function#MyLambda#Console';
 7 |   FunctionMyLambdaResponse: 'Function#MyLambda#Response' = 'Function#MyLambda#Response';
 8 |   SnsSubscriptionMyTopicMyLambda: 'SnsSubscription#MyTopic#MyLambda' = 'SnsSubscription#MyTopic#MyLambda';
 9 |   FunctionMyPythonLambdaRequest: 'Function#MyPythonLambda#Request' = 'Function#MyPythonLambda#Request';
10 |   FunctionMyPythonLambdaError: 'Function#MyPythonLambda#Error' = 'Function#MyPythonLambda#Error';
11 |   FunctionMyPythonLambdaConsole: 'Function#MyPythonLambda#Console' = 'Function#MyPythonLambda#Console';
12 |   FunctionMyPythonLambdaResponse: 'Function#MyPythonLambda#Response' = 'Function#MyPythonLambda#Response';
13 |   SnsSubscriptionMyTopicMyPythonLambda: 'SnsSubscription#MyTopic#MyPythonLambda' = 'SnsSubscription#MyTopic#MyPythonLambda';
14 | }
15 | 


--------------------------------------------------------------------------------
/test/cdk/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     //"rootDir": "src",
 4 |     "outDir": "lib",
 5 |     "alwaysStrict": true,
 6 |     "declaration": true,
 7 |     "esModuleInterop": true,
 8 |     "experimentalDecorators": true,
 9 |     "inlineSourceMap": true,
10 |     "inlineSources": true,
11 |     "lib": ["es2019"],
12 |     "module": "CommonJS",
13 |     "noEmitOnError": false,
14 |     "noFallthroughCasesInSwitch": true,
15 |     "noImplicitAny": true,
16 |     "noImplicitReturns": true,
17 |     "noImplicitThis": true,
18 |     "noUnusedLocals": true,
19 |     "noUnusedParameters": true,
20 |     "resolveJsonModule": true,
21 |     "strict": true,
22 |     "strictNullChecks": true,
23 |     "strictPropertyInitialization": true,
24 |     "stripInternal": true,
25 |     "target": "ES2019",
26 |     "paths": {
27 |       "serverless-spy/*": ["../../*"],
28 |       "serverless-spy": ["../../"]
29 |     },
30 |   },
31 |   "include": ["src/**/*.ts", "test/**/*.ts"],
32 |   "exclude": ["cdk.out"],
33 |   "ts-node": {
34 |     "require": [
35 |       "tsconfig-paths/register"
36 |     ]
37 |   },
38 |   "//": "~~ Generated by projen. To modify, edit .projenrc.js and run \"npx projen\"."
39 | }
40 | 


--------------------------------------------------------------------------------
/test/cdk/serverlessSpyEvents/SingletonLambdaFunction.ts:
--------------------------------------------------------------------------------
1 | /* eslint-disable */
2 | export class ServerlessSpyEvents {
3 |   S3SingletonLambdaFunctionBucket3fc2bca1567b4c3eA1ba34af41a09dcc: 'S3#SingletonLambdaFunctionBucket3fc2bca1567b4c3eA1ba34af41a09dcc' = 'S3#SingletonLambdaFunctionBucket3fc2bca1567b4c3eA1ba34af41a09dcc';
4 |   FunctionCustomCDKBucketDeployment8693BB64968944B69AAFB0CC9EB8756CRequest: 'Function#CustomCDKBucketDeployment8693BB64968944B69AAFB0CC9EB8756C#Request' = 'Function#CustomCDKBucketDeployment8693BB64968944B69AAFB0CC9EB8756C#Request';
5 |   FunctionCustomCDKBucketDeployment8693BB64968944B69AAFB0CC9EB8756CError: 'Function#CustomCDKBucketDeployment8693BB64968944B69AAFB0CC9EB8756C#Error' = 'Function#CustomCDKBucketDeployment8693BB64968944B69AAFB0CC9EB8756C#Error';
6 |   FunctionCustomCDKBucketDeployment8693BB64968944B69AAFB0CC9EB8756CConsole: 'Function#CustomCDKBucketDeployment8693BB64968944B69AAFB0CC9EB8756C#Console' = 'Function#CustomCDKBucketDeployment8693BB64968944B69AAFB0CC9EB8756C#Console';
7 |   FunctionCustomCDKBucketDeployment8693BB64968944B69AAFB0CC9EB8756CResponse: 'Function#CustomCDKBucketDeployment8693BB64968944B69AAFB0CC9EB8756C#Response' = 'Function#CustomCDKBucketDeployment8693BB64968944B69AAFB0CC9EB8756C#Response';
8 | }
9 | 


--------------------------------------------------------------------------------
/extension/aws/HttpResponseStream.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 3 |  *
 4 |  * This code was copied from:
 5 |  * https://github.com/aws/aws-lambda-nodejs-runtime-interface-client
 6 |  *
 7 |  * HttpResponseStream is NOT used by the runtime.
 8 |  * It is only exposed in the `awslambda` variable for customers to use.
 9 |  */
10 | 
11 | 'use strict';
12 | 
13 | const METADATA_PRELUDE_CONTENT_TYPE =
14 |   'application/vnd.awslambda.http-integration-response';
15 | const DELIMITER_LEN = 8;
16 | 
17 | // Implements the application/vnd.awslambda.http-integration-response content type.
18 | class HttpResponseStream {
19 |   static from(underlyingStream, prelude) {
20 |     underlyingStream.setContentType(METADATA_PRELUDE_CONTENT_TYPE);
21 | 
22 |     // JSON.stringify is required. NULL byte is not allowed in metadataPrelude.
23 |     const metadataPrelude = JSON.stringify(prelude);
24 | 
25 |     underlyingStream._onBeforeFirstWrite = (write) => {
26 |       write(metadataPrelude);
27 | 
28 |       // Write 8 null bytes after the JSON prelude.
29 |       write(new Uint8Array(DELIMITER_LEN));
30 |     };
31 | 
32 |     return underlyingStream;
33 |   }
34 | }
35 | 
36 | module.exports.HttpResponseStream = HttpResponseStream;
37 | 


--------------------------------------------------------------------------------
/_layouts/archive.html:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: default
 3 | ---
 4 | 
 5 | {% if page.header.overlay_color or page.header.overlay_image or page.header.image %}
 6 | {% include page__hero.html %}
 7 | {% elsif page.header.video.id and page.header.video.provider %}
 8 | {% include page__hero_video.html %}
 9 | {% endif %}
10 | 
11 | {% if page.url != "/" and site.breadcrumbs %}
12 | {% unless paginator %}
13 | {% include breadcrumbs.html %}
14 | {% endunless %}
15 | {% endif %}
16 | 
17 | <div id="main" role="main">
18 |   {% include sidebar.html %}
19 | 
20 |   <div class="archive">
21 |     {% unless page.header.overlay_color or page.header.overlay_image %}
22 |     <p><a href="../"><img src="/logo/full_logo_white.svg" alt="ServerlessSpy"></a></p>
23 |     <div class="link-author">
24 |       <h2>
25 |         <a class="link-author" href="https://www.serverlesslife.com/about.html">Marko (ServerlessLife)</a>
26 |         <a href="https://www.serverlesslife.com/">
27 |           <img class="logo-serverlesslife" src="/logo/serverlesslife_logo_invert.png">
28 |         </a>
29 |         <a href="https://github.com/ServerlessLife/serverless-spy">
30 |           <img class="logo-serverlesslife" src="/doc/github.svg">
31 |         </a>
32 |       </h2>
33 |     </div>
34 |     {% endunless %}
35 |     {{ content }}
36 |   </div>
37 | </div>


--------------------------------------------------------------------------------
/cli/style.css:
--------------------------------------------------------------------------------
 1 | body {
 2 |   font-size: 14px;
 3 |   line-height: 1.2;
 4 |   padding-top: 10px;
 5 | }
 6 | 
 7 | .col-form-label {
 8 |   line-height: 1.2;
 9 |   flex: 0 0 0% !important;
10 | }
11 | 
12 | .form-select {
13 |   font-size: 14px;
14 |   line-height: 1.2;
15 |   flex: 0 0 0% !important;
16 |   align-content: flex-start
17 | }
18 | 
19 | 
20 | .table {
21 |   width: 100%;
22 |   table-layout: fixed;
23 | }
24 | 
25 | .table td {
26 |   text-overflow: ellipsis;
27 |   white-space: nowrap;
28 | }
29 | 
30 | .col-time {
31 |   width: 185px;
32 | }
33 | 
34 | .col-servicekey {
35 |   width: 400px;  
36 | }
37 | 
38 | .col-servicekey .serviceKey {  
39 |   overflow: hidden;
40 |   text-overflow: ellipsis;
41 | }
42 | 
43 | .col-data .data {  
44 |   overflow: hidden;
45 |   text-overflow: ellipsis;
46 |   font-family: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;;
47 |   font-size: 12px;
48 | } 
49 | 
50 | .aws-icon {
51 |   width: 16px;
52 |   margin-top: -2px;
53 |   margin-right: 5px;
54 |   display: inline;
55 | }
56 | 
57 | /* .icon-subscription {
58 |   position: absolute;
59 |   margin-left: 9px;
60 |   font-size: 11px;
61 |   margin-top: 8px;
62 | } */
63 | 
64 | .icon-linked {
65 |   padding-left: 3px;
66 |   padding-right: 4px;
67 | }
68 | 
69 | .logo {
70 |   width: 400px;
71 | }


--------------------------------------------------------------------------------
/test/cdk/serverlessSpyEvents/ServerlessSpyEventsLambda.ts:
--------------------------------------------------------------------------------
 1 | /* eslint-disable */
 2 | export class ServerlessSpyEvents {
 3 |   FunctionMyLambdaRequest: 'Function#MyLambda#Request' = 'Function#MyLambda#Request';
 4 |   FunctionMyLambdaError: 'Function#MyLambda#Error' = 'Function#MyLambda#Error';
 5 |   FunctionMyLambdaConsole: 'Function#MyLambda#Console' = 'Function#MyLambda#Console';
 6 |   FunctionMyLambdaResponse: 'Function#MyLambda#Response' = 'Function#MyLambda#Response';
 7 |   FunctionMyLambdaTestName2Request: 'Function#MyLambdaTestName2#Request' = 'Function#MyLambdaTestName2#Request';
 8 |   FunctionMyLambdaTestName2Error: 'Function#MyLambdaTestName2#Error' = 'Function#MyLambdaTestName2#Error';
 9 |   FunctionMyLambdaTestName2Console: 'Function#MyLambdaTestName2#Console' = 'Function#MyLambdaTestName2#Console';
10 |   FunctionMyLambdaTestName2Response: 'Function#MyLambdaTestName2#Response' = 'Function#MyLambdaTestName2#Response';
11 |   FunctionMyLambdaThatFailsRequest: 'Function#MyLambdaThatFails#Request' = 'Function#MyLambdaThatFails#Request';
12 |   FunctionMyLambdaThatFailsError: 'Function#MyLambdaThatFails#Error' = 'Function#MyLambdaThatFails#Error';
13 |   FunctionMyLambdaThatFailsConsole: 'Function#MyLambdaThatFails#Console' = 'Function#MyLambdaThatFails#Console';
14 |   FunctionMyLambdaThatFailsResponse: 'Function#MyLambdaThatFails#Response' = 'Function#MyLambdaThatFails#Response';
15 | }
16 | 


--------------------------------------------------------------------------------
/.projenrc.js.bak:
--------------------------------------------------------------------------------
 1 | const { awscdk } = require('projen');
 2 | 
 3 | const cdkVersion = '2.37.1';
 4 | 
 5 | const project = new awscdk.AwsCdkConstructLibrary({
 6 |   author: 'Marko (ServerlessLife.com)',
 7 |   authorAddress: 'marko@serverlesslife.com',
 8 |   cdkVersion,
 9 |   defaultReleaseBranch: 'main',
10 |   name: 'serverless-spy',
11 |   repositoryUrl: 'git@github.com:ServerlessLife/serverless-spy.git',
12 |   deps: [
13 |     `@aws-cdk/aws-apigatewayv2-alpha@${cdkVersion}-alpha.0`,
14 |     `@aws-cdk/aws-apigatewayv2-integrations-alpha@${cdkVersion}-alpha.0`,
15 |   ],
16 |   eslint: true,
17 |   eslintOptions: {
18 |     yaml: true,
19 |   },
20 |   packageManager: 'npm',
21 |   prettier: true,
22 |   prettierOptions: {
23 |     settings: {
24 |       useTabs: false,
25 |       singleQuote: true,
26 |     },
27 |   },
28 |   jestOptions: {
29 |     jestConfig: {
30 |       moduleNameMapper: {
31 |         ['^aws-cdk-lib/.warnings.jsii.js$']: '<rootDir>/node_modules/aws-cdk-lib/.warnings.jsii.js',
32 |       },
33 |     },
34 |   },
35 | 
36 |   // deps: [],                /* Runtime dependencies of this module. */
37 |   // description: undefined,  /* The description is just a string that helps people understand the purpose of the package. */
38 |   // devDeps: [],             /* Build dependencies for this module. */
39 |   // packageName: undefined,  /* The "name" in package.json. */
40 | });
41 | project.synth();
42 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | !/.gitattributes
 2 | !/.projen/tasks.json
 3 | !/.github/workflows/pull-request-lint.yml
 4 | !/package.json
 5 | !/.npmignore
 6 | logs
 7 | *.log
 8 | npm-debug.log*
 9 | yarn-debug.log*
10 | yarn-error.log*
11 | lerna-debug.log*
12 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
13 | pids
14 | *.pid
15 | *.seed
16 | *.pid.lock
17 | lib-cov
18 | coverage
19 | *.lcov
20 | .nyc_output
21 | build/Release
22 | node_modules/
23 | jspm_packages/
24 | *.tsbuildinfo
25 | .eslintcache
26 | *.tgz
27 | .yarn-integrity
28 | .cache
29 | !/.projenrc.js
30 | /test-reports/
31 | junit.xml
32 | /coverage/
33 | !/.github/workflows/build.yml
34 | /dist/changelog.md
35 | /dist/version.txt
36 | !/.github/workflows/release.yml
37 | !/.mergify.yml
38 | !/.github/workflows/upgrade-main.yml
39 | !/.github/pull_request_template.md
40 | !/.prettierignore
41 | !/.prettierrc.json
42 | !/test/
43 | !/src/
44 | /lib
45 | /dist/
46 | !/.eslintrc.yml
47 | .jsii
48 | !/API.md
49 | temp
50 | .idea
51 | .DS_Store
52 | ._.DS_Store
53 | **/.DS_Store
54 | **/._.DS_Store
55 | 
56 | ### Jekyll ###
57 | _site/
58 | .sass-cache/
59 | .jekyll-cache/
60 | .jekyll-metadata
61 | 
62 | /_layouts/*
63 | /_sass/*
64 | /assets/css/*
65 | /_includes/**/*
66 | 
67 | !/_layouts/home.html
68 | !/_layouts/default.html
69 | !/_layouts/archive.html
70 | !/assets/css/main.scss
71 | !_includes/head/
72 | !_includes/head/custom.html
73 | 
74 | cdkOutput.json
75 | tsconfig.json
76 | 
77 | 


--------------------------------------------------------------------------------
/test/cdk/src/singletonLambdaFunctionStack.ts:
--------------------------------------------------------------------------------
 1 | import { Stack } from 'aws-cdk-lib';
 2 | import * as s3 from 'aws-cdk-lib/aws-s3';
 3 | import * as s3deploy from 'aws-cdk-lib/aws-s3-deployment';
 4 | import { Construct } from 'constructs';
 5 | import { GenerateSpyEventsFileProps } from './GenerateSpyEventsFileProps';
 6 | import { ServerlessSpy } from '../../../src/ServerlessSpy';
 7 | 
 8 | // No test file for this stack, because the error will occur during deployment
 9 | export class SingletonLambdaFunctionStack extends Stack {
10 |   constructor(scope: Construct, id: string, props: GenerateSpyEventsFileProps) {
11 |     super(scope, id, props);
12 | 
13 |     const bucket = new s3.Bucket(
14 |       this,
15 |       'SingletonLambdaFunctionBucket-3fc2bca1-567b-4c3e-a1ba-34af41a09dcc'
16 |     );
17 | 
18 |     new s3deploy.BucketDeployment(this, 'DeployStaticAssets1', {
19 |       sources: [s3deploy.Source.jsonData('DummyKey1', { test: 'testing' })],
20 |       destinationBucket: bucket,
21 |     });
22 | 
23 |     new s3deploy.BucketDeployment(this, 'DeployStaticAssets2', {
24 |       sources: [s3deploy.Source.jsonData('DummyKey2', { test: 'testing' })],
25 |       destinationBucket: bucket,
26 |     });
27 | 
28 |     const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
29 |       generateSpyEventsFileLocation: props.generateSpyEventsFile
30 |         ? 'serverlessSpyEvents/SingletonLambdaFunction.ts'
31 |         : undefined,
32 |       debugMode: true,
33 |     });
34 | 
35 |     serverlessSpy.spy();
36 |   }
37 | }
38 | 


--------------------------------------------------------------------------------
/doc/DynamoDB.md:
--------------------------------------------------------------------------------
 1 | # DynamoDB
 2 | 
 3 | DynamoDB integration subscribes to DynamoDb Stream and intercepts events. The event has the following properties:
 4 |  - `keys`
 5 |  - `newImage`
 6 |  - `oldImage`
 7 |  - `eventName` (`INSERT`, `MODIFY`, `REMOVE`) 
 8 |  
 9 | You can use `eventName` and compare `newImage` and `oldImage` to validate if the correct operation has been executed.
10 | 
11 | Basic example:
12 | 
13 | ```typescript
14 | await serverlessSpyListener.waitForDynamoDBMyTable<TestData>();
15 | ```
16 | 
17 | You can use conditions to wait for a particular event. You can also use generic (`TestData`) to strongly type the event.
18 | 
19 | ```typescript    
20 | await serverlessSpyListener.waitForDynamoDBMyTable<TestData>({
21 |   condition: (d) => d.keys.pk === id,
22 | });
23 | ```
24 | 
25 | Validating the data with Jest would look like this:
26 | ```typescript
27 | (
28 |   await serverlessSpyListener.waitForDynamoDBMyTable<TestData>({
29 |     condition: (d) => d.keys.pk === id,
30 |   })
31 | ).toMatchObject({
32 |   eventName: 'INSERT',
33 |   newImage: data,
34 | });
35 | ```
36 | 
37 | **⚠️Warning: DynamoDB can have only two Lambdas subscribed to DynamoDB Streams. If your primary stack already has two, you can not use DynamoDB interception. You should [exclude DynamoDB interception in your CDK stack](./CDK_construct.md):
38 | ```typescript
39 | serverlessSpy.spy({
40 |   spyDynamoDB: false,
41 | });
42 | ```
43 | 
44 | Check [this test](https://github.com/ServerlessLife/serverless-spy/blob/main/test/cdk/test/lambdaToDynamoDb.test.ts){:target="_blank"}.


--------------------------------------------------------------------------------
/doc/web_console.md:
--------------------------------------------------------------------------------
 1 | # Web Console
 2 | 
 3 | The web console runs on your local computer and displays all events that ServerlessSpy intercepts in the environment. That is useful when developing to investigate what is happening in the system. The web console receives events via WebSocket and displays them in the table with a timestamp, event name, and data. You can filter events by event name and data. You can use regular expressions.
 4 | 
 5 | If events are hierarchical, like Lambda request & response, you can see an arrow from a parent to child event.
 6 | 
 7 | ![Web console](./web_console.gif)
 8 | 
 9 | ## Start
10 | ```bash
11 | npx sspy --cdkoutput cdkOutput.json
12 | ```
13 | The browser window will open [http://localhost:3456/](http://localhost:3456/).
14 | 
15 | `cdkOutput.json` contains exported CloudFormation outputs ([see](./quick_start.md)). The key output is `ServerlessSpyWsUrl`, which is the URL to the AWS IoT endpoint where the testing library and web console receive events. You can also set websocket directly with parameter `--ws`.
16 | 
17 | ## Parameters:
18 | `--ws <ws>` - Websocket link (optional)
19 | 
20 | `--cdkoutput <cdkoutput>` - CDK output file that contains AWS IoT endpoint link in a property `ServerlessSpyWsUrl` (optional)
21 | 
22 | `--cdkstack <cdkstack>` - CDK stack in CDK output file. If not specified, the first one is picked (optional)
23 | 
24 | `--open <open>` - Open browser (optional, default: true)
25 | 
26 | `--port` - A port on localhost where the ServerlessSpy web console is accessible (optional, default: "3456")  
27 | 
28 | 


--------------------------------------------------------------------------------
/extension/aws/VerboseLog.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 3 |  *
 4 |  * This code was copied from:
 5 |  * https://github.com/aws/aws-lambda-nodejs-runtime-interface-client
 6 |  *
 7 |  */
 8 | 
 9 | 'use strict';
10 | 
11 | const EnvVarName = 'AWS_LAMBDA_RUNTIME_VERBOSE';
12 | const Tag = 'RUNTIME';
13 | const Verbosity = (() => {
14 |   if (!process.env[EnvVarName]) {
15 |     return 0;
16 |   }
17 | 
18 |   try {
19 |     const verbosity = parseInt(process.env[EnvVarName]);
20 |     return verbosity < 0 ? 0 : verbosity > 3 ? 3 : verbosity;
21 |   } catch (_) {
22 |     return 0;
23 |   }
24 | })();
25 | 
26 | exports.logger = function (category) {
27 |   return {
28 |     verbose: function () {
29 |       if (Verbosity >= 1) {
30 |         const args = [...arguments].map((arg) =>
31 |           typeof arg === 'function' ? arg() : arg
32 |         );
33 |         console.log.apply(null, [Tag, category, ...args]);
34 |       }
35 |     },
36 |     vverbose: function () {
37 |       if (Verbosity >= 2) {
38 |         const args = [...arguments].map((arg) =>
39 |           typeof arg === 'function' ? arg() : arg
40 |         );
41 |         console.log.apply(null, [Tag, category, ...args]);
42 |       }
43 |     },
44 |     vvverbose: function () {
45 |       if (Verbosity >= 3) {
46 |         const args = [...arguments].map((arg) =>
47 |           typeof arg === 'function' ? arg() : arg
48 |         );
49 |         console.log.apply(null, [Tag, category, ...args]);
50 |       }
51 |     },
52 |   };
53 | };
54 | 


--------------------------------------------------------------------------------
/tsconfig.npm.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     //"lib": ["es2021"],
 4 |     "module": "esnext",
 5 |     //"target": "es2021",
 6 |     //"strict": true,
 7 |     "allowSyntheticDefaultImports": true,
 8 |     //"esModuleInterop": true,
 9 |     "skipLibCheck": true,
10 |     //"forceConsistentCasingInFileNames": true,
11 |     "moduleResolution": "node",
12 |     //"resolveJsonModule": true,
13 | 
14 |     // "outDir": "build",
15 |      "declarationMap": false,
16 |      "inlineSourceMap": true,
17 |      "inlineSources": true,
18 |      "alwaysStrict": true,
19 |      "declaration": true,
20 |      "experimentalDecorators": true,
21 |      "incremental": true,
22 |      "lib": [
23 |        "es2020"
24 |      ],
25 |     // "module": "CommonJS",
26 |      "newLine": "lf",
27 |      "noEmitOnError": true,
28 |      "noFallthroughCasesInSwitch": true,
29 |      "noImplicitAny": true,
30 |      "noImplicitReturns": true,
31 |      "noImplicitThis": true,
32 |      "noUnusedLocals": true,
33 |      "noUnusedParameters": true,
34 |      "resolveJsonModule": true,
35 |      "strict": true,
36 |      "strictNullChecks": true,
37 |      "strictPropertyInitialization": true,
38 |      "stripInternal": false,
39 |      "target": "ES2020",
40 |      "composite": false,
41 |      "tsBuildInfoFile": "lib/tsconfig.tsbuildinfo"
42 |   },
43 |   "include": [
44 |     "src/**/*.ts",
45 |     "common/**/*.ts",
46 |     "listener/**/*.ts",
47 |     "cli/**/*.ts",
48 |     "functions/**/*.ts",
49 |     "index.ts",
50 |   ],
51 |   "exclude": ["cli/webServerlessSpy.ts"]
52 | }
53 | 


--------------------------------------------------------------------------------
/test/cdk/src/lambdaToSqsStack.ts:
--------------------------------------------------------------------------------
 1 | import * as path from 'path';
 2 | import { Duration, Stack, CfnOutput } from 'aws-cdk-lib';
 3 | import * as lambda from 'aws-cdk-lib/aws-lambda';
 4 | import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
 5 | import * as sqs from 'aws-cdk-lib/aws-sqs';
 6 | import { Construct } from 'constructs';
 7 | import { GenerateSpyEventsFileProps } from './GenerateSpyEventsFileProps';
 8 | import { ServerlessSpy } from '../../../src/ServerlessSpy';
 9 | 
10 | export class LambdaToSqsStack extends Stack {
11 |   constructor(scope: Construct, id: string, props: GenerateSpyEventsFileProps) {
12 |     super(scope, id, props);
13 | 
14 |     const queue = new sqs.Queue(this, 'MyQueue');
15 | 
16 |     const func = new NodejsFunction(this, 'MyLambda', {
17 |       memorySize: 512,
18 |       timeout: Duration.seconds(5),
19 |       runtime: lambda.Runtime.NODEJS_22_X,
20 |       handler: 'handler',
21 |       entry: path.join(__dirname, '../functions/toSqs.ts'),
22 |       environment: {
23 |         SQS_URL: queue.queueUrl,
24 |         NODE_OPTIONS: '--enable-source-maps',
25 |       },
26 |     });
27 |     queue.grantSendMessages(func);
28 | 
29 |     const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
30 |       generateSpyEventsFileLocation: props.generateSpyEventsFile
31 |         ? 'serverlessSpyEvents/ServerlessSpyEventsLambdaToSqs.ts'
32 |         : undefined,
33 |       debugMode: true,
34 |     });
35 | 
36 |     serverlessSpy.spy();
37 | 
38 |     new CfnOutput(this, `FunctionName${serverlessSpy.getConstructName(func)}`, {
39 |       value: func.functionName,
40 |     });
41 |   }
42 | }
43 | 


--------------------------------------------------------------------------------
/test/cdk/src/lambdaToS3Stack.ts:
--------------------------------------------------------------------------------
 1 | import * as path from 'path';
 2 | import { Duration, Stack, CfnOutput } from 'aws-cdk-lib';
 3 | import * as lambda from 'aws-cdk-lib/aws-lambda';
 4 | import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
 5 | import * as s3 from 'aws-cdk-lib/aws-s3';
 6 | import { Construct } from 'constructs';
 7 | import { GenerateSpyEventsFileProps } from './GenerateSpyEventsFileProps';
 8 | import { ServerlessSpy } from '../../../src/ServerlessSpy';
 9 | 
10 | export class LambdaToS3Stack extends Stack {
11 |   constructor(scope: Construct, id: string, props: GenerateSpyEventsFileProps) {
12 |     super(scope, id, props);
13 | 
14 |     const s3Bucket = new s3.Bucket(this, 'MyBucket');
15 | 
16 |     const func = new NodejsFunction(this, 'MyLambda', {
17 |       memorySize: 512,
18 |       timeout: Duration.seconds(5),
19 |       runtime: lambda.Runtime.NODEJS_22_X,
20 |       handler: 'handler',
21 |       entry: path.join(__dirname, '../functions/toS3.ts'),
22 |       environment: {
23 |         S3_BUCKET_NAME: s3Bucket.bucketName,
24 |         NODE_OPTIONS: '--enable-source-maps',
25 |       },
26 |     });
27 |     s3Bucket.grantWrite(func);
28 | 
29 |     const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
30 |       generateSpyEventsFileLocation: props.generateSpyEventsFile
31 |         ? 'serverlessSpyEvents/ServerlessSpyEventsLambdaToS3.ts'
32 |         : undefined,
33 |       debugMode: true,
34 |     });
35 | 
36 |     serverlessSpy.spy();
37 | 
38 |     new CfnOutput(this, `FunctionName${serverlessSpy.getConstructName(func)}`, {
39 |       value: func.functionName,
40 |     });
41 |   }
42 | }
43 | 


--------------------------------------------------------------------------------
/test/cdk/src/lambdaToSnsStack.ts:
--------------------------------------------------------------------------------
 1 | import * as path from 'path';
 2 | import { Duration, Stack, CfnOutput } from 'aws-cdk-lib';
 3 | import * as lambda from 'aws-cdk-lib/aws-lambda';
 4 | import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
 5 | import * as sns from 'aws-cdk-lib/aws-sns';
 6 | import { Construct } from 'constructs';
 7 | import { GenerateSpyEventsFileProps } from './GenerateSpyEventsFileProps';
 8 | import { ServerlessSpy } from '../../../src/ServerlessSpy';
 9 | 
10 | export class LambdaToSnsStack extends Stack {
11 |   constructor(scope: Construct, id: string, props: GenerateSpyEventsFileProps) {
12 |     super(scope, id, props);
13 | 
14 |     const topic = new sns.Topic(this, 'MyTopic', {});
15 | 
16 |     const func = new NodejsFunction(this, 'MyLambda', {
17 |       memorySize: 512,
18 |       timeout: Duration.seconds(5),
19 |       runtime: lambda.Runtime.NODEJS_22_X,
20 |       handler: 'handler',
21 |       entry: path.join(__dirname, '../functions/toSns.ts'),
22 |       environment: {
23 |         SNS_TOPIC_ARN: topic.topicArn,
24 |         NODE_OPTIONS: '--enable-source-maps',
25 |       },
26 |     });
27 |     topic.grantPublish(func);
28 | 
29 |     const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
30 |       generateSpyEventsFileLocation: props.generateSpyEventsFile
31 |         ? 'serverlessSpyEvents/ServerlessSpyEventsLambdaToSns.ts'
32 |         : undefined,
33 |       debugMode: true,
34 |     });
35 | 
36 |     serverlessSpy.spy();
37 | 
38 |     new CfnOutput(this, `FunctionName${serverlessSpy.getConstructName(func)}`, {
39 |       value: func.functionName,
40 |     });
41 |   }
42 | }
43 | 


--------------------------------------------------------------------------------
/test/cdk/src/lambdaToEventBridgeStack.ts:
--------------------------------------------------------------------------------
 1 | import * as path from 'path';
 2 | import { Duration, Stack, CfnOutput } from 'aws-cdk-lib';
 3 | import * as events from 'aws-cdk-lib/aws-events';
 4 | import * as lambda from 'aws-cdk-lib/aws-lambda';
 5 | import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
 6 | import { Construct } from 'constructs';
 7 | import { GenerateSpyEventsFileProps } from './GenerateSpyEventsFileProps';
 8 | import { ServerlessSpy } from '../../../src/ServerlessSpy';
 9 | 
10 | export class LambdaToEventBridgeStack extends Stack {
11 |   constructor(scope: Construct, id: string, props: GenerateSpyEventsFileProps) {
12 |     super(scope, id, props);
13 | 
14 |     const bus = new events.EventBus(this, 'MyEventBus');
15 | 
16 |     const func = new NodejsFunction(this, 'MyLambda', {
17 |       memorySize: 512,
18 |       timeout: Duration.seconds(5),
19 |       runtime: lambda.Runtime.NODEJS_22_X,
20 |       handler: 'handler',
21 |       entry: path.join(__dirname, '../functions/toEventBridge.ts'),
22 |       environment: {
23 |         EB_NAME: bus.eventBusName,
24 |         NODE_OPTIONS: '--enable-source-maps',
25 |       },
26 |     });
27 |     bus.grantPutEventsTo(func);
28 | 
29 |     const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
30 |       generateSpyEventsFileLocation: props.generateSpyEventsFile
31 |         ? 'serverlessSpyEvents/ServerlessSpyEventsLambdaToEventBridge.ts'
32 |         : undefined,
33 |       debugMode: true,
34 |     });
35 | 
36 |     serverlessSpy.spy();
37 | 
38 |     new CfnOutput(this, `FunctionName${serverlessSpy.getConstructName(func)}`, {
39 |       value: func.functionName,
40 |     });
41 |   }
42 | }
43 | 


--------------------------------------------------------------------------------
/test/cdk/functions/fromSnsToSqsAndS3.ts:
--------------------------------------------------------------------------------
 1 | import { PutObjectCommand, S3Client } from '@aws-sdk/client-s3';
 2 | import { SendMessageCommand, SQSClient } from '@aws-sdk/client-sqs';
 3 | import { SNSEvent } from 'aws-lambda';
 4 | 
 5 | const s3Client = new S3Client({});
 6 | const sqsClient = new SQSClient({});
 7 | 
 8 | export const handler = async (event: SNSEvent) => {
 9 |   const message = JSON.parse(event.Records[0].Sns.Message);
10 | 
11 |   try {
12 |     const sendMessageCommand = new SendMessageCommand({
13 |       MessageAttributes: {
14 |         Title: {
15 |           DataType: 'String',
16 |           StringValue: 'The Whistler',
17 |         },
18 |         Author: {
19 |           DataType: 'String',
20 |           StringValue: 'John Grisham',
21 |         },
22 |         WeeksOn: {
23 |           DataType: 'Number',
24 |           StringValue: '6',
25 |         },
26 |       },
27 |       MessageBody: JSON.stringify(message),
28 |       QueueUrl: process.env.SQS_URL,
29 |     });
30 | 
31 |     await sqsClient.send(sendMessageCommand);
32 |   } catch (err) {
33 |     console.error(err);
34 |   }
35 |   console.log('sqs message send');
36 | 
37 |   const bucketParams = {
38 |     Bucket: process.env.S3_BUCKET_NAME,
39 |     // Specify the name of the new object. For example, 'index.html'.
40 |     // To create a directory for the object, use '/'. For example, 'myApp/package.json'.
41 |     Key: `${message.id}.json`,
42 |     // Content of the new object.
43 |     Body: JSON.stringify(message),
44 |   };
45 | 
46 |   await s3Client.send(new PutObjectCommand(bucketParams));
47 |   console.log('s3 file stored');
48 | 
49 |   return { message: 'Hello ' + message.key1 };
50 | };
51 | 


--------------------------------------------------------------------------------
/sst-esbuild/esbuild.js:
--------------------------------------------------------------------------------
 1 | const fs = require('fs');
 2 | 
 3 | const getCopyFunction =
 4 |   (files = {}) =>
 5 |   async () => {
 6 |     // const operations = Object.entries(files).map(([target, source]) =>
 7 |     //   cp(source, target)
 8 |     // );
 9 |     // await Promise.all(operations);
10 |     //console.log("************** getCopyFunction");
11 |   };
12 | 
13 | const afterFunction =
14 |   (out = {}) =>
15 |   async (e) => {
16 |     // const operations = Object.entries(files).map(([target, source]) =>
17 |     //   cp(source, target)
18 |     // );
19 |     // await Promise.all(operations);
20 |     //console.log("AFTER", out);
21 | 
22 |     // fs.appendFileSync(
23 |     //   out,
24 |     //   "\nconsole.log('*************** INJECTED ***************')"
25 |     // );
26 | 
27 |     const data = fs.readFileSync(out, 'utf8');
28 |     //console.log(data);
29 |   };
30 | 
31 | const copyFilePlugin = ({ before, after }) => ({
32 |   name: 'copyFile',
33 |   async setup(build) {
34 |     //console.log("************** before: " + before);
35 |     //console.log("BUILD ", build);
36 |     const out = build.initialOptions.outfile;
37 | 
38 |     //before && build.onStart(getCopyFunction(before));
39 |     //after && build.onEnd(getCopyFunction(after));
40 |     build.onEnd(afterFunction(out));
41 |   },
42 | });
43 | 
44 | console.log('**************** DELA *****************');
45 | 
46 | module.exports = [
47 |   copyFilePlugin({
48 |     before: {
49 |       // copy before bundling
50 |       './assets/favicon.png': './media/images/favicon.png',
51 |     },
52 |     after: {
53 |       // copy after bundling
54 |       './logs/build-report.json': './dist/report.json',
55 |     },
56 |   }),
57 | ];
58 | 


--------------------------------------------------------------------------------
/listener/matchers.ts:
--------------------------------------------------------------------------------
 1 | /*
 2 | // import { ServerlessSpyListener } from "./ServerlessSpyListener";
 3 | 
 4 | type CustomMatcherResult = {
 5 |   message: () => string;
 6 |   pass: boolean;
 7 | };
 8 | 
 9 | export const toReceiveEvent = async (
10 |   spy: any,
11 |   serviceKey: string,
12 |   condition?: (data: any) => boolean
13 | ): Promise<CustomMatcherResult> => {
14 |   console.log('NOTRI');
15 | 
16 |   await sleep(3000);
17 | 
18 |   // console.log("SPY", spy);
19 |   // const events = await spy.awaitEvents((events) => {
20 |   //   return events.some((event) => event["detail-type"] === expected);
21 |   // });
22 | 
23 |   // const pass = events.some((event) => event["detail-type"] === expected);
24 | 
25 |   // const message = pass
26 |   //   ? () => {
27 |   //       return (
28 |   //         matcherHint("toHaveEventWithDetailType", "eventsSpy", "detail-type") +
29 |   //         "\n\n" +
30 |   //         `Expected: not ${printExpected(expected)}\n` +
31 |   //         `Number of events: ${printReceived(events.length)}`
32 |   //       );
33 |   //     }
34 |   //   : () => {
35 |   //       return (
36 |   //         matcherHint("toHaveEventWithDetailType", "eventsSpy", "detail-type") +
37 |   //         "\n\n" +
38 |   //         `Expected: ${printExpected(expected)}\n` +
39 |   //         (events.length > 0
40 |   //           ? `Received: ${printReceived(events[0]?.["detail-type"])}`
41 |   //           : `Number of events: ${printReceived(events.length)}`)
42 |   //       );
43 |   //     };
44 | 
45 |   return { message: () => 'OK', pass: true };
46 | };
47 | 
48 | function sleep(ms: number) {
49 |   return new Promise((resolve) => {
50 |     setTimeout(resolve, ms);
51 |   });
52 | }
53 | */
54 | 


--------------------------------------------------------------------------------
/test/cdk/src/lambdaToDynamoDb2Stack.ts:
--------------------------------------------------------------------------------
 1 | import * as path from 'path';
 2 | import { Duration, Stack, CfnOutput } from 'aws-cdk-lib';
 3 | import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
 4 | import * as lambda from 'aws-cdk-lib/aws-lambda';
 5 | import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
 6 | import { Construct } from 'constructs';
 7 | import { GenerateSpyEventsFileProps } from './GenerateSpyEventsFileProps';
 8 | import { ServerlessSpy } from '../../../src/ServerlessSpy';
 9 | 
10 | export class LambdaToDynamoDb2Stack extends Stack {
11 |   constructor(scope: Construct, id: string, props: GenerateSpyEventsFileProps) {
12 |     super(scope, id, props);
13 | 
14 |     const dynamoDb = new dynamodb.TableV2(this, 'MyTable', {
15 |       partitionKey: { name: 'pk', type: dynamodb.AttributeType.STRING },
16 |       billing: dynamodb.Billing.onDemand(),
17 |     });
18 | 
19 |     const func = new NodejsFunction(this, 'MyLambda', {
20 |       memorySize: 512,
21 |       timeout: Duration.seconds(5),
22 |       runtime: lambda.Runtime.NODEJS_22_X,
23 |       handler: 'handler',
24 |       entry: path.join(__dirname, '../functions/toDynamoDb.ts'),
25 |       environment: {
26 |         DYNAMODB_TABLE_NAME: dynamoDb.tableName,
27 |         NODE_OPTIONS: '--enable-source-maps',
28 |       },
29 |     });
30 |     dynamoDb.grantWriteData(func);
31 | 
32 |     const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
33 |       generateSpyEventsFileLocation: props.generateSpyEventsFile
34 |         ? 'serverlessSpyEvents/ServerlessSpyEventsLambdaToDynamoDbStack.ts'
35 |         : undefined,
36 |       debugMode: true,
37 |     });
38 | 
39 |     serverlessSpy.spy();
40 | 
41 |     new CfnOutput(this, `FunctionName${serverlessSpy.getConstructName(func)}`, {
42 |       value: func.functionName,
43 |     });
44 |   }
45 | }
46 | 


--------------------------------------------------------------------------------
/test/cdk/src/lambdaToDynamoDbStack.ts:
--------------------------------------------------------------------------------
 1 | import * as path from 'path';
 2 | import { Duration, Stack, CfnOutput } from 'aws-cdk-lib';
 3 | import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
 4 | import * as lambda from 'aws-cdk-lib/aws-lambda';
 5 | import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
 6 | import { Construct } from 'constructs';
 7 | import { GenerateSpyEventsFileProps } from './GenerateSpyEventsFileProps';
 8 | import { ServerlessSpy } from '../../../src/ServerlessSpy';
 9 | 
10 | export class LambdaToDynamoDbStack extends Stack {
11 |   constructor(scope: Construct, id: string, props: GenerateSpyEventsFileProps) {
12 |     super(scope, id, props);
13 | 
14 |     const dynamoDb = new dynamodb.Table(this, 'MyTable', {
15 |       partitionKey: { name: 'pk', type: dynamodb.AttributeType.STRING },
16 |       billingMode: dynamodb.BillingMode.PAY_PER_REQUEST,
17 |     });
18 | 
19 |     const func = new NodejsFunction(this, 'MyLambda', {
20 |       memorySize: 512,
21 |       timeout: Duration.seconds(5),
22 |       runtime: lambda.Runtime.NODEJS_22_X,
23 |       handler: 'handler',
24 |       entry: path.join(__dirname, '../functions/toDynamoDb.ts'),
25 |       environment: {
26 |         DYNAMODB_TABLE_NAME: dynamoDb.tableName,
27 |         NODE_OPTIONS: '--enable-source-maps',
28 |       },
29 |     });
30 |     dynamoDb.grantWriteData(func);
31 | 
32 |     const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
33 |       generateSpyEventsFileLocation: props.generateSpyEventsFile
34 |         ? 'serverlessSpyEvents/ServerlessSpyEventsLambdaToDynamoDbStack.ts'
35 |         : undefined,
36 |       debugMode: true,
37 |     });
38 | 
39 |     serverlessSpy.spy();
40 | 
41 |     new CfnOutput(this, `FunctionName${serverlessSpy.getConstructName(func)}`, {
42 |       value: func.functionName,
43 |     });
44 |   }
45 | }
46 | 


--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
 1 | title: 'ServerlessSpy'
 2 | project: 'ServerlessSpy'
 3 | description: 'CDK-based library for writing elegant integration tests on AWS serverless architecture and an additional web console to monitor events in real time.'
 4 | keywords: 'serverless-spy, serverlessspy, cdk, aws, integration testing, testing, jest, serverless'
 5 | author: Marko (ServerlessLife)
 6 | email: marko@serverlesslife.com
 7 | image: https://serverlessspy.com/logo/square_logo.png
 8 | twitter:
 9 |   username: ServerlessL
10 | og_image: https://serverlessspy.com/logo/square_logo.png
11 | github_username: serverlesslife
12 | show_downloads: false
13 | encoding: UTF-8
14 | kramdown:
15 |   input: GFM
16 |   hard_wrap: false
17 |   auto_ids: true # Auto-generate ID's for headings
18 | future: true
19 | jailed: false
20 | gfm_quirks: paragraph_end
21 | theme: minimal-mistakes-jekyll
22 | minimal_mistakes_skin: dark
23 | teaser: https://serverlessspy.com/logo/square_logo.png
24 | logo: https://serverlessspy.com/logo/square_logo.png
25 | markdown: kramdown
26 | sass:
27 |   # Where you keep your scss files
28 |   sass_dir: assets/css/
29 |   # Where sass should look for other scss
30 |   load_paths:
31 |     - node_modules/
32 | exclude:
33 |   - node_modules
34 |   - test/node_modules
35 |   - vendor
36 | repository: ServerlessLife/serverless-spy
37 | baseurl: /
38 | include:
39 |   - CONTRIBUTING.md
40 |   - CODE_OF_CONDUCT.md
41 |   - LICENSE.md
42 | analytics:
43 |   provider: 'google-gtag'
44 |   google:
45 |     tracking_id: 'G-C2PHH6WYPP'
46 | social:
47 |   links:
48 |     - 'https://twitter.com/ServerlessL'
49 |     - 'https://www.linkedin.com/in/marko-serverlesslife/'
50 | author:
51 |   name     : Marko (ServerlessLife)
52 |   avatar   : "/logo/marko_serverlesslife.jpg"
53 |   bio      : "Full-stack Software Developer | AWS Certified Professional | Serverless Specialist"
54 | 


--------------------------------------------------------------------------------
/listener/iot-connection.ts:
--------------------------------------------------------------------------------
 1 | import { fromNodeProviderChain } from '@aws-sdk/credential-providers';
 2 | import { device } from 'aws-iot-device-sdk';
 3 | 
 4 | export type fragment = { id: string; index: number; count: number; data: any };
 5 | 
 6 | function createLog(debugMode: boolean) {
 7 |   return (message: string, ...optionalParams: any[]) => {
 8 |     if (debugMode) {
 9 |       console.debug('SSPY', message, ...optionalParams);
10 |     }
11 |   };
12 | }
13 | 
14 | function createErrorLog() {
15 |   return (message: string, ...optionalParams: any[]) => {
16 |     console.error('SSPY', message, ...optionalParams);
17 |   };
18 | }
19 | 
20 | export async function getConnection(
21 |   debugMode: boolean,
22 |   iotEndpoint: string
23 | ): Promise<device> {
24 |   const log = createLog(debugMode);
25 |   const logError = createErrorLog();
26 |   log('Using IoT endpoint:', iotEndpoint);
27 | 
28 |   if (!iotEndpoint) {
29 |     logError('No IoT endpoint could be found');
30 |     throw new Error('IoT Endpoint address not found');
31 |   }
32 |   const region = iotEndpoint.split('.')[2];
33 | 
34 |   const provider = fromNodeProviderChain();
35 |   const credentials = await provider();
36 |   const connection = new device({
37 |     protocol: 'wss',
38 |     host: iotEndpoint,
39 |     region,
40 |     reconnectPeriod: 1,
41 |     accessKeyId: credentials.accessKeyId,
42 |     secretKey: credentials.secretAccessKey,
43 |     sessionToken: credentials.sessionToken,
44 |   });
45 | 
46 |   connection.on('connect', () => {
47 |     log('IoT connected');
48 |   });
49 | 
50 |   connection.on('error', (err) => {
51 |     logError('IoT error', err);
52 |   });
53 | 
54 |   connection.on('close', () => {
55 |     log('IoT closed');
56 |   });
57 | 
58 |   connection.on('reconnect', () => {
59 |     log('IoT reconnected');
60 |   });
61 | 
62 |   return connection;
63 | }
64 | 


--------------------------------------------------------------------------------
/test/cdk/src/snsToSqsStack.ts:
--------------------------------------------------------------------------------
 1 | import * as path from 'path';
 2 | import { Duration, Stack, CfnOutput } from 'aws-cdk-lib';
 3 | import * as lambda from 'aws-cdk-lib/aws-lambda';
 4 | import { SqsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';
 5 | import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
 6 | import * as sns from 'aws-cdk-lib/aws-sns';
 7 | import { SqsSubscription } from 'aws-cdk-lib/aws-sns-subscriptions';
 8 | import * as sqs from 'aws-cdk-lib/aws-sqs';
 9 | import { Construct } from 'constructs';
10 | import { GenerateSpyEventsFileProps } from './GenerateSpyEventsFileProps';
11 | import { ServerlessSpy } from '../../../src/ServerlessSpy';
12 | 
13 | export class SnsToSqsStack extends Stack {
14 |   constructor(scope: Construct, id: string, props: GenerateSpyEventsFileProps) {
15 |     super(scope, id, props);
16 | 
17 |     const topic = new sns.Topic(this, 'MyTopic', {});
18 | 
19 |     const queue = new sqs.Queue(this, 'MyQueue');
20 | 
21 |     topic.addSubscription(new SqsSubscription(queue));
22 | 
23 |     const func = new NodejsFunction(this, 'MyLambda', {
24 |       memorySize: 512,
25 |       timeout: Duration.seconds(5),
26 |       runtime: lambda.Runtime.NODEJS_22_X,
27 |       handler: 'handler',
28 |       entry: path.join(__dirname, '../functions/dummy.ts'),
29 |       environment: {
30 |         NODE_OPTIONS: '--enable-source-maps',
31 |       },
32 |     });
33 |     func.addEventSource(new SqsEventSource(queue));
34 | 
35 |     const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
36 |       generateSpyEventsFileLocation: props.generateSpyEventsFile
37 |         ? 'serverlessSpyEvents/ServerlessSpyEventsSnsToSqs.ts'
38 |         : undefined,
39 |       debugMode: true,
40 |     });
41 | 
42 |     serverlessSpy.spy();
43 | 
44 |     new CfnOutput(this, `SnsTopicArn${serverlessSpy.getConstructName(topic)}`, {
45 |       value: topic.topicArn,
46 |     });
47 |   }
48 | }
49 | 


--------------------------------------------------------------------------------
/test/cdk/test/sqs.test.ts:
--------------------------------------------------------------------------------
 1 | import * as fs from 'fs';
 2 | import * as path from 'path';
 3 | import { SendMessageCommand, SQSClient } from '@aws-sdk/client-sqs';
 4 | import { v4 as uuidv4 } from 'uuid';
 5 | import { TestData } from './TestData';
 6 | import { createServerlessSpyListener } from '../../../listener/createServerlessSpyListener';
 7 | import { ServerlessSpyListener } from '../../../listener/ServerlessSpyListener';
 8 | import { ServerlessSpyEvents } from '../serverlessSpyEvents/ServerlessSpyEventsSqs';
 9 | 
10 | jest.setTimeout(30000);
11 | 
12 | describe('SQS with option spySqsWithNoSubscriptionAndDropAllMessages', () => {
13 |   const exportLocation = path.join(__dirname, '../cdkOutput.json');
14 |   let serverlessSpyListener: ServerlessSpyListener<ServerlessSpyEvents>;
15 | 
16 |   if (!fs.existsSync(exportLocation)) {
17 |     throw new Error(`File ${exportLocation} does not exists.`);
18 |   }
19 |   const output = JSON.parse(fs.readFileSync(exportLocation).toString())[
20 |     'ServerlessSpySqs'
21 |   ];
22 | 
23 |   beforeEach(async () => {
24 |     serverlessSpyListener =
25 |       await createServerlessSpyListener<ServerlessSpyEvents>({
26 |         serverlessSpyWsUrl: output.ServerlessSpyWsUrl,
27 |       });
28 |   });
29 | 
30 |   afterEach(async () => {
31 |     serverlessSpyListener.stop();
32 |   });
33 | 
34 |   test('Basic test', async () => {
35 |     const id = uuidv4();
36 |     const data = <TestData>{
37 |       id,
38 |       message: 'Hello',
39 |     };
40 | 
41 |     const sqsClient = new SQSClient({});
42 |     const sendMessageCommand = new SendMessageCommand({
43 |       MessageBody: JSON.stringify(data),
44 |       QueueUrl: output.QueueUrlMyQueue,
45 |     });
46 |     await sqsClient.send(sendMessageCommand);
47 | 
48 |     (
49 |       await serverlessSpyListener.waitForSqsMyQueue<TestData>({
50 |         condition: (d) => d.body.id === id,
51 |       })
52 |     ).toMatchObject({ body: data });
53 |   });
54 | });
55 | 


--------------------------------------------------------------------------------
/test/cdk/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "serverless-spy-test",
 3 |   "scripts": {
 4 |     "build": "scripts/run-task build",
 5 |     "bundle": "scripts/run-task bundle",
 6 |     "clobber": "scripts/run-task clobber",
 7 |     "compile": "scripts/run-task compile",
 8 |     "deploy": "scripts/run-task deploy",
 9 |     "destroy": "scripts/run-task destroy",
10 |     "diff": "scripts/run-task diff",
11 |     "package": "scripts/run-task package",
12 |     "post-compile": "scripts/run-task post-compile",
13 |     "post-upgrade": "scripts/run-task post-upgrade",
14 |     "pre-compile": "scripts/run-task pre-compile",
15 |     "synth": "scripts/run-task synth",
16 |     "synth:silent": "scripts/run-task synth:silent",
17 |     "test": "scripts/run-task test",
18 |     "test:update": "scripts/run-task test:update",
19 |     "test:watch": "scripts/run-task test:watch",
20 |     "upgrade": "scripts/run-task upgrade",
21 |     "watch": "scripts/run-task watch"
22 |   },
23 |   "devDependencies": {
24 |     "@types/jest": "^29.5.11",
25 |     "@types/node": "^20.10.4",
26 |     "esbuild": "^0.19.9",
27 |     "jest": "^29.7.0",
28 |     "jest-junit": "^16.0.0",
29 |     "npm-check-updates": "^16",
30 |     "projen": "^0.77.6",
31 |     "ts-jest": "^29.1.1",
32 |     "ts-node": "^10.9.2",
33 |     "typescript": "^5.3.3"
34 |   },
35 |   "dependencies": {
36 |     "@aws-sdk/client-dynamodb": "^3.470.0",
37 |     "@aws-sdk/client-eventbridge": "^3.470.0",
38 |     "@aws-sdk/client-lambda": "^3.470.0",
39 |     "@aws-sdk/client-s3": "^3.470.0",
40 |     "@aws-sdk/client-sns": "^3.470.0",
41 |     "@aws-sdk/client-sqs": "^3.470.0",
42 |     "@aws-sdk/lib-dynamodb": "^3.470.0",
43 |     "@aws-sdk/util-dynamodb": "^3.470.0",
44 |     "aws-cdk-lib": "^2.168",
45 |     "@serverless-stack/node": "^1.15.4",
46 |     "@aws-cdk/aws-lambda-python-alpha": ">=2.168.0-alpha.0",
47 |     "aws4": "^1.11.0",
48 |     "constructs": "^10.3.0",
49 |     "tsconfig-paths": "^4.2.0"
50 |   },
51 |   "license": "MPL-2.0",
52 |   "version": "0.0.0"
53 | }


--------------------------------------------------------------------------------
/test/cdk/src/defaultEventBridgeToLambdaStack.ts:
--------------------------------------------------------------------------------
 1 | import * as path from 'path';
 2 | import { Duration, Stack } from 'aws-cdk-lib';
 3 | import * as events from 'aws-cdk-lib/aws-events';
 4 | import * as targets from 'aws-cdk-lib/aws-events-targets';
 5 | import * as lambda from 'aws-cdk-lib/aws-lambda';
 6 | import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
 7 | import { Construct } from 'constructs';
 8 | import { GenerateSpyEventsFileProps } from './GenerateSpyEventsFileProps';
 9 | import { ServerlessSpy } from '../../../src/ServerlessSpy';
10 | 
11 | export class DefaultEventBridgeToLambdaStack extends Stack {
12 |   constructor(scope: Construct, id: string, props: GenerateSpyEventsFileProps) {
13 |     super(scope, id, props);
14 | 
15 |     const func = new NodejsFunction(this, 'MyLambda', {
16 |       memorySize: 512,
17 |       timeout: Duration.seconds(5),
18 |       runtime: lambda.Runtime.NODEJS_22_X,
19 |       handler: 'handler',
20 |       entry: path.join(__dirname, '../functions/dummy.ts'),
21 |       environment: {
22 |         NODE_OPTIONS: '--enable-source-maps',
23 |       },
24 |     });
25 | 
26 |     const pythonFunc = new lambda.Function(this, 'MyPythonLambda', {
27 |       memorySize: 512,
28 |       timeout: Duration.seconds(5),
29 |       runtime: lambda.Runtime.PYTHON_3_9,
30 |       handler: 'dummy.handler',
31 |       code: lambda.Code.fromAsset(path.join(__dirname, '../functions/python/')),
32 |       environment: {},
33 |     });
34 | 
35 |     new events.Rule(this, 'MyRule', {
36 |       eventPattern: { version: ['0'] },
37 |       targets: [
38 |         new targets.LambdaFunction(func),
39 |         new targets.LambdaFunction(pythonFunc),
40 |       ],
41 |     });
42 | 
43 |     const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
44 |       generateSpyEventsFileLocation: props.generateSpyEventsFile
45 |         ? 'serverlessSpyEvents/ServerlessSpyEventsDefaultEventBridgeToLambda.ts'
46 |         : undefined,
47 |       debugMode: true,
48 |     });
49 | 
50 |     serverlessSpy.spy();
51 |   }
52 | }
53 | 


--------------------------------------------------------------------------------
/test/cdk/src/pythonLambdaStack.ts:
--------------------------------------------------------------------------------
 1 | import * as path from 'path';
 2 | import { Duration, Stack, CfnOutput } from 'aws-cdk-lib';
 3 | import * as lambda from 'aws-cdk-lib/aws-lambda';
 4 | import { Architecture } from 'aws-cdk-lib/aws-lambda';
 5 | import { Construct } from 'constructs';
 6 | import { GenerateSpyEventsFileProps } from './GenerateSpyEventsFileProps';
 7 | import { ServerlessSpy } from '../../../src/ServerlessSpy';
 8 | 
 9 | export class PythonLambdaStack extends Stack {
10 |   constructor(scope: Construct, id: string, props: GenerateSpyEventsFileProps) {
11 |     super(scope, id, props);
12 | 
13 |     const func = new lambda.Function(this, 'MyLambda', {
14 |       memorySize: 512,
15 |       timeout: Duration.seconds(5),
16 |       runtime: lambda.Runtime.PYTHON_3_9,
17 |       handler: 'lambda.handler',
18 |       architecture: Architecture.X86_64,
19 |       code: lambda.Code.fromAsset(path.join(__dirname, '../functions/python/')),
20 |       environment: {},
21 |     });
22 | 
23 |     const func3 = new lambda.Function(this, 'MyLambdaThatFails', {
24 |       memorySize: 512,
25 |       timeout: Duration.seconds(5),
26 |       runtime: lambda.Runtime.PYTHON_3_11, // use a different version
27 |       handler: 'lambdaFail.handler',
28 |       architecture: Architecture.X86_64,
29 |       code: lambda.Code.fromAsset(path.join(__dirname, '../functions/python/')),
30 |       environment: {},
31 |     });
32 | 
33 |     const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
34 |       generateSpyEventsFileLocation: props.generateSpyEventsFile
35 |         ? 'serverlessSpyEvents/ServerlessSpyEventsPythonLambda.ts'
36 |         : undefined,
37 |       debugMode: true,
38 |     });
39 | 
40 |     serverlessSpy.spy();
41 | 
42 |     new CfnOutput(this, `FunctionName${serverlessSpy.getConstructName(func)}`, {
43 |       value: func.functionName,
44 |     });
45 |     new CfnOutput(
46 |       this,
47 |       `FunctionName${serverlessSpy.getConstructName(func3)}`,
48 |       {
49 |         value: func3.functionName,
50 |       }
51 |     );
52 |   }
53 | }
54 | 


--------------------------------------------------------------------------------
/doc/CDK_construct.md:
--------------------------------------------------------------------------------
 1 | # CDK Construct
 2 | 
 3 | Adding ServerlessSpy construct is super simple.
 4 | 
 5 | # Step 1: Create object:
 6 | ```typescript
 7 | const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
 8 |   generateSpyEventsFileLocation: 'serverlessSpyEvents/ServerlessSpyEvents.ts'              
 9 | });
10 | ```
11 | 
12 | Parameters:
13 |  - `generateSpyEventsFileLocation: serverlessSpyEvents/ServerlessSpyEvents.ts`  
14 | It is a TypeScript file that will be generated by CDK construct. It will make your tests strongly typed 💪. It just contains an interface with a list of possible events, but thanks to this file and the magic of TypeScript, every test becomes strongly typed.
15 | 
16 |  - `debugMode: true`  
17 | Enable debug mode.
18 | 
19 |  - `spySqsWithNoSubscriptionAndDropAllMessages`.   
20 | If no Lambda is subscribed to SQS, the ServerlessSpy can not intercept events. With this flag on, additional Lambda will be created that will just consume messages and throw them away (= lost forever ⛔). Of course, that is undesirable in most cases, but it could be useful for some tests.
21 | 
22 | 
23 | # Step 2: Star spying
24 | 
25 | You can spy on everything:
26 | ```typescript
27 | serverlessSpy.spy();
28 | ```
29 | 
30 | or you can limit what to spy on:
31 | ```typescript
32 | serverlessSpy.spy({
33 |   spyLambda: true,
34 |   spySqs: true,
35 |   spySnsTopic: true,
36 |   spySnsSubsription: true,
37 |   spyEventBridge: true,
38 |   spyEventBridgeRule: true,
39 |   spyS3: true,
40 |   spyDynamoDB: true,
41 | });
42 | ```
43 | 
44 | You can also specify just some nodes
45 | ```typescript
46 | serverlessSpy.spyNodes([...]);
47 | ```
48 | All child nodes are also included in the spying.
49 | 
50 | You can mix and match both methods.
51 | 
52 | **Why would you exclude some of the nodes?**
53 | For DynamoDB, there could be only two Lambdas subscribed to DynamoDB Streams, and S3 can only have one. If you reach the quotas with your primary stack, you can not use ServerlessSpy on those resources. 
54 | 
55 | There could also be other reasons to exclude some of the nodes specific to your use case.
56 | 
57 |  
58 | 


--------------------------------------------------------------------------------
/test/cdk/src/snsToLambdaStack.ts:
--------------------------------------------------------------------------------
 1 | import * as path from 'path';
 2 | import { Duration, Stack, CfnOutput } from 'aws-cdk-lib';
 3 | import * as lambda from 'aws-cdk-lib/aws-lambda';
 4 | import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
 5 | import * as sns from 'aws-cdk-lib/aws-sns';
 6 | import { LambdaSubscription } from 'aws-cdk-lib/aws-sns-subscriptions';
 7 | import { Construct } from 'constructs';
 8 | import { GenerateSpyEventsFileProps } from './GenerateSpyEventsFileProps';
 9 | import { ServerlessSpy } from '../../../src/ServerlessSpy';
10 | 
11 | export class SnsToLambdaStack extends Stack {
12 |   constructor(scope: Construct, id: string, props: GenerateSpyEventsFileProps) {
13 |     super(scope, id, props);
14 | 
15 |     const topic = new sns.Topic(this, 'MyTopic', {});
16 | 
17 |     const func = new NodejsFunction(this, 'MyLambda', {
18 |       memorySize: 512,
19 |       timeout: Duration.seconds(5),
20 |       runtime: lambda.Runtime.NODEJS_22_X,
21 |       handler: 'handler',
22 |       entry: path.join(__dirname, '../functions/dummy.ts'),
23 |       environment: {
24 |         NODE_OPTIONS: '--enable-source-maps',
25 |       },
26 |     });
27 |     topic.addSubscription(new LambdaSubscription(func));
28 | 
29 |     const pythonFunc = new lambda.Function(this, 'MyPythonLambda', {
30 |       memorySize: 512,
31 |       timeout: Duration.seconds(5),
32 |       runtime: lambda.Runtime.PYTHON_3_9,
33 |       handler: 'dummy.handler',
34 |       code: lambda.Code.fromAsset(path.join(__dirname, '../functions/python/')),
35 |       environment: {},
36 |     });
37 |     topic.addSubscription(new LambdaSubscription(pythonFunc));
38 | 
39 |     const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
40 |       generateSpyEventsFileLocation: props.generateSpyEventsFile
41 |         ? 'serverlessSpyEvents/ServerlessSpyEventsSnsToLambda.ts'
42 |         : undefined,
43 |       debugMode: true,
44 |     });
45 | 
46 |     serverlessSpy.spy();
47 | 
48 |     new CfnOutput(this, `SnsTopicArn${serverlessSpy.getConstructName(topic)}`, {
49 |       value: topic.topicArn,
50 |     });
51 |   }
52 | }
53 | 


--------------------------------------------------------------------------------
/cli/icons/Arch_AWS-Lambda_16.svg:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <svg width="24px" height="24px" viewBox="0 0 24 24" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
 3 |     <!-- Generator: Sketch 64 (93537) - https://sketch.com -->
 4 |     <title>Icon-Architecture/16/Arch_AWS-Lambda_16</title>
 5 |     <desc>Created with Sketch.</desc>
 6 |     <defs>
 7 |         <linearGradient x1="0%" y1="100%" x2="100%" y2="0%" id="linearGradient-1">
 8 |             <stop stop-color="#C8511B" offset="0%"></stop>
 9 |             <stop stop-color="#FF9900" offset="100%"></stop>
10 |         </linearGradient>
11 |     </defs>
12 |     <g id="Icon-Architecture/16/Arch_AWS-Lambda_16" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
13 |         <g id="Icon-Architecture-BG/16/Compute" fill="url(#linearGradient-1)">
14 |             <rect id="Rectangle" x="0" y="0" width="24" height="24"></rect>
15 |         </g>
16 |         <path d="M8.35471698,19 L5.33377354,19 L8.87677893,11.806 L10.3893141,14.832 L8.35471698,19 Z M9.3369363,10.435 C9.25026989,10.262 9.06971487,10.153 8.87265196,10.153 L8.87058847,10.153 C8.67352556,10.153 8.49297054,10.264 8.40733588,10.437 L4.05028527,19.285 C3.97393629,19.439 3.98528546,19.622 4.07917407,19.767 C4.17409443,19.912 4.33814156,20 4.51560135,20 L8.68074777,20 C8.8809059,20 9.06249267,19.889 9.14812734,19.714 L11.4282793,15.043 C11.4943109,14.907 11.4932791,14.748 11.4262158,14.611 L9.3369363,10.435 Z M18.968257,19 L15.7987426,19 L10.1747116,7.289 C10.0901087,7.113 9.90749017,7 9.70733203,7 L7.61598901,7 L7.6180525,5 L11.7883576,5 L17.386595,16.71 C17.471198,16.887 17.6548482,17 17.8550063,17 L18.968257,17 L18.968257,19 Z M19.4841285,16 L18.1841324,16 L12.5869267,4.29 C12.5023238,4.113 12.3186735,4 12.1174836,4 L7.10321275,4 C6.81845169,4 6.58734126,4.224 6.58734126,4.5 L6.58424603,7.5 C6.58424603,7.632 6.63892841,7.759 6.73591225,7.854 C6.83186434,7.947 6.9628957,8 7.10011752,8 L9.37820602,8 L15.002237,19.711 C15.0868399,19.887 15.2694584,20 15.4696166,20 L19.4841285,20 C19.7688896,20 20,19.776 20,19.5 L20,16.5 C20,16.224 19.7688896,16 19.4841285,16 L19.4841285,16 Z" id="AWS-Lambda_Icon_16_Squid" fill="#FFFFFF"></path>
17 |     </g>
18 | </svg>


--------------------------------------------------------------------------------
/.github/workflows/pages.yml:
--------------------------------------------------------------------------------
 1 | # This workflow uses actions that are not certified by GitHub.
 2 | # They are provided by a third-party and are governed by
 3 | # separate terms of service, privacy policy, and support
 4 | # documentation.
 5 | 
 6 | # Sample workflow for building and deploying a Jekyll site to GitHub Pages
 7 | name: Deploy Jekyll site to Pages
 8 | 
 9 | on:
10 |   # Runs on pushes targeting the default branch
11 |   push:
12 |     branches: ['main']
13 | 
14 |   # Allows you to run this workflow manually from the Actions tab
15 |   workflow_dispatch:
16 | 
17 | # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
18 | permissions:
19 |   contents: read
20 |   pages: write
21 |   id-token: write
22 | 
23 | # Allow one concurrent deployment
24 | concurrency:
25 |   group: 'pages'
26 |   cancel-in-progress: true
27 | 
28 | jobs:
29 |   # Build job
30 |   build:
31 |     runs-on: ubuntu-22.04
32 |     steps:
33 |       - name: Checkout
34 |         uses: actions/checkout@v3
35 |       - name: Setup Ruby
36 |         uses: ruby/setup-ruby@0a29871fe2b0200a17a4497bae54fe5df0d973aa # v1.115.3
37 |         with:
38 |           ruby-version: '3.0' # Not needed with a .ruby-version file
39 |           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
40 |           cache-version: 0 # Increment this number if you need to re-download cached gems
41 |       - name: Setup Pages
42 |         id: pages
43 |         uses: actions/configure-pages@v2
44 |       - name: Build with Jekyll
45 |         # Outputs to the './_site' directory by default
46 |         run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
47 |         env:
48 |           JEKYLL_ENV: production
49 |       - name: Upload artifact
50 |         # Automatically uploads an artifact from the './_site' directory by default
51 |         uses: actions/upload-pages-artifact@v3
52 | 
53 |   # Deployment job
54 |   deploy:
55 |     environment:
56 |       name: github-pages
57 |       url: ${{ steps.deployment.outputs.page_url }}
58 |     runs-on: ubuntu-22.04
59 |     needs: build
60 |     steps:
61 |       - name: Deploy to GitHub Pages
62 |         id: deployment
63 |         uses: actions/deploy-pages@v1
64 | 


--------------------------------------------------------------------------------
/test/cdk/src/eventBridgeToLambdaStack.ts:
--------------------------------------------------------------------------------
 1 | import * as path from 'path';
 2 | import { Duration, Stack, CfnOutput } from 'aws-cdk-lib';
 3 | import * as events from 'aws-cdk-lib/aws-events';
 4 | import * as targets from 'aws-cdk-lib/aws-events-targets';
 5 | import * as lambda from 'aws-cdk-lib/aws-lambda';
 6 | import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
 7 | import { Construct } from 'constructs';
 8 | import { GenerateSpyEventsFileProps } from './GenerateSpyEventsFileProps';
 9 | import { ServerlessSpy } from '../../../src/ServerlessSpy';
10 | 
11 | export class EventBridgeToLambdaStack extends Stack {
12 |   constructor(scope: Construct, id: string, props: GenerateSpyEventsFileProps) {
13 |     super(scope, id, props);
14 | 
15 |     const bus = new events.EventBus(this, 'MyEventBus');
16 | 
17 |     const func = new NodejsFunction(this, 'MyLambda', {
18 |       memorySize: 512,
19 |       timeout: Duration.seconds(5),
20 |       runtime: lambda.Runtime.NODEJS_22_X,
21 |       handler: 'handler',
22 |       entry: path.join(__dirname, '../functions/dummy.ts'),
23 |       environment: {
24 |         NODE_OPTIONS: '--enable-source-maps',
25 |       },
26 |     });
27 | 
28 |     const pythonFunc = new lambda.Function(this, 'MyPythonLambda', {
29 |       memorySize: 512,
30 |       timeout: Duration.seconds(5),
31 |       runtime: lambda.Runtime.PYTHON_3_9,
32 |       handler: 'dummy.handler',
33 |       code: lambda.Code.fromAsset(path.join(__dirname, '../functions/python/')),
34 |       environment: {},
35 |     });
36 | 
37 |     new events.Rule(this, 'MyRule', {
38 |       eventBus: bus,
39 |       eventPattern: { version: ['0'] },
40 |       targets: [
41 |         new targets.LambdaFunction(func),
42 |         new targets.LambdaFunction(pythonFunc),
43 |       ],
44 |     });
45 | 
46 |     const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
47 |       generateSpyEventsFileLocation: props.generateSpyEventsFile
48 |         ? 'serverlessSpyEvents/ServerlessSpyEventsEventBridgeToLambda.ts'
49 |         : undefined,
50 |       debugMode: true,
51 |     });
52 | 
53 |     serverlessSpy.spy();
54 | 
55 |     new CfnOutput(this, `EventBusName${serverlessSpy.getConstructName(bus)}`, {
56 |       value: bus.eventBusName,
57 |     });
58 |   }
59 | }
60 | 


--------------------------------------------------------------------------------
/test/cdk/src/sqsToLambdaStack.ts:
--------------------------------------------------------------------------------
 1 | import * as path from 'path';
 2 | import { Duration, Stack, CfnOutput } from 'aws-cdk-lib';
 3 | import * as lambda from 'aws-cdk-lib/aws-lambda';
 4 | import { SqsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';
 5 | import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
 6 | import * as sqs from 'aws-cdk-lib/aws-sqs';
 7 | import { Construct } from 'constructs';
 8 | import { GenerateSpyEventsFileProps } from './GenerateSpyEventsFileProps';
 9 | import { ServerlessSpy } from '../../../src/ServerlessSpy';
10 | 
11 | export class SqsToLambdaStack extends Stack {
12 |   constructor(scope: Construct, id: string, props: GenerateSpyEventsFileProps) {
13 |     super(scope, id, props);
14 | 
15 |     const queue = new sqs.Queue(this, 'MyQueue');
16 | 
17 |     const func = new NodejsFunction(this, 'MyLambda', {
18 |       memorySize: 512,
19 |       timeout: Duration.seconds(5),
20 |       runtime: lambda.Runtime.NODEJS_22_X,
21 |       handler: 'handler',
22 |       entry: path.join(__dirname, '../functions/dummy.ts'),
23 |       environment: {
24 |         NODE_OPTIONS: '--enable-source-maps',
25 |       },
26 |     });
27 |     func.addEventSource(new SqsEventSource(queue));
28 | 
29 |     const queue2 = new sqs.Queue(this, 'MyQueue2');
30 | 
31 |     const pythonFunc = new lambda.Function(this, 'MyPythonLambda', {
32 |       memorySize: 512,
33 |       timeout: Duration.seconds(5),
34 |       runtime: lambda.Runtime.PYTHON_3_9,
35 |       handler: 'dummy.handler',
36 |       code: lambda.Code.fromAsset(path.join(__dirname, '../functions/python/')),
37 |       environment: {},
38 |     });
39 |     pythonFunc.addEventSource(new SqsEventSource(queue2));
40 | 
41 |     const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
42 |       generateSpyEventsFileLocation: props.generateSpyEventsFile
43 |         ? 'serverlessSpyEvents/ServerlessSpyEventsSqsToLambda.ts'
44 |         : undefined,
45 |       debugMode: true,
46 |     });
47 | 
48 |     serverlessSpy.spy();
49 | 
50 |     new CfnOutput(this, `QueueUrl${serverlessSpy.getConstructName(queue)}`, {
51 |       value: queue.queueUrl,
52 |     });
53 |     new CfnOutput(this, `QueueUrl${serverlessSpy.getConstructName(queue2)}`, {
54 |       value: queue2.queueUrl,
55 |     });
56 |   }
57 | }
58 | 


--------------------------------------------------------------------------------
/test/cdk/test/lambdaToSqs.test.ts:
--------------------------------------------------------------------------------
 1 | import * as fs from 'fs';
 2 | import * as path from 'path';
 3 | import { LambdaClient, InvokeCommand } from '@aws-sdk/client-lambda';
 4 | import { v4 as uuidv4 } from 'uuid';
 5 | import { TestData } from './TestData';
 6 | import { createServerlessSpyListener } from '../../../listener/createServerlessSpyListener';
 7 | import { ServerlessSpyListener } from '../../../listener/ServerlessSpyListener';
 8 | import { ServerlessSpyEvents } from '../serverlessSpyEvents/ServerlessSpyEventsLambdaToSqs';
 9 | 
10 | jest.setTimeout(30000);
11 | 
12 | describe('Lambda to SQS', () => {
13 |   const exportLocation = path.join(__dirname, '../cdkOutput.json');
14 |   let serverlessSpyListener: ServerlessSpyListener<ServerlessSpyEvents>;
15 | 
16 |   if (!fs.existsSync(exportLocation)) {
17 |     throw new Error(`File ${exportLocation} does not exists.`);
18 |   }
19 |   const output = JSON.parse(fs.readFileSync(exportLocation).toString())[
20 |     'ServerlessSpyLambdaToSqs'
21 |   ];
22 | 
23 |   beforeEach(async () => {
24 |     serverlessSpyListener =
25 |       await createServerlessSpyListener<ServerlessSpyEvents>({
26 |         serverlessSpyWsUrl: output.ServerlessSpyWsUrl,
27 |       });
28 |   });
29 | 
30 |   afterEach(async () => {
31 |     serverlessSpyListener.stop();
32 |   });
33 | 
34 |   test('Basic test', async () => {
35 |     const lambdaClient = new LambdaClient({});
36 | 
37 |     const id = uuidv4();
38 |     const data = <TestData>{
39 |       id,
40 |       message: 'Hello',
41 |     };
42 | 
43 |     const command = new InvokeCommand({
44 |       FunctionName: output.FunctionNameMyLambda,
45 |       InvocationType: 'RequestResponse',
46 |       LogType: 'Tail',
47 |       Payload: JSON.stringify(data) as any,
48 |     });
49 | 
50 |     await lambdaClient.send(command);
51 | 
52 |     (
53 |       await (
54 |         await serverlessSpyListener.waitForFunctionMyLambdaRequest<TestData>({
55 |           condition: (d) => d.request.id === id,
56 |         })
57 |       )
58 |         .toMatchObject({ request: data })
59 |         .followedByResponse({})
60 |     ).toMatchObject({ response: data });
61 | 
62 |     // await serverlessSpyListener.waitForSqsMyQueueNo2<TestData>({
63 |     //   condition: (d) => d.body.id === id,
64 |     // });
65 |   });
66 | });
67 | 


--------------------------------------------------------------------------------
/doc/quick_start.md:
--------------------------------------------------------------------------------
 1 | # Quick Start
 2 | 
 3 | ServerlessSpy is meant for the following environments:
 4 |  - Development environment: So you can write tests. The web console helps you gain insight into what is happening in the system.
 5 |  - Automatic test environment: You execute written tests in CI/CD.
 6 | 
 7 | ## Step 1: Install
 8 | ```bash
 9 | npm install serverless-spy
10 | ```
11 | 
12 | ## Step 2: Include ServerlessSpy in the CDK stack 
13 | ```typescript
14 | const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
15 |   generateSpyEventsFileLocation: 'serverlessSpyEvents/ServerlessSpyEvents.ts'              
16 | });
17 | serverlessSpy.spy();
18 | ```
19 | [more](./CDK_construct.md)
20 | 
21 | ## Step 3: Deploy CDK stack with exporting CloudFormation outputs
22 | ```bash
23 | cdk deploy --outputs-file cdkOutput.json
24 | ```
25 | 
26 | The key part of the output is `ServerlessSpyWsUrl`, which is the URL to the WebSocket where the testing library and web console receive events. Exclude the `cdkOutput.json` file from `git` (like you always do), especially if it has secrets.
27 | 
28 | Apart from CF output, ServerlessSpy generates the TypeScript file `serverlessSpyEvents/ServerlessSpyEvents.ts` specified in the first step. This makes your tests strongly typed 💪 thanks to TypeScript.
29 | 
30 | ## Step 4: Write tests 🔨
31 | Initialize the `ServerlessSpyListener`
32 | ```typescript
33 | import { ServerlessSpyEvents } from '../serverlessSpyEvents/ServerlessSpyEvents';
34 | 
35 | let serverlessSpyListener: ServerlessSpyListener<ServerlessSpyEvents>;
36 | beforeEach(async () => {
37 |   serverlessSpyListener =
38 |     await createServerlessSpyListener<ServerlessSpyEvents>({
39 |       ServerlessSpyWsUrl: output.ServerlessSpyWsUrl, // ServerlessSpy IoT URL from CloudFormation output
40 |     });
41 | });
42 | ```  
43 | 
44 | Write test:
45 | ```typescript
46 | (
47 |   await serverlessSpyListener.waitForSnsTopicMyTopic<TestData>()
48 | ).toMatchObject({ message: data });
49 | ```
50 | Close the `ServerlessSpyListener`
51 | ```typescript
52 | afterEach(async () => {
53 |   serverlessSpyListener.stop();
54 | });
55 | ```
56 | [more](./writing_tests.md)
57 | 
58 | ## Step 5: Start local web console to gain more insights 🕵
59 | ```bash
60 | npx sspy --cdkoutput cdkOutput.json
61 | ```
62 | [more](./web_console.md)


--------------------------------------------------------------------------------
/test/cdk/test/lambdaToS3.test.ts:
--------------------------------------------------------------------------------
 1 | import * as fs from 'fs';
 2 | import * as path from 'path';
 3 | import { LambdaClient, InvokeCommand } from '@aws-sdk/client-lambda';
 4 | import { v4 as uuidv4 } from 'uuid';
 5 | import { TestData } from './TestData';
 6 | import { createServerlessSpyListener } from '../../../listener/createServerlessSpyListener';
 7 | import { ServerlessSpyListener } from '../../../listener/ServerlessSpyListener';
 8 | import { ServerlessSpyEvents } from '../serverlessSpyEvents/ServerlessSpyEventsLambdaToS3';
 9 | 
10 | jest.setTimeout(30000);
11 | 
12 | describe('Lambda to S3', () => {
13 |   const exportLocation = path.join(__dirname, '../cdkOutput.json');
14 |   let serverlessSpyListener: ServerlessSpyListener<ServerlessSpyEvents>;
15 | 
16 |   if (!fs.existsSync(exportLocation)) {
17 |     throw new Error(`File ${exportLocation} does not exists.`);
18 |   }
19 |   const output = JSON.parse(fs.readFileSync(exportLocation).toString())[
20 |     'ServerlessSpyLambdaToS3'
21 |   ];
22 | 
23 |   beforeEach(async () => {
24 |     serverlessSpyListener =
25 |       await createServerlessSpyListener<ServerlessSpyEvents>({
26 |         serverlessSpyWsUrl: output.ServerlessSpyWsUrl,
27 |       });
28 |   });
29 | 
30 |   afterEach(async () => {
31 |     serverlessSpyListener.stop();
32 |   });
33 | 
34 |   test('Basic test', async () => {
35 |     const lambdaClient = new LambdaClient({});
36 | 
37 |     const id = uuidv4();
38 |     const data = <TestData>{
39 |       id,
40 |       message: 'Hello',
41 |     };
42 | 
43 |     const command = new InvokeCommand({
44 |       FunctionName: output.FunctionNameMyLambda,
45 |       InvocationType: 'RequestResponse',
46 |       LogType: 'Tail',
47 |       Payload: JSON.stringify(data) as any,
48 |     });
49 | 
50 |     await lambdaClient.send(command);
51 | 
52 |     (
53 |       await (
54 |         await serverlessSpyListener.waitForFunctionMyLambdaRequest<TestData>({
55 |           condition: (d) => d.request.id === id,
56 |         })
57 |       )
58 |         .toMatchObject({ request: data })
59 |         .followedByResponse({})
60 |     ).toMatchObject({ response: data });
61 | 
62 |     (
63 |       await serverlessSpyListener.waitForS3MyBucket({
64 |         condition: (d) => d.key === `${id}.json`,
65 |       })
66 |     ).toMatchObject({ key: `${id}.json` }); //redundant
67 |   });
68 | });
69 | 


--------------------------------------------------------------------------------
/test/cdk/test/lambdaToSnS.test.ts:
--------------------------------------------------------------------------------
 1 | import * as fs from 'fs';
 2 | import * as path from 'path';
 3 | import { LambdaClient, InvokeCommand } from '@aws-sdk/client-lambda';
 4 | import { v4 as uuidv4 } from 'uuid';
 5 | import { TestData } from './TestData';
 6 | import { createServerlessSpyListener } from '../../../listener/createServerlessSpyListener';
 7 | import { ServerlessSpyListener } from '../../../listener/ServerlessSpyListener';
 8 | import { ServerlessSpyEvents } from '../serverlessSpyEvents/ServerlessSpyEventsLambdaToSns';
 9 | 
10 | jest.setTimeout(30000);
11 | 
12 | describe('Lambda to SNS', () => {
13 |   const exportLocation = path.join(__dirname, '../cdkOutput.json');
14 |   let serverlessSpyListener: ServerlessSpyListener<ServerlessSpyEvents>;
15 | 
16 |   if (!fs.existsSync(exportLocation)) {
17 |     throw new Error(`File ${exportLocation} does not exists.`);
18 |   }
19 |   const output = JSON.parse(fs.readFileSync(exportLocation).toString())[
20 |     'ServerlessSpyLambdaToSns'
21 |   ];
22 | 
23 |   beforeEach(async () => {
24 |     serverlessSpyListener =
25 |       await createServerlessSpyListener<ServerlessSpyEvents>({
26 |         serverlessSpyWsUrl: output.ServerlessSpyWsUrl,
27 |       });
28 |   });
29 | 
30 |   afterEach(async () => {
31 |     serverlessSpyListener.stop();
32 |   });
33 | 
34 |   test('Basic test', async () => {
35 |     const lambdaClient = new LambdaClient({});
36 | 
37 |     const id = uuidv4();
38 |     const data = <TestData>{
39 |       id,
40 |       message: 'Hello',
41 |     };
42 | 
43 |     const command = new InvokeCommand({
44 |       FunctionName: output.FunctionNameMyLambda,
45 |       InvocationType: 'RequestResponse',
46 |       LogType: 'Tail',
47 |       Payload: JSON.stringify(data) as any,
48 |     });
49 | 
50 |     await lambdaClient.send(command);
51 | 
52 |     (
53 |       await (
54 |         await serverlessSpyListener.waitForFunctionMyLambdaRequest<TestData>({
55 |           condition: (d) => d.request.id === id,
56 |         })
57 |       )
58 |         .toMatchObject({ request: data })
59 |         .followedByResponse({})
60 |     ).toMatchObject({ response: data });
61 | 
62 |     (
63 |       await serverlessSpyListener.waitForSnsTopicMyTopic<TestData>({
64 |         condition: (d) => d.message.id === id,
65 |       })
66 |     ).toMatchObject({ message: data });
67 |   });
68 | });
69 | 


--------------------------------------------------------------------------------
/.eslintrc.yml:
--------------------------------------------------------------------------------
 1 | env:
 2 |   jest: true
 3 |   node: true
 4 | root: true
 5 | plugins:
 6 |   - '@typescript-eslint'
 7 |   - import
 8 |   - prettier
 9 | parser: '@typescript-eslint/parser'
10 | parserOptions:
11 |   ecmaVersion: 2018
12 |   sourceType: module
13 |   project: ./tsconfig.dev.json
14 | extends:
15 |   - plugin:import/typescript
16 |   - prettier
17 |   - plugin:prettier/recommended
18 | settings:
19 |   import/parsers:
20 |     '@typescript-eslint/parser':
21 |       - .ts
22 |       - .tsx
23 |   import/resolver:
24 |     node: {}
25 |     typescript:
26 |       project: ./**/tsconfig.dev.json
27 |       alwaysTryTypes: true
28 | ignorePatterns:
29 |   - '*.js'
30 |   - '!.projenrc.js'
31 |   - '*.d.ts'
32 |   - node_modules/
33 |   - '*.generated.ts'
34 |   - coverage
35 | rules:
36 |   prettier/prettier:
37 |     - error
38 |   '@typescript-eslint/no-require-imports':
39 |     - error
40 |   import/no-extraneous-dependencies:
41 |     - off
42 |     - devDependencies:
43 |         - '**/test/**'
44 |         - '**/build-tools/**'
45 |       optionalDependencies: false
46 |       peerDependencies: true
47 |   import/no-unresolved:
48 |     - error
49 |   import/order:
50 |     - warn
51 |     - groups:
52 |         - builtin
53 |         - external
54 |       alphabetize:
55 |         order: asc
56 |         caseInsensitive: true
57 |   no-duplicate-imports:
58 |     - error
59 |   no-shadow:
60 |     - off
61 |   '@typescript-eslint/no-shadow':
62 |     - off
63 |   key-spacing:
64 |     - error
65 |   no-multiple-empty-lines:
66 |     - error
67 |   '@typescript-eslint/no-floating-promises':
68 |     - error
69 |   no-return-await:
70 |     - off
71 |   '@typescript-eslint/return-await':
72 |     - error
73 |   no-trailing-spaces:
74 |     - error
75 |   dot-notation:
76 |     - off
77 |   no-bitwise:
78 |     - error
79 |   '@typescript-eslint/member-ordering':
80 |     - error
81 |     - default:
82 |         - public-static-field
83 |         - public-static-method
84 |         - protected-static-field
85 |         - protected-static-method
86 |         - private-static-field
87 |         - private-static-method
88 |         - field
89 |         - constructor
90 |         - method
91 | overrides:
92 |   - files:
93 |       - .projenrc.js
94 |     rules:
95 |       '@typescript-eslint/no-require-imports': off
96 |       import/no-extraneous-dependencies: off
97 | 


--------------------------------------------------------------------------------
/test/cdk/test/lambdaToEventBridge.test.ts:
--------------------------------------------------------------------------------
 1 | import * as fs from 'fs';
 2 | import * as path from 'path';
 3 | import { LambdaClient, InvokeCommand } from '@aws-sdk/client-lambda';
 4 | import { v4 as uuidv4 } from 'uuid';
 5 | import { TestData } from './TestData';
 6 | import { createServerlessSpyListener } from '../../../listener/createServerlessSpyListener';
 7 | import { ServerlessSpyListener } from '../../../listener/ServerlessSpyListener';
 8 | import { ServerlessSpyEvents } from '../serverlessSpyEvents/ServerlessSpyEventsLambdaToEventBridge';
 9 | 
10 | jest.setTimeout(30000);
11 | 
12 | describe('Lambda to EventBridge', () => {
13 |   const exportLocation = path.join(__dirname, '../cdkOutput.json');
14 |   let serverlessSpyListener: ServerlessSpyListener<ServerlessSpyEvents>;
15 | 
16 |   if (!fs.existsSync(exportLocation)) {
17 |     throw new Error(`File ${exportLocation} does not exists.`);
18 |   }
19 |   const output = JSON.parse(fs.readFileSync(exportLocation).toString())[
20 |     'ServerlessSpyLambdaToEventBridge'
21 |   ];
22 | 
23 |   beforeEach(async () => {
24 |     serverlessSpyListener =
25 |       await createServerlessSpyListener<ServerlessSpyEvents>({
26 |         serverlessSpyWsUrl: output.ServerlessSpyWsUrl,
27 |       });
28 |   });
29 | 
30 |   afterEach(async () => {
31 |     serverlessSpyListener.stop();
32 |   });
33 | 
34 |   test('Basic test', async () => {
35 |     const lambdaClient = new LambdaClient({});
36 | 
37 |     const id = uuidv4();
38 |     const data = <TestData>{
39 |       id,
40 |       message: 'Hello',
41 |     };
42 | 
43 |     const command = new InvokeCommand({
44 |       FunctionName: output.FunctionNameMyLambda,
45 |       InvocationType: 'RequestResponse',
46 |       LogType: 'Tail',
47 |       Payload: JSON.stringify(data) as any,
48 |     });
49 | 
50 |     await lambdaClient.send(command);
51 | 
52 |     (
53 |       await (
54 |         await serverlessSpyListener.waitForFunctionMyLambdaRequest<TestData>({
55 |           condition: (d) => d.request.id === id,
56 |         })
57 |       )
58 |         .toMatchObject({ request: data })
59 |         .followedByResponse({})
60 |     ).toMatchObject({ response: data });
61 | 
62 |     (
63 |       await serverlessSpyListener.waitForEventBridgeMyEventBus<TestData>({
64 |         condition: (d) => d.detail.id === id,
65 |       })
66 |     ).toMatchObject({ detail: data });
67 |   });
68 | });
69 | 


--------------------------------------------------------------------------------
/test/cdk/test/lambdaToDynamoDb.test.ts:
--------------------------------------------------------------------------------
 1 | import * as fs from 'fs';
 2 | import * as path from 'path';
 3 | import { LambdaClient, InvokeCommand } from '@aws-sdk/client-lambda';
 4 | import { v4 as uuidv4 } from 'uuid';
 5 | import { TestData } from './TestData';
 6 | import { createServerlessSpyListener } from '../../../listener/createServerlessSpyListener';
 7 | import { ServerlessSpyListener } from '../../../listener/ServerlessSpyListener';
 8 | import { ServerlessSpyEvents } from '../serverlessSpyEvents/ServerlessSpyEventsLambdaToDynamoDbStack';
 9 | 
10 | jest.setTimeout(30000);
11 | 
12 | describe('Lambda to DynamoDB', () => {
13 |   const exportLocation = path.join(__dirname, '../cdkOutput.json');
14 |   let serverlessSpyListener: ServerlessSpyListener<ServerlessSpyEvents>;
15 | 
16 |   if (!fs.existsSync(exportLocation)) {
17 |     throw new Error(`File ${exportLocation} does not exists.`);
18 |   }
19 |   const output = JSON.parse(fs.readFileSync(exportLocation).toString())[
20 |     'ServerlessSpyLambdaToDynamoDb'
21 |   ];
22 | 
23 |   beforeEach(async () => {
24 |     serverlessSpyListener =
25 |       await createServerlessSpyListener<ServerlessSpyEvents>({
26 |         serverlessSpyWsUrl: output.ServerlessSpyWsUrl,
27 |       });
28 |   });
29 | 
30 |   afterEach(async () => {
31 |     serverlessSpyListener.stop();
32 |   });
33 | 
34 |   test('Basic test', async () => {
35 |     const lambdaClient = new LambdaClient({});
36 | 
37 |     const id = uuidv4();
38 |     const data = <TestData>{
39 |       id,
40 |       message: 'Hello',
41 |     };
42 | 
43 |     const command = new InvokeCommand({
44 |       FunctionName: output.FunctionNameMyLambda,
45 |       InvocationType: 'RequestResponse',
46 |       LogType: 'Tail',
47 |       Payload: JSON.stringify(data) as any,
48 |     });
49 | 
50 |     await lambdaClient.send(command);
51 | 
52 |     (
53 |       await (
54 |         await serverlessSpyListener.waitForFunctionMyLambdaRequest<TestData>({
55 |           condition: (d) => d.request.id === id,
56 |         })
57 |       )
58 |         .toMatchObject({ request: data })
59 |         .followedByResponse({})
60 |     ).toMatchObject({ response: data });
61 | 
62 |     (
63 |       await serverlessSpyListener.waitForDynamoDBMyTable<TestData>({
64 |         condition: (d) => d.keys.pk === id,
65 |       })
66 |     ).toMatchObject({
67 |       eventName: 'INSERT',
68 |       newImage: data,
69 |     });
70 |   });
71 | });
72 | 


--------------------------------------------------------------------------------
/test/cdk/test/lambdaToDynamoDb2.test.ts:
--------------------------------------------------------------------------------
 1 | import * as fs from 'fs';
 2 | import * as path from 'path';
 3 | import { LambdaClient, InvokeCommand } from '@aws-sdk/client-lambda';
 4 | import { v4 as uuidv4 } from 'uuid';
 5 | import { TestData } from './TestData';
 6 | import { createServerlessSpyListener } from '../../../listener/createServerlessSpyListener';
 7 | import { ServerlessSpyListener } from '../../../listener/ServerlessSpyListener';
 8 | import { ServerlessSpyEvents } from '../serverlessSpyEvents/ServerlessSpyEventsLambdaToDynamoDbStack';
 9 | 
10 | jest.setTimeout(30000);
11 | 
12 | describe('Lambda to DynamoDB for table V2', () => {
13 |   const exportLocation = path.join(__dirname, '../cdkOutput.json');
14 |   let serverlessSpyListener: ServerlessSpyListener<ServerlessSpyEvents>;
15 | 
16 |   if (!fs.existsSync(exportLocation)) {
17 |     throw new Error(`File ${exportLocation} does not exists.`);
18 |   }
19 |   const output = JSON.parse(fs.readFileSync(exportLocation).toString())[
20 |     'ServerlessSpyLambdaToDynamoDb2'
21 |   ];
22 | 
23 |   beforeEach(async () => {
24 |     serverlessSpyListener =
25 |       await createServerlessSpyListener<ServerlessSpyEvents>({
26 |         serverlessSpyWsUrl: output.ServerlessSpyWsUrl,
27 |       });
28 |   });
29 | 
30 |   afterEach(async () => {
31 |     serverlessSpyListener.stop();
32 |   });
33 | 
34 |   test('Basic test', async () => {
35 |     const lambdaClient = new LambdaClient({});
36 | 
37 |     const id = uuidv4();
38 |     const data = <TestData>{
39 |       id,
40 |       message: 'Hello',
41 |     };
42 | 
43 |     const command = new InvokeCommand({
44 |       FunctionName: output.FunctionNameMyLambda,
45 |       InvocationType: 'RequestResponse',
46 |       LogType: 'Tail',
47 |       Payload: JSON.stringify(data) as any,
48 |     });
49 | 
50 |     await lambdaClient.send(command);
51 | 
52 |     (
53 |       await (
54 |         await serverlessSpyListener.waitForFunctionMyLambdaRequest<TestData>({
55 |           condition: (d) => d.request.id === id,
56 |         })
57 |       )
58 |         .toMatchObject({ request: data })
59 |         .followedByResponse({})
60 |     ).toMatchObject({ response: data });
61 | 
62 |     (
63 |       await serverlessSpyListener.waitForDynamoDBMyTable<TestData>({
64 |         condition: (d) => d.keys.pk === id,
65 |       })
66 |     ).toMatchObject({
67 |       eventName: 'INSERT',
68 |       newImage: data,
69 |     });
70 |   });
71 | });
72 | 


--------------------------------------------------------------------------------
/cli/icons/Arch_Amazon-Simple-Storage-Service_16.svg:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <svg width="24px" height="24px" viewBox="0 0 24 24" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
 3 |     <title>Icon-Architecture/16/Arch_Amazon-Simple-Storage-Service_16</title>
 4 |     <defs>
 5 |         <linearGradient x1="0%" y1="100%" x2="100%" y2="0%" id="linearGradient-1">
 6 |             <stop stop-color="#1B660F" offset="0%"></stop>
 7 |             <stop stop-color="#6CAE3E" offset="100%"></stop>
 8 |         </linearGradient>
 9 |     </defs>
10 |     <g id="Icon-Architecture/16/Arch_Amazon-Simple-Storage-Service_16" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
11 |         <g id="Rectangle" fill="url(#linearGradient-1)">
12 |             <rect x="0" y="0" width="24" height="24"></rect>
13 |         </g>
14 |         <g id="Icon-Service/16/Amazon-Simple-Storage-Service_16" transform="translate(4.000000, 4.000000)" fill="#FFFFFF">
15 |             <path d="M13.9082,9.0508 L13.9492,8.8068 C14.2152,8.9598 14.4192,9.0888 14.5642,9.1918 C14.3942,9.1638 14.1662,9.1138 13.9082,9.0508 L13.9082,9.0508 Z M12.0492,14.0928 C11.9992,14.3958 10.9792,14.9998 7.4782,14.9998 C4.0442,14.9998 3.0432,14.3968 2.9932,14.0898 L1.2592,3.9648 C2.6962,4.6678 5.1522,4.9998 7.5002,4.9998 C9.8502,4.9998 12.3112,4.6658 13.7482,3.9618 L12.9402,8.7748 C11.3852,8.2668 9.5682,7.3978 8.6442,6.9548 L8.4742,6.8728 C8.4092,6.3838 8.0072,5.9998 7.5002,5.9998 C6.9482,5.9998 6.5002,6.4488 6.5002,6.9998 C6.5002,7.5508 6.9482,7.9998 7.5002,7.9998 C7.7212,7.9998 7.9142,7.9138 8.0792,7.7928 L8.2132,7.8568 C9.1842,8.3228 11.1192,9.2468 12.7732,9.7698 L12.0492,14.0928 Z M7.5002,0.9998 C11.7612,0.9998 13.9712,2.0368 14.0002,2.4898 L14.0002,2.5188 C13.9462,2.9768 11.7352,3.9998 7.5002,3.9998 C3.2702,3.9998 1.0592,2.9798 1.0002,2.5208 L1.0002,2.4888 C1.0302,2.0348 3.2422,0.9998 7.5002,0.9998 L7.5002,0.9998 Z M15.0002,2.4998 C15.0002,0.7818 11.1122,-0.0002 7.5002,-0.0002 C3.8872,-0.0002 0.0002,0.7818 0.0002,2.4998 L0.0472,2.8158 L2.0072,14.2548 C2.1972,15.4248 3.9362,15.9998 7.4782,15.9998 C12.2072,15.9998 12.9142,14.9908 13.0352,14.2568 L13.7422,10.0428 C14.3202,10.1828 14.7312,10.2388 15.0232,10.2388 C15.4852,10.2388 15.6612,10.1038 15.7832,9.9598 C15.9292,9.7858 15.9852,9.5668 15.9422,9.3428 C15.8492,8.8678 15.3302,8.4158 14.1252,7.7598 L14.9542,2.8138 L15.0002,2.4998 Z" id="Amazon-Simple-Storage-Service-Icon_16_Squid"></path>
16 |         </g>
17 |     </g>
18 | </svg>


--------------------------------------------------------------------------------
/doc/Lambda.md:
--------------------------------------------------------------------------------
 1 | # Lambda
 2 | 
 3 | 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/).
 4 | 
 5 | Basic example:
 6 | 
 7 | ```typescript
 8 | await serverlessSpyListener.waitForFunctionMyLambdaRequest();
 9 | ```
10 | 
11 | You can use conditions to wait for a particular event. You can also use generic (`TestData`) to strongly type the event.
12 | 
13 | ```typescript
14 | await serverlessSpyListener.waitForFunctionMyLambdaRequest<TestData>({
15 |   condition: (d) => d.request.id === myData.id,
16 | });
17 | ```
18 | 
19 | Lambda produces three kinds of events: **Request, Console, Response**
20 | ```typescript
21 | await serverlessSpyListener.waitForFunctionMyLambdaRequest();
22 | await serverlessSpyListener.waitForFunctionMyLambdaConsole();
23 | await serverlessSpyListener.waitForFunctionMyLambdaResponse();
24 | ```
25 | The `Console` event can be useful to validate intermediate processing steps. You write events with a simple `console.log()` method in the Lambda code.
26 | 
27 | You can chain calls for the same request:
28 | ```typescript
29 | await (
30 |   await (
31 |     await serverlessSpyListener.waitForFunctionMyLambdaRequest({
32 |       condition: (d) => d.request.id === myData.id,
33 |     })
34 |   ).followedByConsole()
35 | ).followedByResponse();
36 | ```
37 | 
38 | The condition `condition: (d) => d.request.id === myData.id` finds the correct request and than you can use on each part `getData()` to get the event or any Jest functions to validate.
39 | 
40 | So a fully blown test would look like this:
41 | ```typescript
42 | (
43 |   await (
44 |     await (
45 |       await serverlessSpyListener.waitForFunctionMyLambdaRequest<TestData>({
46 |         condition: (d) => d.request.id === myData.id,
47 |       })
48 |     )
49 |       .toMatchObject({
50 |         request: myData,
51 |       })
52 |       .followedByConsole()
53 |   )
54 |     .toMatchObject({
55 |       request: myData,
56 |       console: {
57 |         message: 'My console log message',
58 |         optionalParams: [myData],
59 |       },
60 |     })
61 |     .followedByResponse()
62 | ).toMatchObject({
63 |   request: myData,
64 |   response: {
65 |     ...myData,
66 |     message: `${myData.message} ServerlessSpy`,
67 |   },
68 | ```
69 | 
70 | You can see all combinations in [this test](https://github.com/ServerlessLife/serverless-spy/blob/main/test/cdk/test/lambda.test.ts){:target="_blank"}.


--------------------------------------------------------------------------------
/test/cdk/src/esmLambdaStack.ts:
--------------------------------------------------------------------------------
 1 | import * as path from 'path';
 2 | import { Duration, Stack, CfnOutput } from 'aws-cdk-lib';
 3 | import * as lambda from 'aws-cdk-lib/aws-lambda';
 4 | import {
 5 |   NodejsFunction,
 6 |   OutputFormat,
 7 |   BundlingOptions,
 8 | } from 'aws-cdk-lib/aws-lambda-nodejs';
 9 | import { Construct } from 'constructs';
10 | import { GenerateSpyEventsFileProps } from './GenerateSpyEventsFileProps';
11 | import { ServerlessSpy } from '../../../src/ServerlessSpy';
12 | 
13 | export class EsmLambdaStack extends Stack {
14 |   constructor(scope: Construct, id: string, props: GenerateSpyEventsFileProps) {
15 |     super(scope, id, props);
16 |     const bundling: BundlingOptions = {
17 |       format: OutputFormat.ESM,
18 |       target: 'node18.13.0',
19 |       // See https://github.com/evanw/esbuild/issues/1921#issuecomment-1152991694
20 |       banner:
21 |         "import { createRequire } from 'module';const require = createRequire(import.meta.url);",
22 |       esbuildArgs: {
23 |         '--out-extension:.js': '.mjs',
24 |       },
25 |       tsconfig: path.join(__dirname, '../tsconfig.esm.json'),
26 |     };
27 |     const func = new NodejsFunction(this, 'MyLambda', {
28 |       memorySize: 512,
29 |       timeout: Duration.seconds(5),
30 |       runtime: lambda.Runtime.NODEJS_22_X,
31 |       handler: 'handler',
32 |       entry: path.join(__dirname, '../functions/lambda.ts'),
33 |       environment: {
34 |         NODE_OPTIONS: '--enable-source-maps',
35 |       },
36 |       bundling,
37 |     });
38 | 
39 |     // use uncommon name
40 |     const func2 = new NodejsFunction(this, 'my_lambda-TestName_2', {
41 |       memorySize: 512,
42 |       timeout: Duration.seconds(5),
43 |       runtime: lambda.Runtime.NODEJS_22_X,
44 |       handler: 'handler',
45 |       entry: path.join(__dirname, '../functions/lambda.ts'),
46 |       environment: {
47 |         NODE_OPTIONS: '--enable-source-maps',
48 |       },
49 |       bundling,
50 |     });
51 | 
52 |     const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
53 |       generateSpyEventsFileLocation: props.generateSpyEventsFile
54 |         ? 'serverlessSpyEvents/ServerlessSpyEventsEsmLambda.ts'
55 |         : undefined,
56 |       debugMode: true,
57 |     });
58 | 
59 |     serverlessSpy.spy();
60 | 
61 |     new CfnOutput(this, `FunctionName${serverlessSpy.getConstructName(func)}`, {
62 |       value: func.functionName,
63 |     });
64 |     new CfnOutput(
65 |       this,
66 |       `FunctionName${serverlessSpy.getConstructName(func2)}`,
67 |       {
68 |         value: func2.functionName,
69 |       }
70 |     );
71 |   }
72 | }
73 | 


--------------------------------------------------------------------------------
/.github/workflows/build.yml:
--------------------------------------------------------------------------------
 1 | name: build
 2 | on:
 3 |   pull_request: {}
 4 |   workflow_dispatch: {}
 5 | env:
 6 |   node_version: 22
 7 | jobs:
 8 |   build:
 9 |     runs-on: ubuntu-latest
10 |     permissions:
11 |       contents: write
12 |     outputs:
13 |       self_mutation_happened: ${{ steps.self_mutation.outputs.self_mutation_happened }}
14 |     env:
15 |       CI: 'true'
16 |       AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
17 |       AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
18 |       AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }}
19 |       AWS_REGION: ${{ secrets.AWS_REGION }}
20 |     steps:
21 |       - name: Checkout
22 |         uses: actions/checkout@v3
23 |         with:
24 |           ref: ${{ github.event.pull_request.head.ref }}
25 |           repository: ${{ github.event.pull_request.head.repo.full_name }}
26 |       - name: Configure AWS credentials from Test account
27 |         uses: aws-actions/configure-aws-credentials@v4
28 |         with:
29 |           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
30 |           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
31 |           aws-region: ${{ secrets.AWS_REGION }}
32 |       - uses: actions/setup-node@v6
33 |         with:
34 |           node-version: ${{ env.node_version }}
35 |       - name: Update npm
36 |         run: npm install -g npm@latest
37 |       - name: sudo docker
38 |         run: sudo chmod 777 /var/run/docker.sock
39 |       - name: Install dependencies
40 |         run: npm install
41 |       - name: build
42 |         run: scripts/run-task build
43 |       - name: Upload artifact
44 |         uses: actions/upload-artifact@v4.3.6
45 |         with:
46 |           name: build-artifact
47 |           path: dist
48 |     container:
49 |       image: jsii/superchain:1-buster-slim-node14
50 |   package-js:
51 |     needs: build
52 |     runs-on: ubuntu-latest
53 |     permissions: {}
54 |     if: '! needs.build.outputs.self_mutation_happened'
55 |     steps:
56 |       - uses: actions/setup-node@v6
57 |         with:
58 |           node-version: ${{ env.node_version }}
59 |       - name: Update npm
60 |         run: npm install -g npm@latest
61 |       - name: Download build artifacts
62 |         uses: actions/download-artifact@v4
63 |         with:
64 |           name: build-artifact
65 |           path: dist
66 |       - name: Prepare Repository
67 |         run: mv dist .repo
68 |       - name: Install Dependencies
69 |         run: cd .repo && npm ci
70 |       - name: Create js artifact
71 |         run: cd .repo && npx projen package:js
72 |       - name: Collect js Artifact
73 |         run: mv .repo/dist dist
74 | 


--------------------------------------------------------------------------------
/test/cdk/src/lambdaStack.ts:
--------------------------------------------------------------------------------
 1 | import * as path from 'path';
 2 | import { Duration, Stack, CfnOutput } from 'aws-cdk-lib';
 3 | import * as lambda from 'aws-cdk-lib/aws-lambda';
 4 | import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
 5 | import { Construct } from 'constructs';
 6 | import { GenerateSpyEventsFileProps } from './GenerateSpyEventsFileProps';
 7 | import { ServerlessSpy } from '../../../src/ServerlessSpy';
 8 | 
 9 | export class LambdaStack extends Stack {
10 |   constructor(scope: Construct, id: string, props: GenerateSpyEventsFileProps) {
11 |     super(scope, id, props);
12 | 
13 |     const func = new NodejsFunction(this, 'MyLambda', {
14 |       memorySize: 512,
15 |       timeout: Duration.seconds(5),
16 |       runtime: lambda.Runtime.NODEJS_20_X, // older version to test
17 |       handler: 'handler',
18 |       entry: path.join(__dirname, '../functions/lambda.ts'),
19 |       environment: {
20 |         NODE_OPTIONS: '--enable-source-maps',
21 |       },
22 |     });
23 |     func.addAlias('live');
24 | 
25 |     // use uncommon name
26 |     const func2 = new NodejsFunction(this, 'my_lambda-TestName_2', {
27 |       memorySize: 512,
28 |       timeout: Duration.seconds(5),
29 |       runtime: lambda.Runtime.NODEJS_22_X,
30 |       handler: 'handler',
31 |       entry: path.join(__dirname, '../functions/lambda.ts'),
32 |       environment: {
33 |         NODE_OPTIONS: '--enable-source-maps',
34 |       },
35 |     });
36 | 
37 |     const func3 = new NodejsFunction(this, 'MyLambdaThatFails', {
38 |       memorySize: 512,
39 |       timeout: Duration.seconds(5),
40 |       runtime: lambda.Runtime.NODEJS_22_X,
41 |       handler: 'handler',
42 |       entry: path.join(__dirname, '../functions/lambdaFail.ts'),
43 |       environment: {
44 |         NODE_OPTIONS: '--enable-source-maps',
45 |       },
46 |     });
47 | 
48 |     const serverlessSpy = new ServerlessSpy(this, 'ServerlessSpy', {
49 |       generateSpyEventsFileLocation: props.generateSpyEventsFile
50 |         ? 'serverlessSpyEvents/ServerlessSpyEventsLambda.ts'
51 |         : undefined,
52 |       debugMode: true,
53 |     });
54 | 
55 |     serverlessSpy.spy();
56 | 
57 |     new CfnOutput(this, `FunctionName${serverlessSpy.getConstructName(func)}`, {
58 |       value: func.functionName,
59 |     });
60 |     new CfnOutput(
61 |       this,
62 |       `FunctionName${serverlessSpy.getConstructName(func2)}`,
63 |       {
64 |         value: func2.functionName,
65 |       }
66 |     );
67 |     new CfnOutput(
68 |       this,
69 |       `FunctionName${serverlessSpy.getConstructName(func3)}`,
70 |       {
71 |         value: func3.functionName,
72 |       }
73 |     );
74 |   }
75 | }
76 | 


--------------------------------------------------------------------------------
/common/getWebSocketUrl.ts:
--------------------------------------------------------------------------------
 1 | import { fromNodeProviderChain } from '@aws-sdk/credential-providers';
 2 | import { Credentials } from '@aws-sdk/types';
 3 | import * as aws4 from 'aws4';
 4 | 
 5 | // ""wss://m6g3w6ttdh.execute-api.eu-west-1.amazonaws.com/prod";"
 6 | 
 7 | export async function getSignedWebSocketUrl(
 8 |   url: string,
 9 |   credentials?: Credentials
10 | ) {
11 |   let hostParts: string[];
12 |   let pathname: string;
13 | 
14 |   if (!url) {
15 |     throw new Error(`Missing websocket URL`);
16 |   }
17 | 
18 |   try {
19 |     new URL(url); //validate URL
20 | 
21 |     const urlParsed = parseUrl(url);
22 |     pathname = urlParsed!.pathname!;
23 |     hostParts = urlParsed!.host.split('.');
24 |   } catch {
25 |     throw new Error(`Invalid websocket URL ${url}`);
26 |   }
27 | 
28 |   if (!credentials) {
29 |     const credentialsProvider = fromNodeProviderChain();
30 |     credentials = await credentialsProvider();
31 |   }
32 | 
33 |   const AWS_REGION = hostParts[2]; // The region of your API-gateway
34 |   const SOCKET_HOST = hostParts[0]; // Your API-gateway ID
35 |   const ENV = pathname.replace(/^\//, ''); // The stage of your target deployment
36 |   const WEBSOCKET_URL = `${SOCKET_HOST}.execute-api.${AWS_REGION}.amazonaws.com`; // Don't prepend with wss!
37 |   // const AWS_REGION = "eu-west-1"; // The region of your API-gateway
38 |   // const SOCKET_HOST = "m6g3w6ttdh"; // Your API-gateway ID
39 |   // const ENV = "prod"; // The stage of your target deployment
40 |   // const WEBSOCKET_URL = `${SOCKET_HOST}.execute-api.${AWS_REGION}.amazonaws.com`; // Don't prepend with wss!
41 | 
42 |   // Get a signed path
43 |   const { path } = aws4.sign(
44 |     {
45 |       method: 'GET',
46 |       host: WEBSOCKET_URL,
47 |       // path: `/${ENV}?X-Amz-Security-Token=${encodeURIComponent(
48 |       //   credentials!.SessionToken!
49 |       // )}`,
50 |       path: `/${ENV}`,
51 |       service: 'execute-api',
52 |       region: AWS_REGION,
53 |       signQuery: true,
54 |     },
55 |     {
56 |       accessKeyId: credentials.accessKeyId,
57 |       secretAccessKey: credentials.secretAccessKey,
58 |       sessionToken: credentials.sessionToken,
59 |     }
60 |   );
61 | 
62 |   const url2 = `wss://${WEBSOCKET_URL}${path}`;
63 |   return url2;
64 | }
65 | 
66 | function parseUrl(href: string) {
67 |   const match = href.match(
68 |     /^(wss?:)\/\/(([^:/?#]*)(?::([0-9]+))?)([/]{0,1}[^?#]*)(\?[^#]*|)(#.*|)$/
69 |   );
70 |   return (
71 |     match && {
72 |       href,
73 |       protocol: match[1],
74 |       host: match[2],
75 |       hostname: match[3],
76 |       port: match[4],
77 |       pathname: match[5],
78 |       search: match[6],
79 |       hash: match[7],
80 |     }
81 |   );
82 | }
83 | 


--------------------------------------------------------------------------------
/test/cdk/test/snsToSqs.test.ts:
--------------------------------------------------------------------------------
 1 | import * as fs from 'fs';
 2 | import * as path from 'path';
 3 | import { PublishCommand, SNSClient } from '@aws-sdk/client-sns';
 4 | import { App } from 'aws-cdk-lib';
 5 | import { Template } from 'aws-cdk-lib/assertions';
 6 | import { SNSMessage } from 'aws-lambda';
 7 | import { v4 as uuidv4 } from 'uuid';
 8 | import { TestData } from './TestData';
 9 | import { createServerlessSpyListener } from '../../../listener/createServerlessSpyListener';
10 | import { ServerlessSpyListener } from '../../../listener/ServerlessSpyListener';
11 | import { ServerlessSpyEvents } from '../serverlessSpyEvents/ServerlessSpyEventsSnsToSqs';
12 | import { SnsToSqsStack } from '../src/snsToSqsStack';
13 | 
14 | jest.setTimeout(30000);
15 | 
16 | describe('SNS to SQS', () => {
17 |   const exportLocation = path.join(__dirname, '../cdkOutput.json');
18 |   let serverlessSpyListener: ServerlessSpyListener<ServerlessSpyEvents>;
19 | 
20 |   if (!fs.existsSync(exportLocation)) {
21 |     throw new Error(`File ${exportLocation} does not exists.`);
22 |   }
23 |   const output = JSON.parse(fs.readFileSync(exportLocation).toString())[
24 |     'ServerlessSpySnsToSqs'
25 |   ];
26 | 
27 |   beforeEach(async () => {
28 |     serverlessSpyListener =
29 |       await createServerlessSpyListener<ServerlessSpyEvents>({
30 |         serverlessSpyWsUrl: output.ServerlessSpyWsUrl,
31 |       });
32 |   });
33 | 
34 |   afterEach(async () => {
35 |     serverlessSpyListener.stop();
36 |   });
37 | 
38 |   test('Basic test', async () => {
39 |     const id = uuidv4();
40 |     const data = <TestData>{
41 |       id,
42 |       message: 'Hello',
43 |     };
44 | 
45 |     const snsClient = new SNSClient({});
46 |     const params = new PublishCommand({
47 |       Message: JSON.stringify(data),
48 |       TopicArn: output.SnsTopicArnMyTopic,
49 |     });
50 |     await snsClient.send(params);
51 | 
52 |     (
53 |       await serverlessSpyListener.waitForSnsTopicMyTopic<TestData>({
54 |         condition: (d) => d.message.id === id,
55 |       })
56 |     ).toMatchObject({ message: data });
57 | 
58 |     (
59 |       await serverlessSpyListener.waitForSnsSubscriptionMyTopicMyQueue<TestData>(
60 |         {
61 |           condition: (d) => d.message.id === id,
62 |         }
63 |       )
64 |     ).toMatchObject({ message: data });
65 | 
66 |     (
67 |       await serverlessSpyListener.waitForSqsMyQueue<SNSMessage>({
68 |         condition: (d) => JSON.parse(d.body.Message).id === id,
69 |       })
70 |     ).toMatchObject({
71 |       body: {
72 |         Message: JSON.stringify(data),
73 |       },
74 |     });
75 |   });
76 | 
77 |   test('Snapshot', () => {
78 |     const app = new App();
79 |     const stack = new SnsToSqsStack(app, 'Test', {
80 |       generateSpyEventsFile: false,
81 |     });
82 |     const template = Template.fromStack(stack);
83 |     expect(template.toJSON()).toMatchSnapshot();
84 |   });
85 | });
86 | 


--------------------------------------------------------------------------------
/doc/FAQ.md:
--------------------------------------------------------------------------------
 1 | # Frequently Asked Questions (FAQ)
 2 | 
 3 | ## In which environment should ServerlessSpy be used?
 4 |  - Development environment: So you can write tests. The web console helps you gain insight into what is happening in the system.
 5 |  - Automatic test environment: You execute written tests in CI/CD.
 6 | 
 7 | ## Can ServerlessSpy be used as distributer tracing like XRay, Lumigo, Epsagon...
 8 | No. ServerlessSpy can be useful as a developer tool to see events that are occurring in the development environment. The main benefit compared to mentioned tools is that you can see events in real time. But ServerlessSpy does not have near capabilities of those tools, especially not tracing an event through services, which is the main point of distributed tracing.
 9 | 
10 | ## What kind of costs does ServerlessSpy induce?
11 | If you are using ServerlessSpy in a low-traffic environment like dev and test usually are, the costs are negligible. For high-load environments, like production, you should exclude ServerlessSpy. It has no use there, and it will just induce costs and could contribute to hitting AWS quotas & limits like Lambda concurrent executions.
12 | 
13 | ## Does ServerlessSpy increase response time?
14 | Negligible, and that's only when hitting Lambda. You should exclude the ServerlessSpy construct in the production environment anyway.
15 | 
16 | ## I do not want a new resource created by ServerlessSpy in my stack.
17 | Additional resources do not harm and do not cause any noticeable costs (in a dev or test environment). But if you still do not want them, you can add them just for the period of executing the test. Some similar testing libraries do that out of the box. Just redeploy before executing the tests with ServerlessSpy construct included via parameter and then again redeploy afterward with ServerlessSpy construct excluded.
18 | 
19 | ## I want to use ServerlessSpy in a developer environment that is used by many developers.
20 | The recommended way to develop serverless systems is to have a separate environment for each developer or/and each feature. You can still use ServerlessSpy if you share an environment, although discouraged. In the web console, you will see events that other developers triggered. And those events could also interfere with your tests if you do not use conditions that filter events by some unique attribute.
21 | 
22 | ## Why are API Gateway and AppSync not supported?
23 | They are, but not directly. API Gateway and AppSync services do not support intercepting events, except via CloudWatch, which is slooooow 🐌🐌🐌. ServerlessSpy needs to be fast. You can intercept those events when they hit other supported services like Lambda.
24 | 
25 | ## My custom resource/S3 deployment does not show up?
26 | Custom resources and s3Deployments (among other CDK constructs) are backed by a SingletonFunction which can cause a lot of issues with your deploy (circular dependencies etc.). 
27 | For everyone's sanity, these are excluded. Feel free to open an issue if you have a use-case where you need this to be included.  


--------------------------------------------------------------------------------
/test/cdk/.github/workflows/upgrade.yml:
--------------------------------------------------------------------------------
 1 | name: upgrade
 2 | on:
 3 |   workflow_dispatch: {}
 4 |   schedule:
 5 |     - cron: 0 0 * * *
 6 | jobs:
 7 |   upgrade:
 8 |     name: Upgrade
 9 |     runs-on: ubuntu-latest
10 |     permissions:
11 |       contents: read
12 |     outputs:
13 |       patch_created: ${{ steps.create_patch.outputs.patch_created }}
14 |     steps:
15 |       - name: Checkout
16 |         uses: actions/checkout@v3
17 |       - name: Install dependencies
18 |         run: npm ci
19 |       - name: Upgrade dependencies
20 |         run: scripts/run-task upgrade
21 |       - id: create_patch
22 |         name: Find mutations
23 |         run: |-
24 |           git add .
25 |           git diff --staged --patch --exit-code > .repo.patch || echo "::set-output name=patch_created::true"
26 |       - if: steps.create_patch.outputs.patch_created
27 |         name: Upload patch
28 |         uses: actions/upload-artifact@v4.3.6
29 |         with:
30 |           name: .repo.patch
31 |           path: .repo.patch
32 |           include-hidden-files: true
33 |   pr:
34 |     name: Create Pull Request
35 |     needs: upgrade
36 |     runs-on: ubuntu-latest
37 |     permissions:
38 |       contents: write
39 |       pull-requests: write
40 |     if: ${{ needs.upgrade.outputs.patch_created }}
41 |     steps:
42 |       - name: Checkout
43 |         uses: actions/checkout@v3
44 |         with:
45 |           token: ${{ secrets.PROJEN_GITHUB_TOKEN }}
46 |       - name: Download patch
47 |         uses: actions/download-artifact@v3
48 |         with:
49 |           name: .repo.patch
50 |           path: ${{ runner.temp }}
51 |       - name: Apply patch
52 |         run: '[ -s ${{ runner.temp }}/.repo.patch ] && git apply ${{ runner.temp }}/.repo.patch || echo "Empty patch. Skipping."'
53 |       - name: Set git identity
54 |         run: |-
55 |           git config user.name "github-actions"
56 |           git config user.email "github-actions@github.com"
57 |       - name: Create Pull Request
58 |         id: create-pr
59 |         uses: peter-evans/create-pull-request@v3
60 |         with:
61 |           token: ${{ secrets.PROJEN_GITHUB_TOKEN }}
62 |           commit-message: |-
63 |             chore(deps): upgrade dependencies
64 | 
65 |             Upgrades project dependencies. See details in [workflow run].
66 | 
67 |             [Workflow Run]: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
68 | 
69 |             ------
70 | 
71 |             *Automatically created by projen via the "upgrade" workflow*
72 |           branch: github-actions/upgrade
73 |           title: 'chore(deps): upgrade dependencies'
74 |           body: |-
75 |             Upgrades project dependencies. See details in [workflow run].
76 | 
77 |             [Workflow Run]: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
78 | 
79 |             ------
80 | 
81 |             *Automatically created by projen via the "upgrade" workflow*
82 |           author: github-actions <github-actions@github.com>
83 |           committer: github-actions <github-actions@github.com>
84 |           signoff: true
85 | 


--------------------------------------------------------------------------------
/.github/workflows/upgrade-main.yml:
--------------------------------------------------------------------------------
 1 | name: upgrade-main
 2 | on:
 3 |   workflow_dispatch: {}
 4 |   schedule:
 5 |     - cron: 0 0 * * *
 6 | env:
 7 |   node_version: 22
 8 | jobs:
 9 |   upgrade:
10 |     name: Upgrade
11 |     runs-on: ubuntu-latest
12 |     permissions:
13 |       contents: read
14 |     outputs:
15 |       patch_created: ${{ steps.create_patch.outputs.patch_created }}
16 |     steps:
17 |       - name: Checkout
18 |         uses: actions/checkout@v3
19 |         with:
20 |           ref: main
21 |       - uses: actions/setup-node@v6
22 |         with:
23 |           node-version: ${{ env.node_version }}
24 |       - name: Install dependencies
25 |         run: npm ci
26 |       - name: Upgrade dependencies
27 |         run: scripts/run-task upgrade
28 |     container:
29 |       image: jsii/superchain:1-buster-slim-node14
30 |   pr:
31 |     name: Create Pull Request
32 |     needs: upgrade
33 |     runs-on: ubuntu-latest
34 |     permissions:
35 |       contents: write
36 |       pull-requests: write
37 |     if: ${{ needs.upgrade.outputs.patch_created }}
38 |     steps:
39 |       - name: Checkout
40 |         uses: actions/checkout@v3
41 |         with:
42 |           token: ${{ secrets.PROJEN_GITHUB_TOKEN }}
43 |           ref: main
44 |       - uses: actions/setup-node@v6
45 |         with:
46 |           node-version: ${{ env.node_version }}
47 |       - name: Update npm
48 |         run: npm install -g npm@latest
49 |       - name: Download patch
50 |         uses: actions/download-artifact@v4
51 |         with:
52 |           name: .repo.patch
53 |           path: ${{ runner.temp }}
54 |       - name: Apply patch
55 |         run: '[ -s ${{ runner.temp }}/.repo.patch ] && git apply ${{ runner.temp }}/.repo.patch || echo "Empty patch. Skipping."'
56 |       - name: Set git identity
57 |         run: |-
58 |           git config user.name "github-actions"
59 |           git config user.email "github-actions@github.com"
60 |       - name: Create Pull Request
61 |         id: create-pr
62 |         uses: peter-evans/create-pull-request@v6
63 |         with:
64 |           token: ${{ secrets.PROJEN_GITHUB_TOKEN }}
65 |           commit-message: |-
66 |             chore(deps): upgrade dependencies
67 | 
68 |             Upgrades project dependencies. See details in [workflow run].
69 | 
70 |             [Workflow Run]: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
71 | 
72 |             ------
73 | 
74 |             *Automatically created by projen via the "upgrade-main" workflow*
75 |           branch: github-actions/upgrade-main
76 |           title: 'chore(deps): upgrade dependencies'
77 |           body: |-
78 |             Upgrades project dependencies. See details in [workflow run].
79 | 
80 |             [Workflow Run]: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
81 | 
82 |             ------
83 | 
84 |             *Automatically created by projen via the "upgrade-main" workflow*
85 |           author: github-actions <github-actions@github.com>
86 |           committer: github-actions <github-actions@github.com>
87 |           signoff: true
88 | 


--------------------------------------------------------------------------------
/serverlessSpyEvents/ServerlessSpyEventsE2e.ts:
--------------------------------------------------------------------------------
 1 | /* eslint-disable */
 2 | export class ServerlessSpyEvents {
 3 |   S3MyBucket: 'S3#MyBucket' = 'S3#MyBucket';
 4 |   SnsSubscriptionMyTopicNo1MyQueueNo1: 'SnsSubscription#MyTopicNo1#MyQueueNo1' = 'SnsSubscription#MyTopicNo1#MyQueueNo1';
 5 |   SnsTopicMyTopicNo1: 'SnsTopic#MyTopicNo1' = 'SnsTopic#MyTopicNo1';
 6 |   EventBridgeMyEventBus: 'EventBridge#MyEventBus' = 'EventBridge#MyEventBus';
 7 |   DynamoDBMyTable: 'DynamoDB#MyTable' = 'DynamoDB#MyTable';
 8 |   FunctionToSnsAndDynamoDbRequest: 'Function#ToSnsAndDynamoDb#Request' = 'Function#ToSnsAndDynamoDb#Request';
 9 |   FunctionToSnsAndDynamoDbError: 'Function#ToSnsAndDynamoDb#Error' = 'Function#ToSnsAndDynamoDb#Error';
10 |   FunctionToSnsAndDynamoDbConsole: 'Function#ToSnsAndDynamoDb#Console' = 'Function#ToSnsAndDynamoDb#Console';
11 |   FunctionToSnsAndDynamoDbResponse: 'Function#ToSnsAndDynamoDb#Response' = 'Function#ToSnsAndDynamoDb#Response';
12 |   FunctionFromSnsToSqsAndS3Request: 'Function#FromSnsToSqsAndS3#Request' = 'Function#FromSnsToSqsAndS3#Request';
13 |   FunctionFromSnsToSqsAndS3Error: 'Function#FromSnsToSqsAndS3#Error' = 'Function#FromSnsToSqsAndS3#Error';
14 |   FunctionFromSnsToSqsAndS3Console: 'Function#FromSnsToSqsAndS3#Console' = 'Function#FromSnsToSqsAndS3#Console';
15 |   FunctionFromSnsToSqsAndS3Response: 'Function#FromSnsToSqsAndS3#Response' = 'Function#FromSnsToSqsAndS3#Response';
16 |   SnsSubscriptionMyTopicNo1FromSnsToSqsAndS3: 'SnsSubscription#MyTopicNo1#FromSnsToSqsAndS3' = 'SnsSubscription#MyTopicNo1#FromSnsToSqsAndS3';
17 |   FunctionFromSqsToEventBridgeRequest: 'Function#FromSqsToEventBridge#Request' = 'Function#FromSqsToEventBridge#Request';
18 |   FunctionFromSqsToEventBridgeError: 'Function#FromSqsToEventBridge#Error' = 'Function#FromSqsToEventBridge#Error';
19 |   FunctionFromSqsToEventBridgeConsole: 'Function#FromSqsToEventBridge#Console' = 'Function#FromSqsToEventBridge#Console';
20 |   FunctionFromSqsToEventBridgeResponse: 'Function#FromSqsToEventBridge#Response' = 'Function#FromSqsToEventBridge#Response';
21 |   SqsMyQueueNo2: 'Sqs#MyQueueNo2' = 'Sqs#MyQueueNo2';
22 |   FunctionReceiveSqsRequest: 'Function#ReceiveSqs#Request' = 'Function#ReceiveSqs#Request';
23 |   FunctionReceiveSqsError: 'Function#ReceiveSqs#Error' = 'Function#ReceiveSqs#Error';
24 |   FunctionReceiveSqsConsole: 'Function#ReceiveSqs#Console' = 'Function#ReceiveSqs#Console';
25 |   FunctionReceiveSqsResponse: 'Function#ReceiveSqs#Response' = 'Function#ReceiveSqs#Response';
26 |   SqsMyQueueNo1: 'Sqs#MyQueueNo1' = 'Sqs#MyQueueNo1';
27 |   FunctionReceiveEventBridgeRequest: 'Function#ReceiveEventBridge#Request' = 'Function#ReceiveEventBridge#Request';
28 |   FunctionReceiveEventBridgeError: 'Function#ReceiveEventBridge#Error' = 'Function#ReceiveEventBridge#Error';
29 |   FunctionReceiveEventBridgeConsole: 'Function#ReceiveEventBridge#Console' = 'Function#ReceiveEventBridge#Console';
30 |   FunctionReceiveEventBridgeResponse: 'Function#ReceiveEventBridge#Response' = 'Function#ReceiveEventBridge#Response';
31 |   EventBridgeRuleMyEventBusMyEventBridge: 'EventBridgeRule#MyEventBus#MyEventBridge' = 'EventBridgeRule#MyEventBus#MyEventBridge';
32 | }
33 | 


--------------------------------------------------------------------------------
/test/cdk/serverlessSpyEvents/ServerlessSpyEventsE2e.ts:
--------------------------------------------------------------------------------
 1 | /* eslint-disable */
 2 | export class ServerlessSpyEvents {
 3 |   S3MyBucket: 'S3#MyBucket' = 'S3#MyBucket';
 4 |   SnsSubscriptionMyTopicNo1MyQueueNo1: 'SnsSubscription#MyTopicNo1#MyQueueNo1' = 'SnsSubscription#MyTopicNo1#MyQueueNo1';
 5 |   SnsTopicMyTopicNo1: 'SnsTopic#MyTopicNo1' = 'SnsTopic#MyTopicNo1';
 6 |   EventBridgeMyEventBus: 'EventBridge#MyEventBus' = 'EventBridge#MyEventBus';
 7 |   DynamoDBMyTable: 'DynamoDB#MyTable' = 'DynamoDB#MyTable';
 8 |   FunctionToSnsAndDynamoDbRequest: 'Function#ToSnsAndDynamoDb#Request' = 'Function#ToSnsAndDynamoDb#Request';
 9 |   FunctionToSnsAndDynamoDbError: 'Function#ToSnsAndDynamoDb#Error' = 'Function#ToSnsAndDynamoDb#Error';
10 |   FunctionToSnsAndDynamoDbConsole: 'Function#ToSnsAndDynamoDb#Console' = 'Function#ToSnsAndDynamoDb#Console';
11 |   FunctionToSnsAndDynamoDbResponse: 'Function#ToSnsAndDynamoDb#Response' = 'Function#ToSnsAndDynamoDb#Response';
12 |   FunctionFromSnsToSqsAndS3Request: 'Function#FromSnsToSqsAndS3#Request' = 'Function#FromSnsToSqsAndS3#Request';
13 |   FunctionFromSnsToSqsAndS3Error: 'Function#FromSnsToSqsAndS3#Error' = 'Function#FromSnsToSqsAndS3#Error';
14 |   FunctionFromSnsToSqsAndS3Console: 'Function#FromSnsToSqsAndS3#Console' = 'Function#FromSnsToSqsAndS3#Console';
15 |   FunctionFromSnsToSqsAndS3Response: 'Function#FromSnsToSqsAndS3#Response' = 'Function#FromSnsToSqsAndS3#Response';
16 |   SnsSubscriptionMyTopicNo1FromSnsToSqsAndS3: 'SnsSubscription#MyTopicNo1#FromSnsToSqsAndS3' = 'SnsSubscription#MyTopicNo1#FromSnsToSqsAndS3';
17 |   FunctionFromSqsToEventBridgeRequest: 'Function#FromSqsToEventBridge#Request' = 'Function#FromSqsToEventBridge#Request';
18 |   FunctionFromSqsToEventBridgeError: 'Function#FromSqsToEventBridge#Error' = 'Function#FromSqsToEventBridge#Error';
19 |   FunctionFromSqsToEventBridgeConsole: 'Function#FromSqsToEventBridge#Console' = 'Function#FromSqsToEventBridge#Console';
20 |   FunctionFromSqsToEventBridgeResponse: 'Function#FromSqsToEventBridge#Response' = 'Function#FromSqsToEventBridge#Response';
21 |   SqsMyQueueNo2: 'Sqs#MyQueueNo2' = 'Sqs#MyQueueNo2';
22 |   FunctionReceiveSqsRequest: 'Function#ReceiveSqs#Request' = 'Function#ReceiveSqs#Request';
23 |   FunctionReceiveSqsError: 'Function#ReceiveSqs#Error' = 'Function#ReceiveSqs#Error';
24 |   FunctionReceiveSqsConsole: 'Function#ReceiveSqs#Console' = 'Function#ReceiveSqs#Console';
25 |   FunctionReceiveSqsResponse: 'Function#ReceiveSqs#Response' = 'Function#ReceiveSqs#Response';
26 |   SqsMyQueueNo1: 'Sqs#MyQueueNo1' = 'Sqs#MyQueueNo1';
27 |   FunctionReceiveEventBridgeRequest: 'Function#ReceiveEventBridge#Request' = 'Function#ReceiveEventBridge#Request';
28 |   FunctionReceiveEventBridgeError: 'Function#ReceiveEventBridge#Error' = 'Function#ReceiveEventBridge#Error';
29 |   FunctionReceiveEventBridgeConsole: 'Function#ReceiveEventBridge#Console' = 'Function#ReceiveEventBridge#Console';
30 |   FunctionReceiveEventBridgeResponse: 'Function#ReceiveEventBridge#Response' = 'Function#ReceiveEventBridge#Response';
31 |   EventBridgeRuleMyEventBusMyEventBridge: 'EventBridgeRule#MyEventBus#MyEventBridge' = 'EventBridgeRule#MyEventBus#MyEventBridge';
32 | }
33 | 


--------------------------------------------------------------------------------
/test/cdk/src/main.ts:
--------------------------------------------------------------------------------
  1 | import { App } from 'aws-cdk-lib';
  2 | import { E2eStack } from './e2eStack';
  3 | import { EsmLambdaStack } from './esmLambdaStack';
  4 | import { EventBridgeToLambdaStack } from './eventBridgeToLambdaStack';
  5 | import { LambdaStack } from './lambdaStack';
  6 | import { LambdaToDynamoDb2Stack } from './lambdaToDynamoDb2Stack';
  7 | import { LambdaToDynamoDbStack } from './lambdaToDynamoDbStack';
  8 | import { LambdaToEventBridgeStack } from './lambdaToEventBridgeStack';
  9 | import { LambdaToS3Stack } from './lambdaToS3Stack';
 10 | import { LambdaToSnsStack } from './lambdaToSnsStack';
 11 | import { LambdaToSqsStack } from './lambdaToSqsStack';
 12 | import { PythonLambdaStack } from './pythonLambdaStack';
 13 | import { SingletonLambdaFunctionStack } from './singletonLambdaFunctionStack';
 14 | import { SnsToLambdaStack } from './snsToLambdaStack';
 15 | import { SnsToSqsStack } from './snsToSqsStack';
 16 | import { SqsStack } from './sqsStack';
 17 | import { SqsToLambdaStack } from './sqsToLambdaStack';
 18 | import { DefaultEventBridgeToLambdaStack } from 'serverless-spy/test/cdk/src/defaultEventBridgeToLambdaStack';
 19 | 
 20 | const testEnv = {
 21 |   account: process.env.CDK_DEFAULT_ACCOUNT,
 22 |   region: process.env.CDK_DEFAULT_REGION,
 23 | };
 24 | 
 25 | const app = new App();
 26 | 
 27 | new E2eStack(app, 'ServerlessSpyE2e', {
 28 |   env: testEnv,
 29 |   generateSpyEventsFile: true,
 30 | });
 31 | new EventBridgeToLambdaStack(app, 'ServerlessSpyEventBridgeToLambda', {
 32 |   env: testEnv,
 33 |   generateSpyEventsFile: true,
 34 | });
 35 | new LambdaStack(app, 'ServerlessSpyLambda', {
 36 |   env: testEnv,
 37 |   generateSpyEventsFile: true,
 38 | });
 39 | new EsmLambdaStack(app, 'ServerlessSpyEsmLambda', {
 40 |   env: testEnv,
 41 |   generateSpyEventsFile: true,
 42 | });
 43 | new PythonLambdaStack(app, 'ServerlessSpyPythonLambda', {
 44 |   env: testEnv,
 45 |   generateSpyEventsFile: true,
 46 | });
 47 | new LambdaToDynamoDbStack(app, 'ServerlessSpyLambdaToDynamoDb', {
 48 |   env: testEnv,
 49 |   generateSpyEventsFile: true,
 50 | });
 51 | new LambdaToDynamoDb2Stack(app, 'ServerlessSpyLambdaToDynamoDb2', {
 52 |   env: testEnv,
 53 |   generateSpyEventsFile: true,
 54 | });
 55 | new LambdaToEventBridgeStack(app, 'ServerlessSpyLambdaToEventBridge', {
 56 |   env: testEnv,
 57 |   generateSpyEventsFile: true,
 58 | });
 59 | new LambdaToS3Stack(app, 'ServerlessSpyLambdaToS3', {
 60 |   env: testEnv,
 61 |   generateSpyEventsFile: true,
 62 | });
 63 | new LambdaToSnsStack(app, 'ServerlessSpyLambdaToSns', {
 64 |   env: testEnv,
 65 |   generateSpyEventsFile: true,
 66 | });
 67 | new LambdaToSqsStack(app, 'ServerlessSpyLambdaToSqs', {
 68 |   env: testEnv,
 69 |   generateSpyEventsFile: true,
 70 | });
 71 | new SnsToLambdaStack(app, 'ServerlessSpySnsToLambda', {
 72 |   env: testEnv,
 73 |   generateSpyEventsFile: true,
 74 | });
 75 | new SnsToSqsStack(app, 'ServerlessSpySnsToSqs', {
 76 |   env: testEnv,
 77 |   generateSpyEventsFile: true,
 78 | });
 79 | new SqsStack(app, 'ServerlessSpySqs', {
 80 |   env: testEnv,
 81 |   generateSpyEventsFile: true,
 82 | });
 83 | new SqsToLambdaStack(app, 'ServerlessSpySqsToLambda', {
 84 |   env: testEnv,
 85 |   generateSpyEventsFile: true,
 86 | });
 87 | new DefaultEventBridgeToLambdaStack(
 88 |   app,
 89 |   'ServerlessSpyDefaultEventBridgeToLambda',
 90 |   {
 91 |     env: testEnv,
 92 |     generateSpyEventsFile: true,
 93 |   }
 94 | );
 95 | new SingletonLambdaFunctionStack(app, 'ServerlessSpySingletonLambdaFunction', {
 96 |   env: testEnv,
 97 |   generateSpyEventsFile: true,
 98 | });
 99 | 
100 | app.synth();
101 | 


--------------------------------------------------------------------------------
/test/cdk/test/defaultEventBridgeToLambda.test.ts:
--------------------------------------------------------------------------------
  1 | import * as fs from 'fs';
  2 | import * as path from 'path';
  3 | import {
  4 |   EventBridgeClient,
  5 |   PutEventsCommand,
  6 | } from '@aws-sdk/client-eventbridge';
  7 | import { EventBridgeEvent } from 'aws-lambda';
  8 | import { v4 as uuidv4 } from 'uuid';
  9 | import { TestData } from './TestData';
 10 | import { createServerlessSpyListener } from '../../../listener/createServerlessSpyListener';
 11 | import { ServerlessSpyListener } from '../../../listener/ServerlessSpyListener';
 12 | import { ServerlessSpyEvents } from '../serverlessSpyEvents/ServerlessSpyEventsDefaultEventBridgeToLambda';
 13 | 
 14 | jest.setTimeout(30000);
 15 | 
 16 | describe('EventBridge to Lambda', () => {
 17 |   const exportLocation = path.join(__dirname, '../cdkOutput.json');
 18 |   let serverlessSpyListener: ServerlessSpyListener<ServerlessSpyEvents>;
 19 | 
 20 |   if (!fs.existsSync(exportLocation)) {
 21 |     throw new Error(`File ${exportLocation} does not exists.`);
 22 |   }
 23 |   const output = JSON.parse(fs.readFileSync(exportLocation).toString())[
 24 |     'ServerlessSpyDefaultEventBridgeToLambda'
 25 |   ];
 26 | 
 27 |   beforeEach(async () => {
 28 |     serverlessSpyListener =
 29 |       await createServerlessSpyListener<ServerlessSpyEvents>({
 30 |         serverlessSpyWsUrl: output.ServerlessSpyWsUrl,
 31 |       });
 32 |   });
 33 | 
 34 |   afterEach(async () => {
 35 |     serverlessSpyListener.stop();
 36 |   });
 37 | 
 38 |   test('Basic test', async () => {
 39 |     const id = uuidv4();
 40 |     const data = <TestData>{
 41 |       id,
 42 |       message: 'Hello',
 43 |     };
 44 | 
 45 |     const command = new PutEventsCommand({
 46 |       Entries: [
 47 |         {
 48 |           Detail: JSON.stringify(data),
 49 |           DetailType: 'test',
 50 |           Source: 'test-source',
 51 |         },
 52 |       ],
 53 |     });
 54 | 
 55 |     const eventBridgeClient = new EventBridgeClient({});
 56 |     await eventBridgeClient.send(command);
 57 | 
 58 |     (
 59 |       await serverlessSpyListener.waitForEventBridgeRuleDefaultMyRule<TestData>(
 60 |         {
 61 |           condition: (d) => d.detail.id === id,
 62 |         }
 63 |       )
 64 |     ).toMatchObject({
 65 |       detail: data,
 66 |       detailType: 'test',
 67 |       source: 'test-source',
 68 |     });
 69 | 
 70 |     (
 71 |       await (
 72 |         await serverlessSpyListener.waitForFunctionMyLambdaRequest<
 73 |           EventBridgeEvent<'test', TestData>
 74 |         >({
 75 |           condition: (d) => d.request.detail.id === id,
 76 |         })
 77 |       )
 78 |         .toMatchObject({
 79 |           request: {
 80 |             detail: data,
 81 |             source: 'test-source',
 82 |           },
 83 |         })
 84 |         .followedByResponse<EventBridgeEvent<'test', TestData>>({})
 85 |     ).toMatchObject({
 86 |       request: {
 87 |         detail: data,
 88 |         source: 'test-source',
 89 |       },
 90 |     });
 91 |     (
 92 |       await (
 93 |         await serverlessSpyListener.waitForFunctionMyPythonLambdaRequest<
 94 |           EventBridgeEvent<'test', TestData>
 95 |         >({
 96 |           condition: (d) => d.request.detail.id === id,
 97 |         })
 98 |       )
 99 |         .toMatchObject({
100 |           request: {
101 |             detail: data,
102 |             source: 'test-source',
103 |           },
104 |         })
105 |         .followedByResponse<EventBridgeEvent<'test', TestData>>({})
106 |     ).toMatchObject({
107 |       request: {
108 |         detail: data,
109 |         source: 'test-source',
110 |       },
111 |     });
112 |   });
113 | });
114 | 


--------------------------------------------------------------------------------
/extension/aws/Errors.js:
--------------------------------------------------------------------------------
  1 | /**
  2 |  * Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  3 |  *
  4 |  * This code was copied from:
  5 |  * https://github.com/aws/aws-lambda-nodejs-runtime-interface-client
  6 |  *
  7 |  * Defines custom error types throwable by the runtime.
  8 |  */
  9 | 
 10 | 'use strict';
 11 | 
 12 | const util = require('util');
 13 | 
 14 | function _isError(obj) {
 15 |   return (
 16 |     obj &&
 17 |     obj.name &&
 18 |     obj.message &&
 19 |     obj.stack &&
 20 |     typeof obj.name === 'string' &&
 21 |     typeof obj.message === 'string' &&
 22 |     typeof obj.stack === 'string'
 23 |   );
 24 | }
 25 | 
 26 | function intoError(err) {
 27 |   if (err instanceof Error) {
 28 |     return err;
 29 |   } else {
 30 |     return new Error(err);
 31 |   }
 32 | }
 33 | 
 34 | module.exports.intoError = intoError;
 35 | 
 36 | /**
 37 |  * Attempt to convert an object into a response object.
 38 |  * This method accounts for failures when serializing the error object.
 39 |  */
 40 | function toRapidResponse(error) {
 41 |   try {
 42 |     if (util.types.isNativeError(error) || _isError(error)) {
 43 |       return {
 44 |         errorType: error.name,
 45 |         errorMessage: error.message,
 46 |         trace: error.stack.split('\n'),
 47 |       };
 48 |     } else {
 49 |       return {
 50 |         errorType: typeof error,
 51 |         errorMessage: error.toString(),
 52 |         trace: [],
 53 |       };
 54 |     }
 55 |   } catch (_err) {
 56 |     return {
 57 |       errorType: 'handled',
 58 |       errorMessage:
 59 |         'callback called with Error argument, but there was a problem while retrieving one or more of its message, name, and stack',
 60 |     };
 61 |   }
 62 | }
 63 | 
 64 | module.exports.toRapidResponse = toRapidResponse;
 65 | 
 66 | /**
 67 |  * Format an error with the expected properties.
 68 |  * For compatability, the error string always starts with a tab.
 69 |  */
 70 | module.exports.toFormatted = (error) => {
 71 |   try {
 72 |     return (
 73 |       '\t' + JSON.stringify(error, (_k, v) => _withEnumerableProperties(v))
 74 |     );
 75 |   } catch (err) {
 76 |     return '\t' + JSON.stringify(toRapidResponse(error));
 77 |   }
 78 | };
 79 | 
 80 | /**
 81 |  * Error name, message, code, and stack are all members of the superclass, which
 82 |  * means they aren't enumerable and don't normally show up in JSON.stringify.
 83 |  * This method ensures those interesting properties are available along with any
 84 |  * user-provided enumerable properties.
 85 |  */
 86 | function _withEnumerableProperties(error) {
 87 |   if (error instanceof Error) {
 88 |     let ret = Object.assign(
 89 |       {
 90 |         errorType: error.name,
 91 |         errorMessage: error.message,
 92 |         code: error.code,
 93 |       },
 94 |       error
 95 |     );
 96 |     if (typeof error.stack == 'string') {
 97 |       ret.stack = error.stack.split('\n');
 98 |     }
 99 |     return ret;
100 |   } else {
101 |     return error;
102 |   }
103 | }
104 | 
105 | const errorClasses = [
106 |   class ImportModuleError extends Error {},
107 |   class HandlerNotFound extends Error {},
108 |   class MalformedHandlerName extends Error {},
109 |   class UserCodeSyntaxError extends Error {},
110 |   class MalformedStreamingHandler extends Error {},
111 |   class InvalidStreamingOperation extends Error {},
112 |   class UnhandledPromiseRejection extends Error {
113 |     constructor(reason, promise) {
114 |       super(reason);
115 |       this.reason = reason;
116 |       this.promise = promise;
117 |     }
118 |   },
119 | ];
120 | 
121 | errorClasses.forEach((e) => {
122 |   module.exports[e.name] = e;
123 |   e.prototype.name = `Runtime.${e.name}`;
124 | });
125 | 


--------------------------------------------------------------------------------
/test/cdk/test/eventBridgeToLambda.test.ts:
--------------------------------------------------------------------------------
  1 | import * as fs from 'fs';
  2 | import * as path from 'path';
  3 | import {
  4 |   EventBridgeClient,
  5 |   PutEventsCommand,
  6 | } from '@aws-sdk/client-eventbridge';
  7 | import { EventBridgeEvent } from 'aws-lambda';
  8 | import { v4 as uuidv4 } from 'uuid';
  9 | import { TestData } from './TestData';
 10 | import { createServerlessSpyListener } from '../../../listener/createServerlessSpyListener';
 11 | import { ServerlessSpyListener } from '../../../listener/ServerlessSpyListener';
 12 | import { ServerlessSpyEvents } from '../serverlessSpyEvents/ServerlessSpyEventsEventBridgeToLambda';
 13 | 
 14 | jest.setTimeout(30000);
 15 | 
 16 | describe('EventBridge to Lambda', () => {
 17 |   const exportLocation = path.join(__dirname, '../cdkOutput.json');
 18 |   let serverlessSpyListener: ServerlessSpyListener<ServerlessSpyEvents>;
 19 | 
 20 |   if (!fs.existsSync(exportLocation)) {
 21 |     throw new Error(`File ${exportLocation} does not exists.`);
 22 |   }
 23 |   const output = JSON.parse(fs.readFileSync(exportLocation).toString())[
 24 |     'ServerlessSpyEventBridgeToLambda'
 25 |   ];
 26 | 
 27 |   beforeEach(async () => {
 28 |     serverlessSpyListener =
 29 |       await createServerlessSpyListener<ServerlessSpyEvents>({
 30 |         serverlessSpyWsUrl: output.ServerlessSpyWsUrl,
 31 |       });
 32 |   });
 33 | 
 34 |   afterEach(async () => {
 35 |     serverlessSpyListener.stop();
 36 |   });
 37 | 
 38 |   test('Basic test', async () => {
 39 |     const id = uuidv4();
 40 |     const data = <TestData>{
 41 |       id,
 42 |       message: 'Hello',
 43 |     };
 44 | 
 45 |     const command = new PutEventsCommand({
 46 |       Entries: [
 47 |         {
 48 |           EventBusName: output.EventBusNameMyEventBus,
 49 |           Detail: JSON.stringify(data),
 50 |           DetailType: 'test',
 51 |           Source: 'test-source',
 52 |         },
 53 |       ],
 54 |     });
 55 | 
 56 |     const eventBridgeClient = new EventBridgeClient({});
 57 |     await eventBridgeClient.send(command);
 58 | 
 59 |     (
 60 |       await serverlessSpyListener.waitForEventBridgeMyEventBus<TestData>({
 61 |         condition: (d) => d.detail.id === id,
 62 |       })
 63 |     ).toMatchObject({
 64 |       detail: data,
 65 |       detailType: 'test',
 66 |       source: 'test-source',
 67 |     });
 68 | 
 69 |     (
 70 |       await serverlessSpyListener.waitForEventBridgeRuleMyEventBusMyRule<TestData>(
 71 |         {
 72 |           condition: (d) => d.detail.id === id,
 73 |         }
 74 |       )
 75 |     ).toMatchObject({
 76 |       detail: data,
 77 |       detailType: 'test',
 78 |       source: 'test-source',
 79 |     });
 80 | 
 81 |     (
 82 |       await (
 83 |         await serverlessSpyListener.waitForFunctionMyLambdaRequest<
 84 |           EventBridgeEvent<'test', TestData>
 85 |         >({
 86 |           condition: (d) => d.request.detail.id === id,
 87 |         })
 88 |       )
 89 |         .toMatchObject({
 90 |           request: {
 91 |             detail: data,
 92 |             source: 'test-source',
 93 |           },
 94 |         })
 95 |         .followedByResponse<EventBridgeEvent<'test', TestData>>({})
 96 |     ).toMatchObject({
 97 |       request: {
 98 |         detail: data,
 99 |         source: 'test-source',
100 |       },
101 |     });
102 |     (
103 |       await (
104 |         await serverlessSpyListener.waitForFunctionMyPythonLambdaRequest<
105 |           EventBridgeEvent<'test', TestData>
106 |         >({
107 |           condition: (d) => d.request.detail.id === id,
108 |         })
109 |       )
110 |         .toMatchObject({
111 |           request: {
112 |             detail: data,
113 |             source: 'test-source',
114 |           },
115 |         })
116 |         .followedByResponse<EventBridgeEvent<'test', TestData>>({})
117 |     ).toMatchObject({
118 |       request: {
119 |         detail: data,
120 |         source: 'test-source',
121 |       },
122 |     });
123 |   });
124 | });
125 | 


--------------------------------------------------------------------------------
/test/cdk/test/sqsToLambda.test.ts:
--------------------------------------------------------------------------------
  1 | import * as fs from 'fs';
  2 | import * as path from 'path';
  3 | import { SendMessageCommand, SQSClient } from '@aws-sdk/client-sqs';
  4 | import { SQSEvent } from 'aws-lambda';
  5 | import { v4 as uuidv4 } from 'uuid';
  6 | import { TestData } from './TestData';
  7 | import { createServerlessSpyListener } from '../../../listener/createServerlessSpyListener';
  8 | import { ServerlessSpyListener } from '../../../listener/ServerlessSpyListener';
  9 | import { ServerlessSpyEvents } from '../serverlessSpyEvents/ServerlessSpyEventsSqsToLambda';
 10 | 
 11 | jest.setTimeout(60000);
 12 | 
 13 | describe('SQS to Lambda', () => {
 14 |   const exportLocation = path.join(__dirname, '../cdkOutput.json');
 15 |   let serverlessSpyListener: ServerlessSpyListener<ServerlessSpyEvents>;
 16 | 
 17 |   if (!fs.existsSync(exportLocation)) {
 18 |     throw new Error(`File ${exportLocation} does not exists.`);
 19 |   }
 20 |   const output = JSON.parse(fs.readFileSync(exportLocation).toString())[
 21 |     'ServerlessSpySqsToLambda'
 22 |   ];
 23 | 
 24 |   beforeEach(async () => {
 25 |     serverlessSpyListener =
 26 |       await createServerlessSpyListener<ServerlessSpyEvents>({
 27 |         serverlessSpyWsUrl: output.ServerlessSpyWsUrl,
 28 |       });
 29 |   });
 30 | 
 31 |   afterEach(async () => {
 32 |     serverlessSpyListener.stop();
 33 |   });
 34 | 
 35 |   test('Basic test', async () => {
 36 |     const id = uuidv4();
 37 |     const data = <TestData>{
 38 |       id,
 39 |       message: 'Hello',
 40 |     };
 41 | 
 42 |     const sqsClient = new SQSClient({});
 43 |     const sendMessageCommand = new SendMessageCommand({
 44 |       MessageBody: JSON.stringify(data),
 45 |       QueueUrl: output.QueueUrlMyQueue,
 46 |     });
 47 |     await sqsClient.send(sendMessageCommand);
 48 |     const sendMessageCommand2 = new SendMessageCommand({
 49 |       MessageBody: JSON.stringify(data),
 50 |       QueueUrl: output.QueueUrlMyQueue2,
 51 |     });
 52 |     await sqsClient.send(sendMessageCommand2);
 53 | 
 54 |     (
 55 |       await serverlessSpyListener.waitForSqsMyQueue<TestData>({
 56 |         condition: (d) => d.body.id === id,
 57 |       })
 58 |     ).toMatchObject({ body: data });
 59 | 
 60 |     (
 61 |       await (
 62 |         await serverlessSpyListener.waitForFunctionMyLambdaRequest<SQSEvent>({
 63 |           condition: (d) =>
 64 |             !!d.request.Records.map((r) => JSON.parse(r.body) as TestData).find(
 65 |               (d) => d.id === data.id
 66 |             ),
 67 |         })
 68 |       )
 69 |         .toMatchObject({
 70 |           request: {
 71 |             Records: expect.arrayContaining([
 72 |               expect.objectContaining({
 73 |                 body: JSON.stringify(data),
 74 |               }),
 75 |             ]),
 76 |           },
 77 |         })
 78 |         .followedByResponse({})
 79 |     ).toMatchObject({
 80 |       request: {
 81 |         Records: expect.arrayContaining([
 82 |           expect.objectContaining({
 83 |             body: JSON.stringify(data),
 84 |           }),
 85 |         ]),
 86 |       },
 87 |     });
 88 | 
 89 |     (
 90 |       await (
 91 |         await serverlessSpyListener.waitForFunctionMyPythonLambdaRequest<SQSEvent>(
 92 |           {
 93 |             condition: (d) =>
 94 |               !!d.request.Records.map(
 95 |                 (r) => JSON.parse(r.body) as TestData
 96 |               ).find((d) => d.id === data.id),
 97 |           }
 98 |         )
 99 |       )
100 |         .toMatchObject({
101 |           request: {
102 |             Records: expect.arrayContaining([
103 |               expect.objectContaining({
104 |                 body: JSON.stringify(data),
105 |               }),
106 |             ]),
107 |           },
108 |         })
109 |         .followedByResponse({})
110 |     ).toMatchObject({
111 |       request: {
112 |         Records: expect.arrayContaining([
113 |           expect.objectContaining({
114 |             body: JSON.stringify(data),
115 |           }),
116 |         ]),
117 |       },
118 |     });
119 |   });
120 | });
121 | 


--------------------------------------------------------------------------------
/cli/icons/Arch_Amazon-EventBridge_16.svg:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <svg width="24px" height="24px" viewBox="0 0 24 24" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
 3 |     <!-- Generator: Sketch 64 (93537) - https://sketch.com -->
 4 |     <title>Icon-Architecture/16/Arch_Amazon-EventBridge_16</title>
 5 |     <desc>Created with Sketch.</desc>
 6 |     <defs>
 7 |         <linearGradient x1="0%" y1="100%" x2="100%" y2="0%" id="linearGradient-1">
 8 |             <stop stop-color="#B0084D" offset="0%"></stop>
 9 |             <stop stop-color="#FF4F8B" offset="100%"></stop>
10 |         </linearGradient>
11 |     </defs>
12 |     <g id="Icon-Architecture/16/Arch_Amazon-EventBridge_16" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
13 |         <g id="Icon-Architecture-BG/16/Application-Integration" fill="url(#linearGradient-1)">
14 |             <rect id="Rectangle" x="0" y="0" width="24" height="24"></rect>
15 |         </g>
16 |         <path d="M6.5485452,16.461 C6.00062039,16.461 5.55592779,16.012 5.55592779,15.461 C5.55592779,14.91 6.00062039,14.461 6.5485452,14.461 C7.09647,14.461 7.5411626,14.91 7.5411626,15.461 C7.5411626,16.012 7.09647,16.461 6.5485452,16.461 L6.5485452,16.461 Z M7.89254917,16.924 C8.28463304,16.558 8.53378001,16.041 8.53378001,15.461 C8.53378001,14.358 7.6434022,13.461 6.5485452,13.461 C6.34406601,13.461 6.15050561,13.502 5.96389354,13.56 L5.06954526,11.998 L6.3718593,9.723 L5.51324524,9.223 L4.06700168,11.748 C3.97766611,11.902 3.97766611,12.093 4.06700168,12.248 L5.11818351,14.081 C4.77672312,14.44 4.56331038,14.925 4.56331038,15.461 C4.56331038,16.564 5.45368819,17.461 6.5485452,17.461 C6.71133445,17.461 6.86717538,17.436 7.01904585,17.398 L7.79527266,18.753 C7.88361561,18.908 8.04739748,19.003 8.22408338,19.003 L10.998449,19.003 L10.998449,18.003 L8.51194243,18.003 L7.89254917,16.924 Z M17.4504622,9.517 C16.90353,9.517 16.4578448,9.068 16.4578448,8.517 C16.4578448,7.965 16.90353,7.517 17.4504622,7.517 C17.998387,7.517 18.4430796,7.965 18.4430796,8.517 C18.4430796,9.068 17.998387,9.517 17.4504622,9.517 L17.4504622,9.517 Z M18.8818165,9.896 C19.2232769,9.537 19.435697,9.052 19.435697,8.517 C19.435697,7.414 18.5453192,6.517 17.4504622,6.517 C17.2876729,6.517 17.1328246,6.542 16.9809542,6.58 L16.20572,5.225 C16.117377,5.07 15.9535951,4.975 15.7759166,4.975 L13.001551,4.975 L13.001551,5.975 L15.4890502,5.975 L16.1074508,7.054 C15.715367,7.419 15.4652274,7.937 15.4652274,8.517 C15.4652274,9.62 16.3565978,10.517 17.4504622,10.517 C17.6549414,10.517 17.8494944,10.476 18.0351138,10.418 L18.9314474,11.981 L17.6271481,14.254 L18.4857621,14.754 L19.9329983,12.231 C20.0223339,12.076 20.0223339,11.885 19.9329983,11.731 L18.8818165,9.896 Z M15.9794032,19 C15.4314784,19 14.9867858,18.551 14.9867858,18 C14.9867858,17.448 15.4314784,17 15.9794032,17 C16.527328,17 16.9720206,17.448 16.9720206,18 C16.9720206,18.551 16.527328,19 15.9794032,19 L15.9794032,19 Z M12.9836839,14.1 L10.7949625,14.1 L9.59091755,12 L10.7066195,10.053 L10.9607296,9.899 L13.2010671,9.899 L14.405112,12 L13.3162107,13.898 L12.9836839,14.1 Z M8.03846392,7 C7.49053912,7 7.04584652,6.551 7.04584652,6 C7.04584652,5.448 7.49053912,5 8.03846392,5 C8.58638873,5 9.03108133,5.448 9.03108133,6 C9.03108133,6.551 8.58638873,7 8.03846392,7 L8.03846392,7 Z M15.9794032,16 C15.6577951,16 15.3570321,16.085 15.0880328,16.222 L14.0914449,14.547 L15.4076556,12.25 C15.4969911,12.095 15.4969911,11.904 15.4076556,11.75 L13.9177368,9.149 C13.8293939,8.995 13.665612,8.899 13.4879335,8.899 L10.7264719,8.899 L9.67231218,7.13 C9.89366586,6.808 10.0236987,6.419 10.0236987,6 C10.0236987,4.897 9.13332093,4 8.03846392,4 C6.94360692,4 6.05322911,4.897 6.05322911,6 C6.05322911,7.103 6.94360692,8 8.03846392,8 C8.35113841,8 8.64396054,7.919 8.90799677,7.789 L9.9016068,9.459 L8.58936659,11.75 C8.50003102,11.904 8.50003102,12.095 8.58936659,12.25 L10.0792853,14.85 C10.1676283,15.004 10.3314101,15.1 10.508096,15.1 L13.2626093,15.1 L14.3286804,16.891 C14.1182455,17.209 13.9941684,17.589 13.9941684,18 C13.9941684,19.103 14.8845462,20 15.9794032,20 C17.0742602,20 17.964638,19.103 17.964638,18 C17.964638,16.897 17.0742602,16 15.9794032,16 L15.9794032,16 Z" id="Amazon-EventBridge_Icon_16_Squid" fill="#FFFFFF"></path>
17 |     </g>
18 | </svg>


--------------------------------------------------------------------------------
/.github/workflows/release.yml:
--------------------------------------------------------------------------------
  1 | name: release
  2 | on:
  3 |   push:
  4 |     branches:
  5 |       - main
  6 |   workflow_dispatch: {}
  7 | env:
  8 |   node_version: 22
  9 | jobs:
 10 |   release:
 11 |     runs-on: ubuntu-latest
 12 |     permissions:
 13 |       contents: write
 14 |     outputs:
 15 |       latest_commit: ${{ steps.git_remote.outputs.latest_commit }}
 16 |     env:
 17 |       CI: 'true'
 18 |       AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
 19 |       AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
 20 |       AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }}
 21 |       AWS_REGION: ${{ secrets.AWS_REGION }}
 22 |     steps:
 23 |       - name: Checkout
 24 |         uses: actions/checkout@v3
 25 |         with:
 26 |           fetch-depth: 0
 27 |       - uses: actions/setup-node@v6
 28 |         with:
 29 |           node-version: ${{ env.node_version }}
 30 |       - name: Update npm
 31 |         run: npm install -g npm@latest
 32 |       - name: sudo docker
 33 |         run: sudo chmod 777 /var/run/docker.sock
 34 |       - name: Set git identity
 35 |         run: |-
 36 |           git config user.name "github-actions"
 37 |           git config user.email "github-actions@github.com"
 38 |       - name: Install dependencies
 39 |         run: npm ci
 40 |       - name: release
 41 |         run: scripts/run-task release
 42 |       - name: Check for new commits
 43 |         id: git_remote
 44 |         run: echo ::set-output name=latest_commit::"$(git ls-remote origin -h ${{ github.ref }} | cut -f1)"
 45 |       - name: Upload artifact
 46 |         if: ${{ steps.git_remote.outputs.latest_commit == github.sha }}
 47 |         uses: actions/upload-artifact@v4.3.6
 48 |         with:
 49 |           name: build-artifact
 50 |           path: dist
 51 |     container:
 52 |       image: jsii/superchain:1-buster-slim-node14
 53 |   release_github:
 54 |     name: Publish to GitHub Releases
 55 |     needs: release
 56 |     runs-on: ubuntu-latest
 57 |     permissions:
 58 |       contents: write
 59 |     if: needs.release.outputs.latest_commit == github.sha
 60 |     steps:
 61 |       - uses: actions/setup-node@v6
 62 |         with:
 63 |           node-version: ${{ env.node_version }}
 64 |       - name: Update npm
 65 |         run: npm install -g npm@latest
 66 |       - name: Download build artifacts
 67 |         uses: actions/download-artifact@v4
 68 |         with:
 69 |           name: build-artifact
 70 |           path: dist
 71 |       - name: Prepare Repository
 72 |         run: mv dist .repo
 73 |       - name: Collect GitHub Metadata
 74 |         run: mv .repo/dist dist
 75 |       - name: Release
 76 |         run: errout=$(mktemp); gh release create $(cat dist/releasetag.txt) -R $GITHUB_REPOSITORY -F dist/changelog.md -t $(cat dist/releasetag.txt) --target $GITHUB_REF 2> $errout && true; exitcode=$?; if [ $exitcode -ne 0 ] && ! grep -q "Release.tag_name already exists" $errout; then cat $errout; exit $exitcode; fi
 77 |         env:
 78 |           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 79 |           GITHUB_REPOSITORY: ${{ github.repository }}
 80 |           GITHUB_REF: ${{ github.ref }}
 81 |   release_npm:
 82 |     name: Publish to npm
 83 |     needs: release
 84 |     runs-on: ubuntu-latest
 85 |     permissions:
 86 |       id-token: write
 87 |       contents: read
 88 |     if: needs.release.outputs.latest_commit == github.sha
 89 |     steps:
 90 |       - uses: actions/setup-node@v6
 91 |         with:
 92 |           node-version: ${{ env.node_version }}
 93 |           registry-url: 'https://registry.npmjs.org'
 94 |       - name: Update npm
 95 |         run: npm install -g npm@latest
 96 |       - name: Download build artifacts
 97 |         uses: actions/download-artifact@v4
 98 |         with:
 99 |           name: build-artifact
100 |           path: dist
101 |       - name: Prepare Repository
102 |         run: mv dist .repo
103 |       - name: Install Dependencies
104 |         run: cd .repo && npm ci
105 |       - name: Create js artifact
106 |         run: cd .repo && npx projen package:js
107 |       - name: Collect js Artifact
108 |         run: mv .repo/dist dist
109 |       - name: Release
110 |         run: npx -p publib@latest publib-npm
111 |         env:
112 |           NPM_DIST_TAG: latest
113 |           NPM_TRUSTED_PUBLISHER: true
114 | 


--------------------------------------------------------------------------------