feat: 启动容器时日志打印版本信息 (#477)

在启动auth, portal-web, mis-web, portal-server和mis-server时在日志中打印版本信息，包含`tag`和`commit`。npm会打印package.json的信息 ![image](https://user-images.githubusercontent.com/8363856/221754574-5b9b467a-aed4-438f-bdb1-7811636ae563.png) 注意：PR构建的容器的所log出来的commit号不是PR的commit的commit号！参考：actions/checkout#881 实现： 1. 在构建容器时，根据构建容器时的最新commit，生成一个`version.json`文件放在容器pwd下 2. 在这些组件启动时读取version.json和package.json的内容并生成内容
PKUHPC · Feb 28, 2023 · bdc990a · bdc990a
1 parent e6ed30b
commit bdc990a
Show file tree

Hide file tree

Showing 18 changed files with 162 additions and 39 deletions.
diff --git a/.changeset/early-kangaroos-count.md b/.changeset/early-kangaroos-count.md
@@ -0,0 +1,10 @@
+---
+"@scow/portal-server": patch
+"@scow/mis-server": patch
+"@scow/portal-web": patch
+"@scow/mis-web": patch
+"@scow/utils": patch
+"@scow/auth": patch
+---
+
+系统启动时，各个容器在日志中打印版本信息
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,4 @@ internal
 .turbo
 out
 dist
+version.json
diff --git a/apps/auth/package.json b/apps/auth/package.json
@@ -29,6 +29,7 @@
     "@scow/config": "workspace:*",
     "@scow/lib-config": "workspace:*",
     "@scow/lib-ssh": "workspace:*",
+    "@scow/utils": "workspace:*",
     "@sinclair/typebox": "0.25.24",
     "asn1": "0.2.6",
     "fastify": "4.13.0",

diff --git a/apps/auth/src/app.ts b/apps/auth/src/app.ts
@@ -12,6 +12,7 @@
 
 import createError from "@fastify/error";
 import { omitConfigSpec } from "@scow/lib-config";
+import { readVersionFile } from "@scow/utils/build/version";
 import fastify, { FastifyInstance, FastifyPluginAsync, FastifyPluginCallback } from "fastify";
 import { config } from "src/config/env";
 import { plugins } from "src/plugins";
@@ -53,7 +54,9 @@ export function buildApp(pluginOverrides?: PluginOverrides) {
     },
   });
 
-  server.log.info({ config: omitConfigSpec(config) }, "Loaded config");
+  server.log.info({ version: readVersionFile() }, "Running @scow/auth");
+
+  server.log.info({ config: omitConfigSpec(config) }, "Loaded env config");
 
   applyPlugins(server, pluginOverrides);
 

diff --git a/apps/mis-server/package.json b/apps/mis-server/package.json
@@ -39,6 +39,7 @@
     "@sinclair/typebox": "0.25.24",
     "@scow/lib-auth": "workspace:*",
     "@scow/protos": "workspace:*",
+    "@scow/utils": "workspace:*",
     "dotenv": "16.0.3",
     "node-cron": "3.0.2",
     "uuid": "9.0.0",

diff --git a/apps/mis-server/src/app.ts b/apps/mis-server/src/app.ts
@@ -11,6 +11,8 @@
  */
 
 import { Server } from "@ddadaal/tsgrpc-server";
+import { omitConfigSpec } from "@scow/lib-config";
+import { readVersionFile } from "@scow/utils/build/version";
 import { updateBlockStatusInSlurm } from "src/bl/block";
 import { config } from "src/config/env";
 import { plugins } from "src/plugins";
@@ -37,6 +39,9 @@ export async function createServer() {
     },
   });
 
+  server.logger.info({ version: readVersionFile() }, "@scow/mis-server: ");
+  server.logger.info({ config: omitConfigSpec(config) }, "Loaded env config");
+
   for (const plugin of plugins) {
     await server.register(plugin);
   }

diff --git a/apps/mis-web/config.js b/apps/mis-web/config.js
@@ -9,6 +9,7 @@ const { DEFAULT_PRIMARY_COLOR, getUiConfig } = require("@scow/config/build/ui");
 const { PHASE_DEVELOPMENT_SERVER, PHASE_PRODUCTION_BUILD, PHASE_PRODUCTION_SERVER } = require("next/constants");
 const { join } = require("path");
 const { getCapabilities } = require("@scow/lib-auth");
