@next-core/brick-container 3.6.10 → 3.6.12

package/index.d.ts

@@ -0,0 +1,91 @@
+import { RequestHandler } from "express";
+
+export interface DevConfig {
+  /**
+   * 设置用于查找本地构件包的文件夹。
+   *
+   * @default ["node_modules/@next-bricks","node_modules/@bricks"]
+   *
+   * @example
+   *
+   * ```js
+   * export default {
+   *   brickFolders: [
+   *     "node_modules/@next-bricks",
+   *     "node_modules/@bricks",
+   *     "../next-*\/bricks",
+   *   ]
+   * }
+   * ```
+   */
+  brickFolders?: string[];
+
+  /**
+   * 服务端设置（特性开关和杂项配置等）
+   *
+   * @example
+   * ```js
+   * export default {
+   *   settings: {
+   *     featureFlags: {
+   *       "my-flag": true,
+   *     }
+   *     misc: {
+   *       "myMisc": "anything",
+   *     },
+   *   },
+   * }
+   * ```
+   */
+  settings?: Settings;
+
+  /**
+   * 微应用配置
+   *
+   * @example
+   * ```js
+   * export default {
+   *   userConfigByApps: {
+   *     "my-app-id": {
+   *       myAnyAppConfig: "anything",
+   *     },
+   *   },
+   * }
+   * ```
+   */
+  userConfigByApps?: UserConfigByApps;
+
+  /**
+   * API mocks
+   *
+   * @example
+   * ```js
+   * export default {
+   *   mocks: [
+   *     (req, res, next) => {
+   *       switch (`${req.method} ${req.path}`) {
+   *         case "GET /api/my-any-api":
+   *           res.send("fake response");
+   *           return;
+   *         case "GET /api/my-another-api":
+   *           res.send("another fake response");
+   *           return;
+   *       }
+   *       next();
+   *     }
+   *   ]
+   * }
+   * ```
+   */
+  mocks?: RequestHandler[];
+}
+
+interface Settings {
+  /** 特性开关 */
+  featureFlags?: Record<string, boolean>;
+  /** 杂项配置 */
+  misc?: Record<string, unknown>;
+  [k: string]: unknown;
+}
+
+type UserConfigByApps = Record<string, Record<string, unknown>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next-core/brick-container",
-  "version": "3.6.10",
+  "version": "3.6.12",
   "description": "Brick Container Server",
   "homepage": "https://github.com/easyops-cn/next-core/tree/v3/packages/brick-container",
   "license": "GPL-3.0",
@@ -14,8 +14,15 @@
     "deploy",
     "dist",
     "tools",
-    "serve"
+    "serve",
+    "index.d.ts"
   ],
