Proposal：为应用市场插件添加依赖/推荐应用支持

[ruibaby]

摘要

目前 Halo 的单个主题或者插件（尤其是主题）可能会依赖于其他插件，虽然目前插件已经在底层支持了插件依赖，但没有很好的办法引导用户安装，尤其是依赖的还只是 metadata.name，用户即便看到依赖提示，可能仍然无法知道具体需要安装什么插件。

所以我建议专门为应用市场插件提供元数据定义，专门用于定义依赖/或者推荐应用，可以实现用户在应用市场安装主题或者插件之后，如果有依赖/推荐定义，在安装完之后可以显示引导安装其他推荐或者依赖插件的界面，引导用户安装。

定义方式

以默认主题为例。

apiVersion: theme.halo.run/v1alpha1
kind: Theme
metadata:
  name: theme-earth
  annotations:
    "store.halo.run/app-id": "app-KgWqR"
     # 推荐安装 app-SnwWD（瞬间），app-sqpgf（highlight.js 代码高亮）
    "store.halo.run/recommend-apps": ["app-SnwWD", "app-sqpgf"]
     # 依赖 app-UpUJA（编辑器超链接卡片）
    "store.halo.run/required-apps": ["app-UpUJA"]
spec:
  displayName: Earth
  author:
    name: Halo
    website: https://www.halo.run
  description: Default theme for Halo 2.0
  logo: https://www.halo.run/logo
  homepage: https://www.halo.run/store/apps/app-KgWqR
  repo: https://github.com/halo-dev/theme-earth
  issues: https://github.com/halo-dev/theme-earth/issues
  settingName: "theme-earth-setting"
  configMapName: "theme-earth-configMap"
  version: 1.12.1
  requires: ">=2.20.0"
  license:
    - name: "GPL-3.0"
      url: "https://github.com/halo-dev/theme-earth/blob/main/LICENSE"

说明：

1. store.halo.run/recommend-apps：推荐应用的定义，为应用市场应用 id 的数组。
2. store.halo.run/required-apps：依赖应用的定义，为应用市场应用 id 的数组。

最终用户在应用市场安装这个主题之后，会解析这个定义，然后判断是否已经安装，如果有未安装的应用，会根据应用 id 显示出所需的应用，引导用户安装。

疑问

Q1. 为什么不直接在插件/主题定义的 spec 中定义依赖？

因为 Halo 并不依赖应用市场插件，应用市场插件应该始终为可选，用户可以自行决定是否要使用应用市场插件，所以我认为放在 spec 中并不合适，这需要修改 Halo 本身的代码。

Q2. 为什么插件有了 spec.pluginDependencies 字段，还需要单独定义这两个元数据？

这只是底层插件机制的依赖，如果按照这个字段去实现，以目前应用市场的系统设计无法完成，并且可能仍然需要为应用市场插件去修改 Halo 的代码，这可能会导致强依赖。我认为 store.halo.run/recommend-apps 和 store.halo.run/required-apps 并不需要和 spec.pluginDependencies 有关联，这应该让开发者自行决定。

相关讨论

1. https://github.com/orgs/halo-dev/discussions/7007
2. 主题支持配置依赖插件 #2296

参考：

1. VSCode 插件依赖定义：https://code.visualstudio.com/api/references/extension-manifest#:~:text=vscode.csharp.-,extensionDependencies,-array
2. VSCode 项目插件推荐定义：https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions

[guqing]

在应用市场获取插件定义的这个字段即可

halo/api/src/main/java/run/halo/app/core/extension/Plugin.java

Line 75 in 568c7d2

private Map<String, String> pluginDependencies = new HashMap<>(4);

没有必要单独去定义annotation ， key以？结尾表示可选依赖推荐安装，否则为必装依赖

示例参考：

https://github.com/halo-sigs/plugin-moments/blob/a6d3491c14385fe82ca861a777e216f2a91ed1f7/src/main/resources/plugin.yaml#L23

如果是主题则可能得使用另外的方式，这两者可以分开识别，但定义推荐可能还是需要考虑版本范围的约束

[guqing]

以前没有做唯一限制，并且做这个限制可能需要单独区分主题和插件，我们没有理由不允许主题和插件不能同名，并且即便应用市场以 metadata.name 为唯一标识，仍然不能避免市面上出现相同的 metadata.name。所以如果要使用应用市场，那么定义一个 app id 来区分不同应用也是合理的。

app id 这个是需要的，和之前一致， 应用市场出一个api 可以根据 metadata.name 查询插件并给出版本列表，如果插件具有app id 那么可以在应用市场或者插件列表根据插件名称查询 pluginDependencies 中定义的插件弹出来让用户安装，获取到版本列表是关于根据插件定义的依赖插件版本范围过滤掉那些不符合的版本，主题可以参考这样做，至于应用市场出的api是对主题和插件出两个api还是出一个api通过不同参数区别暂不在此讨论

假如区分插件或主题的字段叫 type 或许可以根据 type 和 metadata.name 创建一个组合唯一索引，然后能通过 api 根据 type 和 metadata.name来得到对应 type 的应用信息和版本列表

[ruibaby]

要做那就按照相同的方式，此外我也赞成通过 metadata.name 来做应用市场的唯一标识，最好是参考 VSCode 拓展市场或者 npm，支持通过 scope + id 来组成唯一标识，比如 Halo 在 VSCode 发布了一个插件，它的唯一标识就是读取的 package.json 中定义的 publisher + name（halo-dev.halo），我不确定 Halo 是否可以满足这样的改动，目前没有强制规定 metadata.name，抛开这个问题也是非常容易重复的。

此外，Halo 应用市场目前没有保存 metadata.name，以前提出过在创建应用或者发布版本的时候支持解析插件和主题制品的定义文件并持久化。目前版本号和 requires 等信息都是手动填写，如果还要手动填写 metadata.name 也是比较麻烦的，本身这种信息手动填写也并不可靠。

[guqing]

目前没有强制规定 metadata.name，抛开这个问题也是非常容易重复的。

插件和主题都有 metadata.name 所以需要按照 type 来确定唯一，只要保证同一个 type 下 metadata.name 是唯一的即可，比如 type=plugin,metadata.name=halo，type=theme,metadata.name=halo 是可以同时存在的,然后可以根据比如 /apis/store.halo.run/v1alpha1/apps?type=plugin&name=halo 这样的 API 来获取名为 halo 的插件的信息

[guqing]

@JohnNiang any idea?

[JohnNiang]

我推荐在 metadata.annotations 中添加应用市场依赖关系。和 spec.pluginDependencies 不同，它只涉及到应用本身，和主题/插件无关。