TypeScript migration

.eslintrc.json

@@ -0,0 +1,25 @@
+ {
+  "root": true,
+  "plugins": [
+   "@typescript-eslint"
+  ],
+  "extends": [
+    "standard-with-typescript"
+  ],
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "rules": {
+    "@typescript-eslint/no-floating-promises": 0,
+    "no-template-curly-in-string": 0,
+    "@typescript-eslint/restrict-template-expressions": 0,
+    "@typescript-eslint/explicit-function-return-type": 0
+  },
+  "ignorePatterns": [
+    "core/coverage",
+    "cf-macro/coverage",
+    "serverless-plugin/dist/index.js",
+    "cf-macro/dist/index.js",
+    "**/dist/*"
+  ]
+}

.github/workflows/build.yml

@@ -14,31 +14,33 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14, 16, 18]
+        node-version: [16, 18]
 
     steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}.x
-      - name: Ensure npm >= 7
-        run: npm i -g npm@^7
+          cache: 'npm'
       - run: npm ci
-      - run: npm run audit
       - run: npm test
+        name: Run unit tests
+      - working-directory: ./serverless-test-project
+        run: npm test
+        name: Run Serverless Framework packaging test
+      - working-directory: ./serverless-test-project-alb
+        name: Run Serverless Framework packaging test for ALB test project
+        run: npm test
+      - working-directory: ./serverless-test-project-appsync
+        name: Run Serverless Framework packaging test for AppSync test project
+        run: npm test
       - name: Coveralls Parallel
         uses: coverallsapp/github-action@master
         with:
           github-token: ${{ secrets.github_token }}
           flag-name: run-node-${{ matrix.node-version }}
           parallel: true
           path-to-lcov: coverage/lcov.info
-      - name: Package test project with Serverless v2
-        working-directory: ./serverless-test-project
-        run: |
-          npm i serverless@2
-          npm run test:v2
   finish:
     needs: build
     runs-on: ubuntu-latest
@@ -48,4 +50,4 @@ jobs:
         with:
           github-token: ${{ secrets.github_token }}
           parallel-finished: true
-          path-to-lcov: coverage/lcov.info
+          path-to-lcov: coverage/lcov.info

.gitignore

@@ -122,6 +122,7 @@ __pycache__/
 build/
 develop-eggs/
 dist/
+core/dist/
 downloads/
 eggs/
 .eggs/

README.md

@@ -8,7 +8,7 @@
 
 Automatic, best-practice CloudWatch **Dashboards** and **Alarms** for your SAM, CloudFormation, CDK and Serverless Framework applications.
 
