@tremho/mist-lift 1.1.1 → 1.1.3-pre-release.1

package/src/expressRoutes/functionBinder.ts

@@ -1,156 +1,155 @@
-/* eslint @typescript-eslint/no-var-requires: "off" */
-import path from 'path'
-
-import * as ac from 'ansi-colors'
-import { resolvePaths } from '../lib/pathResolve'
-
-import express from 'express'
-import { gatherFunctionDefinitions } from '../lib/openAPI/ApiBuildCollector'
-import { buildOpenApi } from '../lib/openAPI/openApiConstruction'
-import {Log} from '@tremho/inverse-y'
-
-const clearModule = require('clear-module')
-const router = express.Router()
-
-export function functionBinder (): void {
-  const defs = gatherFunctionDefinitions()
-  buildOpenApi(defs).then(() => { // creates apidoc.yaml for when /api is run
-    const projectPaths = resolvePaths()
-
-    for (const def of defs) {
-      const { name, pathMap, allowedMethods } = def
-      const methods = allowedMethods.split(',')
-      for (let method of methods) {
-        try {
-          method = method.trim().toLowerCase()
-          const rpath = path.join(projectPaths.buildPath, 'functions', name, 'src', 'main.js')
-          clearModule(rpath)
-          const { start } = require(rpath)
-
-          let entryRoot: string = pathMap
-          const n = entryRoot.indexOf('/{')
-          if (n !== -1) entryRoot = entryRoot.substring(0, n) + '/*'
-
-          const callHandler = (pathMap: string, req: any, res: any): void => {
-            const event = requestToEvent(pathMap, req)
-            Promise.resolve(start(event, null, null)).then(respOut => {
-              handleResponse(res, respOut)
-            }).catch<any>((reason: any) => undefined)
-          }
-
-          if (method === 'get') {
-            router.get(entryRoot, (req, res) => callHandler(pathMap, req, res))
-          } else if (method === 'post') {
-            router.post(entryRoot, (req, res) => callHandler(pathMap, req, res))
-          } else if (method === 'put') {
-            router.put(entryRoot, (req, res) => callHandler(pathMap, req, res))
-          } else if (method === 'patch') {
-            router.patch(entryRoot, (req, res) => callHandler(pathMap, req, res))
-          } else if (method === 'delete') {
-            router.delete(entryRoot, (req, res) => callHandler(pathMap, req, res))
-          } else {
-            console.log(ac.red.bold('Cannot map method ') + ac.blue.bold(method))
-          }
-        }
-        catch(e:any) {
-          Log.Error(ac.bold.red(e.message.split('\n')[0]));
-        }
-      }
-    }
-  }).catch<any>((reason: any) => undefined)
-}
-
-function requestToEvent (template: string, req: any): any {
-  let path: string = req.originalUrl ?? ''
-  const qi = path.indexOf('?')
-  if (qi !== -1) path = path.substring(0, qi)
-  const ptci: number = path.indexOf('://') + 3
-  const ei: number = path.indexOf('/', ptci)
-  let host: string = path.substring(0, ei)
-  if (ptci < 3) {
-    host = req.headers?.host ?? req.headers?.origin ?? req.headers?.referer ?? ''
-    if(!host.startsWith('http')) {
-      if(!host.startsWith('https')) {
-        host = 'http://'+host;
-      }
-    }
-  }
-  const cookies: any = {}
-  const cookieString = req.headers?.cookie ?? ''
-  const crumbs = cookieString.split(';')
-  for (const c of crumbs) {
-    const pair: string[] = c.split('=')
-    if (pair.length === 2) cookies[pair[0]] = pair[1]
-  }
-  const parameters: any = {}
-  const tslots = template.split('/')
-  const pslots = path.split('/')
-  for (let i = 0; i < tslots.length; i++) {
-    const brknm = (tslots[i] ?? '').trim()
-    if (brknm.charAt(0) === '{') {
-      const pn = brknm.substring(1, brknm.length - 1)
-      parameters[pn] = (pslots[i] ?? '').trim()
-    }
-  }
-  for (const p of Object.getOwnPropertyNames(req.query)) {
-    parameters[p] = req.query[p]
-  }
-  const eventOut: any = {
-    requestContext: req,
-    request: {
-      originalUrl: host + (req.originalUrl as string),
-      headers: req.headers
-    },
-    body: req.body,
-    cookies,
-    parameters
-  }
-  return eventOut
-}
-function handleResponse (res: any, resp: any): void {
-  // console.log(">>>>>>>> Handling response >>>>>>>>>")
-
-  if (resp !== undefined) {
-    if (resp.cookies !== undefined) {
-      // console.log("--- see cookies", resp.cookies)
-      let cookies: any = []
-      if (Array.isArray(resp.cookies)) {
-        cookies = resp.cookies
-      } else {
-        const age: number = resp.cookies.expireSeconds ?? 60 // 1 minute
-        delete resp.expireSeconds
-        Object.getOwnPropertyNames(resp.cookies).forEach(name => {
-          const value: string = resp.cookies[name]
-          cookies.push(`${name}=${value}; Max-Age=${age}; `)
-        })
-      }
-      // console.log("cookies being set", cookies)
-      res.setHeader('set-cookie', cookies)
-      delete resp.cookies
-    }
-    if (resp.headers !== undefined) {
-      // if (resp.statusCode === 301) ClogTrace("Redirecting...");
-      for (const hdr of Object.getOwnPropertyNames(resp.headers)) {
-        // ClogTrace("Setting header ", hdr, resp.headers[hdr]);
-        res.setHeader(hdr, resp.headers[hdr])
-      }
-      delete resp.headers
-      // console.log("past setting headers");
-    }
-    if (resp.statusCode !== undefined) {
-      res.statusCode = resp.statusCode
-      delete resp.statusCode
-    }
-
-    if (resp.contentType !== undefined) {
-      res.setHeader('Content-Type', resp.contentType)
-      delete resp.contentType
-    }
-    if (resp.body !== undefined) resp = resp.body
-  }
-  // console.log("headers to be sent", res.getHeaders())
-  // console.log("-- Sending response", resp)
-  res.send(resp)
-}
-
-export default router
+/* eslint @typescript-eslint/no-var-requires: "off" */
+import path from 'path'
+
+import * as ac from 'ansi-colors'
+import { resolvePaths } from '../lib/pathResolve'
+
+import express from 'express'
+import { gatherFunctionDefinitions } from '../lib/openAPI/ApiBuildCollector'
+import { buildOpenApi } from '../lib/openAPI/openApiConstruction'
+import { Log } from '@tremho/inverse-y'
+
+const clearModule = require('clear-module')
+const router = express.Router()
+
+export function functionBinder (): void {
+  const defs = gatherFunctionDefinitions()
+  buildOpenApi(defs).then(() => { // creates apidoc.yaml for when /api is run
+    const projectPaths = resolvePaths()
+
+    for (const def of defs) {
+      const { name, pathMap, allowedMethods } = def
+      const methods = allowedMethods.split(',')
+      for (let method of methods) {
+        try {
+          method = method.trim().toLowerCase()
+          const rpath = path.join(projectPaths.buildPath, 'functions', name, 'src', 'main.js')
+          clearModule(rpath)
+          const { start } = require(rpath)
+
+          let entryRoot: string = pathMap
+          const n = entryRoot.indexOf('/{')
+          if (n !== -1) entryRoot = entryRoot.substring(0, n) + '/*'
+
+          const callHandler = (pathMap: string, req: any, res: any): void => {
+            const event = requestToEvent(pathMap, req)
+            Promise.resolve(start(event, null, null)).then(respOut => {
+              handleResponse(res, respOut)
+            }).catch<any>((reason: any) => undefined)
+          }
+
+          if (method === 'get') {
+            router.get(entryRoot, (req, res) => callHandler(pathMap, req, res))
+          } else if (method === 'post') {
+            router.post(entryRoot, (req, res) => callHandler(pathMap, req, res))
+          } else if (method === 'put') {
+            router.put(entryRoot, (req, res) => callHandler(pathMap, req, res))
+          } else if (method === 'patch') {
+            router.patch(entryRoot, (req, res) => callHandler(pathMap, req, res))
+          } else if (method === 'delete') {
+            router.delete(entryRoot, (req, res) => callHandler(pathMap, req, res))
+          } else {
+            console.log(ac.red.bold('Cannot map method ') + ac.blue.bold(method))
+          }
+        } catch (e: any) {
+          Log.Error(ac.bold.red(e.message.split('\n')[0]))
+        }
+      }
+    }
+  }).catch<any>((reason: any) => undefined)
+}
+
+function requestToEvent (template: string, req: any): any {
+  let path: string = req.originalUrl ?? ''
+  const qi = path.indexOf('?')
+  if (qi !== -1) path = path.substring(0, qi)
+  const ptci: number = path.indexOf('://') + 3
+  const ei: number = path.indexOf('/', ptci)
+  let host: string = path.substring(0, ei)
+  if (ptci < 3) {
+    host = req.headers?.host ?? req.headers?.origin ?? req.headers?.referer ?? ''
+    if (!host.startsWith('http')) {
+      if (!host.startsWith('https')) {
+        host = 'http://' + host
+      }
+    }
+  }
+  const cookies: any = {}
+  const cookieString = req.headers?.cookie ?? ''
+  const crumbs = cookieString.split(';')
+  for (const c of crumbs) {
+    const pair: string[] = c.split('=')
+    if (pair.length === 2) cookies[pair[0]] = pair[1]
+  }
+  const parameters: any = {}
+  const tslots = template.split('/')
+  const pslots = path.split('/')
+  for (let i = 0; i < tslots.length; i++) {
+    const brknm = (tslots[i] ?? '').trim()
+    if (brknm.charAt(0) === '{') {
+      const pn = brknm.substring(1, brknm.length - 1)
+      parameters[pn] = (pslots[i] ?? '').trim()
+    }
+  }
+  for (const p of Object.getOwnPropertyNames(req.query)) {
+    parameters[p] = req.query[p]
+  }
+  const eventOut: any = {
+    requestContext: req,
+    request: {
+      originalUrl: host + (req.originalUrl as string),
+      headers: req.headers
+    },
+    body: req.body,
+    cookies,
+    parameters
+  }
+  return eventOut
+}
+function handleResponse (res: any, resp: any): void {
+  // console.log(">>>>>>>> Handling response >>>>>>>>>")
+
+  if (resp !== undefined) {
+    if (resp.cookies !== undefined) {
+      // console.log("--- see cookies", resp.cookies)
+      let cookies: any = []
+      if (Array.isArray(resp.cookies)) {
+        cookies = resp.cookies
+      } else {
+        const age: number = resp.cookies.expireSeconds ?? 60 // 1 minute
+        delete resp.expireSeconds
+        Object.getOwnPropertyNames(resp.cookies).forEach(name => {
+          const value: string = resp.cookies[name]
+          cookies.push(`${name}=${value}; Max-Age=${age}; `)
+        })
+      }
+      // console.log("cookies being set", cookies)
+      res.setHeader('set-cookie', cookies)
+      delete resp.cookies
+    }
+    if (resp.headers !== undefined) {
+      // if (resp.statusCode === 301) ClogTrace("Redirecting...");
+      for (const hdr of Object.getOwnPropertyNames(resp.headers)) {
+        // ClogTrace("Setting header ", hdr, resp.headers[hdr]);
+        res.setHeader(hdr, resp.headers[hdr])
+      }
+      delete resp.headers
+      // console.log("past setting headers");
+    }
+    if (resp.statusCode !== undefined) {
+      res.statusCode = resp.statusCode
+      delete resp.statusCode
+    }
+
+    if (resp.contentType !== undefined) {
+      res.setHeader('Content-Type', resp.contentType)
+      delete resp.contentType
+    }
+    if (resp.body !== undefined) resp = resp.body
+  }
+  // console.log("headers to be sent", res.getHeaders())
+  // console.log("-- Sending response", resp)
+  res.send(resp)
+}
+
+export default router

