Add envs input to the plugin (#46)

The envs input enables us to selectively forward environment variables from Netlify CI to Nimbella Functions.

Author: satyarohith

README.md

@@ -9,6 +9,7 @@
 The Nimbella add-on for Netlify is a Netlify Build Plugin that extends Netlify Sites with portable and stateful serverless functions using [Nimbella](https://nimbella.com/product/platform). The add-on enables developers to deploy sites to Netlify's CDN, and serverless functions and stateful APIs to the [Nimbella Cloud](https://nimbella.com).
 
 The Nimbella add-on provides the following benefits.
+
 1. **More runtimes:** implement functions in numerous languages including Python, Rust, Swift, Ruby, PHP, Java, Go, Node, and Deno.
 2. **Resource customization:** run functions for longer durations, and with more memory.
 3. **Support for key-value and object stores:** build stateful APIs, and handle images or files.
@@ -36,6 +37,7 @@ Learn more about the Nimbella add-on for Netlify [on our website](https://nimbel
 
 Add the Nimbella add-on for Netlify to connect your Netlify site to Nimbella.
 To do that, run the following command from the base of your local project directory which is linked to your Netlify site.
+
 ```sh
 netlify addons:create nimbella
 ```
@@ -123,10 +125,17 @@ package = "netlify-plugin-nimbella"
 + functions = "functions" # Functions source directory. Use this if you would like to use Nimbella to deploy your functions.
 ```
 
+To be able to pass **environment variables** to functions, you should first set them as Netlify build environment variables and use the below plugin input to selectively forward the variables to functions deployed on Nimbella.
+
+```toml
+[plugins.inputs]
+envs = ['ENV_ONE', 'ENV_TWO']
+```
+
 This plugin builds your functions using a modified version of [netlify-lambda](https://github.com/netlify/netlify-lambda). You can get rid of any build steps you're performing on functions since the plugin handles it for you.
 
 **Notes:**
-- None of environment variables present in the Netlify build runtime are made available to the deployed functions on Nimbella Cloud. _An enhancement to permit selective forwarding of environment variables is coming soon._
+
 - Replace occurrences of `/.netlify/functions` in your API calls with `/.netlify/nimbella`, or use `/api`, as your API path instead.
 - All Netlify functions are deployed to a "default" package in your Nimbella namespace. The package name is required in the API path. For Netlify functions, the path will be `/.netlify/nimbella/default/` or `/api/default`. For named packages, replace `default` with your package name instead.
 

index.js

@@ -1,13 +1,14 @@
 const {existsSync} = require('fs');
-const {appendFile, readFile, readdir} = require('fs').promises;
+const {appendFile, readFile, readdir, writeFile} = require('fs').promises;
 const {join} = require('path');
+const {homedir, tmpdir} = require('os');
 
 const toml = require('@iarna/toml');
 const cpx = require('cpx');
 const build = require('netlify-lambda/lib/build');
 
 const functionsBuildDir = `functions-build-${Date.now()}`;
-const nimConfig = join(require('os').homedir(), '.nimbella');
+const nimConfig = join(homedir(), '.nimbella');
 let netlifyToml = {};
 let isProject = false;
 let isActions = false;
@@ -28,22 +29,30 @@ async function deployProject(run) {
  * @param {function} run - function provided under utils by Netlify to build event functions.
  * @param {string} functionsDir - Path to the actions directory.
  */
-async function deployActions({run, functionsDir, timeout, memory}) {
+async function deployActions({run, functionsDir, timeout, memory, envsFile}) {
   const files = await readdir(functionsDir);
+  if (!existsSync(envsFile)) {
+    envsFile = false;
+  }
 
   await Promise.all(
     files.map(async (file) => {
       const [actionName, extension] = file.split('.');
-      let command =
-        `nim action update ${actionName} ${join(functionsDir, file)} ` +
-        `--timeout=${Number(timeout)} --memory=${Number(memory)} ` +
-        `--web=raw `;
+      const command = [
+        `nim action update ${actionName} ${join(functionsDir, file)}`,
+        `--timeout=${Number(timeout)} --memory=${Number(memory)} `,
+        `--web=raw`
+      ];
 
       if (extension === 'js') {
-        command += '--kind nodejs-lambda:10 --main handler';
+        command.push('--kind nodejs-lambda:10 --main handler');
+      }
+
+      if (envsFile) {
+        command.push(`--env-file=${envsFile}`);
       }
 
-      const {stderr, exitCode, failed} = await run.command(command, {
+      const {stderr, exitCode, failed} = await run.command(command.join(' '), {
         reject: false,
         stdout: 'ignore'
       });
@@ -132,8 +141,20 @@ module.exports = {
       if (isActions) {
         console.log('\n------------------Functions------------------\n');
         try {
+          if (inputs.envs.length > 0) {
+            const envs = {};
+            let envMessage = 'Forwarded the following environment variables: ';
+            inputs.envs.forEach((env, index) => {
+              envs[env] = process.env[env];
+              envMessage += index === inputs.envs.length - 1 ? env : env + ', ';
+            });
+            await writeFile(join(tmpdir(), 'env.json'), JSON.stringify(envs));
+            console.log(envMessage);
+          }
+
           await deployActions({
             run: utils.run,
+            envsFile: join(tmpdir(), 'env.json'),
             functionsDir: functionsBuildDir,
             timeout: inputs.timeout, // Default is 6 seconds
             memory: inputs.memory // Default is 256MB (max for free tier)

manifest.yml

@@ -8,6 +8,9 @@ inputs:
   - name: memory
     description: Maximum memory LIMIT in MB for the function (functions input value is required to utilize this option).
     default: 256
+  - name: envs
+    description: Specify the names of the environment variables that need to be forwarded from Netlify CI to Nimbella Functions (functions input value is required to utilize this option).
+    default: []
   - name: path
     description: The API prefix path you would like to use to access your functions.
-    default: '/api/'
+    default: '/api/'