Swagger Typescript API (minio#1503)

Signed-off-by: Daniel Valdivia <[email protected]>

.semgrepignore

@@ -0,0 +1,35 @@
+# Ignore git items
+.gitignore
+.git/
+:include .gitignore
+
+# Common large paths
+node_modules/
+portal-ui/node_modules/
+build/
+dist/
+.idea/
+vendor/
+.env/
+.venv/
+.tox/
+*.min.js
+
+# Common test paths
+test/
+tests/
+*_test.go
+
+# Semgrep rules folder
+.semgrep
+
+# Semgrep-action log folder
+.semgrep_logs/
+
+# Ignore VsCode files
+.vscode/
+*.code-workspace
+*~
+.eslintcache
+
+operatorApi.ts

Makefile

@@ -116,6 +116,8 @@ clean-swagger:
 swagger-operator:
 	@echo "Generating swagger server code from yaml"
 	@swagger generate server -A operator --main-package=operator --server-package=api --exclude-main -P models.Principal -f ./swagger.yml -r NOTICE
+	@echo "Generating typescript api"
+	@npx swagger-typescript-api -p ./swagger.yml -o ./web-app/src/api -n operatorApi.ts
 
 
 swagger-gen: clean-swagger swagger-operator apply-gofmt

api/tenant_get.go

@@ -151,5 +151,18 @@ func getTenantDetailsResponse(session *models.Principal, params operator_api.Ten
 
 	info.Domains = &domains
 
+	var tiers []*models.TenantTierElement
+
+	for _, tier := range minTenant.Status.Usage.Tiers {
+		tierItem := &models.TenantTierElement{
+			Name: tier.Name,
+			Type: tier.Type,
+			Size: tier.TotalSize,
+		}
+
+		tiers = append(tiers, tierItem)
+	}
+	info.Tiers = tiers
+
 	return info, nil
 }

swagger.yml

@@ -1891,6 +1891,10 @@ definitions:
         type: boolean
       domains:
         $ref: "#/definitions/domainsConfiguration"
+      tiers:
+        type: array
+        items:
+          $ref: "#/definitions/tenantTierElement"
 
   tenantUsage:
     type: object

web-app/package.json

@@ -12,28 +12,23 @@
     "@mui/styles": "^5.11.2",
     "@mui/x-date-pickers": "^5.0.15",
     "@reduxjs/toolkit": "^1.9.1",
-    "@uiw/react-textarea-code-editor": "^2.0.6",
+    "@uiw/react-textarea-code-editor": "^2.1.1",
     "kbar": "^0.1.0-beta.39",
     "local-storage-fallback": "^4.1.1",
     "lodash": "^4.17.21",
-    "luxon": "^3.2.1",
-    "mds": "https://github.com/minio/mds.git#v0.2.5",
-    "minio": "^7.0.32",
+    "luxon": "^3.3.0",
+    "mds": "https://github.com/minio/mds.git#v0.3.0",
     "react": "^18.1.0",
-    "react-component-export-image": "^1.0.6",
     "react-copy-to-clipboard": "^5.0.2",
     "react-dom": "^18.1.0",
-    "react-dropzone": "^14.2.3",
     "react-grid-layout": "^1.2.0",
     "react-redux": "^8.0.5",
     "react-router-dom": "6.7.0",
     "react-virtualized": "^9.22.3",
     "react-window": "^1.8.8",
     "react-window-infinite-loader": "^1.0.7",
-    "recharts": "^2.2.0",
-    "superagent": "^8.0.8",
-    "tinycolor2": "^1.5.2",
-    "websocket": "^1.0.31"
+    "recharts": "^2.4.3",
+    "superagent": "^8.0.8"
   },
   "scripts": {
     "start": "PORT=5050 react-scripts start",
@@ -61,23 +56,22 @@
   },
   "proxy": "http://localhost:9090/",
   "devDependencies": {
-    "@types/luxon": "^3.2.0",
-    "@types/react-window": "^1.8.5",
-    "@types/react-window-infinite-loader": "^1.0.6",
-    "@types/recharts": "^1.8.24",
     "@types/lodash": "^4.14.191",
-    "@types/minio": "^7.0.15",
+    "@types/luxon": "^3.2.0",
     "@types/node": "18.11.18",
     "@types/react": "18.0.27",
     "@types/react-copy-to-clipboard": "^5.0.2",
     "@types/react-dom": "18.0.10",
     "@types/react-grid-layout": "^1.1.1",
     "@types/react-redux": "^7.1.25",
     "@types/react-virtualized": "^9.21.21",
+    "@types/react-window": "^1.8.5",
+    "@types/react-window-infinite-loader": "^1.0.6",
+    "@types/recharts": "^1.8.24",
     "@types/superagent": "^4.1.16",
     "@types/webpack-env": "^1.14.1",
     "@types/websocket": "^1.0.0",
-    "prettier": "2.8.3",
+    "prettier": "2.8.4",
     "react-scripts": "5.0.1",
     "testcafe": "^2.3.0",
     "typescript": "^4.4.3"

web-app/src/screens/Console/Support/types.ts → web-app/src/api/errors.ts

@@ -1,4 +1,4 @@
-// This file is part of MinIO Operator
+// This file is part of MinIO Console Server
 // Copyright (c) 2023 MinIO, Inc.
 //
 // This program is free software: you can redistribute it and/or modify
@@ -14,7 +14,22 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-export interface ICallHomeResponse {
-  diagnosticsStatus?: boolean;
-  logsStatus?: boolean;
-}
+import { ErrorResponseHandler } from "../common/types";
+import { Error } from "./operatorApi";
+
+// errorToHandler translates a swagger error to a ErrorResponseHandler which
+// is legacy, when all API calls are using the swagger API, we can remove this.
+export const errorToHandler = (e: Error): ErrorResponseHandler => {
+  if (!e) {
+    return {
+      statusCode: 0,
+      errorMessage: "",
+      detailedError: "",
+    };
+  }
+  return {
+    statusCode: e.code,
+    errorMessage: e.message,
+    detailedError: e.detailedMessage,
+  };
+};

web-app/src/api/index.ts

@@ -0,0 +1,38 @@
+import { Api, Error, FullRequestParams, HttpResponse } from "./operatorApi";
+
+export let api = new Api();
+const internalRequestFunc = api.request;
+api.request = async <T = any, E = any>({
+  body,
+  secure,
+  path,
+  type,
+  query,
+  format,
+  baseUrl,
+  cancelToken,
+  ...params
+}: FullRequestParams): Promise<HttpResponse<T, E>> => {
+  const internalResp = internalRequestFunc({
+    body,
+    secure,
+    path,
+    type,
+    query,
+    format,
+    baseUrl,
+    cancelToken,
+    ...params,
+  });
+  return internalResp.then(CommonAPIValidation);
+};
+
+export function CommonAPIValidation<D, E>(
+  res: HttpResponse<D, E>
+): HttpResponse<D, E> {
+  const err = res.error as Error;
+  if (err && err.code === 403 && err.message === "invalid session") {
+    document.location = "/";
+  }
+  return res;
+}