+const { readVersionFile } = require("@scow/utils/build/version");
 
 /**
  * Get auth capabilities
@@ -116,6 +117,8 @@ const buildRuntimeConfig = async (phase, basePath) => {
   };
 
   if (!building) {
+    console.log("Running @scow/mis-web");
+    console.log("Version: ", readVersionFile());
     console.log("Server Runtime Config", serverRuntimeConfig);
     console.log("Public Runtime Config", publicRuntimeConfig);
   }

diff --git a/apps/portal-server/package.json b/apps/portal-server/package.json
@@ -28,6 +28,7 @@
     "@scow/lib-slurm": "workspace:*",
     "@scow/lib-ssh": "workspace:*",
     "@scow/protos": "workspace:*",
+    "@scow/utils": "workspace:*",
     "@sinclair/typebox": "0.25.24",
     "dotenv": "16.0.3",
     "node-cron": "3.0.2",

diff --git a/apps/portal-server/src/app.ts b/apps/portal-server/src/app.ts
@@ -11,6 +11,8 @@
  */
 
 import { Server } from "@ddadaal/tsgrpc-server";
+import { omitConfigSpec } from "@scow/lib-config";
+import { readVersionFile } from "@scow/utils/build/version";
 import { config } from "src/config/env";
 import { plugins } from "src/plugins";
 import { appServiceServer } from "src/services/app";
@@ -33,6 +35,9 @@ export async function createServer() {
     },
   });
 
+  server.logger.info({ version: readVersionFile() }, "Running @scow/portal-server");
+  server.logger.info({ config: omitConfigSpec(config) }, "Loaded env config");
+
   for (const plugin of plugins) {
     await server.register(plugin);
   }

diff --git a/apps/portal-web/config.js b/apps/portal-web/config.js
@@ -5,6 +5,7 @@ const { join } = require("path");
 const { homedir } = require("os");
 const { PHASE_DEVELOPMENT_SERVER, PHASE_PRODUCTION_BUILD, PHASE_PRODUCTION_SERVER, PHASE_TEST } = require("next/constants");
 
+const { readVersionFile } = require("@scow/utils/build/version");
 const { getCapabilities } = require("@scow/lib-auth");
 const { DEFAULT_PRIMARY_COLOR, getUiConfig } = require("@scow/config/build/ui");
 const { getPortalConfig } = require("@scow/config/build/portal");
@@ -145,6 +146,8 @@ const buildRuntimeConfig = async (phase, basePath) => {
   }
 
   if (!building && !testenv) {
+    console.log("Running @scow/portal-web");
+    console.log("Version", readVersionFile());
     console.log("Server Runtime Config", serverRuntimeConfig);
     console.log("Public Runtime Config", publicRuntimeConfig);
   }

diff --git a/dockerfiles/Dockerfile.auth b/dockerfiles/Dockerfile.auth
@@ -11,7 +11,7 @@
 
 FROM node:hydrogen-alpine@sha256:0d2712ac2b2c1149391173de670406f6e3dbdb1b2ba44e8530647e623e0e1b17 AS base
 
-RUN apk update && apk add libc6-compat python3 make gcc g++
+RUN apk update && apk add libc6-compat python3 make gcc g++ git
 
 RUN corepack enable
 
@@ -26,6 +26,8 @@ WORKDIR /app
 
 COPY . .
 
+RUN node scripts/createVersionFile.mjs version.json
+
 RUN pnpm dlx turbo prune --scope="@scow/auth" --docker
 
 FROM base AS builder
@@ -40,12 +42,14 @@ COPY tsconfig.json .eslintrc.json turbo.json ./
 COPY libs/tsconfig.json ./libs/
 COPY protos ./protos
 
-
 RUN pnpm build
 
 COPY scripts scripts
 RUN node scripts/copyDist.mjs
-RUN cd dist && pnpm i --offline --prod --frozen-lockfile
+
+WORKDIR /app/dist
+
+RUN pnpm i --offline --prod --frozen-lockfile
 
 FROM node:hydrogen-alpine@sha256:0d2712ac2b2c1149391173de670406f6e3dbdb1b2ba44e8530647e623e0e1b17 AS runner
 
@@ -59,4 +63,6 @@ EXPOSE 5000
 
 WORKDIR /app/apps/auth
 
+COPY --from=pruner /app/version.json ./version.json
+
 CMD ["npm", "run", "serve"]
diff --git a/dockerfiles/Dockerfile.mis-server b/dockerfiles/Dockerfile.mis-server
@@ -11,15 +11,15 @@
 
 FROM node:hydrogen-alpine@sha256:0d2712ac2b2c1149391173de670406f6e3dbdb1b2ba44e8530647e623e0e1b17 AS base
 
