@solhun/feedback-kit-core 0.1.0

package/src/diagnostics.test.ts

@@ -0,0 +1,382 @@
+// DP-253 진단 링버퍼 검증.
+//
+// 여기서 지키는 것:
+// - TC3: 링버퍼에 인증정보와 본문이 기록되지 않는다.
+// - TC4: 상한(network 30 / logs 50)을 넘으면 오래된 것부터 밀려난다.
+// - TC5 의 절반: 스냅샷의 배열은 **실제로 모은 결과**다(상수 빈 배열이 아니다).
+//   나머지 절반("수집이 배선 안 된 경우는 null")은 context.test.ts 에 있다.
+//
+// 글로벌(fetch/XMLHttpRequest/console)을 패치하는 모듈이라, 각 테스트는 자기 스텁을
+// 깔고 afterEach 에서 원복한다. 원복이 새면 다른 파일의 테스트가 오염된다.
+
+import { afterEach, beforeEach, describe, expect, it } from "vitest";
+
+import {
+  DiagnosticsCollector,
+  LOG_BUFFER_LIMIT,
+  NETWORK_BUFFER_LIMIT,
+  REDACTED,
+  sanitizeUrl,
+} from "./diagnostics.js";
+
+// ────────────────────────────────────────────────────────────────────────────
+// 테스트 도구
+// ────────────────────────────────────────────────────────────────────────────
+
+const START_TIME = 1_700_000_000_000;
+let clockNow = START_TIME;
+const clock = (): number => clockNow;
+
+type G = Record<string, unknown>;
+const g = globalThis as unknown as G;
+
+type Listener = () => void;
+
+/**
+ * 최소 XMLHttpRequest 스텁.
+ * 응답 완료는 테스트가 `finish(status)` 로 직접 일으킨다(실 네트워크 없음).
+ */
+class FakeXhr {
+  static instances: FakeXhr[] = [];
+
+  status = 0;
+  opened: { method: string; url: string } | null = null;
+  sentBody: unknown = undefined;
+
+  private listeners = new Map<string, Listener[]>();
+
+  open(method: string, url: string): void {
+    this.opened = { method, url };
+  }
+
+  send(body?: unknown): void {
+    this.sentBody = body;
+    FakeXhr.instances.push(this);
+  }
+
+  addEventListener(type: string, cb: Listener): void {
+    const arr = this.listeners.get(type) ?? [];
+    arr.push(cb);
+    this.listeners.set(type, arr);
+  }
+
+  finish(status: number): void {
+    this.status = status;
+    for (const cb of this.listeners.get("loadend") ?? []) cb();
+  }
+}
+
+let originals: {
+  fetch: unknown;
+  xhr: unknown;
+  warn: unknown;
+  error: unknown;
+};
+
+let collector: DiagnosticsCollector;
+
+beforeEach(() => {
+  clockNow = START_TIME;
+  FakeXhr.instances = [];
+  originals = {
+    fetch: g.fetch,
+    xhr: g.XMLHttpRequest,
+    warn: (g.console as { warn: unknown }).warn,
+    error: (g.console as { error: unknown }).error,
+  };
+  collector = new DiagnosticsCollector({
+    now: clock,
+    iso: (n: number): string => new Date(n).toISOString(),
+  });
+});
+
+afterEach(() => {
+  collector.uninstall();
+  g.fetch = originals.fetch;
+  g.XMLHttpRequest = originals.xhr;
+  (g.console as G).warn = originals.warn;
+  (g.console as G).error = originals.error;
+});
+
+/** 응답 status 를 돌려주는 fetch 스텁. 호출될 때마다 시계를 `elapsed` 만큼 민다. */
+function stubFetch(
+  status: number,
+  elapsed = 12
+): { calls: Array<{ input: unknown; init: unknown }> } {
+  const calls: Array<{ input: unknown; init: unknown }> = [];
+  g.fetch = (input: unknown, init: unknown): Promise<unknown> => {
+    calls.push({ input, init });
+    clockNow += elapsed;
+    return Promise.resolve({ status });
+  };
+  return { calls };
+}
+
+// ────────────────────────────────────────────────────────────────────────────
+// TC4 — 상한 초과 시 오래된 것부터 밀려난다
+// ────────────────────────────────────────────────────────────────────────────
+
+describe("링버퍼 상한 (TC4)", () => {
+  it("요청 35건·로그 55건을 넣으면 network 30 / logs 50 만 남고 최근 것만 남는다", async () => {
+    stubFetch(200, 1);
+    (g.console as G).warn = (): void => {}; // 테스트 출력이 55줄 밀리지 않게
+    collector.install();
+
+    for (let i = 0; i < 35; i += 1) {
+      await (g.fetch as (u: string) => Promise<unknown>)(
+        `https://api.example/items/${i}`
+      );
+    }
+    for (let i = 0; i < 55; i += 1) {
+      (g.console as { warn: (m: string) => void }).warn(`경고 ${i}`);
+    }
+
+    const snap = collector.snapshot();
+
+    expect(snap.network).toHaveLength(NETWORK_BUFFER_LIMIT);
+    expect(snap.logs).toHaveLength(LOG_BUFFER_LIMIT);
+    expect(NETWORK_BUFFER_LIMIT).toBe(30);
+    expect(LOG_BUFFER_LIMIT).toBe(50);
+
+    // 밀려난 건 오래된 쪽(0~4 / 0~4)이고, 남은 건 최근 것이다.
+    expect(snap.network[0]?.url).toBe("https://api.example/items/5");
+    expect(snap.network.at(-1)?.url).toBe("https://api.example/items/34");
+    expect(snap.logs[0]?.message).toBe("경고 5");
+    expect(snap.logs.at(-1)?.message).toBe("경고 54");
+  });
+});
+
+// ────────────────────────────────────────────────────────────────────────────
+// TC3 — 인증정보·본문 미기록
+// ────────────────────────────────────────────────────────────────────────────
+
+describe("자격증명·본문 미기록 (TC3)", () => {
+  const AUTH = "Bearer super-secret-access-token";
+  const COOKIE = "session=abcdef-cookie-value";
+  const REQ_BODY = JSON.stringify({ password: "hunter2", card: "4111111111111111" });
+  const RES_BODY = { secretAnswer: "top-secret-response-payload" };
+
+  it("fetch 로 오간 인증 헤더·쿠키·요청 본문·응답 본문이 버퍼에 남지 않는다", async () => {
+    g.fetch = (): Promise<unknown> => {
+      clockNow += 7;
+      // 응답 객체에 본문이 들어 있어도 수집기는 status 만 본다.
+      return Promise.resolve({
+        status: 201,
+        body: RES_BODY,
+        json: () => Promise.resolve(RES_BODY),
+      });
+    };
+    collector.install();
+
+    await (g.fetch as (u: string, i: unknown) => Promise<unknown>)(
+      "https://api.example/login?token=super-secret-access-token&api_key=abc123",
+      {
+        method: "post",
+        headers: { Authorization: AUTH, Cookie: COOKIE },
+        body: REQ_BODY,
+      }
+    );
+
+    const snap = collector.snapshot();
+    const dumped = JSON.stringify(snap);
+
+    for (const secret of [
+      "super-secret-access-token",
+      "abcdef-cookie-value",
+      "hunter2",
+      "4111111111111111",
+      "top-secret-response-payload",
+      "abc123",
+    ]) {
+      expect(dumped).not.toContain(secret);
+    }
+
+    // 기록되는 건 메서드·URL·상태코드·소요시간까지다.
+    expect(snap.network).toHaveLength(1);
+    expect(snap.network[0]).toMatchObject({
+      method: "POST",
+      status: 201,
+      durationMs: 7,
+    });
+    expect(snap.network[0]?.url).toBe(
+      `https://api.example/login?token=${REDACTED}&api_key=${REDACTED}`
+    );
+  });
+
+  it("XHR 로 보낸 요청 본문과 URL 자격증명도 남지 않는다", () => {
+    g.XMLHttpRequest = FakeXhr as unknown as G;
+    collector.install();
+
+    const xhr = new (g.XMLHttpRequest as unknown as typeof FakeXhr)();
+    xhr.open("PUT", "https://api.example/profile?access_token=super-secret-access-token");
+    xhr.send(REQ_BODY);
+    clockNow += 30;
+    xhr.finish(204);
+
+    const snap = collector.snapshot();
+    const dumped = JSON.stringify(snap);
+
+    expect(dumped).not.toContain("super-secret-access-token");
+    expect(dumped).not.toContain("hunter2");
+    expect(snap.network[0]).toMatchObject({
+      method: "PUT",
+      url: `https://api.example/profile?access_token=${REDACTED}`,
+      status: 204,
+      durationMs: 30,
+    });
+    // 원본 동작은 그대로 — 본문은 손대지 않고 그대로 전달된다.
+    expect(xhr.sentBody).toBe(REQ_BODY);
+  });
+
+  it("sanitizeUrl 은 fragment 와 user:pass@ 를 지우고 자격증명 파라미터 값만 가린다", () => {
+    expect(sanitizeUrl("https://u:p@api.example/a?x=1")).toBe("https://api.example/a?x=1");
+    expect(sanitizeUrl("https://api.example/a#access_token=zzz")).toBe(
+      "https://api.example/a"
+    );
+    expect(sanitizeUrl("https://api.example/a?page=2&refresh_token=zzz")).toBe(
+      `https://api.example/a?page=2&refresh_token=${REDACTED}`
+    );
+    // 진단에 필요한 정보(어떤 파라미터가 있었는지)는 남는다.
+    expect(sanitizeUrl("https://api.example/a?q=hello")).toBe(
+      "https://api.example/a?q=hello"
+    );
+  });
+});
+
+// ────────────────────────────────────────────────────────────────────────────
+// TC5(절반) — 스냅샷은 실제로 모은 결과다
+// ────────────────────────────────────────────────────────────────────────────
+
+describe("스냅샷은 수집 결과다 (TC5)", () => {
+  it("아무 일도 없었으면 비어 있고, 요청·로그가 생기면 그 수만큼 늘어난다", async () => {
+    stubFetch(200, 3);
+    (g.console as G).error = (): void => {};
+    collector.install();
+
+    expect(collector.snapshot()).toEqual({ network: [], logs: [] });
+
+    await (g.fetch as (u: string) => Promise<unknown>)("https://api.example/a");
+    (g.console as { error: (m: string) => void }).error("실패했다");
+
+    const snap = collector.snapshot();
+    expect(snap.network).toHaveLength(1);
+    expect(snap.logs).toHaveLength(1);
+    expect(snap.logs[0]?.level).toBe("error");
+  });
+
+  it("스냅샷은 사본이라 이후 수집이 이미 만든 페이로드를 바꾸지 않는다", async () => {
+    stubFetch(200, 1);
+    collector.install();
+
+    await (g.fetch as (u: string) => Promise<unknown>)("https://api.example/first");
+    const snap = collector.snapshot();
+    await (g.fetch as (u: string) => Promise<unknown>)("https://api.example/second");
+
+    expect(snap.network).toHaveLength(1);
+    expect(collector.snapshot().network).toHaveLength(2);
+  });
+});
+
+// ────────────────────────────────────────────────────────────────────────────
+// 수집기가 호스트 동작을 바꾸지 않는다는 보장
+// ────────────────────────────────────────────────────────────────────────────
+
+describe("수집기의 비침습성", () => {
+  it("실패한 요청도 1건으로 남기고 예외를 그대로 전파한다", async () => {
+    const failure = new TypeError("Failed to fetch");
+    g.fetch = (): Promise<unknown> => {
+      clockNow += 9;
+      return Promise.reject(failure);
+    };
+    collector.install();
+
+    await expect(
+      (g.fetch as (u: string) => Promise<unknown>)("https://api.example/down")
+    ).rejects.toBe(failure);
+
+    // 응답을 못 받았으므로 status 는 null 이다(0 이 아니라).
+    expect(collector.snapshot().network[0]).toMatchObject({
+      url: "https://api.example/down",
+      status: null,
+    });
+  });
+
+  it("console.warn/error 는 원본 출력을 그대로 유지한다", () => {
+    const seen: string[] = [];
+    (g.console as G).warn = (...a: unknown[]): void => {
+      seen.push(String(a[0]));
+    };
+    collector.install();
+
+    (g.console as { warn: (m: string) => void }).warn("사용자에게 보이던 경고");
+
+    expect(seen).toEqual(["사용자에게 보이던 경고"]);
+    expect(collector.snapshot().logs[0]?.message).toBe("사용자에게 보이던 경고");
+  });
+
+  it("RN 처럼 fetch 가 내부에서 XHR 을 쓰면 1건으로만 센다", async () => {
+    g.XMLHttpRequest = FakeXhr as unknown as G;
+    // whatwg-fetch 폴리필 흉내: Promise 실행자 안에서 동기적으로 send() 한다.
+    g.fetch = (url: string, init?: { method?: string }): Promise<unknown> =>
+      new Promise((resolve) => {
+        const x = new FakeXhr();
+        x.open(init?.method ?? "GET", url);
+        x.addEventListener("loadend", () => resolve({ status: x.status }));
+        x.send(null);
+      });
+    collector.install();
+
+    const pending = (g.fetch as (u: string) => Promise<unknown>)(
+      "https://api.example/rn"
+    );
+    clockNow += 4;
+    FakeXhr.instances[0]?.finish(200);
+    await pending;
+
+    expect(collector.snapshot().network).toHaveLength(1);
+  });
+
+  it("excludeMatcher 가 지목한 요청(위젯 자신의 전송)은 기록하지 않는다", async () => {
+    stubFetch(200, 1);
+    collector.install({
+      excludeMatcher: ({ url }) => url.startsWith("https://ingest.example/"),
+    });
+
+    await (g.fetch as (u: string) => Promise<unknown>)(
+      "https://ingest.example/api/feedback"
+    );
+    await (g.fetch as (u: string) => Promise<unknown>)("https://api.example/normal");
+
+    const snap = collector.snapshot();
+    expect(snap.network).toHaveLength(1);
+    expect(snap.network[0]?.url).toBe("https://api.example/normal");
+  });
+
+  it("originalConsole 로 찍으면 자기 로그가 버퍼에 되먹임되지 않는다", () => {
+    const seen: string[] = [];
+    (g.console as G).warn = (...a: unknown[]): void => {
+      seen.push(String(a[0]));
+    };
+    collector.install();
+
+    collector.originalConsole.warn("feedback-kit: 큐가 가득 찼다");
+
+    expect(seen).toEqual(["feedback-kit: 큐가 가득 찼다"]);
+    expect(collector.snapshot().logs).toHaveLength(0);
+  });
+
+  it("uninstall 하면 글로벌이 원복되고 이후 요청은 기록되지 않는다", async () => {
+    const { calls } = stubFetch(200, 1);
+    const patchedRef = g.fetch;
+    collector.install();
+    expect(g.fetch).not.toBe(patchedRef);
+
+    await (g.fetch as (u: string) => Promise<unknown>)("https://api.example/before");
+    collector.uninstall();
+    await (g.fetch as (u: string) => Promise<unknown>)("https://api.example/after");
+
+    expect(g.fetch).toBe(patchedRef);
+    expect(calls).toHaveLength(2); // 원본은 두 번 다 호출됐다
+    expect(collector.snapshot().network).toHaveLength(1); // 기록은 원복 전 1건뿐
+  });
+});