@adcops/autocore-react 3.3.85 → 3.3.87

package/src/hooks/useTisConfig.ts

@@ -0,0 +1,164 @@
+/**
+ * useTisConfig — load and edit the TIS test_methods schema.
+ *
+ * Thin wrapper around the `tis.show_config` / `tis.put_method` /
+ * `tis.remove_method` / `tis.save_config` / `tis.discard_config_changes`
+ * IPC surface. Mirrors the server's staged-then-saved model: edits land in
+ * the server's in-memory copy (dirty = true) until `save()` persists them
+ * to project.json.
+ *
+ * Today the server hosts exactly one project (the one configured at
+ * startup), so `projectId` is informational; the hook still threads it
+ * through every call so the wire contract matches a future multi-project
+ * world without a rewrite.
+ *
+ * Pass an `invoker` override to mock the IPC layer (used by the playground
+ * demo and by tests). When omitted, the hook reads `EventEmitterContext`.
+ */
+
+import { useCallback, useContext, useEffect, useState } from 'react';
+import { EventEmitterContext } from '../core/EventEmitterContext';
+import { MessageType } from '../hub/CommandMessage';
+
+/** Minimal subset of a TestMethod we model client-side. Treat as opaque —
+ *  the structural integrity of each method is the server's responsibility. */
+export type TestMethod = Record<string, unknown>;
+
+export interface TisConfig {
+    projectId: string;
+    methods: Record<string, TestMethod>;
+    dirty: boolean;
+    defaultMethodId: string;
+}
+
+/** IPC invoker contract: `topic` is e.g. "tis.show_config", payload is the
+ *  request data. Returns an object with at least { success, data?, error_message? }. */
+export interface TisIpcInvoker {
+    (topic: string, payload: object): Promise<{
+        success: boolean;
+        data?: any;
+        error_message?: string;
+    }>;
+}
+
+export interface UseTisConfigResult {
+    config: TisConfig | null;
+    loading: boolean;
+    /** Last server-reported error from a mutation. Cleared on next successful call. */
+    error: string | null;
+    refresh: () => Promise<void>;
+    putMethod: (methodId: string, method: TestMethod) => Promise<void>;
+    removeMethod: (methodId: string) => Promise<void>;
+    save: () => Promise<void>;
+    revert: () => Promise<void>;
+}
+
+export interface UseTisConfigOptions {
+    invoker?: TisIpcInvoker;
+}
+
+export function useTisConfig(
+    projectId: string,
+    options?: UseTisConfigOptions,
+): UseTisConfigResult {
+    const ctx = useContext(EventEmitterContext);
+
+    // Default invoker dispatches via the live EventEmitterContext. Tests and
+    // the playground pass a mock instead.
+    const invoker: TisIpcInvoker = options?.invoker
+        ?? (async (topic, payload) => {
+            return await ctx.invoke(topic as any, MessageType.Request, payload as any);
+        });
+
+    const [config, setConfig] = useState<TisConfig | null>(null);
+    const [loading, setLoading] = useState<boolean>(true);
+    const [error, setError] = useState<string | null>(null);
+
+    // Stable identity so consumers can put `refresh` in dep arrays without
+    // re-triggering loops. Reconstructed only when projectId or invoker
+    // identity changes.
+    const refresh = useCallback(async () => {
+        setLoading(true);
+        try {
+            const resp = await invoker('tis.show_config', { project_id: projectId });
+            if (!resp.success) {
+                setError(resp.error_message ?? 'tis.show_config failed');
+                setConfig(null);
+                return;
+            }
+            const d = resp.data ?? {};
+            setConfig({
+                projectId,
+                methods: (d.test_methods ?? {}) as Record<string, TestMethod>,
+                dirty: !!d.dirty,
+                defaultMethodId: typeof d.default_method_id === 'string'
+                    ? d.default_method_id
+                    : '',
+            });
+            setError(null);
+        } catch (e: any) {
+            setError(String(e?.message ?? e));
+            setConfig(null);
+        } finally {
+            setLoading(false);
+        }
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [projectId, invoker]);
+
+    useEffect(() => {
+        void refresh();
+    }, [refresh]);
+
+    const putMethod = useCallback(async (methodId: string, method: TestMethod) => {
+        const resp = await invoker('tis.put_method', {
+            project_id: projectId,
+            method_id: methodId,
+            method,
+        });
+        if (!resp.success) {
+            const m = resp.error_message ?? 'tis.put_method failed';
+            setError(m);
+            throw new Error(m);
+        }
+        setError(null);
+        await refresh();
+    }, [invoker, projectId, refresh]);
+
+    const removeMethod = useCallback(async (methodId: string) => {
+        const resp = await invoker('tis.remove_method', {
+            project_id: projectId,
+            method_id: methodId,
+        });
+        if (!resp.success) {
+            const m = resp.error_message ?? 'tis.remove_method failed';
+            setError(m);
+            throw new Error(m);
+        }
+        setError(null);
+        await refresh();
+    }, [invoker, projectId, refresh]);
+
+    const save = useCallback(async () => {
+        const resp = await invoker('tis.save_config', { project_id: projectId });
+        if (!resp.success) {
+            const m = resp.error_message ?? 'tis.save_config failed';
+            setError(m);
+            throw new Error(m);
+        }
+        setError(null);
+        await refresh();
+    }, [invoker, projectId, refresh]);
+
+    const revert = useCallback(async () => {
+        const resp = await invoker('tis.discard_config_changes', { project_id: projectId });
+        if (!resp.success) {
+            const m = resp.error_message ?? 'tis.discard_config_changes failed';
+            setError(m);
+            throw new Error(m);
+        }
+        setError(null);
+        await refresh();
+    }, [invoker, projectId, refresh]);
+
+    return { config, loading, error, refresh, putMethod, removeMethod, save, revert };
+}