+  "exports": {
+    ".": {
+      "types": "./index.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
   "repository": {
     "type": "git",
     "url": "git@github.com:easyops-cn/next-core.git"
@@ -65,5 +72,5 @@
     "@next-core/runtime": "*",
     "@next-core/utils": "*"
   },
-  "gitHead": "70bf6b500764afe0d97a7d8360f1407b92ad54a2"
+  "gitHead": "b7439ff425770820937f2222b034808d6105b676"
 }

package/serve/env.js

@@ -100,6 +100,7 @@ export async function getEnv(rootDir, runtimeFlags) {
   let brickFolders = ["node_modules/@next-bricks", "node_modules/@bricks"];
   const devConfigMjs = path.join(rootDir, "dev.config.mjs");
   let configuredBrickFolders = false;
+  let userConfigByApps;
   if (existsSync(devConfigMjs)) {
     const devConfig = (await import(devConfigMjs)).default;
     if (devConfig) {
@@ -109,6 +110,7 @@ export async function getEnv(rootDir, runtimeFlags) {
       }
       localSettings = devConfig.settings;
       localMocks = devConfig.mocks;
+      userConfigByApps = devConfig.userConfigByApps;
     }
   }
 
@@ -139,6 +141,7 @@ export async function getEnv(rootDir, runtimeFlags) {
     cookieSameSiteNone: flags.cookieSameSiteNone,
     liveReload: flags.liveReload,
     localSettings,
+    userConfigByApps,
     port: Number(flags.port),
     wsPort: Number(flags.wsPort),
     server: getServerPath(flags.server),
@@ -167,6 +170,11 @@ export async function getEnv(rootDir, runtimeFlags) {
     console.log("local settings: enabled");
   }
 
+  const configuredApps = Object.keys(userConfigByApps ?? {});
+  if (configuredApps.length) {
+    console.log(`Override user config for apps: ${configuredApps.join(", ")}`);
+  }
+
   if (localMocks?.length) {
     console.log("local mock: enabled");
   }

package/serve/getProxy.js

@@ -1,11 +1,14 @@
 import { responseInterceptor } from "http-proxy-middleware";
 import _ from "lodash";
+import jsYaml from "js-yaml";
 import { getBrickPackages } from "@next-core/serve-helpers";
 import { getStoryboards } from "./utils/getStoryboards.js";
 import { fixV2Storyboard } from "./utils/fixV2Storyboard.js";
 import { injectIndexHtml } from "./utils/injectIndexHtml.js";
 import { concatBrickPackages } from "./utils/concatBrickPackages.js";
 
+const { safeDump, JSON_SCHEMA } = jsYaml;
+
 export default function getProxy(env, getRawIndexHtml) {
   const {
     rootDir,
@@ -15,6 +18,7 @@ export default function getProxy(env, getRawIndexHtml) {
     useLocalContainer,
     localBricks,
     localBrickFolders,
+    userConfigByApps,
   } = env;
   if (useRemote) {
     return [
@@ -151,7 +155,10 @@ export default function getProxy(env, getRawIndexHtml) {
               );
               return responseBuffer;
             }
-            if (res.statusCode !== 200 && req.method !== "GET") {
+            if (
+              res.statusCode < 200 ||
+              (res.statusCode >= 300 && req.method !== "GET")
+            ) {
               return responseBuffer;
             }
             if ((res.getHeader("content-type") || "").includes("text/html")) {
@@ -266,6 +273,32 @@ export default function getProxy(env, getRawIndexHtml) {
                 console.error("Stub bootstrap.json failed:", error);
               }
             }
+
+            if (
+              /^\/next\/sa-static\/[^/]+\/versions\/[^/]+\/webroot\/conf\.yaml$/.test(
+                req.path
+              ) ||
+              /^\/next\/[^/]+\/conf\.yaml$/.test(req.path)
+            ) {
+              removeCacheHeaders(res);
+              if (userConfigByApps) {
+                if (res.statusCode === 204) {
+                  res.statusCode = 200;
+                  res.statusMessage = "OK";
+                }
+                const conf = {
+                  user_config_by_apps: userConfigByApps,
+                };
+                return safeDump(conf, {
+                  indent: 2,
+                  schema: JSON_SCHEMA,
+                  skipInvalid: true,
+                  noRefs: true,
+                  noCompatMode: true,
+                });
+              }
+            }
+
             return responseBuffer;
           }
         ),

package/serve/middlewares/getMiddlewares.js

@@ -1,10 +1,13 @@
 import express from "express";
+import jsYaml from "js-yaml";
 import bootstrapJson from "./bootstrapJson.js";
 import mockAuth from "./mockAuth.js";
 import singleAppBootstrapJson from "./singleAppBootstrapJson.js";
 import standaloneBootstrapJson from "./standaloneBootstrapJson.js";
 import serveBricksWithVersions from "./serveBricksWithVersions.js";
 
+const { safeDump, JSON_SCHEMA } = jsYaml;
+
 export function getMiddlewares(env) {
   const { baseHref, useRemote, localMicroApps } = env;
 
@@ -18,13 +21,6 @@ export function getMiddlewares(env) {
       path: `${baseHref}sa-static/${appId}/versions/0.0.0/webroot/-/bootstrap.hash.json`,
       middleware: standaloneBootstrapJson(env, appId),
     });
-    middlewares.push({
-      path: `${baseHref}sa-static/${appId}/versions/0.0.0/webroot/conf.yaml`,
-      middleware(req, res) {
-        res.status(204);
-        res.send();
-      },
-    });
   }
 
   if (!useRemote) {
@@ -53,7 +49,7 @@ export function getMiddlewares(env) {
 }
 
 export function getPreMiddlewares(env) {
-  const { baseHref, localMicroApps, localBrickFolders } = env;
+  const { baseHref, localMicroApps, localBrickFolders, userConfigByApps } = env;
 
   /**
    * @type {import("webpack-dev-server").Middleware[]}
@@ -65,6 +61,28 @@ export function getPreMiddlewares(env) {
       path: `${baseHref}api/auth/v2/bootstrap/${appId}`,
       middleware: singleAppBootstrapJson(env, appId),
     });
+    middlewares.push({
+      path: `${baseHref}sa-static/${appId}/versions/0.0.0/webroot/conf.yaml`,
+      middleware(req, res) {
+        if (userConfigByApps) {
+          const conf = {
+            user_config_by_apps: userConfigByApps,
+          };
+          const content = safeDump(conf, {
+            indent: 2,
+            schema: JSON_SCHEMA,
+            skipInvalid: true,
+            noRefs: true,
+            noCompatMode: true,
+          });
+          res.type(".yaml");
+          res.send(content);
+        } else {
+          res.status(204);
+          res.send();
+        }
+      },
+    });
   }
 
   middlewares.push({