[supervisor] Provide TypeScript clients for gRPC, gRPC-web and REST

olearycrew · Sep 24, 2020 · 282346e · 282346e
1 parent 9cb4125
commit 282346e
Show file tree

Hide file tree

Showing 38 changed files with 330 additions and 7,698 deletions.
diff --git a/components/BUILD.yaml b/components/BUILD.yaml
@@ -25,7 +25,7 @@ packages:
       - components/ws-proxy:docker
       - components/ws-sync:docker
       - components/gitpod-protocol:publish
-      - components/supervisor-api/typescript:publish
+      - components/supervisor-api/typescript-grpc:publish
   - name: all-apps
     type: generic
     deps:

diff --git a/components/supervisor-api/BUILD.yaml b/components/supervisor-api/BUILD.yaml
@@ -0,0 +1,10 @@
+packages:
+  - name: proto
+    type: generic
+    srcs:
+      - "*.proto"
+    config:
+      commands:
+        - ["git", "clone", "https://github.com/grpc-ecosystem/grpc-gateway"]
+        - ["mv", "grpc-gateway/third_party", "third_party"]
+        - ["rm", "-r", "grpc-gateway"]
diff --git a/components/supervisor-api/generate.sh b/components/supervisor-api/generate.sh
@@ -4,23 +4,6 @@ PROTOC_INCLUDE="-I. -I $GOPATH/src/github.com/grpc-ecosystem/grpc-gateway/third_
 
 GO111MODULE=on  go get github.com/golang/protobuf/[email protected] 
 GO111MODULE=off go get github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway
+GO111MODULE=off go get github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger
 protoc $PROTOC_INCLUDE --go_out=plugins=grpc:go *.proto
 protoc $PROTOC_INCLUDE --grpc-gateway_out=allow_colon_final_segments=true,logtostderr=true,paths=source_relative:go *.proto
