feat: generate and use swagger typescript client [DET-3249 DET-3324 D…

…ET-3355] (#691)
determined-ai · Jun 25, 2020 · 06d0850 · 06d0850
1 parent ddeeddd
commit 06d0850
Show file tree

Hide file tree

Showing 19 changed files with 322 additions and 57 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -56,14 +56,12 @@ upstream-feature-branch: &upstream-feature-branch
       - /release-.*/
       - master
 
-
 commands:
   fix-circle-working-directory:
     description: "Fix CIRCLE_WORKING_DIRECTORY"
     steps:
       - run: echo 'CIRCLE_WORKING_DIRECTORY="${CIRCLE_WORKING_DIRECTORY/#\~/$HOME}"' >> $BASH_ENV
 
-
   set-slack-user-id:
     steps:
       - run:
@@ -86,7 +84,6 @@ commands:
               echo "Unable to find Slack user ID for  \"${AUTHOR_EMAIL}\"."
             fi
 
-
   pull-task-images:
     parameters:
       tf1:
@@ -157,6 +154,10 @@ commands:
           key: det-react-deps-v1dev3-{{ checksum  "webui/react/package-lock.json" }}
           paths:
             - "webui/react/node_modules"
+      - attach_workspace:
+          at: .
+      - run: make -C webui/api-ts-sdk get-deps-package
+      - run: make -C webui/api-ts-sdk build-package
 
   install-wheel:
     parameters:
@@ -342,7 +343,6 @@ commands:
             det-deploy aws down \
               --cluster-id <<parameters.cluster-id>>
 
-
   setup-aws-cluster:
     parameters:
       cluster-id:
@@ -392,7 +392,6 @@ commands:
           make -C webui/tests get-deps
       - run: docker pull cypress/included:4.8.0
 
-
   setup-local-cluster:
     parameters:
       det-version:
@@ -448,7 +447,6 @@ commands:
     steps:
       - run: python .circleci/scripts/wait_for_master.py http://<<parameters.host>>:<<parameters.port>>
 
-
 jobs:
   build-docs:
     docker:
@@ -575,6 +573,20 @@ jobs:
       - run: make -C <<parameters.path>> build
       - run: make -C <<parameters.path>> publish
 
+  build-and-package-ts-sdk:
+    docker:
+      - image: cimg/openjdk:14.0.1
+    steps:
+      - checkout
+      - attach_workspace:
+          at: .
+      - run: make -C webui/api-ts-sdk get-deps-swagger
+      - run: make -C webui/api-ts-sdk build-swagger
+      - persist_to_workspace:
+          root: .
+          paths:
+            - webui/api-ts-sdk/src
+
   upload-try-now-template:
     docker:
       - image: determinedai/cimg-base:stable
@@ -629,8 +641,6 @@ jobs:
       - store_artifacts:
           path: webui/tests/results/recordings
 
-
-
   lint-elm:
     docker:
       - image: cimg/node:12.16
@@ -659,8 +669,6 @@ jobs:
       - elm-get-deps
       - run: make -C webui/elm test
 
-
-
   lint-react:
     docker:
       - image: cimg/node:12.16
@@ -699,7 +707,6 @@ jobs:
       - store_artifacts:
           path: webui/react/build-storybook
 
-
   lint-go:
     docker:
       - image: cimg/go:1.13
@@ -730,6 +737,20 @@ jobs:
             - "master/build"
             - "agent/build"
 
+  build-proto:
+    docker:
+      - image: cimg/go:1.13
+        environment:
+          GO111MODULE: "on"
+    steps:
+      - checkout
+      - go-get-deps
+      - run: make -C proto build
+      - persist_to_workspace:
+          root: .
+          paths:
+            - "proto/build/**/*"
+
   test-unit-go:
     docker:
       - image: cimg/go:1.13
@@ -742,9 +763,6 @@ jobs:
       - run: make -C master test
       - run: make -C agent test
 
-
-
-
   lint-python:
     docker:
       - image: determinedai/cimg-base:stable
@@ -869,7 +887,6 @@ jobs:
       - store_test_results:
           path: /tmp/test-results/
 
-
   deploy:
     parameters:
       agent-instance-type:
@@ -897,7 +914,6 @@ jobs:
           failure_message: ':thisisfine: A \`${CIRCLE_JOB}\` job on branch \`${CIRCLE_BRANCH}\` has failed! Author Email: \`${AUTHOR_EMAIL}\`'
           mentions: "${SLACK_USER_ID}"
 
-
   nightly-tests:
     docker:
       - image: determinedai/cimg-base:stable
@@ -959,8 +975,6 @@ jobs:
           failure_message: ':thisisfine: A \`${CIRCLE_JOB}\` job on branch \`${CIRCLE_BRANCH}\` has failed! Author Email: \`${AUTHOR_EMAIL}\`'
           mentions: "${SLACK_USER_ID}"
 
-
-
   parallel-tests:
     docker:
       - image: determinedai/cimg-base:stable
@@ -993,38 +1007,62 @@ jobs:
           failure_message: ':thisisfine: A \`${CIRCLE_JOB}\` job on branch \`${CIRCLE_BRANCH}\` has failed! Author Email: \`${AUTHOR_EMAIL}\`'
           mentions: "${SLACK_USER_ID}"
 
-
-
-
 workflows:
   lint:
     jobs:
+      - build-proto
+      - build-and-package-ts-sdk:
+          requires:
+            - build-proto
       - lint-python
       - lint-go
       - lint-elm
-      - lint-react
+      - lint-react:
+          requires:
+            - build-and-package-ts-sdk
 
   test-cli:
     jobs:
       - test-cli:
           matrix:
             parameters:
-              executor-name: ["python-35", "python-36", "python-37", "python-38", "win/default"]
+              executor-name:
+                [
+                  "python-35",
+                  "python-36",
+                  "python-37",
+                  "python-38",
+                  "win/default",
+                ]
 
   test-unit:
     jobs:
       - test-unit-go
+      - build-proto
+      - build-and-package-ts-sdk:
+          requires:
+            - build-proto
       - test-unit-elm
-      - test-unit-react
+      - test-unit-react:
+          requires:
+            - build-and-package-ts-sdk
       - test-unit-harness
       - test-unit-harness-tf2
       - test-examples
 
   test-e2e:
     jobs:
       - build-elm
-      - build-react
-      - build-storybook
+      - build-proto
+      - build-and-package-ts-sdk:
+          requires:
+            - build-proto
+      - build-react:
+          requires:
+            - build-and-package-ts-sdk
+      - build-storybook:
+          requires:
+            - build-and-package-ts-sdk
       - build-docs
       - build-go
       - package-and-push-system-local:
@@ -1079,6 +1117,7 @@ workflows:
 
       - test-e2e-webui:
           requires:
+            - build-and-package-ts-sdk
             - package-and-push-system-local
 
       - deploy:
@@ -1149,7 +1188,6 @@ workflows:
             - request-gpu-tests
             - package-and-push-system-dev
 
-
   nightly:
     triggers:
       - schedule:
@@ -1164,10 +1202,16 @@ workflows:
 
   release:
     jobs:
+      - build-proto
+      - build-and-package-ts-sdk:
+          requires:
+            - build-proto
       - build-elm:
           context: determined-production
           filters: *release-and-rc-filters
       - build-react:
+          requires:
+            - build-and-package-ts-sdk
           context: determined-production
           filters: *release-and-rc-filters
       - build-docs:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -44,9 +44,9 @@ git clone git@github.com:determined-ai/determined.git
 - Go (>= 1.13)
 - Python (>= 3.6)
 - Node (>= 12)
-- Yarn (>= 1.22.0)
 - Docker (>= 19.03)
 - Protoc (>= 3.0)
+- Java (>= 7)
 
 ### Building Determined
 

diff --git a/webui/Makefile b/webui/Makefile
@@ -18,6 +18,7 @@ check:
 	$(MAKE) -C tests $@
 
 get-deps:
+	$(MAKE) -C api-ts-sdk $@ build
 	$(MAKE) -C react $@
 	$(MAKE) -C elm $@
 	$(MAKE) -C tests $@

diff --git a/webui/api-ts-sdk/.gitignore b/webui/api-ts-sdk/.gitignore
@@ -0,0 +1,4 @@
+node_modules/
+deps/
+src/
+lib/
diff --git a/webui/api-ts-sdk/Makefile b/webui/api-ts-sdk/Makefile
@@ -0,0 +1,41 @@
+PROJECT_ROOT := "../.."
+
+.PHONY: all
+all: get-deps build
+
+
+.PHONY: get-deps-swagger
+get-deps-swagger:
+	mkdir -p deps
+	wget https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.14/swagger-codegen-cli-2.4.14.jar \
+		-O deps/swagger-codegen-cli.jar
+
+.PHONY: get-deps-package
+get-deps-package:
+	npm ci --no-audit
+
+.PHONY: build-swagger
+build-swagger:
+	mkdir -p src
+	java -jar deps/swagger-codegen-cli.jar generate -i \
+		${PROJECT_ROOT}/proto/build/swagger/determined/api/v1/api.swagger.json \
+		-l typescript-fetch -o src/
+
+.PHONY: build-package
+build-package:
+	# depends on build-swagger
+	npm run build
+
+.PHONY: get-deps
+get-deps: get-deps-swagger get-deps-package
+
+.PHONY: build
+build: build-swagger
+	$(MAKE) build-package
+
+.PHONY: clean
+clean:
+	rm -r deps/ || true
+	rm -r node_modules/ || true
+	rm -r src/ || true
+	rm -r lib/ || true
diff --git a/webui/api-ts-sdk/deps/swagger-codegen-cli.jar b/webui/api-ts-sdk/deps/swagger-codegen-cli.jar
diff --git a/webui/api-ts-sdk/package-lock.json b/webui/api-ts-sdk/package-lock.json