-SLIC Watch supports: _AWS Lambda, API Gateway, DynamoDB, Kinesis Data Streams, SQS Queues, Step Functions, ECS (Fargate or EC2), SNS, EventBridge and Application Load Balancer._  
+SLIC Watch supports: _AWS Lambda, API Gateway, DynamoDB, Kinesis Data Streams, SQS Queues, Step Functions, ECS (Fargate or EC2), SNS, EventBridge, Application Load Balancer and AppSync._  
 
 Supported tools include:
  * ⚡️ **Serverless Framework** v2 and v3 via the [_SLIC Watch Serverless Plugin_](#getting-started-with-serverless-framework)
@@ -33,6 +33,7 @@ Supported tools include:
     - [SNS](#sns)
     - [EventBridge](#eventbridge)
     - [Application Load Balancer](#application-load-balancer)
+    - [AppSync](#appsync) 
   - [Configuration](#configuration)
     - [Top-level configuration](#top-level-configuration)
     - [Function-level configuration](#function-level-configuration)
@@ -108,7 +109,7 @@ Once you have deployed the macro, you can start using SLIC Watch in SAM or Cloud
 ```yaml
 Transform:
   - ...
-  - SlicWatch-v2
+  - SlicWatch-v3
 ```
 
 🪛 _Optionally_, add some configuration for the plugin to the `Metadata -> slicWatch` section of `template.yml`.
@@ -134,24 +135,24 @@ export class MyStack extends cdk.Stack {
   constructor (scope: cdk.App, id: string, props?: cdk.StackProps) {
     super(scope, id, props)
 
-    this.addTransform('SlicWatch-v2')
+    this.addTransform('SlicWatch-v3')
     ...
   }
 }
 ```
 
 ```python
 # Python:
-self.add_transform("SlicWatch-v2")
+self.add_transform("SlicWatch-v3")
 ```
 ```csharp
 // C#:
-this.AddTransform("SlicWatch-v2")
+this.AddTransform("SlicWatch-v3")
 ```
 
 ```java
 // Java:
-this.addTransform("SlicWatch-v2");
+this.addTransform("SlicWatch-v3");
 ```
 
 🪛 _Optionally_, add some configuration for the plugin as below:
@@ -303,6 +304,18 @@ Application Load Balancer dashboard widgets show:
 |**UnHealthy Host Count**|**Lambda User Error**|**Lambda Internal Error**|
 |![UnHealthyHostCount](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/unHealthyHostCount.png) |![LambdaUserError](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/lambdaUserError.png)| |
 
+### AppSync
+AppSync alarms are created for:
+1. 5XX Error
+2. Latency
+
+AppSync dashboard widgets show:
+
+|5XX Error, Latency, 4XX Error, Request|
+|--|
+|![API Widget](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/appsyncAPI.png)|
+|**Connect Server Error**, **Disconnect Server Error**, **Subscribe Server Error**, **Unsubscribe Server Error**,**PublishDataMessageServerError**|
+|![Real-time Subscriptions Widget](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/appsyncRealTimeSubscriptions.png)|
 ## Configuration
 
 Configuration is entirely optional - SLIC Watch provides defaults that work out of the box.

RELEASING.md

@@ -2,6 +2,6 @@
 
 In order to release a new version of the project:
 
-  - update the package version with `npm version <version> -ws --include-workspace-root` to apply that version across all sub packages
-  - push these changes
-  - draft a new release in GitHub (the CI will do the publish to npm)
+1. Update the package version with `npm version <version>` to apply that version across all sub packages. If the Major version has changed, the Macro name will be automatically updated by [the sync-macro-version script](scripts/sync-macro-version.cjs)
+2. Push these changes (`git push --tags`)
+3. Draft a new release in GitHub (the CI will do the publish to npm) with the same name as the version tag. If you select "pre-release", this will be published in NPM as a `next` label so it will only be installed by users who explictly request the `@next` version.

cdk-test-project/package.json

@@ -1,25 +1,17 @@
 {
   "name": "cdk-test-project",
-  "version": "2.1.3",
+  "version": "3.0.0-rc2",
   "scripts": {
     "build": "tsc",
     "watch": "tsc -w",
     "test": "echo",
     "cdk": "cdk"
   },
-  "devDependencies": {
-    "@types/jest": "^27.5.2",
-    "@types/node": "10.17.27",
-    "@types/prettier": "2.6.0",
-    "aws-cdk": "2.37.0",
-    "eslint-config-standard-with-typescript": "^22.0.0",
-    "jest": "^27.5.1",
-    "ts-jest": "^27.1.4",
-    "ts-node": "^10.9.1",
-    "typescript": "~3.9.7"
-  },
   "dependencies": {
-    "aws-cdk-lib": "2.37.0",
-    "constructs": "^10.0.0"
+    "aws-cdk-lib": "^2.67.0",
+    "constructs": "^10.1.266"
+  },
+  "devDependencies": {
+    "aws-cdk": "^2.67.0"
   }
 }

cdk-test-project/source/ecs-stack.ts

@@ -6,7 +6,7 @@ export class CdkECSStack extends cdk.Stack {
   constructor (scope: cdk.App, id: string, props?: cdk.StackProps) {
     super(scope, id, props)
 
-    this.addTransform('SlicWatch-v2')
+    this.addTransform('SlicWatch-v3')
     this.templateOptions.metadata = {
       slicWatch: {
         enabled: true,

cdk-test-project/source/general-stack.ts

@@ -4,15 +4,15 @@ import * as sns from 'aws-cdk-lib/aws-sns'
 import * as dynamodb from 'aws-cdk-lib/aws-dynamodb'
 import * as apigateway from 'aws-cdk-lib/aws-apigateway'
 import * as sqs from 'aws-cdk-lib/aws-sqs'
-import { CfnResource } from 'aws-cdk-lib'
+import type { CfnResource } from 'aws-cdk-lib'
 import * as events from 'aws-cdk-lib/aws-events'
 import { LambdaFunction } from 'aws-cdk-lib/aws-events-targets'
 
 export class CdkTestGeneralStack extends cdk.Stack {
   constructor (scope: cdk.App, id: string, props?: cdk.StackProps) {
     super(scope, id, props)
 
-    this.addTransform('SlicWatch-v2')
+    this.addTransform('SlicWatch-v3')
     this.templateOptions.metadata = {
       slicWatch: {
         enabled: true,

cdk-test-project/source/sfn-stack.ts

@@ -1,15 +1,16 @@
 import * as cdk from 'aws-cdk-lib'
 import * as lambda from 'aws-cdk-lib/aws-lambda'
 import * as sns from 'aws-cdk-lib/aws-sns'
-import { CfnResource, Duration } from 'aws-cdk-lib'
+import { Duration } from 'aws-cdk-lib'
+import type { CfnResource } from 'aws-cdk-lib'
 import * as sfn from 'aws-cdk-lib/aws-stepfunctions'
 import { LambdaInvoke } from 'aws-cdk-lib/aws-stepfunctions-tasks'
 
 export class CdkSFNStack extends cdk.Stack {
   constructor (scope: cdk.App, id: string, props?: cdk.StackProps) {
     super(scope, id, props)
 
-    this.addTransform('SlicWatch-v2')
+    this.addTransform('SlicWatch-v3')
     this.templateOptions.metadata = {
       slicWatch: {
         enabled: true,