[v1.4] 更新 Subscribe 相关代码和追加注释 #1198
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| import LoggerCore from "@App/app/logger/core"; | ||
| import Logger from "@App/app/logger/logger"; | ||
| import { ScriptDAO, type Script } from "@App/app/repo/scripts"; | ||
| import type { SCMetadata, Subscribe, SubscribeScript } from "@App/app/repo/subscribe"; | ||
| import { SubscribeDAO, SubscribeStatusType } from "@App/app/repo/subscribe"; | ||
| import { type IMessageQueue } from "@Packages/message/message_queue"; | ||
| import { type Group } from "@Packages/message/server"; | ||
| import { type ScriptService } from "./script"; | ||
|
|
@@ -31,13 +31,17 @@ export class SubscribeService { | |
| } | ||
|
|
||
| async install(param: { subscribe: Subscribe }) { | ||
| // 1）由安装页呼叫，进行 user.sub.js 的安装 | ||
| // 2）静默更新启动状态下，Subscribe 列表自动更新 | ||
| const logger = this.logger.with({ | ||
| subscribeUrl: param.subscribe.url, | ||
| name: param.subscribe.name, | ||
| }); | ||
| try { | ||
| await this.subscribeDAO.save(param.subscribe); // 所谓的安装，仅储存脚本资源。 | ||
| logger.info("upsert subscribe success"); | ||
| // 广播后才会根据 subscribe.scripts 的 url 取得/更新脚本 | ||
| // 注：installSubscribe 的广播是自己和自己对话。（不等待回应） | ||
| this.mq.publish<TInstallSubscribe>("installSubscribe", { | ||
| subscribe: param.subscribe, | ||
| }); | ||
|
|
@@ -83,85 +87,121 @@ export class SubscribeService { | |
| } | ||
| } | ||
|
|
||
| // 更新订阅的脚本（ installSubscribe ） | ||
| // 已订阅的脚本则根据 Script脚本 本身的更新逻辑更新，与 Subscribe脚本 的更新无关 | ||
| async upsertScript(url: string) { | ||
| const subscribe = await this.subscribeDAO.get(url); | ||
| if (!subscribe || !subscribe.metadata.usersubscribe) return; // 有效的 Subscribe 必定有 usersubscribe | ||
| const logger = this.logger.with({ | ||
| url: subscribe.url, | ||
| name: subscribe.name, | ||
| }); | ||
| // 对比脚本是否有变化 | ||
| const addedScripts: string[] = []; | ||
| const removedScripts: SubscribeScript[] = []; | ||
| const metaScriptUrlSet = new Set(subscribe.metadata.scripturl || []); // 订阅列表 | ||
| const subscribeScripts = new Set(Object.keys(subscribe.scripts)); // 已关联 uuid 的列表 | ||
| // 注：首次安装时， subscribeScripts 是空的。 | ||
| for (const url of metaScriptUrlSet) { | ||
| // 不存在于已安装的脚本中, 则添加 | ||
| if (!subscribeScripts.has(url)) { | ||
| addedScripts.push(url); | ||
| } | ||
| } | ||
| for (const url of subscribeScripts) { | ||
| // 不存在于订阅的脚本中, 则删除 | ||
| if (!metaScriptUrlSet.has(url)) { | ||
| removedScripts.push(subscribe.scripts[url]); | ||
| } | ||
| } | ||
|
|
||
| // 一次性取出所有已安装脚本，建立 URL → Script 的索引，避免每个 addedScript 都全表扫描 | ||
| const allScripts = await this.scriptDAO.find(); | ||
| const scriptByUrl = new Map<string, Script>(); | ||
| for (const script of allScripts) { | ||
| if (script.downloadUrl) scriptByUrl.set(script.downloadUrl, script); | ||
| if (script.origin) scriptByUrl.set(script.origin, script); | ||
| } | ||
|
|
||
| const addedScriptNames: string[] = []; | ||
| const removedScriptNames: string[] = []; | ||
| const promises: Promise<void>[] = []; | ||
| // 添加脚本: 根据 订阅列表 的 Script脚本URLs 进行安装 | ||
| addedScripts.forEach((url) => { | ||
| promises.push( | ||
| (async () => { | ||
| const existingScript = scriptByUrl.get(url); | ||
| if (existingScript) { | ||
| // 仅关联至 已安装脚本的 uuid | ||
| // 注：1）已安装的脚本可能是用户用直接下载方式安装 | ||
| // 2）已安装的脚本可能是用户用其他 Subscribe 安装 | ||
| // 这里的 existingScript 的 subscribeUrl 值不一定是这个 Subscribe 的 url | ||
| subscribe.scripts[url] = { | ||
| url, | ||
| uuid: existingScript.uuid, | ||
| }; | ||
| } else { | ||
| // 安装Script脚本 ( script.subscribeUrl 会指定为这个 Subscribe. 当移除 Subscribe 时会一并移除 ) | ||
| const script = await this.scriptService.installByUrl(url, "subscribe", subscribe.url); | ||
| const name = i18nName(script); | ||
| // 把Script脚本关联至Subscribe | ||
| subscribe.scripts[url] = { | ||
| url, | ||
| uuid: script.uuid, | ||
| }; | ||
| addedScriptNames.push(name); | ||
| } | ||
| })().catch((e) => { | ||
| logger.error("install script failed", Logger.E(e)); | ||
| }) | ||
| ); | ||
| }); | ||
| // 删除脚本: 根据 subscribeScripts 的 Script脚本UUIDs 进行反安装 | ||
| removedScripts.forEach((item) => { | ||
| // 通过uuid查询脚本id | ||
| promises.push( | ||
| (async () => { | ||
| // 以 uuid 找出已安装的Script脚本资讯 | ||
| const script = await this.scriptDAO.get(item.uuid); | ||
| const url = item.url; | ||
| // 无论是否删除脚本，都需要清理 subscribe.scripts 中的关联 | ||
| delete subscribe.scripts[url]; | ||
| if (script) { | ||
| const name = i18nName(script); | ||
| // 如果不是以此 Subscribe 安装的话则略过删除（例如其他 Subscribe、直接安装、本地安装等） | ||
| if (script.subscribeUrl === subscribe.url) { | ||
| await this.scriptService.deleteScript(script.uuid); | ||
| removedScriptNames.push(name); | ||
| } else { | ||
| logger.warn("Subscribe Update: skip deletion", { | ||
| scriptUUID: script.uuid, | ||
| scriptUrl: url, | ||
| scriptName: name, | ||
| }); | ||
| } | ||
|
Comment on lines
+172
to
+181
There was a problem hiding this comment. 在 upsertScript 的移除逻辑里，当脚本不是由当前 Subscribe 安装（script.subscribeUrl !== subscribe.url）时会跳过删除，但同时也没有从 subscribe.scripts 中移除该 url 关联；这会导致 subscribe.scripts 与 metadata.scripturl 长期不一致，并在后续更新中反复进入 removedScripts 分支/重复告警。建议无论是否删除脚本本体，都先删除 subscribe.scripts[url]（若脚本确实由该 Subscribe 安装再额外执行 deleteScript）。另外当 scriptDAO.get(item.uuid) 返回空时也应清理该映射。 |
||
| } | ||
| })().catch((e) => { | ||
| logger.error("delete script failed", Logger.E(e)); | ||
| }) | ||
| ); | ||
| }); | ||
|
|
||
| await Promise.allSettled(promises); | ||
|
|
||
| // 把 subscribe.scripts 的新资讯储存到 subscribeDAO | ||
| await this.subscribeDAO.update(subscribe.url, subscribe); | ||
|
|
||
| InfoNotification( | ||
| i18n.t("notification.subscribe_update", { subscribeName: subscribe.name }), | ||
| i18n.t("notification.subscribe_update_desc", { | ||
| newScripts: addedScriptNames.join(","), | ||
| deletedScripts: removedScriptNames.join(","), | ||
| }) | ||
| ); | ||
|
|
||
| logger.info("subscribe list update", { | ||
| installed: addedScriptNames, | ||
| deleted: removedScriptNames, | ||
| }); | ||
|
|
||
| return true; | ||
|
|
@@ -183,9 +223,9 @@ export class SubscribeService { | |
| }); | ||
| try { | ||
| if (delayFn) await delayFn(); | ||
| const code = await fetchScriptBody(url); // user.sub.js 的 代码 | ||
| const metadata = parseMetadata(code); // user.sub.js 的 metadata = 代码内容分析; metadata.usersubscribe 是 空阵列 | ||
| if (!metadata || !metadata.usersubscribe) { | ||
| logger.error("parse metadata failed"); | ||
| return false; | ||
| } | ||
|
|
@@ -203,11 +243,17 @@ export class SubscribeService { | |
| } | ||
|
|
||
| // 检查更新 | ||
| /** | ||
| * @param url Subscribe脚本 的 url | ||
| * @param source 系统自动检查: "system"; subscribeClient.checkUpdate(subscribe.url) 的时候: "user" | ||
| * @returns | ||
| */ | ||
| async checkUpdate(url: string, source: InstallSource) { | ||
| const subscribe = await this.subscribeDAO.get(url); | ||
| if (!subscribe) { | ||
| return false; | ||
| } | ||
| // 先写入更新触发时间 | ||
| await this.subscribeDAO.update(url, { checktime: Date.now() }); | ||
| const logger = this.logger.with({ | ||
| url: subscribe.url, | ||
|
|
@@ -263,7 +309,8 @@ export class SubscribeService { | |
| }); | ||
|
|
||
| for (const subscribe of list) { | ||
| if (!checkDisable && subscribe.status === SubscribeStatusType.disable) { | ||
| // 旧代码一直写反了这个 enable disable | ||
| continue; | ||
| } | ||
| this.checkUpdate(subscribe.url, "system"); | ||
|
|
@@ -280,7 +327,7 @@ export class SubscribeService { | |
| }); | ||
| try { | ||
| await this.subscribeDAO.update(param.url, { | ||
| status: param.enable ? SubscribeStatusType.enable : SubscribeStatusType.disable, | ||
| }); | ||
| logger.info("enable subscribe success"); | ||
| return true; | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
SubscribeStatusType 里引入 unknown3/unknown4 且注释为“3 是什么？/4 是什么？”会把不确定的语义暴露为公共 API，后续维护/排错会非常困难。建议：如果 3/4 只是历史遗留或保留值，用更明确的命名（如 reserved3/reserved4）并说明来源/用途；如果不会出现则不要纳入类型范围，避免代码误用。