feat(nodetime): add sta pkg and refactor

ilgooz · ilgooz · commit e50511e16c9a · 2021-02-13T23:49:38.000-08:00
a new pkg/ called nodetime added to host and use a single NodeJS runtime
that has multiple CLIs bundled inside.

* `swagger-typescript-api` CLI added alongside `protobufjs` CLI.

* switched Starport's Go compiler to 1.16 beta to benefit from new the `embed` feature. it'll be switched to stable 1.16 release once it's available (likely this Feb).
diff --git a/.github/workflows/goreleaser.yml b/.github/workflows/goreleaser.yml
@@ -15,7 +15,8 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.15
+          go-version: "1.16.0-rc1"
+          stable: false
 
       - name: Set up Node
         uses: actions/setup-node@v2-beta
@@ -31,8 +32,6 @@ jobs:
 
       - name: Checkout
         uses: actions/checkout@v2
-        with:
-          lfs: true
         with:
           path: ${{ env.working-directory }}
           fetch-depth: 0
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -11,13 +11,18 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 6
     steps:
-      - uses: actions/checkout@v2
+      - name: Set up Go
+        uses: actions/setup-go@v2
         with:
-          lfs: true
+          go-version: "1.16.0-rc1"
+          stable: false
+
+      - uses: actions/checkout@v2
+
       - uses: golangci/golangci-lint-action@master
         with:
-          # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
-          version: v1.28
+          version: v1.36.0
           args: --timeout 10m
           github-token: ${{ secrets.github_token }}
+          skip-go-installation: true
 
diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml
@@ -9,8 +9,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
-        with:
-          lfs: true
       - uses: actions/setup-node@v1
         with:
           node-version: 14
diff --git a/.github/workflows/test-e2e.yml b/.github/workflows/test-e2e.yml
@@ -16,7 +16,8 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.15
+          go-version: "1.16.0-rc1"
+          stable: false
 
       - name: Set up Node
         uses: actions/setup-node@v2-beta
@@ -34,7 +35,6 @@ jobs:
         with:
           path: ${{ env.working-directory }}
           fetch-depth: 0
-          lfs: true
 
       - name: Build UI
         working-directory: ${{ env.working-directory }}
diff --git a/.github/workflows/test-integration.yml b/.github/workflows/test-integration.yml
@@ -17,7 +17,8 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.15
+          go-version: "1.16.0-rc1"
+          stable: false
 
       - name: Install protoc
         uses: arduino/setup-protoc@v1
@@ -30,7 +31,6 @@ jobs:
         with:
           path: ${{ env.working-directory }}
           fetch-depth: 0
