implement --url flag (default is no url)

Author: tcl89

README.md

@@ -1,7 +1,7 @@
 ![Hyperform Banner](https://github.com/qngapparat/hyperform/blob/master/hyperform-banner.png)
 
 
-<p align="center">Deploys JavaScript functions as serverless functions
+<p align="center">A next-gen serverless deployer
 <br>For AWS Lambda & Google Cloud Functions</p>
 
 ## Install
@@ -13,6 +13,11 @@ $ npm install -g hyperform-cli
 
 ## Usage
 
+```
+$ hf init 
+$ hf deploy [--url]
+```
+
 ### ✍️ Write normal JavaScript
 
 
@@ -47,12 +52,15 @@ $ hf init
 ### 🚀 Deploy exports as functions
 
 ```sh 
-$ hf deploy  
+$ hf deploy --url
 
 🟢 endpointGreet https://ltirihayh9.execute-api.us-east-2.amazonaws.com/endpointGreet
    # or
 🟢 endpointGreet https://us-central1-myproject.cloudfunctions.net/endpointGreet
 ```
+
+If you don't want to make your functions public, omit the `--url` flag.
+
 <!-- 
 ## Invoke 
 

cli.js

@@ -10,15 +10,16 @@ const { maybeShowSurvey, answerSurvey } = require('./surveyor/index')
 
 const args = process.argv.slice(2)
 
-if ((/init|deploy/.test(args[0]) === false) || (args.length > 1)) {
+if ((/init|deploy/.test(args[0]) === false) || (args.length === 2 && args[1] !== '--url') || args.length > 2) {
   log(`Usage: 
  $ hf init
- $ hf deploy
+ $ hf deploy [--url]
 `)
   process.exit(1)
 }
 
 const mode = args[0]
+const isPublic = (args[1] === '--url')
 // $ hf should always be invoked in the desired directory
 const absdir = process.cwd()
 
@@ -76,7 +77,7 @@ try {
   // Do not import earlier, it needs to absorb process.env set above
   // TODO: make less sloppy
   const { main } = require('./index')
-  main(absdir, fnregex, parsedHyperformJson)
+  main(absdir, fnregex, parsedHyperformJson, isPublic)
     // show anonymous survey question with 1/30 percent probability
     .then(() => maybeShowSurvey())
 } catch (e) {

deployer/google/index.js

@@ -186,7 +186,8 @@ async function _allowPublicInvokeGoogle(options) {
  * it creates a new GCF with given code ("pathToZip") and "options". 
  * If GCF exists already, it updates its code with "pathToZip". 
  * If other options are specified, it can update those too (currently only "runtime"). 
- * Returns URL immediately, but Cloud Function takes another 1-2 minutes to be invokable.
+ * Returns IAM-protected URL immediately, but Cloud Function takes another 1-2 minutes to be invokable.
+ * To remove IAM protection to allow anyone with the URL to call it, use publishGoogle afterwards.
  * @param {string} pathToZip 
  * @param {{
  * name: string,
@@ -236,23 +237,33 @@ async function deployGoogle(pathToZip, options) {
     }
     await _updateGoogle(signedUploadUrl, updateParams)
   }
-
-  // allow anyone to invoke function 
-  const allowPublicInvokeOptions = {
-    name: options.name,
-    project: options.project, 
-    region: options.region, 
-  }
-  await _allowPublicInvokeGoogle(allowPublicInvokeOptions)
-    
+   
   // Construct endpoint URL (it's deterministic)
   const endpointUrl = `https://${options.region}-${options.project}.cloudfunctions.net/${options.name}`
 
   // Note: GCF likely not ready by the time we return its URL here
   return endpointUrl 
 }
 
+/**
+ * @description Allows anyone to call function via its HTTP endpoint. 
+ * Does so by turning IAM checking of Google off. 
+ * Unlike publishAmazon, publishgoogle it does not return an URL, deployGoogle does that already.
+ *  @param {*} name 
+  * @param {*} project 
+  * @param {*} region 
+ */
+async function publishGoogle(name, project, region) {
+  const allowPublicInvokeOptions = {
+    name: name,
+    project: project, 
+    region: region, 
+  }
+  await _allowPublicInvokeGoogle(allowPublicInvokeOptions)
+}
+
 module.exports = {
   deployGoogle,
+  publishGoogle,
   _only_for_testing_isExistsGoogle: isExistsGoogle,
 }

index.js

@@ -8,7 +8,7 @@ const { deployAmazon } = require('./deployer/amazon/index')
 const { publishAmazon } = require('./publisher/amazon/index')
 const { spinnies, log, logdev } = require('./printers/index')
 const { zip } = require('./zipper/index')
-const { deployGoogle } = require('./deployer/google/index')
+const { deployGoogle, publishGoogle } = require('./deployer/google/index')
 const { transpile } = require('./transpiler/index')
 const schema = require('./schemas/index').hyperformJsonSchema
 
@@ -73,9 +73,10 @@ async function bundleTranspileZipGoogle(fpath) {
  * @param {string} name 
  * @param {string} region 
  * @param {string} zipPath 
- * @returns {string} URL of the endpoint of the Lambda
+ * @param {boolean} isPublic whether to publish 
+ * @returns {string?} If isPublic was true, URL of the endpoint of the Lambda
  */
-async function deployPublishAmazon(name, region, zipPath) {
+async function deployPublishAmazon(name, region, zipPath, isPublic) {
   const amazonSpinnieName = `amazon-main-${name}`
   try {
     spinnies.add(amazonSpinnieName, { text: `Deploying ${name}` })
@@ -86,11 +87,14 @@ async function deployPublishAmazon(name, region, zipPath) {
       region: region,
     }
     const amazonArn = await deployAmazon(zipPath, amazonDeployOptions)
-    // Publish it
-    const amazonUrl = await publishAmazon(amazonArn, region)
+    let amazonUrl 
+    // Publish it if isPpublic
+    if (isPublic === true) {
+      amazonUrl = await publishAmazon(amazonArn, region)
+    }
     spinnies.succ(amazonSpinnieName, { text: `🟢 ${name} ${chalk.rgb(255, 255, 255).bgWhite(amazonUrl)}` })
 
-    // return url 
+    // (return url)
     return amazonUrl
   } catch (e) {
     spinnies.f(amazonSpinnieName, {
@@ -107,9 +111,10 @@ async function deployPublishAmazon(name, region, zipPath) {
  * @param {string} region 
  * @param {string} project 
  * @param {string} zipPath 
- * @returns {string} URL of the Google Cloud Function 
+ * @param {boolean} isPublic whether to publish
+ * @returns {string?} If isPublic was true, URL of the Google Cloud Function 
  */
-async function deployPublishGoogle(name, region, project, zipPath) {
+async function deployPublishGoogle(name, region, project, zipPath, isPublic) {
   const googleSpinnieName = `google-main-${name}`
   try {
     spinnies.add(googleSpinnieName, { text: `Deploying ${name}` })
@@ -120,6 +125,11 @@ async function deployPublishGoogle(name, region, project, zipPath) {
       runtime: 'nodejs12',
     }
     const googleUrl = await deployGoogle(zipPath, googleOptions)
+    
+    if (isPublic === true) {
+      // enables anyone with the URL to call the function
+      await publishGoogle(name, project, region)
+    }
     spinnies.succ(googleSpinnieName, { text: `🟢 ${name} ${chalk.rgb(255, 255, 255).bgWhite(googleUrl)}` })
     console.log('Google takes another 1 - 2m for changes to take effect')
 
@@ -138,9 +148,10 @@ async function deployPublishGoogle(name, region, project, zipPath) {
  * @param {string} dir 
  * @param {Regex} fnregex 
  * @param {*} parsedHyperformJson
+ * @param {boolean} isPublic Controls whether (Amazon) to create URL endpoint and (Google) whether to remove IAM protection on the URL
  * @returns {{ urls: string[] }} urls: Mixed, nested Array of endpoint URLs.
  */
-async function main(dir, fnregex, parsedHyperformJson) {
+async function main(dir, fnregex, parsedHyperformJson, isPublic) {
   const infos = await getInfos(dir, fnregex)
   /*
     [
@@ -203,6 +214,7 @@ async function main(dir, fnregex, parsedHyperformJson) {
               exp,
               parsedHyperformJson.amazon.aws_default_region,
               amazonZipPath,
+              isPublic,
             )
           }
 
@@ -216,6 +228,7 @@ async function main(dir, fnregex, parsedHyperformJson) {
               'us-central1', 
               'firstnodefunc', 
               googleZipPath,
+              isPublic,
             )
           }
 

index.test.js

@@ -73,10 +73,12 @@ describe('System tests (takes 1-2 minutes)', () => {
           },
 
         }
+
+        const isPublic = true
 
         let err
         try {
-          amazonMainRes = await main(dir, fnregex, amazonParsedHyperformJson)
+          amazonMainRes = await main(dir, fnregex, amazonParsedHyperformJson, isPublic)
         } catch (e) {
           console.log(e)
           err = e
@@ -102,10 +104,13 @@ describe('System tests (takes 1-2 minutes)', () => {
           },
 
         }
+
+        // to test publishing too
+        const isPublic = true
 
         let err
         try {
-          googleMainRes = await main(dir, fnregex, googleParsedHyperformJson)
+          googleMainRes = await main(dir, fnregex, googleParsedHyperformJson, isPublic)
         } catch (e) {
           console.log(e)
           err = e