dsh-zen-remote 2.3.11 → 2.4.0

package/src/client-data/wizard.ts

@@ -12,8 +12,17 @@
  * row layer applies the same rule when the fields land there, so a client
  * that accepts something the resolver would silently drop would only set
  * the user up for a mystery.
+ *
+ * MS-6 adds the paired-pool overview pieces: the pool count is a first-class
+ * "configured" signal (MS-5 pairs straight into the pool store, not the
+ * row), and {@link deriveClientOverviewSummary} derives the overview card's
+ * counters and its two lights (connection health / pool fill) off the
+ * `client/status` pool list.
  */
 
+import { MAX_PAIRED_SERVERS } from './settings-form.ts'
+import type { ClientServerView } from './settings-form.ts'
+
 /** Wizard route constants — mirror of src/wizard/routes.ts. */
 export const WIZARD_STATUS_ROUTE = '/_dsh/zen-remote/admin/wizard/status'
 export const WIZARD_VERIFY_ROUTE = '/_dsh/zen-remote/admin/wizard/verify'
@@ -130,7 +139,12 @@ export function initialStep(status: WizardStatusBody | undefined): WizardStep {
 
 /**
  * Whether the inline overview card should render the configured status
- * dashboard instead of the first-time setup prompt.
+ * dashboard instead of the first-time setup prompt. MS-6: the paired pool's
+ * size is the client's first-class signal — since MS-5 a claim lands in the
+ * pool store and never touches the row's `serverUrl` / `deviceToken`, so a
+ * freshly multi-paired machine with an empty row must still read as
+ * configured. `> 0` answers true no matter what the other inputs say; the
+ * field is optional and an omitted one (or a zero) changes nothing.
  */
 export function isWizardConfigured(input: {
   effectiveClient: boolean
@@ -140,7 +154,9 @@ export function isWizardConfigured(input: {
   tokenConfigured: boolean
   clientServerUrl: string
   clientState: string | undefined
+  pairedServerCount?: number
 }): boolean {
+  if ((input.pairedServerCount ?? 0) > 0) return true
   if (input.effectiveClient) {
     return input.tokenConfigured || input.clientServerUrl.trim() !== '' || input.clientState === 'connected'
   }
@@ -312,6 +328,68 @@ const CLIENT_FAIL_STATES: ReadonlySet<string> = new Set([
   'unexpected',
 ])
 
+/**
+ * The view states that will NOT come back on their own (MS-6): a revoked
+ * token, an incompatible interface, an address that no longer parses — each
+ * needs the settings page before that server serves again. They turn the
+ * overview's connection light red; a merely `unreachable` server is mid-retry
+ * and stays amber.
+ */
+const CLIENT_DEAD_STATES: ReadonlySet<string> = new Set(['revoked', 'incompatible', 'invalid-url'])
+
+/** The overview card's derived counters and lights (MS-6): the 第 3 格
+ * 「连接状态」 shows `M / N 台在线` with {@link WizardOverviewSummary.connectionLight}
+ * summarizing the pool's health, and the 第 4 格 「已配对服务端」 shows
+ * `已配对 N / maxServers 台` with {@link WizardOverviewSummary.serversLight}
+ * turning red exactly at the cap. Input is the DERIVED pool list
+ * ({@link ClientServerView} — the view vocabulary's state words), in pairing
+ * order; order never matters to the counts. */
+export interface WizardOverviewSummary {
+  totalCount: number
+  onlineCount: number
+  /** Everything that is neither connected nor revoked (unreachable,
+   * unexpected, incompatible, invalid-url, …). */
+  offlineCount: number
+  revokedCount: number
+  maxServers: number
+  limitReached: boolean
+  connectionLight: LightState
+  serversLight: LightState
+}
+
+/**
+ * Derive the sub-client overview summary off one derived pool list: green
+ * only when EVERY paired server is connected; red when any server is in a
+ * state that will not recover on its own (revoked / incompatible /
+ * invalid-url) or when the pool is FULL — the cap is a servers fact, so a
+ * full pool of healthy connections still shows a red servers light while its
+ * connection light stays green; amber for the rest (nothing paired yet, or
+ * servers the retry ladder is still working on).
+ */
+export function deriveClientOverviewSummary(
+  servers: readonly ClientServerView[],
+  maxServers: number = MAX_PAIRED_SERVERS,
+): WizardOverviewSummary {
+  const totalCount = servers.length
+  let onlineCount = 0
+  let revokedCount = 0
+  let deadCount = 0
+  for (const server of servers) {
+    if (server.state === 'connected') onlineCount += 1
+    if (server.state === 'revoked') revokedCount += 1
+    if (CLIENT_DEAD_STATES.has(server.state)) deadCount += 1
+  }
+  const offlineCount = totalCount - onlineCount - revokedCount
+  const limitReached = totalCount >= maxServers
+  const connectionLight: LightState = totalCount === 0
+    ? 'pending'
+    : onlineCount === totalCount
+      ? 'pass'
+      : deadCount > 0 ? 'fail' : 'pending'
+  const serversLight: LightState = limitReached ? 'fail' : totalCount > 0 ? 'pass' : 'pending'
+  return { totalCount, onlineCount, offlineCount, revokedCount, maxServers, limitReached, connectionLight, serversLight }
+}
+
 /**
  * Derive the three status lights for the desktop sub-client verification
  * step (`role === 'client'`).
@@ -330,6 +408,27 @@ export function deriveClientWizardLights(input: {
   }
 }
 
+/**
+ * The wizard step-3's three lights for ONE selected paired server (MS-8):
+ * the credential is green by the row's own existence (the token lives in the
+ * pool store, never in the row) and red only when the server refused it
+ * (`revoked`); the connection follows the same fail-set the global lights
+ * use (an offline server mid-retry is red here too — the step is staring at
+ * THAT one server, not the pool); sync is green on a connected row whose
+ * interface groups all match, red on a compat mismatch, amber otherwise.
+ * `undefined` (nothing paired, or nothing selected yet) keeps all three
+ * amber.
+ */
+export function deriveClientServerLights(server: ClientServerView | undefined): ClientWizardLights {
+  if (server === undefined) return { credential: 'pending', connection: 'pending', sync: 'pending' }
+  const connected = server.state === 'connected'
+  return {
+    credential: server.state === 'revoked' ? 'fail' : 'pass',
+    connection: connected ? 'pass' : CLIENT_FAIL_STATES.has(server.state) ? 'fail' : 'pending',
+    sync: connected ? ((server.compat?.mismatchedGroups.length ?? 0) > 0 ? 'fail' : 'pass') : 'pending',
+  }
+}
+
 /** Pairing-code countdown, whole seconds, never negative. */
 export function pairingSecondsLeft(expiresAt: number, now: number): number {
   return Math.max(0, Math.ceil((expiresAt - now) / 1000))
@@ -367,6 +466,7 @@ export interface SnippetInput {
   domain: string
   upstreamHost: string
   upstreamPort: number
+  lang?: 'zh' | 'en' | undefined
 }
 
 /** Same grammar the row layer and the host half enforce. */
@@ -380,8 +480,11 @@ function valid(input: SnippetInput): { domain: string; upstream: string; port: n
 export function nginxSnippetText(input: SnippetInput): string | null {
   const parts = valid(input)
   if (parts === null) return null
+  const headerComment = input.lang === 'en'
+    ? '# Place this in the http {} block (skip if you already have this map)'
+    : '# 这段放在 http {} 层（若已有同名 map 则跳过）'
   return [
-    '# 这段放在 http {} 层（若已有同名 map 则跳过）',
+    headerComment,
     'map $http_upgrade $connection_upgrade {',
     '    default upgrade;',
     "    ''      close;",
@@ -420,6 +523,13 @@ export function caddySnippetText(input: SnippetInput): string | null {
 export function luckyStepTexts(input: SnippetInput): string[] | null {
   const parts = valid(input)
   if (parts === null) return null
+  if (input.lang === 'en') {
+    return [
+      'In Lucky "Web Service", create a new rule listening on port 443 and bind your domain.',
+      `Set the backend (reverse proxy target) to http://${parts.upstream}:${parts.port} and enable WebSocket support.`,
+      'Turn on the catch-all switch to allow all paths, then save.',
+    ]
+  }
   return [
     '在 Lucky 的「Web 服务」里新建一条规则，监听 443 端口，绑定你的域名。',
     `后端（反代目标）填 http://${parts.upstream}:${parts.port}，开启 WebSocket 支持。`,