chore(orchestrator): add openapi client generation support (janus-idp…

…#1649)

* Generate Typescript OpenAPI client

Signed-off-by: Gloria Ciavarrini <[email protected]>

* Add openapi check dependencies in turbo

Signed-off-by: Gloria Ciavarrini <[email protected]>

* Lint ingore generated client

Signed-off-by: Gloria Ciavarrini <[email protected]>

* Ignore generated client files

Signed-off-by: Gloria Ciavarrini <[email protected]>

---------

Signed-off-by: Gloria Ciavarrini <[email protected]>

plugins/orchestrator-common/.eslintrc.js

@@ -1 +1,3 @@
-module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);
+module.exports = require('@backstage/cli/config/eslint-factory')(__dirname, {
+  ignorePatterns: ['src/generated/client/**'],
+});

plugins/orchestrator-common/.gitignore

@@ -0,0 +1 @@
+src/generated/client

plugins/orchestrator-common/package.json

@@ -28,7 +28,7 @@
   ],
   "configSchema": "config.d.ts",
   "scripts": {
-    "build": "yarn openapi:check && backstage-cli package build",
+    "build": "backstage-cli package build",
     "tsc": "tsc",
     "lint": "backstage-cli package lint",
     "test": "backstage-cli package test --passWithNoTests --coverage",
@@ -37,7 +37,7 @@
     "postpack": "backstage-cli package postpack",
     "openapi:generate": "./scripts/openapi.sh generate",
     "openapi:check": "./scripts/openapi.sh check",
-    "openapi:prettier:fix": "prettier --ignore-unknown --write ./src/auto-generated"
+    "openapi:prettier:fix": "prettier --ignore-unknown --write ./src/generated/api"
   },
   "dependencies": {
     "@backstage/types": "^1.1.1",
@@ -47,6 +47,7 @@
     "json-schema": "^0.4.0"
   },
   "devDependencies": {
-    "@backstage/cli": "0.26.4"
+    "@backstage/cli": "0.26.4",
+    "@hey-api/openapi-ts": "0.34.5"
   }
 }

plugins/orchestrator-common/scripts/openapi.sh

@@ -2,14 +2,23 @@
 pwd
 set -e
 
+GENERATED_FOLDER="./src/generated"
 OPENAPI_SPEC_FILE="./src/openapi/openapi.yaml"
-SCHEMA_FILE="./src/auto-generated/api/models/schema.ts"
-DEFINITION_FILE="./src/auto-generated/api/definition.ts"
-METADATA_FILE="./src/auto-generated/.METADATA.sha1"
+API_FOLDER="${GENERATED_FOLDER}/api"
+SCHEMA_FILE="${API_FOLDER}/models/schema.ts"
+DEFINITION_FILE="${API_FOLDER}/definition.ts"
+METADATA_FILE="${GENERATED_FOLDER}/.METADATA.sha1"
+CLIENT_FOLDER="${GENERATED_FOLDER}/client"
 
 openapi_generate() {
+    # TypeScript Client generation
+    openapi-ts --input ${OPENAPI_SPEC_FILE} --output ${CLIENT_FOLDER}
+
+    ## Schema generation
     npx --yes [email protected] ${OPENAPI_SPEC_FILE} -o ${SCHEMA_FILE}
-    npx --yes @openapitools/[email protected] generate -g asciidoc -i ./src/openapi/openapi.yaml -o ./src/auto-generated/docs/index.adoc
+    # Docs generation
+    npx --yes @openapitools/[email protected] generate -g asciidoc -i ./src/openapi/openapi.yaml -o ./src/generated/docs/index.adoc
+
     npx --yes [email protected] -- yaml2json -f ${OPENAPI_SPEC_FILE}
 
     OPENAPI_SPEC_FILE_JSON=$(tr -d '[:space:]' < "$(dirname $OPENAPI_SPEC_FILE)"/openapi.json)
@@ -51,10 +60,10 @@ openapi_check() {
 
     # Check if the stored and current SHA-1 checksums differ
     if [ "${STORED_SHA1}" != "${NEW_SHA1}" ]; then
-        echo "Changes detected in auto-generated files or openapi.yaml. Please run 'yarn openapi:generate' to update."
+        echo "Changes detected in generated files or openapi.yaml. Please run 'yarn openapi:generate' to update."
         exit 1
     else
-        echo "No changes detected in auto-generated files or openapi.yaml. Auto-generated files are up to date."
+        echo "No changes detected in generated files or openapi.yaml. generated files are up to date."
     fi
 }
 

plugins/orchestrator-common/src/index.ts

@@ -1,6 +1,6 @@
 export * from './types';
 export * from './openapi/types';
-export * from './auto-generated/api/definition';
+export * from './generated/api/definition';
 export * from './constants';
 export * from './models';
 export * from './workflow';

plugins/orchestrator-common/src/openapi/types.ts

@@ -1,4 +1,4 @@
-import { components } from '../auto-generated/api/models/schema';
+import { components } from '../generated/api/models/schema';
 
 export type ErrorResponse = components['schemas']['ErrorResponse'];
 export type WorkflowOverviewListResultDTO =

plugins/orchestrator-common/turbo.json

@@ -1,9 +1,24 @@
 {
   "extends": ["//"],
   "pipeline": {
+    "start": {
+      "dependsOn": ["openapi:check"]
+    },
     "tsc": {
       "outputs": ["../../dist-types/plugins/orchestrator-common/**"],
-      "dependsOn": ["^tsc"]
+      "dependsOn": ["^tsc", "openapi:check"]
+    },
+    "openapi:check": {
+      "outputs": ["src/generated/**"]
+    },
+    "openapi:generate": {
+      "outputs": ["src/generated/**"]
+    },
+    "test": {
+      "dependsOn": ["openapi:check"]
+    },
+    "export-dynamic": {
+      "dependsOn": ["openapi:check"]
     }
   }
 }