-          lfs: true
 
       - name: Build UI
         working-directory: ${{ env.working-directory }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -12,9 +12,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-        with:
-          lfs: true
       - uses: actions/setup-go@v2
         with:
-          go-version: '1.15'
+          go-version: "1.16.0-rc1"
+          stable: false
       - run: ./scripts/test-unit 
diff --git a/.gitpod.Dockerfile b/.gitpod.Dockerfile
@@ -1,3 +1,8 @@
 FROM gitpod/workspace-full
 
+RUN wget https://golang.org/dl/go1.16rc1.linux-amd64.tar.gz && \
+    rm -rf /go && \
+    tar -C $HOME -xzf go1.16rc1.linux-amd64.tar.gz && \
+    rm go1.16rc1.linux-amd64.tar.gz
+
 RUN brew install gh protobuf
diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/tendermint/starport
 
-go 1.15
+go 1.16
 
 require (
 	github.com/AlecAivazis/survey/v2 v2.1.1
@@ -28,6 +28,7 @@ require (
 	github.com/imdario/mergo v0.3.11
 	github.com/improbable-eng/grpc-web v0.13.0
 	github.com/jpillora/chisel v1.7.3
+	github.com/kevinburke/go-bindata v3.22.0+incompatible // indirect
 	github.com/manifoldco/promptui v0.8.0
 	github.com/mattn/go-zglob v0.0.3
 	github.com/mwitkow/grpc-proxy v0.0.0-20181017164139-0f1106ef9c76
diff --git a/go.sum b/go.sum
@@ -480,6 +480,8 @@ github.com/karrick/godirwalk v1.16.1 h1:DynhcF+bztK8gooS0+NDJFrdNZjJ3gzVzC545UNA
 github.com/karrick/godirwalk v1.16.1/go.mod h1:j4mkqPuvaLI8mp1DroR3P6ad7cyYd4c1qeJ3RV7ULlk=
 github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 h1:Z9n2FFNUXsshfwJMBgNA0RU6/i7WVaAegv3PtuIHPMs=
 github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51/go.mod h1:CzGEWj7cYgsdH8dAjBGEr58BoE7ScuLd+fwFZ44+/x8=
+github.com/kevinburke/go-bindata v3.22.0+incompatible h1:/JmqEhIWQ7GRScV0WjX/0tqBrC5D21ALg0H0U/KZ/ts=
+github.com/kevinburke/go-bindata v3.22.0+incompatible/go.mod h1:/pEEZ72flUW2p0yi30bslSp9YqD9pysLxunQDdb2CPM=
 github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd h1:Coekwdh0v2wtGp9Gmz1Ze3eVRAWJMLokvN3QjdzCHLY=
 github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM=
 github.com/kisielk/errcheck v1.2.0/go.mod h1:/BMXB+zMLi60iA8Vv6Ksmxu/1UDYcXs4uQLJ+jE2L00=
diff --git a/scripts/data/gen-protobufjs/bin/nodetime b/scripts/data/gen-protobufjs/bin/nodetime
@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+
 var path  = require("path"),
     jscli = require("../pbjs.js"),
     tscli = require("../pbts.js");
@@ -7,6 +8,11 @@ var args = process.argv.slice(3);
 var mode = process.argv[2];
 var ret;
 
+if (mode === "sta") {
+    require("../sta");
+    return;
+}
+
 if (mode === "js") {
     ret = jscli.main(args);
 } else {
diff --git a/scripts/data/gen-protobufjs/package.json b/scripts/data/gen-protobufjs/package.json
@@ -11,7 +11,7 @@
   "main": "index.js",
   "types": "index.d.ts",
   "bin": {
-    "pb": "bin/pb"
+    "nodetime": "bin/nodetime"
   },
   "dependencies": {
     "chalk": "^4.0.0",
@@ -24,7 +24,8 @@
     "protobufjs": "^6.10.2",
     "semver": "^7.1.2",
     "tmp": "^0.2.1",
-    "uglify-js": "^3.7.7"
+    "uglify-js": "^3.7.7",
+    "swagger-typescript-api": "5.0.0"
   },
   "pkg": {
     "assets": ["targets/**/*", "wrappers/**/*"]
diff --git a/scripts/data/gen-protobufjs/sta/index.js b/scripts/data/gen-protobufjs/sta/index.js
@@ -0,0 +1,111 @@
+// Copyright (c) 2019-present acacode
+// Node module: swagger-typescript-api
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+// Repository https://github.com/acacode/swagger-typescript-api
+
+const { Command } = require("commander");
+const { resolve } = require("path");
+const { generateApi } = require("swagger-typescript-api");
+const { TS_KEYWORDS } = require("swagger-typescript-api/src/constants");
+
+const program = new Command("swagger-typescript-api");
+const version = "5.0.0";
+
+program.storeOptionsAsProperties(true);
+
+program
+  .version(version, "-v, --version", "output the current version")
+  .description("Generate api via swagger scheme.\nSupports OA 3.0, 2.0, JSON, yaml.");
+
+program
+  .requiredOption("-p, --path <path>", "path/url to swagger scheme")
+  .option("-o, --output <output>", "output path of typescript api file", "./")
+  .option("-n, --name <name>", "name of output typescript api file", "Api.ts")
+  .option("-t, --templates <path>", "path to folder containing templates")
+  .option(
+    "-d, --default-as-success",
+    'use "default" response status code as success response too.\n' +
+      'some swagger schemas use "default" response status code as success response type by default.',
+    false,
+  )
+  .option(
+    "-r, --responses",
+    "generate additional information about request responses\n" +
+      "also add typings for bad responses",
+    false,
+  )
+  .option("--union-enums", 'generate all "enum" types as union types (T1 | T2 | TN)', false)
+  .option("--route-types", "generate type definitions for API routes", false)
+  .option("--no-client", "do not generate an API class", false)
+  .option(
+    "--enum-names-as-values",
+    "use values in 'x-enumNames' as enum values (not only as keys)",
+    false,
+  )
+  .option(
+    "--extract-request-params",
+    "extract request params to data contract (Also combine path params and query params into one object)",
+    false,
+  )
+  .option(
+    "--modular",
+    "generate separated files for http client, data contracts, and routes",
+    false,
+  )
+  .option("--js", "generate js api module with declaration file", false)
+  .option(
+    "--module-name-index <number>",
+    "determines which path index should be used for routes separation (example: GET:/fruites/getFruit -> index:0 -> moduleName -> fruites)",
+    0,
+  )
+  .option("--disableStrictSSL", "disabled strict SSL", false)
+  .option("--default-response <type>", "default type for empty response schema", TS_KEYWORDS.VOID)
+  .option(
+    "--clean-output",
+    "clean output folder before generate api. WARNING: May cause data loss",
+    false,
+  );
+
+program.parse(process.argv);
+
+const {
+  path,
+  output,
+  name,
+  templates,
+  unionEnums,
+  routeTypes,
+  client,
+  defaultAsSuccess,
+  responses,
+  modular,
+  js,
+  moduleNameIndex,
+  extractRequestParams,
+  enumNamesAsValues,
+  disableStrictSSL,
+  cleanOutput,
+  defaultResponse,
+} = program;
+
+generateApi({
+  name,
+  url: path,
+  generateRouteTypes: routeTypes,
+  generateClient: client,
+  defaultResponseAsSuccess: defaultAsSuccess,
+  defaultResponseType: defaultResponse,
+  generateUnionEnums: unionEnums,
+  generateResponses: responses,
+  extractRequestParams: extractRequestParams,
+  input: resolve(process.cwd(), path),
+  output: resolve(process.cwd(), output || "."),
+  templates,
+  modular: !!modular,
+  toJS: !!js,
+  enumNamesAsValues: enumNamesAsValues,
+  moduleNameIndex: +(moduleNameIndex || 0),
+  disableStrictSSL: !!disableStrictSSL,
+  cleanOutput: !!cleanOutput,
+});
diff --git a/scripts/gen-nodetime b/scripts/gen-nodetime
@@ -0,0 +1,45 @@
+#!/bin/bash
+
+# generates static Go files to embed node cli programs into Starport for linux and darwin.
+# protobufjs and swagger-typescript-api bundled together and packaged as a standalone
+# executable for both platforms.
+# Starport's own binary will only include one or other binary depending on the platform where
+# Starport is being built.
+
+set -e
+
+version=6.10.2
+cachedir=".cache"
+protobufjshash="da34f43ccd51ad97017e139f137521782f5ef119"
+protobufjsdir="$cachedir/protobufjs"
+
+installedprotobufjshash=""
+
+if [ -d $protobufjsdir ]
+then
+    cd $protobufjsdir
+    installedprotobufjshash=$(git rev-parse HEAD)
+fi
+
+if [ "$installedprotobufjshash" != "$protobufjshash" ]
+then
+    rm -rf $protobufjsdir
+    git clone https://github.com/protobufjs/protobuf.js $protobufjsdir
+    cd $protobufjsdir
+    git reset --hard $protobufjshash
+fi
+
+cd cli
+
+cp -r ../../../scripts/data/gen-protobufjs/* . 
+
+sudo npm install -g pkg@4.4.9
+npm i 
+
+pkg --debug -t node14-linux-x64,node14-macos-x64 -o nodetime .
+
+tar -czvf nodetime-linux.tar.gz nodetime-linux
+tar -czvf nodetime-darwin.tar.gz nodetime-macos
+
+cp nodetime-linux.tar.gz ../../../starport/pkg/nodetime/ 
+cp nodetime-darwin.tar.gz ../../../starport/pkg/nodetime/ 
diff --git a/scripts/gen-protobufjs b/scripts/gen-protobufjs
diff --git a/starport/pkg/nodetime/binary_darwin.go b/starport/pkg/nodetime/binary_darwin.go
@@ -0,0 +1,8 @@
+// +build darwin
+
+package nodetime
+
+import _ "embed" // embed is required for binary embedding.
+
+// go:embed nodetime-linux.tar.gz
+var binaryCompressed []byte
diff --git a/starport/pkg/nodetime/binary_linux.go b/starport/pkg/nodetime/binary_linux.go
@@ -0,0 +1,8 @@
+// +build linux
+
+package nodetime
+
+import _ "embed" // embed is required for binary embedding.
+
+// go:embed nodetime-linux.tar.gz
+var binaryCompressed []byte
diff --git a/starport/pkg/nodetime/nodetime-darwin.tar.gz b/starport/pkg/nodetime/nodetime-darwin.tar.gz
diff --git a/starport/pkg/nodetime/nodetime-linux.tar.gz b/starport/pkg/nodetime/nodetime-linux.tar.gz
diff --git a/starport/pkg/nodetime/nodetime.go b/starport/pkg/nodetime/nodetime.go
diff --git a/starport/pkg/nodetime/protobufjs/protobufjs.go b/starport/pkg/nodetime/protobufjs/protobufjs.go
diff --git a/starport/pkg/nodetime/protobufjs/protobufjs_test.go b/starport/pkg/nodetime/protobufjs/protobufjs_test.go
diff --git a/starport/pkg/nodetime/sta/sta.go b/starport/pkg/nodetime/sta/sta.go
