feat(mis/portal): 增加获取 SCOW API 版本的接口

.changeset/kind-owls-buy.md

@@ -0,0 +1,5 @@
+---
+"@scow/grpc-api": minor
+---
+
+增加获取 SCOW 版本的接口

.changeset/mean-boats-repair.md

@@ -0,0 +1,6 @@
+---
+"@scow/portal-server": patch
+"@scow/mis-server": patch
+---
+
+增加获取 SCOW 版本的接口

apps/mis-server/src/services/config.ts

@@ -19,6 +19,8 @@ import { convertClusterConfigsToServerProtoType, NO_CLUSTERS } from "@scow/lib-s
 import { scowErrorMetadata } from "@scow/lib-server/build/error";
 import { libCheckActivatedClusters } from "@scow/lib-server/build/misCommon/clustersActivation";
 import { ConfigServiceServer, ConfigServiceService } from "@scow/protos/build/common/config";
+import { readFileSync } from "fs";
+import { join } from "path";
 import { getActivatedClusters, updateCluster } from "src/bl/clustersUtils";
 
 export const configServiceServer = plugin((server) => {
@@ -76,5 +78,13 @@ export const configServiceServer = plugin((server) => {
       return [{ clusterConfigs: clusterConfigsProto }];
     },
 
+    getVersion: async () => {
+
+      const version = await JSON.parse(readFileSync(join(__dirname, "../../../../package.json"), "utf-8")).version;
+
+      const [major, minor, patch] = version.split(".").map(Number);
+
+      return [{ major, minor, patch }];
+    },
   });
 });

apps/portal-server/src/services/config.ts

@@ -21,11 +21,12 @@ import { ConfigServiceServer, ConfigServiceService, Partition } from "@scow/prot
 import { ConfigServiceServer as runTimeConfigServiceServer, ConfigServiceService as runTimeConfigServiceService }
   from "@scow/protos/build/portal/config";
 import { ApiVersion } from "@scow/utils/build/version";
+import { readFileSync } from "fs";
+import { join } from "path";
 import { callOnOne, checkActivatedClusters } from "src/utils/clusters";
 
 export const staticConfigServiceServer = plugin((server) => {
   return server.addService<ConfigServiceServer>(ConfigServiceService, {
-
     getClusterConfig: async ({ request, logger }) => {
       const { cluster } = request;
       await checkActivatedClusters({ clusterIds: cluster });
@@ -63,7 +64,7 @@ export const staticConfigServiceServer = plugin((server) => {
         availablePartitions = [];
       }
 
-      return [ { partitions: availablePartitions } ];
+      return [{ partitions: availablePartitions }];
     },
 
 
@@ -85,6 +86,14 @@ export const staticConfigServiceServer = plugin((server) => {
       return [{ clusterConfigs: clusterConfigsProto }];
     },
 
+    getVersion: async () => {
+
+      const version = await JSON.parse(readFileSync(join(__dirname, "../../../../package.json"), "utf-8")).version;
+
+      const [major, minor, patch] = version.split(".").map(Number);
+
+      return [{ major, minor, patch }];
+    },
   });
 });
 

apps/portal-server/tests/utils/config.test.ts

@@ -0,0 +1,54 @@
+/**
+ * Copyright (c) 2022 Peking University and Peking University Institute for Computing and Digital Economy
+ * SCOW is licensed under Mulan PSL v2.
+ * You can use this software according to the terms and conditions of the Mulan PSL v2.
+ * You may obtain a copy of Mulan PSL v2 at:
+ *          http://license.coscl.org.cn/MulanPSL2
+ * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
+ * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
+ * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+ * See the Mulan PSL v2 for more details.
+ */
+
+/**
+ * Copyright (c) 2022 Peking University and Peking University Institute for Computing and Digital Economy
+ * SCOW is licensed under Mulan PSL v2.
+ * You can use this software according to the terms and conditions of the Mulan PSL v2.
+ * You may obtain a copy of Mulan PSL v2 at:
+ *          http://license.coscl.org.cn/MulanPSL2
+ * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
+ * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
+ * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+ * See the Mulan PSL v2 for more details.
+ */
+
+import { asyncUnaryCall } from "@ddadaal/tsgrpc-client";
+import { Server } from "@ddadaal/tsgrpc-server";
+import { credentials } from "@grpc/grpc-js";
+import { ConfigServiceClient } from "@scow/protos/build/common/config";
+import { createServer } from "src/app";
+
+let server: Server;
+let client: ConfigServiceClient;
+
+beforeEach(async () => {
+
+  server = await createServer();
+
+  await server.start();
+
+  client = new ConfigServiceClient(server.serverAddress, credentials.createInsecure());
+});
+
+afterEach(async () => {
+  await server.close();
+});
+
+it("get scow version configs info", async () => {
+
+  const reply = await asyncUnaryCall(client, "getVersion", { query: {} });
+
+  expect(reply.major).toBeNumber();
+  expect(reply.minor).toBeNumber();
+  expect(reply.patch).toBeNumber();
+});

protos/common/config.proto

@@ -165,11 +165,24 @@ message GetClusterConfigFilesResponse {
   repeated ClusterConfigSchemaProto cluster_configs = 1;
 }
 
+message GetVersionRequest {
+
+}
+
+message GetVersionResponse {
+  uint32 major = 1;
+  uint32 minor = 2;
+  uint32 patch = 3;
+}
+
 service ConfigService {
   rpc GetClusterConfig(GetClusterConfigRequest) returns (GetClusterConfigResponse);
 
   rpc GetAvailablePartitionsForCluster(GetAvailablePartitionsForClusterRequest) returns (GetAvailablePartitionsForClusterResponse);
 
   // 获取 SCOW 部署的集群配置文件中的集群信息
   rpc GetClusterConfigFiles(GetClusterConfigFilesRequest) returns (GetClusterConfigFilesResponse);
+
+  // 获取当前部署 SCOW 的版本，方便接入其它服务
+  rpc GetVersion(GetVersionRequest) returns (GetVersionResponse);
 }