-
-# GO111MODULE=on go get github.com/golang/mock/mockgen@latest
-# cd go
-# # source mode does not always work for gRPC: see https://github.com/golang/mock/pull/163
-# mockgen -package mock github.com/gitpod-io/gitpod/ws-manager/api WorkspaceManagerClient,WorkspaceManager_SubscribeClient > mock/mock.go
-# cd ..
-
-# generate typescript client
-cd typescript
-export PATH=$PWD/../../../node_modules/.bin:$PATH
-protoc $PROTOC_INCLUDE --plugin=protoc-gen-grpc=`which grpc_tools_node_protoc_plugin` --js_out=import_style=commonjs,binary:src --grpc_out=grpc_js:src -I.. ../*.proto
-protoc $PROTOC_INCLUDE --plugin=protoc-gen-ts=`which protoc-gen-ts` --ts_out=grpc_js:src -I.. ../*.proto
-
-## HACK: we don't care for the API annotations in the generated Javascript/Typescript code.
-##       Rather than trying to make the dependencies work, we just remove the respective code.
-sed -i '/google_api_annotations_pb/d' src/*.js
-
-cd ..
diff --git a/components/supervisor-api/typescript-grpc/.gitignore b/components/supervisor-api/typescript-grpc/.gitignore
@@ -0,0 +1,2 @@
+src/
+lib/
diff --git a/...ents/supervisor-api/typescript/BUILD.yaml → ...supervisor-api/typescript-grpc/BUILD.yaml b/...ents/supervisor-api/typescript/BUILD.yaml → ...supervisor-api/typescript-grpc/BUILD.yaml
@@ -2,9 +2,11 @@ packages:
   - name: lib
     type: yarn
     srcs:
-      - "src/*.ts"
-      - "src/*.js"
       - package.json
+    deps:
+      - components/supervisor-api:proto
+    env:
+      - PROTOLOC=components-supervisor-api--proto
     config:
       packaging: library
       dontTest: true
@@ -21,4 +23,4 @@ packages:
       - version
     config:
       commands:
-        - ["node", "components-gitpod-protocol--scripts/publish.js", "${version}", "components-supervisor-api-typescript--lib/package"]
+        - ["node", "components-gitpod-protocol--scripts/publish.js", "${version}", "components-supervisor-api-typescript-grpc--lib/package"]
diff --git a/components/supervisor-api/typescript-grpc/package.json b/components/supervisor-api/typescript-grpc/package.json
@@ -0,0 +1,23 @@
+{
+  "name": "@gitpod/supervisor-api-grpc",
+  "version": "0.1.5",
+  "license": "UNLICENSED",
+  "scripts": {
+    "prepare": "mkdir -p src; protoc -I ${PROTOLOC:-$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway}/third_party/googleapis -I /usr/lib/protoc/include --plugin=protoc-gen-grpc=`which grpc_tools_node_protoc_plugin` --js_out=import_style=commonjs,binary:src --grpc_out=grpc_js:src -I${PROTOLOC:-..} ${PROTOLOC:-..}/*.proto && protoc -I ${PROTOLOC:-$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway}/third_party/googleapis -I /usr/lib/protoc/include --plugin=protoc-gen-ts=`which protoc-gen-ts` --ts_out=grpc_js:src -I${PROTOLOC:-..} ${PROTOLOC:-..}/*.proto && sed -i '/google_api_annotations_pb/d' src/*.js",
+    "build": "mkdir -p lib; tsc && cp -f src/*.js src/*d.ts lib"
+  },
+  "files": [
+    "lib",
+    "src"
+  ],
+  "dependencies": {
+    "@grpc/grpc-js": "^1.1.5",
+    "google-protobuf": "^3.8.0-rc.1"
+  },
+  "devDependencies": {
+    "@types/google-protobuf": "^3.2.7",
+    "grpc-tools": "^1.7.2",
+    "grpc_tools_node_protoc_ts": "^2.5.0",
+    "typescript-formatter": "^7.2.2"
+  }
+}
diff --git a/...s/supervisor-api/typescript/tsconfig.json → ...ervisor-api/typescript-grpc/tsconfig.json b/...s/supervisor-api/typescript/tsconfig.json → ...ervisor-api/typescript-grpc/tsconfig.json
diff --git a/components/supervisor-api/typescript-grpcweb/.gitignore b/components/supervisor-api/typescript-grpcweb/.gitignore
@@ -0,0 +1,4 @@
+*_pb.*ts
+*_pb.*js
+*_pb_service.*js
+*_pb_service.*ts
diff --git a/components/supervisor-api/typescript-grpcweb/BUILD.yaml b/components/supervisor-api/typescript-grpcweb/BUILD.yaml
@@ -0,0 +1,26 @@
+packages:
+  - name: lib
+    type: yarn
+    srcs:
+      - package.json
+    deps:
+      - components/supervisor-api:proto
+    env:
+      - PROTOLOC=components-supervisor-api--proto
+    config:
+      packaging: library
+      dontTest: true
+      commands:
+        build: ["yarn", "build"]
+      yarnLock: ${coreYarnLockBase}/../yarn.lock
+      tsconfig: tsconfig.json
+  - name: publish
+    type: generic
+    deps:
+      - :lib
+      - components/gitpod-protocol:scripts
+    argdeps:
+      - version
+    config:
+      commands:
+        - ["node", "components-gitpod-protocol--scripts/publish.js", "${version}", "components-supervisor-api-typescript-grpcweb--lib/package"]
diff --git a/components/supervisor-api/typescript-grpcweb/package.json b/components/supervisor-api/typescript-grpcweb/package.json
@@ -0,0 +1,18 @@
+{
+  "name": "@gitpod/supervisor-api-grpcweb",
+  "version": "0.1.5",
+  "license": "UNLICENSED",
+  "scripts": {
+    "prepare": "mkdir -p src; protoc -I ${PROTOLOC:-$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway}/third_party/googleapis -I /usr/lib/protoc/include --plugin=\"protoc-gen-ts=`which protoc-gen-ts`\" --js_out=\"import_style=commonjs,binary:src\" --ts_out=\"service=grpc-web:src\" -I${PROTOLOC:-..} ${PROTOLOC:-..}/*.proto",
+    "build": "mkdir -p lib; tsc && cp -f src/*.js src/*d.ts lib",
+    "full-build": "yarn prepare && yarn build"
+  },
+  "files": [
+    "lib",
+    "src"
+  ],
+  "dependencies": {},
+  "devDependencies": {
+    "ts-protoc-gen": "^0.13.0"
+  }
+}
diff --git a/components/supervisor-api/typescript-grpcweb/tsconfig.json b/components/supervisor-api/typescript-grpcweb/tsconfig.json
@@ -0,0 +1,28 @@
+{
+    "compilerOptions": {
+        "rootDir": "src",
+        "experimentalDecorators": true,
+        "outDir": "lib",
+        "lib": [
+            "es6",
+            "esnext.asynciterable"
+        ],
+        "strict": true,
+        "noEmitOnError": false,
+        "noUnusedLocals": true,
+        "emitDecoratorMetadata": true,
+        "strictPropertyInitialization": false,
+        "downlevelIteration": true,
+        "module": "commonjs",
+        "moduleResolution": "node",
+        "target": "es5",
+        "jsx": "react",
+        "sourceMap": true,
+        "declaration": true,
+        "declarationMap": true,
+        "skipLibCheck": true
+    },
+    "include": [
+        "src"
+    ]
+}
diff --git a/components/supervisor-api/typescript-rest/.gitignore b/components/supervisor-api/typescript-rest/.gitignore
@@ -0,0 +1 @@
+lib/
diff --git a/components/supervisor-api/typescript-rest/BUILD.yaml b/components/supervisor-api/typescript-rest/BUILD.yaml
@@ -0,0 +1,26 @@
+packages:
+  - name: lib
+    type: yarn
+    srcs:
+      - package.json
+    deps:
+      - components/supervisor-api:proto
+    env:
+      - PROTOLOC=components-supervisor-api--proto
+    config:
+      packaging: library
+      dontTest: true
+      commands:
+        build: ["yarn", "build"]
+      yarnLock: ${coreYarnLockBase}/../yarn.lock
+      tsconfig: tsconfig.json
+  - name: publish
+    type: generic
+    deps:
+      - :lib
+      - components/gitpod-protocol:scripts
+    argdeps:
+      - version
+    config:
+      commands:
+        - ["node", "components-gitpod-protocol--scripts/publish.js", "${version}", "components-supervisor-api-typescript-rest--lib/package"]
diff --git a/components/supervisor-api/typescript-rest/package.json b/components/supervisor-api/typescript-rest/package.json
@@ -0,0 +1,15 @@
+{
+  "name": "@gitpod/supervisor-api-rest",
+  "version": "0.1.5",
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "mkdir -p lib; protoc -I ${PROTOLOC:-$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway}/third_party/googleapis -I /usr/lib/protoc/include --swagger_out=logtostderr=true:. -I${PROTOLOC:-..} ${PROTOLOC:-..}/*.proto && mv *.swagger.json lib && for f in $(ls lib/*.swagger.json); do yarn dtsgen -o ${f%.swagger.json}.dt.ts $f; done"
+  },
+  "files": [
+    "lib"
+  ],
+  "dependencies": {},
+  "devDependencies": {
+    "dtsgenerator": "^3.3.0"
+  }
+}
diff --git a/components/supervisor-api/typescript-rest/tsconfig.json b/components/supervisor-api/typescript-rest/tsconfig.json
@@ -0,0 +1,28 @@
+{
+    "compilerOptions": {
+        "rootDir": "src",
+        "experimentalDecorators": true,
+        "outDir": "lib",
+        "lib": [
+            "es6",
+            "esnext.asynciterable"
+        ],
+        "strict": true,
+        "noEmitOnError": false,
+        "noUnusedLocals": true,
+        "emitDecoratorMetadata": true,
+        "strictPropertyInitialization": false,
+        "downlevelIteration": true,
+        "module": "commonjs",
+        "moduleResolution": "node",
+        "target": "es5",
+        "jsx": "react",
+        "sourceMap": true,
+        "declaration": true,
+        "declarationMap": true,
+        "skipLibCheck": true
+    },
+    "include": [
+        "src"
+    ]
+}
diff --git a/components/supervisor-api/typescript/package.json b/components/supervisor-api/typescript/package.json
diff --git a/components/supervisor-api/typescript/src/backup_grpc_pb.d.ts b/components/supervisor-api/typescript/src/backup_grpc_pb.d.ts
diff --git a/components/supervisor-api/typescript/src/backup_grpc_pb.js b/components/supervisor-api/typescript/src/backup_grpc_pb.js