feat: ✨ create plugin for recursiveLoop lambda property

Author: Nilay

.editorconfig

@@ -0,0 +1,5 @@
+[*.{ts,js}]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true

.github/workflows/cd.release.yml

@@ -0,0 +1,25 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: lts/*
+      - name: Install dependencies
+        run: npm ci
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

.gitignore

@@ -0,0 +1,9 @@
+# package directories
+node_modules
+jspm_packages
+
+# Serverless directories
+.serverless
+
+# Webpack directories
+.webpack

.tool-versions

@@ -0,0 +1 @@
+nodejs 20.9.0

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Ryan Sonshine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,50 @@
-# serverless-lambda-recursiveloop
+## Getting started
+
+### Installation
+
+`npm install --save-dev @distinction-dev/serverless-lambda-recursiveloop`
+
+# Serverless RecursiveLoop Plugin
+
+A Serverless Framework plugin that adds a `RecursiveLoop` property to AWS Lambda function configurations. This property controls the recursive loop detection behavior for Lambda functions.
+
+## Functionality
+
+The `RecursiveLoop` property allows you to configure how AWS Lambda handles recursive loop detections for your functions. 
+
+- **Allowed Values**:
+  - `Allow`: No action is taken if a recursive loop is detected.
+  - `Terminate`: The function invocation is stopped, and a notification is sent when a recursive loop is detected.
+
+- **Type**: String
+- **Required**: No
+- **Resource Type**: `AWS::Lambda::Function`
+
+## Installation
+
+To use this plugin in your Serverless project, follow these steps:
+
+1. **Create the Plugin File**:
+   Create a file named `serverless-recursive-loop-plugin.js` in the root directory of your Serverless project and paste the plugin code into it.
+
+2. **Add the Plugin to Your Serverless Configuration**:
+   In your `serverless.yml` file, add the plugin under the `plugins` section.
+
+   ```yaml
+   service: my-service
+
+   provider:
+     name: aws
+     runtime: nodejs14.x
+
+   plugins:
+     - "@distinction-dev/serverless-lambda-recursiveloop"
+
+   functions:
+     myFunction:
+       handler: handler.myFunction
+       recursiveLoop: Terminate
+
+     anotherFunction:
+       handler: handler.anotherFunction
+       recursiveLoop: Allow

index.js

@@ -0,0 +1,56 @@
+'use strict';
+
+/**
+ * Serverless Plugin to add a `RecursiveLoop` property to AWS Lambda functions.
+ * 
+ * The `RecursiveLoop` property allows configuration of recursive loop detection
+ * for Lambda functions. When set to "Allow", no action is taken if a loop is detected.
+ * When set to "Terminate", the function invocation is stopped and a notification is sent.
+ * 
+ * @example
+ * // serverless.yml configuration
+ * functions:
+ *   myFunction:
+ *     handler: handler.myFunction
+ *     recursiveLoop: Terminate
+ */
+
+class ServerlessRecursiveLoopPlugin {
+  constructor(serverless) {
+    this.serverless = serverless;
+    this.provider = this.serverless.getProvider("aws");
+    this.hooks = {
+      "package:compileFunctions": this.addRecursiveLoopProperty.bind(this),
+    };
+  }
+
+  /**
+   * Adds the `RecursiveLoop` property to the Lambda function's CloudFormation template.
+   *
+   * This method iterates through all functions defined in the Serverless service.
+   * If a function has a `recursiveLoop` property, it validates the value and adds
+   * it to the CloudFormation template.
+   */
+  addRecursiveLoopProperty() {
+    const service = this.serverless.service;
+    for (const functionName in service.functions) {
+      const func = service.functions[functionName];
+      if (func.recursiveLoop) {
+        const recursiveLoop = func.recursiveLoop;
+        if (["Allow", "Terminate"].includes(recursiveLoop)) {
+          const functionResource =
+            service.provider.compiledCloudFormationTemplate.Resources[
+              this.provider.naming.getLambdaLogicalId(functionName)
+            ];
+          functionResource.Properties.RecursiveLoop = recursiveLoop;
+        } else {
+          this.serverless.cli.log(
+            `Invalid RecursiveLoop value in function ${functionName}. Allowed values are 'Allow' or 'Terminate'.`
+          );
+        }
+      }
+    }
+  }
+}
+
+module.exports = ServerlessRecursiveLoopPlugin;