-RUN apk update && apk add libc6-compat python3 make gcc g++ curl
+RUN apk update && apk add libc6-compat python3 make gcc g++ curl git
 
 ARG BUF_VERSION="1.11.0"
 
 RUN BIN="/usr/local/bin" && \
-VERSION="${BUF_VERSION}" && \
+  VERSION="${BUF_VERSION}" && \
   curl -sSL \
-    "https://github.com/bufbuild/buf/releases/download/v${VERSION}/buf-$(uname -s)-$(uname -m)" \
-    -o "${BIN}/buf" && \
+  "https://github.com/bufbuild/buf/releases/download/v${VERSION}/buf-$(uname -s)-$(uname -m)" \
+  -o "${BIN}/buf" && \
   chmod +x "${BIN}/buf"
 
 RUN corepack enable
@@ -36,6 +36,7 @@ WORKDIR /app
 
 COPY . .
 
+RUN node scripts/createVersionFile.mjs version.json
 RUN pnpm dlx turbo prune --scope="@scow/mis-server" --docker
 
 FROM base AS builder
@@ -54,7 +55,10 @@ RUN pnpm build
 
 COPY scripts scripts
 RUN node scripts/copyDist.mjs
-RUN cd dist && pnpm i --offline --prod --frozen-lockfile
+
+WORKDIR /app/dist
+
+RUN pnpm i --offline --prod --frozen-lockfile
 
 FROM node:hydrogen-alpine@sha256:0d2712ac2b2c1149391173de670406f6e3dbdb1b2ba44e8530647e623e0e1b17 AS runner
 
@@ -67,4 +71,6 @@ EXPOSE 5000
 
 WORKDIR /app/apps/mis-server
 
+COPY --from=pruner /app/version.json ./version.json
+
 CMD ["npm", "run", "serve"]
diff --git a/dockerfiles/Dockerfile.mis-web b/dockerfiles/Dockerfile.mis-web
@@ -11,15 +11,15 @@
 
 FROM node:hydrogen-alpine@sha256:0d2712ac2b2c1149391173de670406f6e3dbdb1b2ba44e8530647e623e0e1b17 AS base
 
-RUN apk update && apk add libc6-compat python3 make gcc g++ curl
+RUN apk update && apk add libc6-compat python3 make gcc g++ curl git
 
 ARG BUF_VERSION="1.11.0"
 
 RUN BIN="/usr/local/bin" && \
-VERSION="${BUF_VERSION}" && \
+  VERSION="${BUF_VERSION}" && \
   curl -sSL \
-    "https://github.com/bufbuild/buf/releases/download/v${VERSION}/buf-$(uname -s)-$(uname -m)" \
-    -o "${BIN}/buf" && \
+  "https://github.com/bufbuild/buf/releases/download/v${VERSION}/buf-$(uname -s)-$(uname -m)" \
+  -o "${BIN}/buf" && \
   chmod +x "${BIN}/buf"
 
 RUN corepack enable
@@ -35,7 +35,7 @@ WORKDIR /app
 
 COPY . .
 
-# Network connection required
+RUN node scripts/createVersionFile.mjs version.json
 RUN pnpm dlx turbo prune --scope="@scow/mis-web" --docker
 
 FROM base AS builder
@@ -54,7 +54,10 @@ RUN pnpm build
 
 COPY scripts scripts
 RUN node scripts/copyDist.mjs
-RUN cd dist && pnpm i --offline --prod --frozen-lockfile
+
+WORKDIR /app/dist
+
+RUN pnpm i --offline --prod --frozen-lockfile
 
 FROM node:hydrogen-alpine@sha256:0d2712ac2b2c1149391173de670406f6e3dbdb1b2ba44e8530647e623e0e1b17 AS runner
 
@@ -68,4 +71,6 @@ EXPOSE 3000
 
 WORKDIR /app/apps/mis-web
 
+COPY --from=pruner /app/version.json ./version.json
+
 CMD ["npm", "run", "serve"]
diff --git a/dockerfiles/Dockerfile.portal-server b/dockerfiles/Dockerfile.portal-server
@@ -11,15 +11,15 @@
 
 FROM node:hydrogen-alpine@sha256:0d2712ac2b2c1149391173de670406f6e3dbdb1b2ba44e8530647e623e0e1b17 AS base
 
-RUN apk update && apk add libc6-compat python3 make gcc g++ curl
+RUN apk update && apk add libc6-compat python3 make gcc g++ curl git
 
 ARG BUF_VERSION="1.11.0"
 
 RUN BIN="/usr/local/bin" && \