package/src/integration-tests/quickstart-scenario.test.ts

@@ -0,0 +1,74 @@
+
+/* eslint @typescript-eslint/no-floating-promises: "off" */
+
+import Tap from 'tap'
+
+import fs from 'fs'
+import path from 'path'
+
+import { doInit } from '../commands/init'
+import { doCreate } from '../commands/create'
+import { doBuildAsync } from '../commands/build'
+import { doDeployAsync } from '../commands/deploy'
+import { doPublishAsync } from '../commands/publish'
+
+import axios from 'axios'
+
+async function test (t: any): Promise<void> {
+  const testMessage = `test on ${Date.now()}`
+  // start clean
+  fs.rmSync('./QSTest', { recursive: true })
+  // init
+  await doInit('QSTest', true)
+
+  // verify project got made
+  t.ok(fs.existsSync('./QSTest'), 'created test project')
+  // verify we have a functions dir
+  t.ok(fs.existsSync(path.join('./QSTest', 'functions')), 'functions exists')
+  // verify we have a node_modules dir
+  t.ok(fs.existsSync(path.join('./QSTest', 'node_modules')), 'node_modules exists')
+  // verify we have a webroot dir
+  t.ok(fs.existsSync(path.join('./QSTest', 'webroot')), 'webroot exists')
+  // verify we have a package.json
+  t.ok(fs.existsSync(path.join('./QSTest', 'package.json')), 'package.json exists')
+  // verify we have webroot/docs
+  t.ok(fs.existsSync(path.join('./QSTest', 'webroot', 'docs', 'apidoc.yaml')), 'yaml exists')
+  t.ok(fs.existsSync(path.join('./QSTest', 'webroot', 'docs', 'swagger-ui-bundle.js')), 'js exists')
+  t.ok(fs.existsSync(path.join('./QSTest', 'webroot', 'docs', 'swagger-ui-standalone-preset.js')), 'js exists')
+  t.ok(fs.existsSync(path.join('./QSTest', 'webroot', 'docs', 'swagger-ui.css')), 'css exists')
+
+  // create
+  process.chdir('./QSTest')
+  await doCreate('IntegrationTest')
+  t.ok(fs.existsSync(path.join('functions', 'IntegrationTest')), 'function exists')
+  t.ok(fs.existsSync(path.join('functions', 'IntegrationTest', 'src', 'definition.json')), 'definition.json exists')
+  t.ok(fs.existsSync(path.join('functions', 'IntegrationTest', 'src', 'local.ts')), 'local.ts exists')
+  const maints = path.join('functions', 'IntegrationTest', 'src', 'main.ts')
+  t.ok(fs.existsSync(maints), 'main.ts exists')
+  const content = fs.readFileSync(maints).toString().replace('Hello,  World!', testMessage)
+  fs.writeFileSync(maints, content)
+
+  // build
+  await doBuildAsync(['--clean'])
+
+  await doDeployAsync([])
+
+  await doPublishAsync()
+
+  const publishedJson = fs.readFileSync('.published').toString()
+  const publishedInfo = JSON.parse(publishedJson)
+  const apiUrl: string = publishedInfo.url
+  t.ok(apiUrl.length > 0, 'url exists')
+  const testUrl = apiUrl + '/integrationtest'
+
+  const resp: any = await axios.get(testUrl)
+  t.ok(resp.status === 200, 'status is 200')
+  const data: string = resp.data.toString()
+  t.ok(data === testMessage, 'saw expected data')
+
+  t.end()
+}
+
+Tap.test('Integration Quickstart', async t => {
+  await test(t)
+})

