port to new specs

Author: qngapparat

cli.js

@@ -2,7 +2,7 @@
 const path = require('path')
 const fs = require('fs')
 const semver = require('semver')
-const { init } = require('./initer/index')
+const { init, initDumb } = require('./initer/index')
 const { getParsedHyperformJson } = require('./parser/index')
 const { log } = require('./printers/index')
 const { maybeShowSurvey, answerSurvey } = require('./surveyor/index')
@@ -21,68 +21,92 @@ if (semver.satisfies(process.version, version) !== true) {
 }
 
 if (
-  (/init|deploy/.test(args[0]) === false) 
- || ((args.length === 1) && args[0] !== 'init') 
-|| (args.length === 3 && args[2] !== '--url') 
+  (/deploy/.test(args[0]) === false) 
+ || ((args.length === 1)) 
+|| (args.length === 2)
+|| (args.length === 3 && args[2] !== '--amazon' && args[2] !== '--google') 
 || args.length >= 4) {
   log(`Usage: 
- $ hf init                    # Creates 'hyperform.json' in current directory
- $ hf deploy ./some/file.js   # Deploys exports of a Javascript file
+ $ hf deploy ./some/file.js --amazon  # Deploy exports to AWS Lambda
+ $ hf deploy ./some/file.js --google  # Deploy exports to Google Cloud Functions
 `)
   process.exit(1)
 }
 
 // $ hf MODE FPATH [--url]
-const mode = args[0]
+// const mode = args[0]
 const fpath = args[1]
-const isPublic = (args[2] === '--url')
+// const isPublic = (args[2] === '--url')
 
 const currdir = process.cwd() 
 
-// Mode is init
-if (mode === 'init') {
-  init(currdir)
-  process.exit()
-}
+let platform 
+if (args[2] === '--amazon') platform = 'amazon'
+if (args[2] === '--google') platform = 'google'
+
+// // Mode is init
+// if (mode === 'init') {
+//   initDumb(currdir)
+//   process.exit()
+// }
 
 // Mode is answer survey
-if (mode === 'answer') {
-  const answer = args.slice(1) // words after $ hf answer
-  // Send anonymous answer (words and date recorded)
-  answerSurvey(answer)
-    .then(process.exit())
-}
+// if (mode === 'answer') {
+//   const answer = args.slice(1) // words after $ hf answer
+//   // Send anonymous answer (words and date recorded)
+//   answerSurvey(answer)
+//     .then(process.exit())
+// }
 
 // Mode is deploy
 
 // try to read hyperform.json
 const hyperformJsonExists = fs.existsSync(path.join(currdir, 'hyperform.json'))
 if (hyperformJsonExists === false) {
-  log(`No hyperform.json found. You can create one with:
- $ hf init`)
+  if (platform === 'amazon') {
+    log(`No hyperform.json found in current directory. Create it with these fields:
+      
+      amazon: {
+        aws_access_key_id: '',
+        aws_secret_access_key: '',
+        aws_region: '', 
+      }
+      
+      `)
+  }
+
+  if (platform === 'google') {
+    log(`No hyperform.json found in current directory. Create it with these fields:
+      
+    google: {
+      gc_project: '',
+      gc_region: '',
+    }
+    
+    `)
+  }
   process.exit(1)
 }
 // parse and validate hyperform.json
-const parsedHyperformJson = getParsedHyperformJson(currdir)
-
+const parsedHyperformJson = getParsedHyperformJson(currdir, platform)
+  
 // Dev Note: Do this as early as possible
-
+  
 // Load AWS Credentials from hyperform.json into process.env
 // These are identical with variables that Amazon CLI uses, so they may be set
 // However, that is fine, hyperform.json should still take precedence
 if (parsedHyperformJson.amazon != null) {
   process.env.AWS_ACCESS_KEY_ID = parsedHyperformJson.amazon.aws_access_key_id,
   process.env.AWS_SECRET_ACCESS_KEY = parsedHyperformJson.amazon.aws_secret_access_key,
-  process.env.AWS_REGION = parsedHyperformJson.amazon.aws_default_region
+  process.env.AWS_REGION = parsedHyperformJson.amazon.aws_region
   // may, may not be defined.
   process.env.AWS_SESSION_TOKEN = parsedHyperformJson.amazon.aws_session_token
 }
-
+  
 // Load GC Credentials from hyperform.json into process.env
 // These are different from what Google usually occupies (GCLOUD_...)
 if (parsedHyperformJson.google != null) {
-  process.env.GC_CLIENT_EMAIL = parsedHyperformJson.google.gc_client_email,
-  process.env.GC_PRIVATE_KEY = parsedHyperformJson.google.gc_private_key,
+  process.env.GC_REGION = parsedHyperformJson.google.gc_private_key,
   process.env.GC_PROJECT = parsedHyperformJson.google.gc_project
 }
 
