swpp-backends 3.0.0-alpha.3 → 3.0.0-alpha.310

package/dist/swpp/config/ConfigLoader.js

@@ -3,126 +3,144 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigLoader = exports.IndivisibleName = void 0;
+exports.ConfigLoader = void 0;
+exports.defineConfig = defineConfig;
+exports.defineCompilationEnv = defineCompilationEnv;
+exports.defineCompilationFP = defineCompilationFP;
+exports.defineCrossEnv = defineCrossEnv;
+exports.defineRuntimeDep = defineRuntimeDep;
+exports.defineCrossDep = defineCrossDep;
+exports.defineRuntimeCore = defineRuntimeCore;
+exports.defineDomConfig = defineDomConfig;
+exports.defineRuntimeEvent = defineRuntimeEvent;
+exports.defineModifier = defineModifier;
 const jiti_1 = require("jiti");
 const path_1 = __importDefault(require("path"));
-const CompilationEnv_1 = require("../database/CompilationEnv");
 const SwCompiler_1 = require("../SwCompiler");
 const untils_1 = require("../untils");
-exports.IndivisibleName = '1indivisible__';
+const SpecialConfig_1 = require("./SpecialConfig");
+/** 正在加载配置的 loader */
+let activeConfigLoader = null;
+const TMP_PW = Math.random().toString();
 class ConfigLoader {
     constructor() {
         this.modifierList = [];
-        this.isBuilt = false;
+        Object.defineProperty(this, '9zLoadFromInside', {
+            value: (config, pw) => {
+                if (pw !== TMP_PW)
+                    throw new untils_1.RuntimeException(untils_1.exceptionNames.error, '该函数仅能由内部调用');
+                if ('modifier' in config) {
+                    this.modifierList.push(config.modifier);
+                }
+                if (this.config)
+                    ConfigLoader.mergeConfig(this.config, config);
+                else
+                    this.config = config;
+            },
+            writable: false,
+            enumerable: false
+        });
     }
     // noinspection JSUnusedGlobalSymbols
     /**
      * 加载一个配置文件，越早加载的优先级越高
-     * @param file
+     * @param file 配置文件的绝对路径
      */
     async load(file) {
-        if (this.isBuilt)
-            throw {
-                code: untils_1.exceptionNames.configBuilt,
-                message: '配置文件已经完成构建，不能继续加载新的配置',
-                file
-            };
-        const extensionName = path_1.default.extname(file);
+        const extensionName = path_1.default.extname(file).substring(1);
         if (!ConfigLoader.extensions.includes(extensionName)) {
-            throw {
-                code: untils_1.exceptionNames.unsupportedFileType,
-                message: `配置文件传入了不支持的文件类型：${extensionName}，仅支持：${ConfigLoader.extensions}`,
-                file
-            };
+            throw new untils_1.RuntimeException(untils_1.exceptionNames.unsupportedFileType, `配置文件传入了不支持的文件类型：${extensionName}，仅支持：${ConfigLoader.extensions}`, { configPath: file });
         }
+        await ConfigLoader.waitLoad();
+        let error = true;
+        activeConfigLoader?.onRelease?.();
+        activeConfigLoader = new ConfigLoaderLock(this, () => {
+            if (error)
+                throw new untils_1.RuntimeException(untils_1.exceptionNames.error, '锁竞争时出现异常');
+        }, path_1.default.normalize(file));
+        const task = ConfigLoader.prevTask = ConfigLoader.jiti.import(file).then(() => error = false);
+        await task;
+    }
+    /**
+     * 加载一个在代码层面编写的配置
+     */
+    // noinspection JSUnusedGlobalSymbols
+    async loadFromCode(config) {
+        await ConfigLoader.waitLoad();
         // @ts-ignore
-        const content = await ConfigLoader.jiti.import(file);
-        let newConfig = 'default' in content ? content.default : content;
-        if ('modifier' in newConfig) {
-            this.modifierList.push(newConfig.modifier);
-        }
-        if (this.config)
-            this.mergeConfig(newConfig);
-        else
-            this.config = newConfig;
+        this['9zLoadFromInside'](config, TMP_PW);
+    }
+    static async waitLoad() {
+        let prev;
+        do {
+            prev = ConfigLoader.prevTask;
+            await prev;
+        } while (prev !== ConfigLoader.prevTask);
     }
     // noinspection JSUnusedGlobalSymbols
     /** 将配置项的内容写入到环境中 */
     generate() {
         if (!this.config)
-            throw {
-                code: untils_1.exceptionNames.nullPoint,
-                message: '构建配之前必须至少加载一个配置文件'
-            };
+            throw new untils_1.RuntimeException(untils_1.exceptionNames.nullPoint, '构建配之前必须至少加载一个配置文件');
         // 构建属性集
         const { runtime, compilation } = (this.modifierList.find(it => it.build)?.build ?? (() => {
-            const runtime = new SwCompiler_1.RuntimeData();
-            const compilation = {
-                compilationEnv: new CompilationEnv_1.CompilationEnv(runtime.crossEnv, runtime.crossDep),
-                crossDep: runtime.crossDep,
-                crossEnv: runtime.crossEnv
-            };
+            const compilation = new SwCompiler_1.CompilationData();
+            const runtime = new SwCompiler_1.RuntimeData(compilation);
             return { runtime, compilation };
         }))();
+        runtime.initCompilation(compilation);
+        compilation.initRuntime(runtime);
         const config = this.config;
+        /** 将指定配置项目写入到 KV 库中 */
+        const writeConfigToKv = (key, value, database) => {
+            if (SpecialConfig_1.SpecialConfig.isNoCacheConfig(value)) {
+                database.update(key, value);
+            }
+            else {
+                if (typeof value === 'object') {
+                    const def = database.readDefault(key);
+                    ConfigLoader.mergeConfig(value, def, false);
+                }
+                database.update(key, value ?? null);
+            }
+        };
         // 写入运行时信息
         const writeRuntime = () => {
-            const insertList = ['runtimeDep', 'runtimeCore', 'runtimeEvent'];
-            for (let str of insertList) {
-                const configValue = config[str];
-                if (!configValue)
+            for (let configKey in config) {
+                if (!/^(runtime|dom)[A-Z_]/.test(configKey))
                     continue;
+                const configValue = config[configKey];
+                const database = runtime.getDatabase(configKey);
                 for (let key in configValue) {
-                    const value = configValue[key];
-                    runtime.runtimeDep.update(key, () => value ?? null);
+                    writeConfigToKv(key, configValue[key], database);
                 }
             }
         };
         // 写入编译期信息
         const writeCompilation = () => {
             if (!config.compilationEnv)
-                throw {
-                    code: untils_1.exceptionNames.nullPoint,
-                    message: '配置项必须包含 compilationEnv 选项！'
-                };
-            for (let key in config.compilationEnv) {
-                const value = config.compilationEnv[key];
-                compilation.compilationEnv.update(key, () => value);
+                throw new untils_1.RuntimeException(untils_1.exceptionNames.nullPoint, '配置项必须包含 compilationEnv 选项！');
+            for (let configKey in config) {
+                if (!/^compilation[A-Z_]/.test(configKey))
+                    continue;
+                if (!(configKey in compilation)) {
+                    throw new untils_1.RuntimeException(untils_1.exceptionNames.nullPoint, `配置项中传入了一个不存在的分类[${configKey}]`);
+                }
+                const env = config[configKey];
+                for (let key in env) {
+                    writeConfigToKv(key, env[key], compilation[configKey]);
+                }
             }
         };
         // 写入 cross
         const writeCross = () => {
-            if (config.crossEnv) {
-                for (let key in config.crossEnv) {
-                    const env = config.crossEnv[key];
-                    const value = typeof env === 'function' ? env.call(compilation) : env;
-                    if (typeof value === 'function')
-                        throw {
-                            code: untils_1.exceptionNames.invalidVarType,
-                            message: `crossEnv[${key}] 应当返回一个非函数对象，却返回了：${value.toString()}`
-                        };
-                    runtime.crossEnv.update(key, () => value);
-                }
-            }
-            if (config.crossDep) {
-                for (let key in config.crossDep) {
-                    const value = config.crossDep[key];
-                    if (typeof value != 'object')
-                        throw {
-                            code: untils_1.exceptionNames.invalidVarType,
-                            message: `crossDep[${key}] 返回的内容应当为一个对象，却返回了：${value}`
-                        };
-                    if (!('runOnNode' in value))
-                        throw {
-                            code: untils_1.exceptionNames.invalidVarType,
-                            message: `crossDep[${key}] 返回的对象应当包含 {runOnNode} 字段，却返回了：${JSON.stringify(value, null, 2)}`
-                        };
-                    if (!('runOnBrowser' in value))
-                        throw {
-                            code: untils_1.exceptionNames.invalidVarType,
-                            message: `crossDep[${key}] 返回的对象应当包含 {runOnBrowser} 字段，却返回了：${JSON.stringify(value, null, 2)}`
-                        };
-                    runtime.crossDep.update(key, () => value);
+            for (let configKey in config) {
+                if (!/^cross[A-Z_]/.test(configKey))
+                    continue;
+                const env = config[configKey];
+                const database = runtime.getDatabase(configKey);
+                for (let key in env) {
+                    writeConfigToKv(key, env[key], database);
                 }
             }
         };
@@ -134,15 +152,21 @@ class ConfigLoader {
         writeRuntime();
         writeCompilation();
         writeCross();
-        // 运行 dynamic
+        // 运行 dynamicUpdate
         for (let i = this.modifierList.length - 1; i >= 0; i--) {
             const modifier = this.modifierList[i];
-            modifier.dynamic?.(runtime, compilation);
+            modifier.dynamicUpdate?.(runtime, compilation);
         }
+        // 冻结 KV 库
+        runtime.freezeAll();
+        compilation.freezeAll();
+        Object.freeze(runtime.insertOrder);
+        Object.freeze(runtime);
+        Object.freeze(compilation);
         return Object.freeze({ runtime, compilation });
     }
     /** 将新配置合并到已有配置中 */
-    mergeConfig(other) {
+    static mergeConfig(config, other, isTop = true) {
         function mergeHelper(high, low, skip) {
             for (let key in low) {
                 if (skip && key == 'modifier')
@@ -156,7 +180,7 @@ class ConfigLoader {
                     }
                     if (typeof highValue != typeof lowValue)
                         continue;
-                    if (typeof highValue == 'object' && !highValue[exports.IndivisibleName] && !lowValue[exports.IndivisibleName]) {
+                    if (typeof highValue == 'object' && !SpecialConfig_1.SpecialConfig.isIndivisibleConfig(highValue)) {
                         mergeHelper(highValue, lowValue, false);
                     }
                 }
@@ -165,7 +189,7 @@ class ConfigLoader {
                 }
             }
         }
-        mergeHelper(this.config, other, true);
+        mergeHelper(config, other, isTop);
     }
 }
 exports.ConfigLoader = ConfigLoader;
@@ -174,8 +198,75 @@ ConfigLoader.extensions = [
     'js', 'ts', 'cjs', 'cts', 'mjs', 'mjs'
 ];
 ConfigLoader.jiti = (0, jiti_1.createJiti)(__filename, {
-    fsCache: false,
-    alias: {
-        'swpp-backends': path_1.default.join(__dirname, '..', '..', 'index')
-    }
+    fsCache: false
 });
+ConfigLoader.prevTask = null;
+class ConfigLoaderLock {
+    constructor(loader, onRelease, file) {
+        this.loader = loader;
+        this.onRelease = onRelease;
+        this.file = file;
+    }
+    check(file) {
+        if (file !== this.file)
+            throw new untils_1.RuntimeException(untils_1.exceptionNames.error, `错误地在 ${this.file} 加载时期载入了 ${file} 中的配置`);
+    }
+}
+function invokeLoader(loader, config) {
+    const stack = new Error().stack.split('\n');
+    const dist = stack[3];
+    let filePath;
+    if (dist.endsWith(')')) {
+        const startIndex = dist.lastIndexOf('(');
+        const endIndex = untils_1.utils.findSecondLastIndex(dist, ':');
+        filePath = dist.substring(startIndex + 1, endIndex);
+    }
+    else {
+        const startIndex = dist.indexOf('at ');
+        const endIndex = untils_1.utils.findSecondLastIndex(dist, ':');
+        filePath = dist.substring(startIndex + 3, endIndex);
+    }
+    activeConfigLoader.check(path_1.default.normalize(filePath));
+    // @ts-ignore
+    loader['9zLoadFromInside'](config, TMP_PW);
+}
+/** 定义一个通过 `export default` 导出的配置 */
+function defineConfig(config) {
+    invokeLoader(activeConfigLoader.loader, config);
+}
+/** 定义一个通过 `export const compilationEnv` 导出的配置 */
+function defineCompilationEnv(config) {
+    invokeLoader(activeConfigLoader.loader, { compilationEnv: config });
+}
+/** 定义一个通过 `export const compilationFileParser` 导出的配置 */
+function defineCompilationFP(config) {
+    invokeLoader(activeConfigLoader.loader, { compilationFileParser: config });
+}
+/** 定义一个通过 `export const crossEnv` 导出的配置 */
+function defineCrossEnv(config) {
+    invokeLoader(activeConfigLoader.loader, { crossEnv: config });
+}
+/** 定义一个通过 `export const runtimeDep` 导出的配置 */
+function defineRuntimeDep(config) {
+    invokeLoader(activeConfigLoader.loader, { runtimeDep: config });
+}
+/** 定义一个通过 `export const crossDep` 导出的配置 */
+function defineCrossDep(config) {
+    invokeLoader(activeConfigLoader.loader, { crossDep: config });
+}
+/** 定义一个通过 `export const runtimeCore` 导出的配置 */
+function defineRuntimeCore(config) {
+    invokeLoader(activeConfigLoader.loader, { runtimeCore: config });
+}
+/** 定义一个通过 `export const domConfig` 导出的配置 */
+function defineDomConfig(config) {
+    invokeLoader(activeConfigLoader.loader, { domConfig: config });
+}
+/** 定义一个通过 `export const runtimeEvent` 导出的配置 */
+function defineRuntimeEvent(config) {
+    invokeLoader(activeConfigLoader.loader, { runtimeEvent: config });
+}
+/** 定义一个通过 `export const modifier` 导出的配置 */
+function defineModifier(config) {
+    invokeLoader(activeConfigLoader.loader, { modifier: config });
+}

package/dist/swpp/config/SpecialConfig.d.ts

@@ -0,0 +1,29 @@
+import { CompilationData, RuntimeData } from '../SwCompiler';
+export type RuntimeSupplier<T> = (runtime: RuntimeData, compilation: CompilationData) => T;
+export declare class SpecialConfig {
+    static isSpecialConfig(config: any): config is RuntimeSpecialConfig<any>;
+    static isIndivisibleConfig(config: any): config is IndivisibleConfig<any> | RuntimeSpecialConfig<any>;
+    static isNoCacheConfig(config: any): config is NoCacheConfig<any>;
+}
+/** 运行时特殊配置 */
+export declare abstract class RuntimeSpecialConfig<T> extends SpecialConfig {
+    abstract get(runtime: RuntimeData, compilation: CompilationData): T;
+}
+/** 不可分割的配置 */
+export declare class IndivisibleConfig<T> extends SpecialConfig {
+    readonly value: T;
+    constructor(value: T);
+}
+/** 不被缓存的配置 */
+export declare class NoCacheConfig<T> extends RuntimeSpecialConfig<T> {
+    private getter;
+    constructor(getter: RuntimeSupplier<T>);
+    get(runtime: RuntimeData, compilation: CompilationData): T;
+}
+/** 延迟初始化配置 */
+export declare class LazyInitConfig<T> extends RuntimeSpecialConfig<T> {
+    private getter;
+    private cache;
+    constructor(getter: RuntimeSupplier<T>);
+    get(runtime: RuntimeData, compilation: CompilationData): T;
+}

package/dist/swpp/config/SpecialConfig.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LazyInitConfig = exports.NoCacheConfig = exports.IndivisibleConfig = exports.RuntimeSpecialConfig = exports.SpecialConfig = void 0;
+class SpecialConfig {
+    static isSpecialConfig(config) {
+        return config instanceof RuntimeSpecialConfig;
+    }
+    static isIndivisibleConfig(config) {
+        return config instanceof IndivisibleConfig || config instanceof RuntimeSpecialConfig;
+    }
+    static isNoCacheConfig(config) {
+        return config instanceof NoCacheConfig;
+    }
+}
+exports.SpecialConfig = SpecialConfig;
+/** 运行时特殊配置 */
+class RuntimeSpecialConfig extends SpecialConfig {
+}
+exports.RuntimeSpecialConfig = RuntimeSpecialConfig;
+/** 不可分割的配置 */
+class IndivisibleConfig extends SpecialConfig {
+    constructor(value) {
+        super();
+        this.value = value;
+    }
+}
+exports.IndivisibleConfig = IndivisibleConfig;
+/** 不被缓存的配置 */
+class NoCacheConfig extends RuntimeSpecialConfig {
+    constructor(getter) {
+        super();
+        this.getter = getter;
+    }
+    get(runtime, compilation) {
+        return this.getter(runtime, compilation);
+    }
+}
+exports.NoCacheConfig = NoCacheConfig;
+/** 延迟初始化配置 */
+class LazyInitConfig extends RuntimeSpecialConfig {
+    constructor(getter) {
+        super();
+        this.getter = getter;
+    }
+    get(runtime, compilation) {
+        if (this.getter) {
+            this.cache = this.getter(runtime, compilation);
+            this.getter = null;
+        }
+        return this.cache;
+    }
+}
+exports.LazyInitConfig = LazyInitConfig;

package/{types → dist}/swpp/database/CompilationEnv.d.ts

@@ -1,15 +1,14 @@
-import { FileParserRegistry } from '../FileParser';
 import { UpdateJson } from '../JsonBuilder';
 import { FiniteConcurrencyFetcher } from '../NetworkFileHandler';
-import { CrossDepCode } from './CrossDepCode';
-import { CrossEnv } from './CrossEnv';
+import { FileUpdateTracker } from '../ResourcesScanner';
+import { CompilationData } from '../SwCompiler';
 import { KeyValueDatabase } from './KeyValueDatabase';
 export type COMMON_TYPE_COMP_ENV = ReturnType<typeof buildCommon>;
 /**
  * 仅在编译期生效的配置项
  */
 export declare class CompilationEnv extends KeyValueDatabase<any, COMMON_TYPE_COMP_ENV> {
-    constructor(crossEnv: CrossEnv, crossCode: CrossDepCode);
+    constructor();
 }
 /** 拉取版本信息和 tracker 时的 404 等级 */
 export declare enum AllowNotFoundEnum {
@@ -20,29 +19,33 @@ export declare enum AllowNotFoundEnum {
     /** 拒绝任意形式的 404 */
     REJECT_ALL = 2
 }
-declare function buildCommon(_env: any, crossEnv: CrossEnv, crossCode: CrossDepCode): {
-    readonly DOMAIN_HOST: import("./KeyValueDatabase").DatabaseValue<string>;
-    /** HTML 数量限制 */
+declare function buildCommon(_env: any): {
+    readonly DOMAIN_HOST: import("./KeyValueDatabase").DatabaseValue<URL>;
+    readonly SERVICE_WORKER: import("./KeyValueDatabase").DatabaseValue<string>;
+    /** HTML 数量限制，设置为 <= 0 表示不限制 */
     readonly JSON_HTML_LIMIT: import("./KeyValueDatabase").DatabaseValue<number>;
     /** 版本信息长度限制 */
     readonly VERSION_LENGTH_LIMIT: import("./KeyValueDatabase").DatabaseValue<number>;
-    /** 获取已经上线的版本文件 */
-    readonly VERSION_FILE: import("./KeyValueDatabase").DatabaseValue<{
-        path: string;
-        fetcher(): Promise<UpdateJson>;
+    /** swpp 的 JSON 文件的基本信息 */
+    readonly SWPP_JSON_FILE: import("./KeyValueDatabase").DatabaseValue<{
+        swppPath: string;
+        trackerPath: string;
+        versionPath: string;
+        fetchVersionFile(): Promise<UpdateJson>;
+        fetchTrackerFile(compilation: CompilationData): Promise<FileUpdateTracker>;
     }>;
     /** 读取一个本地文件 */
-    readonly LOCAL_FILE_READER: import("./KeyValueDatabase").DatabaseValue<(path: string) => Promise<string>>;
+    readonly readLocalFile: import("./KeyValueDatabase").DatabaseValue<(path: string) => Promise<string>>;
     /** 拉取网络文件 */
-    readonly FETCH_NETWORK_FILE: import("./KeyValueDatabase").DatabaseValue<FiniteConcurrencyFetcher>;
+    readonly NETWORK_FILE_FETCHER: import("./KeyValueDatabase").DatabaseValue<FiniteConcurrencyFetcher>;
     /** 判断文件是否是 404 */
-    readonly IS_NOT_FOUND: import("./KeyValueDatabase").DatabaseValue<{
+    readonly isNotFound: import("./KeyValueDatabase").DatabaseValue<{
         response: (response: Response) => boolean;
         error: (err: any) => boolean;
     }>;
     /** 是否允许 404 */
     readonly ALLOW_NOT_FOUND: import("./KeyValueDatabase").DatabaseValue<AllowNotFoundEnum>;
-    /** 文件解析器 */
-    readonly FILE_PARSER: import("./KeyValueDatabase").DatabaseValue<FileParserRegistry>;
+    /** 检查一个链接是否是稳定的（也就是 URL 不变其返回的结果永远不变） */
+    readonly isStable: import("./KeyValueDatabase").DatabaseValue<(_url: URL) => boolean>;
 };
 export {};