package/src/lib/CaseUtils.ts

@@ -1,63 +1,63 @@
-
-// separate a case-joined string into a string of space-separated words
-export function separated (
-  instr: string
-): string {
-  let outstr = ''
-  for (let i = 0; i < instr.length; i++) {
-    const c = instr.charAt(i)
-    if (!isAlphaNum(c) || isUpperCase(c)) {
-      outstr += ' '
-    }
-    outstr += c.toLowerCase()
-  }
-
-  return outstr.trim()
-}
-
-function isUpperCase (instr: string): boolean {
-  return instr?.toUpperCase() === instr
-}
-function isAlphaNum (char: string): boolean {
-  let alnum = false
-  const cc = char.toUpperCase().charCodeAt(0)
-  if (cc >= 'A'.charCodeAt(0) && cc <= 'Z'.charCodeAt(0)) alnum = true
-  if (cc >= '0'.charCodeAt(0) && cc <= '9'.charCodeAt(0)) alnum = true
-  return alnum
-}
-
-export function camelCase (
-  instr: string
-): string {
-  const seps = separated(instr).split(' ')
-  for (let i = 1; i < seps.length; i++) {
-    seps[i] = seps[i].charAt(0).toUpperCase() + seps[i].substring(1)
-  }
-  return seps.join('')
-}
-
-export function pascalCase (
-  instr: string
-): string {
-  const seps = separated(instr).split(' ')
-  for (let i = 0; i < seps.length; i++) {
-    seps[i] = seps[i].charAt(0).toUpperCase() + seps[i].substring(1)
-  }
-  return seps.join('')
-}
-
-export function snakeCase (
-  instr: string
-): string {
-  return dashCase(instr, '_')
-}
-export function dashCase (
-  instr: string,
-  dashChar: string = '-',
-  allCaps: boolean = false
-): string {
-  const seps = separated(instr).split(' ')
-  let out = seps.join(dashChar)
-  if (allCaps) out = out.toUpperCase()
-  return out
-}
+
+// separate a case-joined string into a string of space-separated words
+export function separated (
+  instr: string
+): string {
+  let outstr = ''
+  for (let i = 0; i < instr.length; i++) {
+    const c = instr.charAt(i)
+    if (!isAlphaNum(c) || isUpperCase(c)) {
+      outstr += ' '
+    }
+    outstr += c.toLowerCase()
+  }
+
+  return outstr.trim()
+}
+
+function isUpperCase (instr: string): boolean {
+  return instr?.toUpperCase() === instr
+}
+function isAlphaNum (char: string): boolean {
+  let alnum = false
+  const cc = char.toUpperCase().charCodeAt(0)
+  if (cc >= 'A'.charCodeAt(0) && cc <= 'Z'.charCodeAt(0)) alnum = true
+  if (cc >= '0'.charCodeAt(0) && cc <= '9'.charCodeAt(0)) alnum = true
+  return alnum
+}
+
+export function camelCase (
+  instr: string
+): string {
+  const seps = separated(instr).split(' ')
+  for (let i = 1; i < seps.length; i++) {
+    seps[i] = seps[i].charAt(0).toUpperCase() + seps[i].substring(1)
+  }
+  return seps.join('')
+}
+
+export function pascalCase (
+  instr: string
+): string {
+  const seps = separated(instr).split(' ')
+  for (let i = 0; i < seps.length; i++) {
+    seps[i] = seps[i].charAt(0).toUpperCase() + seps[i].substring(1)
+  }
+  return seps.join('')
+}
+
+export function snakeCase (
+  instr: string
+): string {
+  return dashCase(instr, '_')
+}
+export function dashCase (
+  instr: string,
+  dashChar: string = '-',
+  allCaps: boolean = false
+): string {
+  const seps = separated(instr).split(' ')
+  let out = seps.join(dashChar)
+  if (allCaps) out = out.toUpperCase()
+  return out
+}

