terminal

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271// Terminals pop out and close through the convergence/tabs service and
// follow its visible tab. Real activation with a canned tabs client:
// popping out calls open, closing calls close, the active event marks the
// pane session, and without a provider the kernel calls still run.
import assert from "node:assert/strict";
import { test } from "node:test";
import * as z from "zod";
import type {
  Api,
  AppState,
  AppStatePatch,
  HostEvent,
  RenderResult,
  SlotOptions,
  ViewContext,
} from "convergence";
import { ui } from "convergence";
import { testLayer } from "convergence/effect/testing";
import { activate } from "./main.ts";

const tick = () => new Promise<void>((resolve) => setImmediate(resolve));
const stable = (value: unknown) =>
  JSON.stringify(value, (_key, item: unknown) => (typeof item === "function" ? "@handler" : item));

const session = (id: string) => ({
  id,
  title: id,
  userTitle: null,
  cwd: "/fixture",
  workspaceId: "w1",
  running: true,
  exitCode: null,
});

function fakeApi(withTabs: boolean) {
  let state: AppState = { workspaceId: "w1", shared: { rightPanelPreview: "terminal" } };
  const appListeners = new Set<(state: AppState) => void>();
  const views: { render: (ctx: ViewContext<object>) => RenderResult; active: boolean }[] = [];
  const listeners = new Map<string, Set<(event: HostEvent) => unknown>>();
  const kernelCalls: { method: string; params: unknown }[] = [];
  const hostCalls: { method: string; params: unknown }[] = [];
  const tabsCalls: { method: string; params: unknown }[] = [];
  const tabsSubs = new Map<string, Set<(payload: unknown) => void>>();
  let dirty = true;
  const update = (patch: AppStatePatch) => {
    state = {
      ...state,
      ...patch,
      workspaceId: patch.workspaceId === null ? undefined : (patch.workspaceId ?? state.workspaceId),
      chatId: patch.chatId === null ? undefined : (patch.chatId ?? state.chatId),
      route: patch.route ?? state.route,
      shared: { ...state.shared, ...patch.shared },
    };
    dirty = true;
    for (const listener of appListeners) listener(state);
  };
  const hostCall = async (method: string, params: unknown) => {
    hostCalls.push({ method, params });
    if (method === "host/workspaces.list")
      return { workspaces: [{ id: "w1", name: "Workspace", path: "/fixture", position: 0 }] };
    throw new Error(`Unexpected host method ${method}`);
  };
  const kernelCall = async (method: string, params: unknown) => {
    kernelCalls.push({ method, params });
    switch (method) {
      case "terminal.list":
        return { terminals: [session("t1")] };
      case "terminal.create":
        return session("t2");
      case "terminal.close":
      case "terminal.focus":
      case "terminal.rename":
        return {};
      default:
        throw new Error(`Unexpected kernel method ${method}`);
    }
  };
  const tabsClient = {
    open: Object.assign(async (params: unknown) => ({ id: "tab" }), {
      // The Effect adapter calls through `result`, never the direct call.
      result: async (params: unknown) => {
        tabsCalls.push({ method: "open", params });
        return { ok: true as const, value: { id: "tab" } };
      },
    }),
    close: Object.assign(async () => null, {
      result: async (params: unknown) => {
        tabsCalls.push({ method: "close", params });
        return { ok: true as const, value: null };
      },
    }),
    active: Object.assign(async () => null, {
      result: async () => ({ ok: true as const, value: null }),
    }),
    on: (event: string, fn: (payload: unknown) => void) => {
      const key = `convergence/tabs|${event}`;
      const set = tabsSubs.get(key) ?? new Set<(payload: unknown) => void>();
      tabsSubs.set(key, set);
      set.add(fn);
      return () => {
        set.delete(fn);
      };
    },
  };
  const broker = testLayer();
  // This assertion describes a local fake; unused API methods fail rather than impersonating external replies.
  const api = new Proxy(
    {
      ...broker.api,
      plugin: "terminal",
      id: "convergence/terminal",
      ui,
      services: {
        provide: async () => ({ emit: () => {}, remove: () => {} }),
        get: (name: string) => {
          if (name === "convergence/tabs" && withTabs) return tabsClient;
          throw new Error(`no provider for ${name}`);
        },
        available: (name: string) => name === "convergence/tabs" && withTabs,
        when: (name: string, fn: (client: unknown) => void) => {
          fn(name === "convergence/tabs" && withTabs ? tabsClient : undefined);
          return () => {};
        },
      },
      host: { ...broker.api.host, call: hostCall, kernel: kernelCall },
      app: {
        state: () => state,
        update,
        share: (key: string, value: unknown) => update({ shared: { [key]: value } }),
        onChange: (fn: (state: AppState) => void) => {
          appListeners.add(fn);
          return () => {
            appListeners.delete(fn);
          };
        },
      },
      slot: (slot: string, render: (ctx: ViewContext<object>) => RenderResult, _options?: SlotOptions) => {
        const view = { render, active: true };
        views.push(view);
        dirty = true;
        return {
          id: views.length,
          update: () => {
            dirty = true;
          },
          remove: () => {
            view.active = false;
          },
        };
      },
      on: (name: string, fn: (event: HostEvent) => unknown) => {
        const subscribers = listeners.get(name) ?? new Set();
        listeners.set(name, subscribers);
        subscribers.add(fn);
        return () => {
          subscribers.delete(fn);
        };
      },
      command: () => ({ remove() {} }),
      notify: () => {},
      focus: () => {},
    },
    {
      get(target, key, receiver) {
        if (Reflect.has(target, key)) return Reflect.get(target, key, receiver);
        throw new Error(`Unexpected API ${String(key)}`);
      },
    },
  ) as unknown as Api;
  const render = () =>
    views
      .filter((view) => view.active)
      .map((view) =>
        view.render({
          state: {},
          app: state,
          plugin: "terminal",
          update: () => {
            dirty = true;
          },
        }),
      );
  let trees: RenderResult[] = [];
  const settle = async () => {
    for (let round = 0; round < 50; round++) {
      await tick();
      if (!dirty) {
        await tick();
        if (!dirty) return;
      }
      dirty = false;
      trees = render();
    }
    throw new Error("terminal did not settle");
  };
  const nodeSchema = z.object({ id: z.string().optional(), children: z.array(z.unknown()).optional() }).passthrough();
  function found(tree: unknown): Record<string, unknown>[] {
    if (Array.isArray(tree)) return tree.flatMap(found);
    const parsed = nodeSchema.safeParse(tree);
    if (!parsed.success) return [];
    return [
      parsed.data,
      ...(parsed.data.children ?? []).flatMap(found),
      ...(Array.isArray(parsed.data.items) ? parsed.data.items.flatMap(found) : []),
    ];
  }
  const invoke = (id: string, event = "onClick", payload: unknown = {}) => {
    const node = trees.flatMap((view) => found(view)).find((node) => node.id === id);
    assert.ok(node, `Missing ${id}`);
    const handler = z.custom<(payload: unknown) => unknown>((value) => typeof value === "function").parse(node[event]);
    handler(payload);
  };
  return {
    api,
    kernelCalls,
    tabsCalls,
    update,
    settle,
    invoke,
    trees: () => stable(trees),
    state: () => state,
    tabsActive: (tab: { kind: string; path: string } | null) => {
      for (const fn of tabsSubs.get("convergence/tabs|activeChanged") ?? []) fn(tab);
    },
  };
}

