dsh-jira-tasks 1.0.8 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.en.md +23 -15
- package/README.md +16 -11
- package/lib/client.js +50 -41
- package/lib/index.js +79 -28
- package/package.json +5 -2
package/README.en.md
CHANGED
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
Shows the current JIRA project's **open / reopened** issues **assigned to the current user** below the DSH composer input. The JIRA base URL and token are configured in **Settings → Plugins → JIRA** (`JIRA_BASE_URL` / `JIRA_API_TOKEN` act as fallback); the project key and JQL are **configured per workspace** and persisted.
|
|
8
8
|
|
|
9
|
+
> **DSH version targeted: 0.1.7 (verified on `0.1.7-rc.2`).** The client slots `conversation.input.dock` / `plugins.item`, the settings service `ctx.configForms` (namespace = profile entry id `jira-tasks`), and the `ctx.effect` / `configForms.whileServed` disposal contracts all follow the 0.1.7 interfaces; the 0.1.6-era `settingsScope` / `settings.register` / `settings.plugin.item` APIs are gone and no longer used.
|
|
10
|
+
|
|
9
11
|
## Features
|
|
10
12
|
|
|
11
13
|
- 📋 Panel shown below the composer in both new and active sessions (aligned with the input width in new sessions)
|
|
@@ -33,6 +35,10 @@ dsh plugin --profile web add github:liu3734/jira-tasks-dsh-plugin
|
|
|
33
35
|
|
|
34
36
|
**Restart DSH** to activate.
|
|
35
37
|
|
|
38
|
+
> **Nothing shows up? Check `dsh.profile.bundles` first.** DSH mounts this package as a profile layer only when `"dsh-jira-tasks"` is listed in `dsh.profile.bundles` of `~/.dsh/profiles/web/package.json`; being in `dependencies` alone is not enough — the startup log then prints `patch: entry "jira-tasks" not found` and the plugin silently never loads. `dsh plugin --profile web add` normally appends that row, but it will not re-append when the package is already a dependency; add `"dsh-jira-tasks"` to `dsh.profile.bundles` by hand.
|
|
39
|
+
|
|
40
|
+
> Using GitHub Packages instead: configure `@liu3734:registry=https://npm.pkg.github.com/` plus a read token in the profile's `.npmrc`, then run `dsh plugin --profile web add @liu3734/dsh-jira-tasks`.
|
|
41
|
+
|
|
36
42
|
<details>
|
|
37
43
|
<summary>Manual install (without npm)</summary>
|
|
38
44
|
|
|
@@ -58,10 +64,10 @@ In a DSH session, use the Cordis tools: `cordis_define` (`kind: new`, `idPrefix:
|
|
|
58
64
|
|
|
59
65
|
Open **Settings → Plugins → Plugin configuration → JIRA** and fill in:
|
|
60
66
|
|
|
61
|
-
- **JIRA base URL**: e.g. `http://jira.example.com/` (
|
|
67
|
+
- **JIRA base URL**: e.g. `http://jira.example.com/` (written to this plugin entry's `Config.baseUrl` — the `jira-tasks` row in the profile's `cordis.patch.yml` — and read back by the form; a host-refused write now surfaces as an error instead of failing silently)
|
|
62
68
|
- **Access token / PAT**: written to the credential store (`$DSH_HOME/.credentials.yaml`) under the plugin-owned ref `JIRA_TASKS_TOKEN`; the browser only ever sees "configured", never the token itself
|
|
63
69
|
|
|
64
|
-
Leaving the token blank on save keeps the existing one; clearing the address on save removes the override and falls back to the environment. Auth is auto-detected: tokens containing `:` use Basic, otherwise Bearer (JIRA PAT).
|
|
70
|
+
Leaving the token blank on save keeps the existing one; clearing the address on save removes the override and falls back to the credential store / environment. Auth is auto-detected: tokens containing `:` use Basic, otherwise Bearer (JIRA PAT).
|
|
65
71
|
|
|
66
72
|
> **The settings-page token takes precedence over the environment.** When the environment that launched DSH already defines `JIRA_API_TOKEN` (a Windows *user-level* variable counts), the card is still editable: it stores the token in its own ref `JIRA_TASKS_TOKEN`, which DSH accepts (it only refuses to write a ref the launching environment shadows), and the Host resolves tokens in this order:
|
|
67
73
|
>
|
|
@@ -79,7 +85,7 @@ The card's footer carries a status light and a **Test connection** button:
|
|
|
79
85
|
- **Green** = address and token work (the current user is shown); **red** = unusable (JIRA's reason, e.g. 401, is shown); **grey** = address or token not configured
|
|
80
86
|
- **Test connection** probes what is currently in the fields, saved or not, so you can check before saving
|
|
81
87
|
|
|
82
|
-
Environment variables / credentials still work as a **fallback** (used when the settings card
|
|
88
|
+
Environment variables / credentials still work as a **fallback** (used when the settings card leaves `baseUrl` empty), hot-reloaded without a restart. Address precedence is `Config.baseUrl` > `JIRA_BASE_URL` > `JIRA_URL`, and `JIRA_BASE_URL` may live in the launching environment or in `.credentials.yaml` — note that a stale record (e.g. an old domain left in the credential file) becomes effective again as soon as the settings page clears the address:
|
|
83
89
|
|
|
84
90
|
```yaml
|
|
85
91
|
JIRA_BASE_URL: "http://jira.example.com/"
|
|
@@ -140,7 +146,9 @@ JIRA_TASKS_TOKEN (settings card) > JIRA_API_TOKEN > JIRA_TOKEN
|
|
|
140
146
|
<summary>Panel does not appear</summary>
|
|
141
147
|
|
|
142
148
|
- Make sure it is installed and DSH was **restarted**; in new sessions the panel sits below the input
|
|
143
|
-
- Check the
|
|
149
|
+
- Check that `dsh.profile.bundles` in `~/.dsh/profiles/web/package.json` lists `"dsh-jira-tasks"` (the most common cause of a silent no-show — see the Install note)
|
|
150
|
+
- Check the DSH startup log: `patch: entry "jira-tasks" not found` means the profile layer was never composed; `webserver: duplicate exact route` means a route was registered twice (the plugin releases its routes through `ctx.effect`, so this points at a second copy)
|
|
151
|
+
- A browser console error `client-modules: could not load "dsh-jira-tasks"` means `/plugins/dsh-jira-tasks/client.js` was not served — confirm `exports["./client"]` resolves to the built `lib/client.js`
|
|
144
152
|
</details>
|
|
145
153
|
|
|
146
154
|
## Architecture & Implementation Details
|
|
@@ -149,21 +157,21 @@ JIRA_TASKS_TOKEN (settings card) > JIRA_API_TOKEN > JIRA_TOKEN
|
|
|
149
157
|
<summary>Expand</summary>
|
|
150
158
|
|
|
151
159
|
```
|
|
152
|
-
|
|
153
|
-
│ conversation.
|
|
154
|
-
│
|
|
155
|
-
│
|
|
156
|
-
│ render: list / error / unconfigured
|
|
157
|
-
│ localStorage per-workspace key/JQL
|
|
158
|
-
│
|
|
159
|
-
|
|
160
|
+
┌────────────── Browser (Client) ──────────────┐ ┌─────────────── Host ───────────────┐
|
|
161
|
+
│ conversation.input.dock (both states) │ │ webServer route /jira/api/search │
|
|
162
|
+
│ CSS order:99 -> below the input, full width │ │ entry Config.baseUrl (volatile) │
|
|
163
|
+
│ on mount/refresh: fetch POST │ │ credentials.resolve(TOKEN_REFS) │
|
|
164
|
+
│ render: list / error / unconfigured │ │ subprocess.spawn(curl ...) │
|
|
165
|
+
│ localStorage: per-workspace key/JQL │ │ parse stdout JSON │
|
|
166
|
+
│ plugins.item (Settings card) │ │ return {ok, issues} │
|
|
167
|
+
└──────────────────────────────────────────────┘ └────────────────────────────────────┘
|
|
160
168
|
└────────────────────────────────┘
|
|
161
169
|
```
|
|
162
170
|
|
|
163
|
-
- **Host**:
|
|
164
|
-
- **Client**: a standard `window.__ModuleLoader__.load({ id, factory })` web bundle
|
|
171
|
+
- **Host**: declares the entry's own `Config` (`baseUrl`, `volatile` — since DSH 0.1.5 a settings page is built from it; `settings.configure({ auto: false }, ctx.fiber)` turns the auto-generated page off and hands its disposer back to `ctx.effect`) plus `webServer` routes `POST /jira/api/search` and `POST /jira/api/test`, each wrapped in its own `ctx.effect` (a reload otherwise hits "duplicate route" and fails activation; non-POST requests get 405); the token comes from the `credentials` service resolved in the order `JIRA_TASKS_TOKEN` (written by the Settings card) → `JIRA_API_TOKEN` → `JIRA_TOKEN` (`$DSH_HOME/.credentials.yaml` / environment, hot-reloaded), so a saved card token overrides the environment; queries run through `subprocess` spawning `curl` directly, with the auth header passed via stdin (`--config -`) so the token never appears in argv.
|
|
172
|
+
- **Client**: a standard `window.__ModuleLoader__.load({ id, factory })` web bundle requiring only `"react"`; registers **only `conversation.input.dock`** (`order: 10`) — that seat renders in both new and active sessions and is a full-width row of `composerStack` (`flex-direction: column`), where the panel's own CSS `order: 99` places it below the input card at the card's width. `conversation.composer.dock` is deliberately NOT used: in 0.1.7 it renders into InputBar's `.dock` **row**, side by side with the context meter, so a full-width panel there gets its right-hand content covered by the meter. Also registers the plugin configuration card on `plugins.item` (`id: "jira-tasks"`) — the address form comes from `ctx.configForms.get("jira-tasks")` and the token is written through `remote.credentials` to `JIRA_TASKS_TOKEN`; `configForms.whileServed` keeps it hidden when the host serves no such namespace. The card's `summary` view is rendered by a dispatcher that calls **no hooks**, while the form lives in a separate `JiraSettingsPage`, so flipping `view` on one mounted instance never changes its hook count.
|
|
165
173
|
- **Why not the `shell` service**: `shell` wraps commands with `sandbox-exec`, which is broken on some macOS versions (`sandbox_apply: Operation not permitted`); `subprocess` is the raw process seam without this issue.
|
|
166
|
-
- **
|
|
174
|
+
- **One registration covers both states**: `conversation.input.dock` renders whenever a session and its input exist, so new and active sessions need no separate registrations (the older `composer.dock` + blank-session de-duplication was both unnecessary under 0.1.7 and the cause of the meter-row collision).
|
|
167
175
|
|
|
168
176
|
**Differences from the dynamic version**
|
|
169
177
|
|
package/README.md
CHANGED
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
在 DSH 会话**输入框下方**展示当前 JIRA 项目**指派给当前用户**的「开启 / 重新开启」任务列表。JIRA 地址与令牌在**设置 → 插件 → JIRA** 中配置(`JIRA_BASE_URL` / `JIRA_API_TOKEN` 作为回退);项目 Key 与 JQL **按工作区配置**并持久化。
|
|
8
8
|
|
|
9
|
+
> **适配的 DSH 版本:0.1.7(`0.1.7-rc.2` 实测)。** 客户端槽位 `conversation.input.dock` / `plugins.item`、设置服务 `ctx.configForms`(命名空间 = profile 条目 id `jira-tasks`)、`ctx.effect` / `configForms.whileServed` 的注销契约均按 0.1.7 的接口实现;0.1.6 及更早版本的 `settingsScope` / `settings.register` / `settings.plugin.item` 已不再使用。
|
|
10
|
+
|
|
9
11
|
## 功能
|
|
10
12
|
|
|
11
13
|
- 📋 新会话与活跃会话的输入框下方均展示任务面板(新会话时与输入框等宽)
|
|
@@ -42,6 +44,8 @@ dsh plugin --profile web add github:liu3734/jira-tasks-dsh-plugin
|
|
|
42
44
|
|
|
43
45
|
**重启 DSH** 后生效。
|
|
44
46
|
|
|
47
|
+
> **装完没反应?先查 `dsh.profile.bundles`。** DSH 只有当 `~/.dsh/profiles/web/package.json` 的 `dsh.profile.bundles` 里列了 `"dsh-jira-tasks"` 时才把本包当作 profile 层挂载;只出现在 `dependencies` 里不够——此时启动日志会打 `patch: entry "jira-tasks" not found`,插件静默不加载。`dsh plugin --profile web add` 一般会补上这一行,但该包已在 `dependencies` 中时重装不会重新补,手动往 `dsh.profile.bundles` 追加 `"dsh-jira-tasks"` 即可。
|
|
48
|
+
|
|
45
49
|
> 若改用 GitHub Packages 源:先在 profile 的 `.npmrc` 配置 `@liu3734:registry=https://npm.pkg.github.com/` 及读取令牌,再执行 `dsh plugin --profile web add @liu3734/dsh-jira-tasks`。
|
|
46
50
|
|
|
47
51
|
<details>
|
|
@@ -69,10 +73,10 @@ dsh plugin --profile web add github:liu3734/jira-tasks-dsh-plugin
|
|
|
69
73
|
|
|
70
74
|
打开 **设置 → 插件 → 插件配置 → JIRA**,填写:
|
|
71
75
|
|
|
72
|
-
- **JIRA 地址**:如 `http://jira.example.com
|
|
76
|
+
- **JIRA 地址**:如 `http://jira.example.com/`(写入本插件 profile 条目 `jira-tasks` 的 `Config.baseUrl`,即 profile 的 `cordis.patch.yml`,可在界面回读;保存被宿主拒绝时会直接报错,不会静默失败)
|
|
73
77
|
- **访问令牌 / PAT**:写入凭据存储(`$DSH_HOME/.credentials.yaml`,引用名是插件自有的 `JIRA_TASKS_TOKEN`),前端只显示"已配置",不回传令牌本身
|
|
74
78
|
|
|
75
|
-
|
|
79
|
+
留空并保存会保持已有令牌不变;地址留空并保存则清除设置项,回退到凭据存储 / 环境变量。认证自动识别:令牌含 `:` 用 Basic,否则用 Bearer(JIRA PAT)。
|
|
76
80
|
|
|
77
81
|
> **设置页令牌优先于环境变量**:启动 DSH 的环境里已有 `JIRA_API_TOKEN`(Windows 用户级环境变量也算)时,卡片照常可以输入并保存——保存的是插件自有引用 `JIRA_TASKS_TOKEN`,DSH 不会拒绝(它只拒绝写入会被环境遮蔽的同名引用),Host 解析时也把它排在环境变量之前:
|
|
78
82
|
>
|
|
@@ -90,7 +94,7 @@ dsh plugin --profile web add github:liu3734/jira-tasks-dsh-plugin
|
|
|
90
94
|
- **绿** = 地址与令牌可用(并显示当前登录用户);**红** = 不可用(显示 JIRA 返回的原因,如 401 认证失败);**灰** = 地址或令牌未配置
|
|
91
95
|
- 点 **测试连接** 会用**当前输入框里的内容**(未保存也可)立即测试,方便改完再存
|
|
92
96
|
|
|
93
|
-
以下环境变量 /
|
|
97
|
+
以下环境变量 / 凭据仍作为**回退**(设置页未配置 `baseUrl` 时生效,兼容旧部署),热加载无需重启。注意地址的优先级是 `Config.baseUrl` > `JIRA_BASE_URL` > `JIRA_URL`,而 `JIRA_BASE_URL` 既可以从启动环境读,也可以像下面这样存在 `.credentials.yaml` 里——旧域名的记录留在凭据文件里时,设置页一旦清空地址就会回退到它:
|
|
94
98
|
|
|
95
99
|
```yaml
|
|
96
100
|
JIRA_BASE_URL: "http://jira.example.com/"
|
|
@@ -154,7 +158,9 @@ JIRA_TASKS_TOKEN(设置页) > JIRA_API_TOKEN > JIRA_TOKEN
|
|
|
154
158
|
<summary>面板不显示</summary>
|
|
155
159
|
|
|
156
160
|
- 确认已安装并**重启 DSH**;新会话面板位于输入框下方
|
|
157
|
-
- 检查
|
|
161
|
+
- 检查 `~/.dsh/profiles/web/package.json` 的 `dsh.profile.bundles` 是否包含 `"dsh-jira-tasks"`(这是最常见的漏装原因,见「安装」一节的提示)
|
|
162
|
+
- 检查 DSH 启动日志:出现 `patch: entry "jira-tasks" not found` 即为 profile 层未挂载;出现 `webserver: duplicate exact route` 说明同一路由被注册了两次(插件自身已用 `ctx.effect` 释放旧路由,若仍有说明有第二份副本)
|
|
163
|
+
- 浏览器控制台若报 `client-modules: could not load "dsh-jira-tasks"`,说明 `/plugins/dsh-jira-tasks/client.js` 没取到——确认 `package.json` 的 `exports["./client"]` 指向已构建的 `lib/client.js`
|
|
158
164
|
</details>
|
|
159
165
|
|
|
160
166
|
## 架构与实现细节
|
|
@@ -164,20 +170,19 @@ JIRA_TASKS_TOKEN(设置页) > JIRA_API_TOKEN > JIRA_TOKEN
|
|
|
164
170
|
|
|
165
171
|
```
|
|
166
172
|
┌────────────────────────────────────────┐ ┌────────────────────────────────────┐
|
|
167
|
-
│ conversation.
|
|
168
|
-
│
|
|
169
|
-
│ 面板 hero 布局(flex order:99) │ │ settings.get("jira-tasks").baseUrl │
|
|
173
|
+
│ conversation.input.dock(两种会话) │ │ webServer 路由 /jira/api/search │
|
|
174
|
+
│ CSS order:99 → 输入框下方、整宽 │ │ 条目 Config.baseUrl(volatile 引用) │
|
|
170
175
|
│ ↓ 挂载 / 刷新时 fetch POST │ │ credentials.resolve(TOKEN_REFS) │
|
|
171
176
|
│ 渲染:任务列表 / 错误 / 未配置 │ │ subprocess.spawn(curl …) │
|
|
172
177
|
│ localStorage 按工作区存取项目 Key/JQL │ │ ↓ stdout JSON │
|
|
173
|
-
│
|
|
178
|
+
│ plugins.item(设置页卡片) │ │ 解析 issues → 返回 {ok,issues} │
|
|
174
179
|
└────────────────────────────────────────┘ └────────────────────────────────────┘
|
|
175
180
|
```
|
|
176
181
|
|
|
177
|
-
- **Host
|
|
178
|
-
- **Client**:`window.__ModuleLoader__.load({ id, factory })` 标准 web bundle
|
|
182
|
+
- **Host**:声明条目自身的 `Config`(`baseUrl`,`volatile`,DSH 0.1.5 起设置页的表单直接来自它;`settings.configure({ auto: false }, ctx.fiber)` 关掉自动生成页,并把返回的注销函数交回 `ctx.effect`)与 `webServer` 路由 `POST /jira/api/search`、`POST /jira/api/test`(两条路由各自包在 `ctx.effect` 里,卸载/重载时先释放,否则重挂载会撞上「重复路由」直接抛错;非 POST 返回 405);令牌经 `credentials` 服务按 `JIRA_TASKS_TOKEN`(设置页写入)→ `JIRA_API_TOKEN` → `JIRA_TOKEN` 的顺序解析(`$DSH_HOME/.credentials.yaml` / 环境变量,热加载),因此设置页保存的令牌能覆盖环境变量;查询用 `subprocess` 直接 `spawn curl`,认证头经 stdin(`--config -`)传入,令牌不进入命令行参数。
|
|
183
|
+
- **Client**:`window.__ModuleLoader__.load({ id, factory })` 标准 web bundle,仅 `require("react")`;**只注册 `conversation.input.dock` 一处**(`order: 10`)。该槽位在新会话与活跃会话下都会渲染,属于 `composerStack`(`flex-direction: column`)的整宽纵向行;面板元素自身 `flex order: 99` 排到输入卡之后,即输入框下方,并以 `--dsh-composer-side-clearance` / `--dsh-composer-card-max-width` 与输入卡等宽。之所以不用 `conversation.composer.dock`:0.1.7 里那一槽位渲染进 InputBar 的 `.dock`**横向** flex 行,与上下文占用环并排,整宽面板会被占用环压住右侧内容。插件配置卡片注册到 `plugins.item`(`id: "jira-tasks"`),表单来自 `ctx.configForms.get("jira-tasks")`(地址)与 `remote.credentials`(令牌写入 `JIRA_TASKS_TOKEN`),并用 `configForms.whileServed` 保证宿主未提供该命名空间时不显示;`plugins.item` 的摘要位由一个**不调用任何 hook** 的分发组件负责,表单在独立的 `JiraSettingsPage` 里,避免同一实例在 `view` 切换时改变 hook 数量。
|
|
179
184
|
- **为什么不用 `shell` 服务**:`shell` 会套 `sandbox-exec`,部分 macOS 上不可用(`sandbox_apply: Operation not permitted`);`subprocess` 是原始进程缝,无此问题。
|
|
180
|
-
-
|
|
185
|
+
- **一处注册覆盖两种会话**:`conversation.input.dock` 只要有 session + input 就会渲染,新会话与活跃会话无需分别注册(旧版曾用 `composer.dock` + 空白判定去重,0.1.7 下既不必要、又会与占用环抢同一行)。
|
|
181
186
|
|
|
182
187
|
**与动态插件版的差异**
|
|
183
188
|
|
package/lib/client.js
CHANGED
|
@@ -8,6 +8,7 @@ window.__ModuleLoader__.load({
|
|
|
8
8
|
var h = React.createElement;
|
|
9
9
|
|
|
10
10
|
var CSS = ".jt-root{box-sizing:border-box;width:100%;padding:2px 0 6px;flex:none;display:flex;flex-direction:column}"
|
|
11
|
+
+ "/* composerStack 是 flex-direction:column:order:99 把面板排到输入卡之后,即输入框下方。 */"
|
|
11
12
|
+ ".jt-hero{order:99;padding:0 var(--dsh-composer-side-clearance, 16px)}"
|
|
12
13
|
+ ".jt-panel{box-sizing:border-box;width:100%;max-width:var(--dsh-composer-card-max-width, 780px);margin:0 auto;border:1px solid var(--dsw-alias-border-l1, rgba(127,127,127,.28));background:var(--dsw-alias-bg-layer-1, rgba(127,127,127,.07));border-radius:10px;overflow:hidden}"
|
|
13
14
|
+ ".jt-header{display:flex;align-items:center;gap:8px;min-height:30px;padding:2px 6px 2px 4px}"
|
|
@@ -95,15 +96,6 @@ window.__ModuleLoader__.load({
|
|
|
95
96
|
persistAll(all);
|
|
96
97
|
}
|
|
97
98
|
|
|
98
|
-
// 新版 DSH:SessionSnapshot.blank 是“会话日志为空”的规范标记;旧版 DSH:消息位于 chat.timeline / chat.legacy.nodes。
|
|
99
|
-
function hasMessages(session) {
|
|
100
|
-
if (!session) return false;
|
|
101
|
-
if (typeof session.blank === "boolean") return !session.blank;
|
|
102
|
-
if (session.chat && session.chat.timeline && session.chat.timeline.length > 0) return true;
|
|
103
|
-
if (session.chat && session.chat.legacy && session.chat.legacy.nodes && session.chat.legacy.nodes.length > 0) return true;
|
|
104
|
-
return false;
|
|
105
|
-
}
|
|
106
|
-
|
|
107
99
|
function query(projectKey, jql) {
|
|
108
100
|
return fetch("/jira/api/search", {
|
|
109
101
|
method: "POST",
|
|
@@ -122,7 +114,6 @@ window.__ModuleLoader__.load({
|
|
|
122
114
|
}
|
|
123
115
|
|
|
124
116
|
function JiraTasksDock(props) {
|
|
125
|
-
var blankOnly = !!(props && props.blankOnly === true);
|
|
126
117
|
var useWorkspaces = props && typeof props.useWorkspaces === "function" ? props.useWorkspaces : null;
|
|
127
118
|
var sessionId = props && props.sessionId;
|
|
128
119
|
var wsState = useWorkspaces ? useWorkspaces(function (s) { return s; }) : null;
|
|
@@ -173,8 +164,9 @@ window.__ModuleLoader__.load({
|
|
|
173
164
|
return function () { cancelled = true; };
|
|
174
165
|
}, [config, tick]);
|
|
175
166
|
|
|
176
|
-
|
|
177
|
-
|
|
167
|
+
// 面板只注册 conversation.input.dock 一处(见 apply 里的说明):
|
|
168
|
+
// 该槽位在“新会话”和“活跃会话”下都会渲染,且是整行纵向排布的元素,
|
|
169
|
+
// 因此这里没有“仅空白会话显示”的分支,也不需要去重。
|
|
178
170
|
function openEditor() {
|
|
179
171
|
setDraftKey(config.projectKey);
|
|
180
172
|
setDraftJql(config.jql || defaultJql(config.projectKey));
|
|
@@ -187,10 +179,8 @@ window.__ModuleLoader__.load({
|
|
|
187
179
|
setEditing(false);
|
|
188
180
|
}
|
|
189
181
|
|
|
190
|
-
var heroLayout = blankOnly;
|
|
191
|
-
|
|
192
182
|
if (editing) {
|
|
193
|
-
return h("div", { className:
|
|
183
|
+
return h("div", { className: "jt-root jt-hero" },
|
|
194
184
|
h("div", { className: "jt-panel" },
|
|
195
185
|
h("div", { className: "jt-header" }, h("span", { className: "jt-title" }, "JIRA 任务设置")),
|
|
196
186
|
h("div", { className: "jt-body" },
|
|
@@ -260,7 +250,7 @@ window.__ModuleLoader__.load({
|
|
|
260
250
|
body = h("div", { className: "jt-hint" }, "未设置 JIRA 项目 Key,", h("button", { className: "jt-linklike", onClick: openEditor }, "点击配置"));
|
|
261
251
|
}
|
|
262
252
|
|
|
263
|
-
return h("div", { className:
|
|
253
|
+
return h("div", { className: "jt-root jt-hero" },
|
|
264
254
|
h("div", { className: "jt-panel" },
|
|
265
255
|
h("div", { className: "jt-header" },
|
|
266
256
|
h("button", {
|
|
@@ -347,7 +337,11 @@ window.__ModuleLoader__.load({
|
|
|
347
337
|
});
|
|
348
338
|
}
|
|
349
339
|
|
|
350
|
-
|
|
340
|
+
// plugins.item 的两个渲染位:列表里的卡片摘要(view="summary")与点开后的
|
|
341
|
+
// 详情面板(view="page")。分发组件自身不调用任何 hook,钩子全部留在
|
|
342
|
+
// JiraSettingsPage 里,这样同一个实例的 hook 数量与 view 取值无关——
|
|
343
|
+
// 这是 React 的硬性要求,早期版本把摘要提前 return 写在 hook 之前会踩这条规则。
|
|
344
|
+
function JiraSettingsPage() {
|
|
351
345
|
var snapshot = useScopeSnapshot(scope);
|
|
352
346
|
var tokenInfoState = React.useState(null);
|
|
353
347
|
var tokenInfo = tokenInfoState[0], setTokenInfo = tokenInfoState[1];
|
|
@@ -400,7 +394,11 @@ window.__ModuleLoader__.load({
|
|
|
400
394
|
setFailed("");
|
|
401
395
|
var tasks = [];
|
|
402
396
|
if (baseDirty) {
|
|
403
|
-
|
|
397
|
+
// ConfigForm.set/unset 解析为 boolean:false = 宿主拒绝写入或连接处于
|
|
398
|
+
// memory 模式。以前忽略返回值会让面板“看起来保存了”,实际没落盘。
|
|
399
|
+
tasks.push((baseEdit === "" ? scope.unset("baseUrl") : scope.set("baseUrl", baseEdit)).then(function (accepted) {
|
|
400
|
+
if (accepted === false) throw new Error("JIRA 地址保存被宿主拒绝(该命名空间只读,或连接处于 memory 模式)");
|
|
401
|
+
}));
|
|
404
402
|
}
|
|
405
403
|
if (tokenDirty) {
|
|
406
404
|
tasks.push(credentials.set(TOKEN_REF, tokenDraftText).then(function (res) {
|
|
@@ -534,47 +532,58 @@ window.__ModuleLoader__.load({
|
|
|
534
532
|
h("button", { className: "jt-btn jt-btn-primary", disabled: !dirty || busy || (baseDirty && !writable) || (tokenDirty && !tokenWritable), onClick: save }, busy ? "保存中…" : "保存")
|
|
535
533
|
)
|
|
536
534
|
);
|
|
535
|
+
}
|
|
536
|
+
|
|
537
|
+
// 槽位组件:摘要位只回一行文字,详情位挂载真正的表单。
|
|
538
|
+
return function JiraSettingsCard(props) {
|
|
539
|
+
if (props && props.view === "summary") return "JIRA 地址、令牌与连接状态";
|
|
540
|
+
return h(JiraSettingsPage, null);
|
|
537
541
|
};
|
|
538
542
|
}
|
|
539
543
|
|
|
540
544
|
function apply(ctx) {
|
|
541
545
|
// ctx.effect(cb) 会立即执行 cb 并把其返回值作为卸载时的清理函数,
|
|
542
546
|
// 所以样式注入必须放在回调内、返回移除函数,否则标签刚插入就被删除。
|
|
543
|
-
|
|
544
|
-
ctx.effect(function () {
|
|
545
|
-
var styleTag = document.createElement("style");
|
|
546
|
-
styleTag.textContent = CSS;
|
|
547
|
-
document.head.appendChild(styleTag);
|
|
548
|
-
return function () { try { styleTag.remove(); } catch (e) {} };
|
|
549
|
-
});
|
|
550
|
-
} else {
|
|
547
|
+
ctx.effect(function () {
|
|
551
548
|
var styleTag = document.createElement("style");
|
|
552
549
|
styleTag.textContent = CSS;
|
|
553
550
|
document.head.appendChild(styleTag);
|
|
554
|
-
|
|
551
|
+
return function () { try { styleTag.remove(); } catch (e) {} };
|
|
552
|
+
}, "jira-tasks: styles");
|
|
555
553
|
var slots = ctx.get("slots");
|
|
556
554
|
if (!slots) return;
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
555
|
+
// 只注册 conversation.input.dock 一处。
|
|
556
|
+
//
|
|
557
|
+
// 为什么不用 conversation.composer.dock:该槽位在 DSH 0.1.7 里渲染进
|
|
558
|
+
// InputBar 的 .dock 行——一个 justify-content:center 的**横向** flex 行,
|
|
559
|
+
// 与右侧的上下文占用环(ContextMeter)并排。整宽任务面板放进那一行,会和
|
|
560
|
+
// 占用环抢同一条 flex line,面板右侧内容被环压住。
|
|
561
|
+
//
|
|
562
|
+
// conversation.input.dock 属于 composerStack(flex-direction:column),
|
|
563
|
+
// 在新会话与活跃会话下都会渲染(只要有 session + input),是整宽纵向行;
|
|
564
|
+
// 面板自身用 CSS order:99 排到输入卡之后,即“输入框下方”。
|
|
560
565
|
slots.inject("conversation.input.dock", function () {
|
|
561
|
-
return slots.register({ name: "conversation.input.dock", id: "jira-open-tasks
|
|
562
|
-
return h(JiraTasksDock, Object.assign({}, props, { blankOnly: true }));
|
|
563
|
-
});
|
|
566
|
+
return slots.register({ name: "conversation.input.dock", id: "jira-open-tasks", order: 10 }, JiraTasksDock);
|
|
564
567
|
});
|
|
565
568
|
|
|
566
|
-
//
|
|
567
|
-
|
|
569
|
+
// 设置页卡片。DSH 0.1.5+ :设置表单的服务是 configForms,命名空间就是本插件
|
|
570
|
+
// 的 profile 条目 id(jira-tasks);卡片注册到“插件”页的 plugins.item 槽,
|
|
571
|
+
// 并且只在宿主确实提供了该命名空间时才出现(whileServed 的 disposer 交回 effect)。
|
|
572
|
+
var configForms = ctx.get("configForms");
|
|
568
573
|
var remote = ctx.get("remote");
|
|
569
|
-
if (
|
|
570
|
-
var card = createJiraSettingsCard(
|
|
571
|
-
|
|
572
|
-
return
|
|
573
|
-
|
|
574
|
+
if (configForms && remote && remote.credentials) {
|
|
575
|
+
var card = createJiraSettingsCard(configForms.get(SETTINGS_NS), remote.credentials);
|
|
576
|
+
ctx.effect(function () {
|
|
577
|
+
return configForms.whileServed([SETTINGS_NS], function () {
|
|
578
|
+
return slots.inject("plugins.item", function () {
|
|
579
|
+
return slots.register({ name: "plugins.item", id: SETTINGS_NS, order: 41, label: "JIRA" }, card);
|
|
580
|
+
});
|
|
581
|
+
});
|
|
582
|
+
}, "jira-tasks: plugins page card");
|
|
574
583
|
}
|
|
575
584
|
}
|
|
576
585
|
|
|
577
|
-
exports.inject = ["slots", "
|
|
586
|
+
exports.inject = ["slots", "configForms", "remote", "remote.credentials"];
|
|
578
587
|
exports.apply = apply;
|
|
579
588
|
return module.exports;
|
|
580
589
|
}
|
package/lib/index.js
CHANGED
|
@@ -1,17 +1,26 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* dsh-jira-tasks — HOST half (persistent profile plugin).
|
|
3
|
-
* Serves POST /jira/api/search: reads the JIRA base URL from
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* issue JSON.
|
|
3
|
+
* Serves POST /jira/api/search: reads the JIRA base URL from this entry's own
|
|
4
|
+
* Config (the `jira-tasks` profile entry, editable on the Plugins settings
|
|
5
|
+
* page) and the token from the credentials service — the settings-page
|
|
6
|
+
* JIRA_TASKS_TOKEN first, so it overrides an exported JIRA_API_TOKEN /
|
|
7
|
+
* JIRA_TOKEN — then queries JIRA /rest/api/2/search through subprocess+curl
|
|
8
|
+
* (auth header via stdin --config -), returning normalized issue JSON.
|
|
9
9
|
*/
|
|
10
10
|
import z from '@deepseek-ai/schemastery';
|
|
11
11
|
|
|
12
12
|
/** Settings namespace exposing the editable connection fields in the GUI. */
|
|
13
13
|
const SETTINGS_NS = 'jira-tasks';
|
|
14
14
|
|
|
15
|
+
/**
|
|
16
|
+
* Diagnostics name for this plugin instance. Deliberately the same string as
|
|
17
|
+
* {@link SETTINGS_NS} (= the profile entry id, `jira-tasks`): that id — not this
|
|
18
|
+
* name and not the package name `dsh-jira-tasks` — is the settings namespace the
|
|
19
|
+
* client card edits, so deriving one from the other removes a whole class of
|
|
20
|
+
* confusion when reading loader logs.
|
|
21
|
+
*/
|
|
22
|
+
const name = SETTINGS_NS;
|
|
23
|
+
|
|
15
24
|
/**
|
|
16
25
|
* Token references in precedence order. `JIRA_TASKS_TOKEN` is the plugin-owned
|
|
17
26
|
* ref the settings card writes to: unlike `JIRA_API_TOKEN`, the credentials
|
|
@@ -22,17 +31,41 @@ const SETTINGS_NS = 'jira-tasks';
|
|
|
22
31
|
const TOKEN_REFS = ['JIRA_TASKS_TOKEN', 'JIRA_API_TOKEN', 'JIRA_TOKEN'];
|
|
23
32
|
|
|
24
33
|
/**
|
|
25
|
-
* Durable connection schema.
|
|
26
|
-
*
|
|
27
|
-
*
|
|
34
|
+
* Durable connection schema. Since DSH 0.1.5 the settings service no longer
|
|
35
|
+
* takes a `register(ns, schema)` call: a plugin's OWN Config IS the form its
|
|
36
|
+
* settings page is built from, keyed by the profile entry id (`jira-tasks`).
|
|
37
|
+
* `baseUrl` is volatile, so a saved change reaches the running plugin without
|
|
38
|
+
* remounting it. The token is deliberately NOT here — it stays in the
|
|
39
|
+
* credentials store (write-only from the client), so no secret ever lands in
|
|
40
|
+
* the profile configuration document.
|
|
28
41
|
*/
|
|
29
|
-
const
|
|
30
|
-
baseUrl: z.string().default('').description('JIRA 地址,例如 http://jira.example.com/')
|
|
42
|
+
const Config = z.object({
|
|
43
|
+
baseUrl: z.string().default('').volatile().description('JIRA 地址,例如 http://jira.example.com/')
|
|
31
44
|
});
|
|
32
45
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
46
|
+
const inject = ['subprocess', 'credentials', 'sandboxPolicy', 'webServer'];
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Answer a non-POST request with 405. `webServer.register` dispatches on the
|
|
50
|
+
* pathname only, so without this guard a stray GET would run a real JIRA
|
|
51
|
+
* query. Returns true when the caller may handle the request.
|
|
52
|
+
* @param req - the HTTP request.
|
|
53
|
+
* @param res - the response the guard writes to on refusal.
|
|
54
|
+
* @returns true for POST, false after answering 405.
|
|
55
|
+
*/
|
|
56
|
+
function methodIsPost(req, res) {
|
|
57
|
+
if (req.method === 'POST') return true;
|
|
58
|
+
res.writeHead(405, { 'Content-Type': 'text/plain; charset=utf-8', 'Cache-Control': 'no-store', Allow: 'POST' });
|
|
59
|
+
res.end('method not allowed');
|
|
60
|
+
return false;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* Mount the host half: the /jira/api/* routes and the settings-page policy.
|
|
65
|
+
* @param ctx - plugin context.
|
|
66
|
+
* @param config - this entry's live Config (profile entry `jira-tasks`).
|
|
67
|
+
*/
|
|
68
|
+
function apply(ctx, config) {
|
|
36
69
|
const sendJson = (res, obj) => {
|
|
37
70
|
res.writeHead(200, { 'Content-Type': 'application/json; charset=utf-8', 'Cache-Control': 'no-store' });
|
|
38
71
|
res.end(JSON.stringify(obj));
|
|
@@ -65,19 +98,32 @@ export default {
|
|
|
65
98
|
return undefined;
|
|
66
99
|
}
|
|
67
100
|
|
|
68
|
-
//
|
|
69
|
-
//
|
|
101
|
+
// DSH 0.1.5+ :设置页的表单直接来自本条目自己的 Config,settings 服务不再有
|
|
102
|
+
// register(ns, schema)。这里把本实例的“自动生成页”关掉,改由客户端注册的
|
|
103
|
+
// 自定义卡片(地址 + 令牌 + 连通性测试)接管。
|
|
104
|
+
// 两个易错点:1) configure 的第二个参数必须是**本插件实例**的 fiber——默认值是
|
|
105
|
+
// settings 服务自己的 fiber,而 describe() 是按 entry.fiber 查策略的,传错不生效;
|
|
106
|
+
// 2) 返回值是注销函数,必须交回 effect,否则卸载后策略会一直挂在死 fiber 上。
|
|
70
107
|
ctx.inject(['settings'], (settingsCtx) => {
|
|
71
|
-
settingsCtx.
|
|
108
|
+
settingsCtx.effect(() => {
|
|
109
|
+
try {
|
|
110
|
+
return settingsCtx.settings.configure({ auto: false }, ctx.fiber);
|
|
111
|
+
} catch (e) {
|
|
112
|
+
// 同一实例重复配置等情况下不阻断插件加载,但要留下可诊断的日志。
|
|
113
|
+
if (ctx.logger && typeof ctx.logger.warn === 'function') {
|
|
114
|
+
ctx.logger.warn('jira-tasks: settings page policy not applied: %s', (e && e.message) || e);
|
|
115
|
+
}
|
|
116
|
+
return undefined;
|
|
117
|
+
}
|
|
118
|
+
}, 'jira-tasks: settings page policy');
|
|
72
119
|
});
|
|
73
120
|
|
|
74
|
-
/**
|
|
121
|
+
/** 本条目 Config 里的 JIRA 地址(volatile 引用),未配置时返回 ''。 */
|
|
75
122
|
function settingsBaseUrl() {
|
|
76
123
|
try {
|
|
77
|
-
const
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
return section && typeof section.baseUrl === 'string' ? section.baseUrl.trim() : '';
|
|
124
|
+
const ref = config && config.baseUrl;
|
|
125
|
+
const value = ref && typeof ref.get === 'function' ? ref.get() : ref;
|
|
126
|
+
return typeof value === 'string' ? value.trim() : '';
|
|
81
127
|
} catch (e) {
|
|
82
128
|
return '';
|
|
83
129
|
}
|
|
@@ -254,28 +300,33 @@ export default {
|
|
|
254
300
|
}
|
|
255
301
|
|
|
256
302
|
if (webServer && typeof webServer.register === 'function') {
|
|
257
|
-
|
|
303
|
+
// 每条路由都必须挂在自己的 effect 上:register 返回注销函数,卸载/重载时先释放,
|
|
304
|
+
// 否则重挂载会因为“同一 (kind, path) 只允许一条路由”直接抛错,整个插件激活失败。
|
|
305
|
+
ctx.effect(() => webServer.register({
|
|
258
306
|
kind: 'exact',
|
|
259
307
|
path: '/jira/api/search',
|
|
260
308
|
handler: async (req, res) => {
|
|
309
|
+
if (!methodIsPost(req, res)) return;
|
|
261
310
|
try {
|
|
262
311
|
sendJson(res, await handleSearch(await readBody(req)));
|
|
263
312
|
} catch (e) {
|
|
264
313
|
sendJson(res, { ok: false, error: String((e && e.message) || e) });
|
|
265
314
|
}
|
|
266
315
|
}
|
|
267
|
-
});
|
|
268
|
-
webServer.register({
|
|
316
|
+
}), 'jira-tasks: /jira/api/search');
|
|
317
|
+
ctx.effect(() => webServer.register({
|
|
269
318
|
kind: 'exact',
|
|
270
319
|
path: '/jira/api/test',
|
|
271
320
|
handler: async (req, res) => {
|
|
321
|
+
if (!methodIsPost(req, res)) return;
|
|
272
322
|
try {
|
|
273
323
|
sendJson(res, await handleTest(await readBody(req)));
|
|
274
324
|
} catch (e) {
|
|
275
325
|
sendJson(res, { ok: false, code: 'error', error: String((e && e.message) || e) });
|
|
276
326
|
}
|
|
277
327
|
}
|
|
278
|
-
});
|
|
328
|
+
}), 'jira-tasks: /jira/api/test');
|
|
279
329
|
}
|
|
280
|
-
|
|
281
|
-
|
|
330
|
+
}
|
|
331
|
+
|
|
332
|
+
export { Config, apply, inject, name };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dsh-jira-tasks",
|
|
3
|
-
"version": "1.0
|
|
4
|
-
"description": "JIRA open tasks panel for DeepSeek Harness (DSH): shows the current user's open/reopened issues below the composer, per-workspace project key, persistent profile bundle.",
|
|
3
|
+
"version": "1.1.0",
|
|
4
|
+
"description": "JIRA open tasks panel for DeepSeek Harness (DSH) 0.1.7: shows the current user's open/reopened issues below the composer, per-workspace project key, persistent profile bundle.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "lib/index.js",
|
|
7
7
|
"exports": {
|
|
@@ -40,7 +40,10 @@
|
|
|
40
40
|
"platform": "web",
|
|
41
41
|
"inject": [
|
|
42
42
|
"@deepseek-ai/dsh-client-ui-conversation",
|
|
43
|
+
"@deepseek-ai/dsh-client-ui-session",
|
|
44
|
+
"@deepseek-ai/dsh-client-ui-workspace",
|
|
43
45
|
"@deepseek-ai/dsh-client-ui-settings",
|
|
46
|
+
"@deepseek-ai/dsh-client-ui-plugin-manager",
|
|
44
47
|
"@deepseek-ai/dsh-api-remotes"
|
|
45
48
|
]
|
|
46
49
|
}
|