package/src/lib/DirectoryUtils.ts

@@ -1,34 +1,34 @@
-
-import fs, { Stats } from 'fs'
-import path from 'path'
-
-// Callback definition for recurseDirectory
-export type RecurseCB = (filepath: string, stats: Stats) => boolean
-
-// Recurse a directory, calling back to a 'for-each' callback for all files in tree
-export function recurseDirectory (dirpath: string, callback?: RecurseCB): void {
-  fs.readdirSync(dirpath).forEach((file: string) => {
-    const fpath = path.join(dirpath, file)
-    const stat = fs.lstatSync(fpath)
-    if ((callback != null) && !callback(fpath, stat)) {
-      if (stat.isDirectory()) {
-        recurseDirectory(fpath, callback)
-      }
-    }
-  })
-}
-
-// find the latest mod time for matching files in this folder tree
-export function latestModification (dirpath: string, match: string): Date {
-  let latestTime = new Date(0)
-  if (fs.existsSync(dirpath)) {
-    recurseDirectory(dirpath, (filepath: string, stats: Stats) => {
-      const basefile = filepath.substring(filepath.lastIndexOf('/') + 1)
-      if (basefile.match(match) != null) {
-        if (stats.mtime > latestTime) latestTime = stats.mtime
-      }
-      return false
-    })
-  }
-  return latestTime
-}
+
+import fs, { Stats } from 'fs'
+import path from 'path'
+
+// Callback definition for recurseDirectory
+export type RecurseCB = (filepath: string, stats: Stats) => boolean
+
+// Recurse a directory, calling back to a 'for-each' callback for all files in tree
+export function recurseDirectory (dirpath: string, callback?: RecurseCB): void {
+  fs.readdirSync(dirpath).forEach((file: string) => {
+    const fpath = path.join(dirpath, file)
+    const stat = fs.lstatSync(fpath)
+    if ((callback != null) && !callback(fpath, stat)) {
+      if (stat.isDirectory()) {
+        recurseDirectory(fpath, callback)
+      }
+    }
+  })
+}
+
+// find the latest mod time for matching files in this folder tree
+export function latestModification (dirpath: string, match: string): Date {
+  let latestTime = new Date(0)
+  if (fs.existsSync(dirpath)) {
+    recurseDirectory(dirpath, (filepath: string, stats: Stats) => {
+      const basefile = filepath.substring(filepath.lastIndexOf('/') + 1)
+      if (basefile.match(match) != null) {
+        if (stats.mtime > latestTime) latestTime = stats.mtime
+      }
+      return false
+    })
+  }
+  return latestTime
+}