-VERSION="${BUF_VERSION}" && \
+  VERSION="${BUF_VERSION}" && \
   curl -sSL \
-    "https://github.com/bufbuild/buf/releases/download/v${VERSION}/buf-$(uname -s)-$(uname -m)" \
-    -o "${BIN}/buf" && \
+  "https://github.com/bufbuild/buf/releases/download/v${VERSION}/buf-$(uname -s)-$(uname -m)" \
+  -o "${BIN}/buf" && \
   chmod +x "${BIN}/buf"
 
 RUN corepack enable
@@ -35,6 +35,7 @@ WORKDIR /app
 
 COPY . .
 
+RUN node scripts/createVersionFile.mjs version.json
 RUN pnpm dlx turbo prune --scope="@scow/portal-server" --docker
 
 FROM base AS builder
@@ -53,7 +54,10 @@ RUN pnpm build
 
 COPY scripts scripts
 RUN node scripts/copyDist.mjs
-RUN cd dist && pnpm i --offline --prod --frozen-lockfile
+
+WORKDIR /app/dist
+
+RUN pnpm i --offline --prod --frozen-lockfile
 
 FROM node:hydrogen-alpine@sha256:0d2712ac2b2c1149391173de670406f6e3dbdb1b2ba44e8530647e623e0e1b17 AS runner
 
@@ -67,4 +71,6 @@ EXPOSE 5000
 
 WORKDIR /app/apps/portal-server
 
+COPY --from=pruner /app/version.json ./version.json
+
 CMD ["npm", "run", "serve"]
diff --git a/dockerfiles/Dockerfile.portal-web b/dockerfiles/Dockerfile.portal-web
@@ -11,15 +11,15 @@
 
 FROM node:hydrogen-alpine@sha256:0d2712ac2b2c1149391173de670406f6e3dbdb1b2ba44e8530647e623e0e1b17 AS base
 
-RUN apk update && apk add libc6-compat python3 make gcc g++ curl
+RUN apk update && apk add libc6-compat python3 make gcc g++ curl git
 
 ARG BUF_VERSION="1.11.0"
 
 RUN BIN="/usr/local/bin" && \
-VERSION="${BUF_VERSION}" && \
+  VERSION="${BUF_VERSION}" && \
   curl -sSL \
-    "https://github.com/bufbuild/buf/releases/download/v${VERSION}/buf-$(uname -s)-$(uname -m)" \
-    -o "${BIN}/buf" && \
+  "https://github.com/bufbuild/buf/releases/download/v${VERSION}/buf-$(uname -s)-$(uname -m)" \
+  -o "${BIN}/buf" && \
   chmod +x "${BIN}/buf"
 
 RUN corepack enable
@@ -35,6 +35,7 @@ WORKDIR /app
 
 COPY . .
 
+RUN node scripts/createVersionFile.mjs version.json
 RUN pnpm dlx turbo prune --scope="@scow/portal-web" --docker
 
 FROM base AS builder
@@ -53,7 +54,10 @@ RUN pnpm build
 
 COPY scripts scripts
 RUN node scripts/copyDist.mjs
-RUN cd dist && pnpm i --offline --prod --frozen-lockfile
+
+WORKDIR /app/dist
+
+RUN pnpm i --offline --prod --frozen-lockfile
 
 FROM node:hydrogen-alpine@sha256:0d2712ac2b2c1149391173de670406f6e3dbdb1b2ba44e8530647e623e0e1b17 AS runner
 
@@ -67,4 +71,6 @@ EXPOSE 3000
 
 WORKDIR /app/apps/portal-web
 
+COPY --from=pruner /app/version.json ./version.json
+
 CMD ["npm", "run", "serve"]
diff --git a/libs/utils/src/version.ts b/libs/utils/src/version.ts
@@ -0,0 +1,30 @@
+/**
+ * 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 { existsSync, readFileSync } from "fs";
+
+interface VersionJsonInfo {
+  tag?: string;
+  commit: string;
+}
+
+export interface VersionInfo extends VersionJsonInfo {}
+
+export function readVersionFile(versionJsonFileName = "version.json") {
+
+  const jsonInfo: VersionJsonInfo = existsSync(versionJsonFileName)
+    ? JSON.parse(readFileSync(versionJsonFileName, "utf-8"))
+    : {};
+
+  return jsonInfo; }
+
+
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,3 +9,4 @@ internal @@
     .turbo
     out
     dist
+    version.json