@@ -92,7 +116,7 @@ try {
   // Do not import earlier, it needs to absorb process.env set above
   // TODO: make less sloppy
   const { main } = require('./index')
-  main(currdir, fpath, parsedHyperformJson, isPublic)
+  main(currdir, fpath, platform, parsedHyperformJson)
   // show anonymous survey question with 1/30 probability
   //  .then(() => maybeShowSurvey())
 } catch (e) {

deployer/google/index.js

@@ -4,6 +4,11 @@ const fetch = require('node-fetch')
 const { logdev } = require('../../printers/index')
 
 let gcOptions
+if (process.env.GC_PROJECT) {
+  gcOptions = {
+    projectId: process.env.GC_PROJECT,
+  }
+}
 // Don't consult hyperform.json yet for Google credentials
 
 // if (process.env.GC_CLIENT_EMAIL && process.env.GC_PRIVATE_KEY && process.env.GC_PROJECT) {

index.js

@@ -15,11 +15,11 @@ const { spinnies, log, logdev } = require('./printers/index')
 const { zip } = require('./zipper/index')
 const { deployGoogle, publishGoogle } = require('./deployer/google/index')
 const { transpile } = require('./transpiler/index')
-const schema = require('./schemas/index').hyperformJsonSchema
 const packagejson = require('./package.json')
 const { createCopy } = require('./copier/index')
 const { zipDir } = require('./zipper/google/index')
 const { kindle } = require('./kindler/index')
+const { amazonSchema, googleSchema } = require('./schemas/index')
 /**
  * 
  * @param {string} fpath Path to .js file
@@ -164,7 +164,7 @@ async function deployPublishAmazon(name, region, zipPath, isPublic) {
     if (isPublic === true) {
       amazonUrl = await publishAmazon(amazonArn, region)
     }
-    spinnies.succ(amazonSpinnieName, { text: `🟢 ${name} ${chalk.rgb(255, 255, 255).bgWhite(amazonUrl || '(no URL. Add --url if you want one)')}` })
+    spinnies.succ(amazonSpinnieName, { text: `🟢 Deployed ${name} to AWS Lambda` })
 
     // (return url)
     return amazonUrl
@@ -207,7 +207,7 @@ async function deployPublishGoogle(name, region, project, zipPath, isPublic) {
       // 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 || '(no URL. Specify --url if you want one)')}` })
+    spinnies.succ(googleSpinnieName, { text: `🟢 Deployed ${name} to Google Cloud Functions` })
     console.log('Google takes another 1 - 2m for changes to take effect')
 
     // return url
@@ -221,14 +221,12 @@ async function deployPublishGoogle(name, region, project, zipPath, isPublic) {
   }
 }
 /**
- * 
  * @param {string} dir 
  * @param {Regex} fpath the path to the .js file whose exports should be deployed 
- * @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 Array of endpoint URLs.
+ * @param {amazon|google} platform
+ * @param {{amazon: {aws_access_key_id:string, aws_secret_access_key: string, aws_region: string}}} parsedHyperformJson 
  */
-async function main(dir, fpath, parsedHyperformJson, isPublic) {
+async function main(dir, fpath, platform, parsedHyperformJson) {
   // Check node version (again)
   const version = packagejson.engines.node 
   if (semver.satisfies(process.version, version) !== true) {
@@ -237,6 +235,9 @@ async function main(dir, fpath, parsedHyperformJson, isPublic) {
   }
 
   // verify parsedHyperformJson (again)
+  let schema 
+  if (platform === 'amazon') schema = amazonSchema
+  if (platform === 'google') schema = googleSchema
   const { error, value } = schema.validate(parsedHyperformJson)
   if (error) {
     throw new Error(`${error} ${value}`)
@@ -252,8 +253,8 @@ async function main(dir, fpath, parsedHyperformJson, isPublic) {
     return [] // no endpoint URLs created
   }
 
-  const isToAmazon = parsedHyperformJson.amazon != null
-  const isToGoogle = parsedHyperformJson.google != null
+  const isToAmazon = platform === 'amazon'
+  const isToGoogle = platform === 'google'
 
   let amazonZipPath
   let googleZipPath
@@ -269,6 +270,7 @@ async function main(dir, fpath, parsedHyperformJson, isPublic) {
   /// ///////////////////////////////////////////////////
   /// Each  export, deploy as function & publish. Obtain URL.
   /// ///////////////////////////////////////////////////
+  const isPublic = false
 
   let endpoints = await Promise.all(
     // For each export
@@ -280,7 +282,7 @@ async function main(dir, fpath, parsedHyperformJson, isPublic) {
       if (isToAmazon === true) {
         amazonUrl = await deployPublishAmazon(
           exp,
-          parsedHyperformJson.amazon.aws_default_region,
+          parsedHyperformJson.amazon.aws_region,
           amazonZipPath,
           isPublic,
         )
@@ -293,8 +295,9 @@ async function main(dir, fpath, parsedHyperformJson, isPublic) {
       if (isToGoogle === true) {
         googleUrl = await deployPublishGoogle(
           exp,
-          'us-central1',
-          'hyperform-7fd42', // TODO
+          // TODO lol
+          parsedHyperformJson.google.gc_region,
+          parsedHyperformJson.google.gc_project, // TODO
           googleZipPath,
           isPublic,
         )
@@ -359,7 +362,7 @@ async function main(dir, fpath, parsedHyperformJson, isPublic) {
   //         if (toAmazon === true) {
   //           amazonUrl = await deployPublishAmazon(
   //             exp,
-  //             parsedHyperformJson.amazon.aws_default_region,
+  //             parsedHyperformJson.amazon.aws_region,
   //             amazonZipPath,
   //             isPublic,
   //           )

initer/index.js

@@ -33,7 +33,7 @@ function getDefaultSectionString(filecontents) {
  * default: { 
   * aws_access_key_id?: string, 
   * aws_secret_access_key?: string, 
-  * aws_default_region?: string 
+  * aws_region?: string 
  * }}
  */
 function parseAwsCredentialsOrConfigFile(filecontents) {
@@ -103,6 +103,47 @@ function parseAwsCredentialsOrConfigFile(filecontents) {
   }
 }
 
+/**
+ * Just creates an empty hyperform.json
+ * @param {string} absdir 
+ */
+function initDumb(absdir, platform) {
+  let json 
+  if (platform === 'amazon') {
+    json = {
+      amazon: {
+        aws_access_key_id: '',
+        aws_secret_access_key: '',
+        aws_region: '', 
+      },
+    }
+  } else if (platform === 'google') {
+    json = {
+      google: {
+        gc_project: '',
+        gc_region: '',
+      },
+    }
+  } else {
+    throw new Error(`platform must be google or amazon but is ${platform}`)
+  }
+
+  // append 'hyperform.json' to .gitignore 
+  // (or create .gitignore if it does not exist yet)
+  fs.appendFileSync(
+    path.join(absdir, '.gitignore'),
+    `${EOL}hyperform.json`,
+  )
+
+  // write results to hyperform.json
+  fs.writeFileSync(
+    path.join(absdir, 'hyperform.json'),
+    JSON.stringify(json, null, 2),
+  )
+  log('✓ Created `hyperform.json` ') //
+  log('✓ Added `hyperform.json` to `.gitignore`') //
+}
+
 // TODO shorten
 /**
  * @description Tries to infer AWS credentials and config, and creates a hyperform.json in "absdir" with what it could infer. If hyperform.json already exists in "absdir" it just prints a message.
@@ -111,7 +152,7 @@ function parseAwsCredentialsOrConfigFile(filecontents) {
  * amazon: { 
  *  aws_access_key_id: string?,
  *  aws_secret_access_key: string?, 
- *  aws_default_region: string? 
+ *  aws_region: string? 
  * }
  * }}
  */
@@ -120,13 +161,12 @@ function init(absdir) {
     amazon: {
       aws_access_key_id: '',
       aws_secret_access_key: '',
-      aws_default_region: '', // TODO
+      aws_region: '', 
+    },
+    google: {
+      gc_project: '',
+      gc_region: '',
     },
-    // google: {
-    //   gc_project: '',
-    //   gc_client_email: '',
-    //   gc_private_key: '',
-    // },
   }
 
   const filedest = path.join(absdir, 'hyperform.json')
@@ -171,7 +211,7 @@ function init(absdir) {
     const configFileContents = fs.readFileSync(possibleConfigPath, { encoding: 'utf-8' })
 
     const parsedConfig = parseAwsCredentialsOrConfigFile(configFileContents)
-    hyperformJsonContents.amazon.aws_default_region = parsedConfig.default.region
+    hyperformJsonContents.amazon.aws_region = parsedConfig.default.region
     logdev(`Inferred AWS region from ${possibleConfigPath}`)
   } else {
     logdev(`Could not guess AWS region. No AWS config file found in ${possibleConfigPath}`) // TODO region will not be a single region, but smartly multiple ones (or?)
@@ -191,7 +231,7 @@ function init(absdir) {
   }
 
   if (typeof process.env.AWS_REGION === 'string' && process.env.AWS_REGION.trim().length > 0) {
-    hyperformJsonContents.amazon.aws_default_region = process.env.AWS_REGION.trim()
+    hyperformJsonContents.amazon.aws_region = process.env.AWS_REGION.trim()
     logdev('Environment variable AWS_REGION set, overriding value from config file')
   }
 
@@ -214,6 +254,7 @@ function init(absdir) {
 
 module.exports = {
   init,
+  initDumb,
   _only_for_testing_getDefaultSectionString: getDefaultSectionString,
   _only_for_testing_parseAwsCredentialsOrConfigFile: parseAwsCredentialsOrConfigFile,
 }