test("popping out opens a tab and closing closes it through the tabs service", async () => {
  const fake = fakeApi(true);
  const dispose = activate(fake.api);
  try {
    await fake.settle();
    assert.ok(fake.kernelCalls.some((call) => call.method === "terminal.list"));
    // While the fly-out is open the visible tab marks the pane session.
    fake.tabsActive({ kind: "terminal", path: "t1" });
    await fake.settle();
    assert.ok(fake.trees().includes("This terminal is open in the tabbed pane."));
    fake.tabsActive({ kind: "file", path: "a.ts" });
    await fake.settle();
    assert.ok(!fake.trees().includes("This terminal is open in the tabbed pane."));
    fake.invoke("terminal-close-t1");
    await fake.settle();
    assert.deepEqual(fake.tabsCalls.at(-1), { method: "close", params: { kind: "terminal", path: "t1" } });
    assert.ok(fake.kernelCalls.some((call) => call.method === "terminal.close"));
    fake.invoke("terminal-popout");
    await fake.settle();
    assert.deepEqual(fake.tabsCalls.at(-1), {
      method: "open",
      params: { kind: "terminal", workspaceId: "w1", path: "t1", title: "t1" },
    });
    assert.ok(fake.kernelCalls.some((call) => call.method === "terminal.focus"));
    assert.equal(fake.state().shared?.openTab, undefined);
    assert.equal(fake.state().shared?.closeTab, undefined);
  } finally {
    await dispose();
  }
});

test("without the tabs plugin popping out still focuses the session", async () => {
  const fake = fakeApi(false);
  const dispose = activate(fake.api);
  try {
    await fake.settle();
    fake.invoke("terminal-popout");
    await fake.settle();
    assert.deepEqual(fake.tabsCalls, []);
    assert.ok(fake.kernelCalls.some((call) => call.method === "terminal.focus"));
  } finally {
    await dispose();
  }
});