dsh-wsl-tool 1.10.1 → 1.10.3

package/index.js

@@ -64,26 +64,37 @@ if (Schema === null) {
  * documents the precedence: this configuration wins, the environment is the
  * deployment default, the built-in defaults are last.
  *
- * `distro` and `timeoutMs` are deliberately absent from the sidebar panel (they
- * are values, not features) but stay here so a patch or a panel could grow a
- * field for them without a schema change.
+ * `distro` and `timeoutMs` are values rather than switches, but they are here so a
+ * patch (or a future row in the panel) can set them without a schema change.
+ *
+ * EVERY field is `.volatile()`, and that is not decoration: DSH's settings service
+ * projects a plugin's config into a form only through `volatileForm()`, which keeps
+ * a field only when its nearest ancestor is marked volatile — a schema without one
+ * contributes no form at all, so the entry never reaches `ctx.settings.describe()`,
+ * its namespace is never served to the browser, and the sidebar panel waits for a
+ * scope that will never arrive. Volatile is also what the platform means by "can be
+ * edited without remounting", which is what the update hook below relies on.
+ *
+ * A volatile field must not sit inside another volatile one, so `tools` is a plain
+ * object whose leaf switches are volatile, not a volatile object.
  */
 export const Config = Schema?.object({
   tools: Schema.object({
-    wsl: Schema.boolean().default(true).description('注册 `wsl` 工具：在 WSL 里执行 Linux 命令。'),
-    path: Schema.boolean().default(true).description('注册 `wsl-path` 工具：Windows 路径与 /mnt/... 互转。'),
-    env: Schema.boolean().default(true).description('注册 `wsl-env` 工具：汇总 WSL 环境能力。'),
-  }).description('要注册哪几个工具。'),
-  backgroundJobs: Schema.boolean().default(true).description('允许 `runInBackground`，由内置 job 工具读回结果。'),
-  translatePaths: Schema.boolean().default(true).description('默认把命令里的 Windows 路径转成 /mnt/...。'),
-  startInSessionWorkspace: Schema.boolean().default(false).description('未传 `workdir` 时从会话工作区开始，而不是 Linux 家目录。'),
-  dangerGuard: Schema.boolean().default(true).description('危险命令必须显式 `allowDangerous` 才放行。关掉后模型可直接删除/分区。'),
-  distro: Schema.string().default('').description('要固定使用的发行版；留空则用系统默认（也可用 DSH_WSL_DISTRO）。'),
-  timeoutMs: Schema.number().default(0).description('默认命令超时毫秒数；0 表示用内置默认（也可用 DSH_WSL_TIMEOUT_MS）。'),
+    wsl: Schema.boolean().default(true).description('注册 `wsl` 工具：在 WSL 里执行 Linux 命令。').volatile(),
+    path: Schema.boolean().default(true).description('注册 `wsl-path` 工具：Windows 路径与 /mnt/... 互转。').volatile(),
+    env: Schema.boolean().default(true).description('注册 `wsl-env` 工具：汇总 WSL 环境能力。').volatile(),
+  }).description('要注册哪几个工具；这三个开关在下次启动 DSH 后生效。'),
+  backgroundJobs: Schema.boolean().default(true).description('允许 `runInBackground`，由内置 job 工具读回结果。').volatile(),
+  translatePaths: Schema.boolean().default(true).description('默认把命令里的 Windows 路径转成 /mnt/...。').volatile(),
+  startInSessionWorkspace: Schema.boolean().default(false).description('未传 `workdir` 时从会话工作区开始，而不是 Linux 家目录。').volatile(),
+  dangerGuard: Schema.boolean().default(true).description('危险命令必须显式 `allowDangerous` 才放行。关掉后模型可直接删除/分区。').volatile(),
+  distro: Schema.string().default('').description('要固定使用的发行版；留空则用系统默认（也可用 DSH_WSL_DISTRO）。').volatile(),
+  timeoutMs: Schema.number().default(0).description('默认命令超时毫秒数；0 表示用内置默认（也可用 DSH_WSL_TIMEOUT_MS）。').volatile(),
 }).description('dsh-wsl 的功能开关与默认值。')
 
 export function apply(ctx, settings = {}) {
-  // Resolved once per mount: a settings change is a restart, not a live edit.
+  // Resolved once per mount. Behaviour reads this object at call time, so the
+  // volatile-update hook below can change it in place without remounting.
   const config = resolveConfig(process.env, settings)
   const runner = createRunner(ctx, config)
   // `ctx` is passed to the `wsl` tool for the optional `jobs` service only
@@ -92,4 +103,20 @@ export function apply(ctx, settings = {}) {
   if (config.tools.wsl) ctx.tools.register(createWslTool({ ctx, config, runner }))
   if (config.tools.path) ctx.tools.register(createWslPathTool({ config, runner }))
   if (config.tools.env) ctx.tools.register(createWslEnvTool({ config, runner }))
+
+  // A volatile edit is written into the same object the loader handed us and then
+  // announced, so re-resolving in place is what makes the behaviour switches
+  // (background jobs, path translation, the guard, workdir, distro, timeout) take
+  // effect without a restart. The three `tools.*` switches are the exception: they
+  // decide which tools were registered, so they need the next start, and the panel
+  // says so on those rows.
+  if (typeof ctx.on === 'function') {
+    ctx.on('loader/volatile-update', () => {
+      try {
+        Object.assign(config, resolveConfig(process.env, settings))
+      } catch (error) {
+        console.error('dsh-wsl-tool: applying a live settings change failed', error)
+      }
+    })
+  }
 }

package/lib/client.js

@@ -163,6 +163,25 @@ window.__ModuleLoader__.load({
       revision: undefined,
     }
 
+    /**
+     * No scope yet — the Host has not listed this namespace, or its `describe()`
+     * round trip is still in flight.
+     *
+     * This is deliberately NOT the unavailable snapshot: a panel that reads "this
+     * DSH does not provide the plugin's settings scope" while it is merely still
+     * waiting sends whoever is debugging it after the wrong thing (measured: it
+     * said exactly that for a namespace the Host was already serving, because the
+     * form had been taken before the round trip settled).
+     */
+    const PENDING_SNAPSHOT = {
+      status: 'loading',
+      value: undefined,
+      base: undefined,
+      user: undefined,
+      writable: false,
+      revision: undefined,
+    }
+
     // ---------------------------------------------------------------- helpers
 
     /** Read one path out of a possibly absent object, never throwing. */
@@ -218,7 +237,7 @@ window.__ModuleLoader__.load({
 
       const read = () => {
         if (scope === undefined || scope === null || typeof scope.getSnapshot !== 'function') {
-          return UNAVAILABLE_SNAPSHOT
+          return PENDING_SNAPSHOT
         }
         try {
           const snapshot = scope.getSnapshot()
@@ -231,8 +250,15 @@ window.__ModuleLoader__.load({
 
       return {
         /** Whether the `configForms` service was there at all. A service this DSH
-         *  does not ship reads differently from a row it does not serve. */
+         *  does not ship reads differently from a row it does not serve — and both
+         *  read differently from a namespace that simply has not been listed yet. */
         hasService: () => served,
+        /** Record that the service exists, before any scope is available. Without
+         *  this, a namespace that has not been served yet reads as "this DSH has no
+         *  configuration forms", which is a different (and wrong) diagnosis. */
+        noteService: () => {
+          served = true
+        },
         /** Bind the scope once the service appears. */
         attach: (next) => {
           if (next === undefined || next === null) return
@@ -528,7 +554,7 @@ window.__ModuleLoader__.load({
           { key: 'header', style: HEADER_STYLE },
           React.createElement('h2', { style: TITLE_STYLE }, 'WSL'),
           React.createElement('p', { style: DESCRIPTION_STYLE }, '通过 WSL 在 Windows 上执行 Linux 命令的开关与说明'),
-          React.createElement('p', { style: NOTE_STYLE }, '改动会在下次启动 DSH 后生效'),
+          React.createElement('p', { style: NOTE_STYLE }, '工具开关在下次启动 DSH 后生效；其余开关即时生效。'),
         ),
       )
 
@@ -542,7 +568,8 @@ window.__ModuleLoader__.load({
           ),
         )
       } else if (snapshot.status === 'loading') {
-        children.push(React.createElement('p', { key: 'note-loading', style: NOTE_STYLE }, '正在读取配置…'))
+        children.push(React.createElement('p', { key: 'note-loading', style: NOTE_STYLE },
+          '正在等待 Host 提供该插件的配置作用域（' + CONFIG_ROW_ID + '）…'))
       } else if (snapshot.status !== 'ready') {
         children.push(
           React.createElement('p', { key: 'note-unavailable', style: NOTE_STYLE }, '此 DSH 未提供该插件的配置作用域'),
@@ -632,18 +659,51 @@ window.__ModuleLoader__.load({
       try {
         if (typeof ctx.inject === 'function') {
           ctx.inject(['configForms'], (inner) => {
-            let scope
+            const configForms = inner.configForms
+            if (configForms === undefined || configForms === null) return
+            // The service is here; whether it lists our namespace is a separate
+            // question that `whileServed` answers below.
+            model.noteService()
+            /**
+             * Take the form once the Host actually lists the namespace.
+             *
+             * A form fetched before the `describe()` round trip settles is born
+             * with its persistence already fixed to "not host" and never upgrades
+             * — it stays `unavailable` forever. That is exactly how this panel
+             * lost every switch while the tools kept working, so the namespace is
+             * awaited through the platform's own gate instead of being requested
+             * eagerly. The shipped settings pages use this same call.
+             */
+            const attachWhenServed = () => {
+              if (typeof configForms.whileServed !== 'function') {
+                // Older host face: no gate to wait on, so take whatever it gives
+                // and let the model report `unavailable` honestly.
+                attach(configForms.get(CONFIG_ROW_ID))
+                return () => model.detach()
+              }
+              return configForms.whileServed([CONFIG_ROW_ID], () => {
+                attach(configForms.get(CONFIG_ROW_ID))
+                return () => model.detach()
+              })
+            }
+            const attach = (scope) => {
+              try {
+                model.attach(scope)
+              } catch (error) {
+                console.error('dsh-wsl-tool: reading the "' + CONFIG_ROW_ID + '" configuration scope failed', error)
+              }
+            }
+            let stop
             try {
-              scope = inner.configForms.get(CONFIG_ROW_ID)
+              stop = attachWhenServed()
             } catch (error) {
               console.error('dsh-wsl-tool: this DSH serves no "' + CONFIG_ROW_ID + '" configuration row', error)
               return
             }
-            model.attach(scope)
             // The subscription lives exactly as long as this fiber: `effect` runs
             // the returned disposer on unload or recomposition.
             if (typeof inner.effect === 'function') {
-              inner.effect(() => () => model.detach(), 'dsh-wsl-tool: configuration scope')
+              inner.effect(() => stop, 'dsh-wsl-tool: configuration scope')
             }
           })
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-wsl-tool",
-  "version": "1.10.1",
+  "version": "1.10.3",
   "description": "Run Linux commands from Windows through WSL, essentially matching a native Linux DSH for command execution: background jobs, stdin, path translation, a destructive-command guard and a WSL capability report. A left-sidebar panel switches each capability on or off, each with a one-line explanation, and an opt-in patch gives the desktop app's sidebar terminal a WSL shell. WSL calls run below the DSH sandbox, and a project on a Windows drive keeps Windows filesystem semantics.",
   "type": "module",
   "main": "index.js",