@antelopejs/dms 0.9.2 → 0.9.4

package/frontend-vue/tests/page-live-refresh.test.ts

@@ -1,169 +0,0 @@
-// @vitest-environment jsdom
-/**
- * `usePageLiveRefresh`, the public face of the Direct / Pause gate: a module's
- * own component refreshes on its topic at the page's `maxRate`, counts what
- * it missed while paused and reads once on resume, reads at once on a user's
- * refresh, and, with `idleRefresh`, reads again after a quiet period while
- * the page is live only.
- */
-import { createApp, defineComponent, h } from "vue";
-import { afterEach, beforeEach, expect, it, vi } from "vitest";
-import type { RealtimeTopicHandler } from "../layers/dms-core/app/composables/realtime/useUserRealtime";
-import { refreshPageBlocks } from "../layers/dms-ui/app/utils/blockRefresh";
-import {
-  createPageLiveController,
-  type PageLiveController,
-} from "../layers/dms-ui/app/build/composables/live/pageLiveController";
-import { setCurrentPageLive } from "../layers/dms-ui/app/build/composables/live/currentPageLive";
-import type {
-  PageLiveRefresh,
-  PageLiveRefreshOptions,
-} from "../layers/dms-ui/app/composables/live/usePageLiveRefresh";
-
-const topicHandlers = new Map<string, RealtimeTopicHandler[]>();
-
-vi.mock("../layers/dms-core/app/composables/realtime/useRealtimeTopic", () => ({
-  useRealtimeTopic: (topic: string, handler: RealtimeTopicHandler) => {
-    topicHandlers.set(topic, [...(topicHandlers.get(topic) ?? []), handler]);
-  },
-}));
-
-const { usePageLiveRefresh } = await import(
-  "../layers/dms-ui/app/composables/live/usePageLiveRefresh"
-);
-
-const TOPIC = "api:requests";
-const MAX_RATE_SECONDS = 15;
-const MAX_RATE_MS = MAX_RATE_SECONDS * 1000;
-const IDLE_SECONDS = 60;
-const mounted: Array<{ unmount: () => void }> = [];
-const controllers: PageLiveController[] = [];
-
-function publish() {
-  const event = { topic: TOPIC, type: "request", ts: Date.now() };
-  for (const handler of topicHandlers.get(TOPIC) ?? []) handler(event);
-}
-
-interface MountedRefresh {
-  onRefresh: ReturnType<typeof vi.fn>;
-  handle: PageLiveRefresh;
-}
-
-function mountComponent(
-  options: PageLiveRefreshOptions = { realtimeTopic: TOPIC },
-): MountedRefresh {
-  const onRefresh = vi.fn();
-  let handle: PageLiveRefresh | undefined;
-  const app = createApp(
-    defineComponent({
-      setup() {
-        handle = usePageLiveRefresh(onRefresh, options);
-        return () => h("div");
-      },
-    }),
-  );
-  app.mount(document.createElement("div"));
-  mounted.push(app);
-  return { onRefresh, handle: handle! };
-}
-
-function installLive(): PageLiveController {
-  const controller = createPageLiveController("api.routes", {
-    maxRate: MAX_RATE_SECONDS,
-  });
-  controllers.push(controller);
-  setCurrentPageLive(controller);
-  return controller;
-}
-
-beforeEach(() => {
-  vi.useFakeTimers();
-  topicHandlers.clear();
-  window.localStorage.clear();
-});
-
-afterEach(() => {
-  mounted.splice(0).forEach((app) => app.unmount());
-  controllers.splice(0).forEach((controller) => controller.dispose());
-  setCurrentPageLive(null);
-  vi.useRealTimers();
-});
-
-it("reads on its topic at the page's maxRate, the last event of a burst kept", () => {
-  installLive();
-  const { onRefresh } = mountComponent();
-
-  publish();
-  publish();
-  publish();
-  expect(onRefresh).toHaveBeenCalledTimes(1);
-
-  vi.advanceTimersByTime(MAX_RATE_MS);
-  expect(onRefresh).toHaveBeenCalledTimes(2);
-});
-
-it("reads nothing while paused, counts what it missed, and reads once on resume", () => {
-  const controller = installLive();
-  const { onRefresh, handle } = mountComponent();
-  controller.pause();
-
-  publish();
-  publish();
-  expect(onRefresh).not.toHaveBeenCalled();
-  expect(handle.missed.value).toBe(2);
-  expect(controller.missedCount.value).toBe(2);
-
-  controller.resume();
-  expect(onRefresh).toHaveBeenCalledTimes(1);
-  expect(handle.missed.value).toBe(0);
-});
-
-it("reads at once on a refresh the user asks for, paused or not", () => {
-  const controller = installLive();
-  const { onRefresh, handle } = mountComponent();
-  controller.pause();
-
-  refreshPageBlocks();
-  expect(onRefresh).toHaveBeenCalledTimes(1);
-
-  handle.refreshNow();
-  expect(onRefresh).toHaveBeenCalledTimes(2);
-});
-
-it("gates its own trigger like an event", () => {
-  const controller = installLive();
-  const { onRefresh, handle } = mountComponent({});
-  controller.pause();
-
-  handle.trigger();
-  expect(onRefresh).not.toHaveBeenCalled();
-  expect(handle.missed.value).toBe(1);
-});
-
-it("reads again after a quiet idleRefresh while live, never while paused", () => {
-  const controller = installLive();
-  const { onRefresh } = mountComponent({
-    realtimeTopic: TOPIC,
-    idleRefresh: IDLE_SECONDS,
-  });
-
-  vi.advanceTimersByTime(IDLE_SECONDS * 1000);
-  expect(onRefresh).toHaveBeenCalledTimes(1);
-
-  controller.pause();
-  vi.advanceTimersByTime(IDLE_SECONDS * 3000);
-  expect(onRefresh).toHaveBeenCalledTimes(1);
-  expect(controller.missedCount.value).toBe(0);
-
-  controller.resume();
-  vi.advanceTimersByTime(IDLE_SECONDS * 1000);
-  expect(onRefresh).toHaveBeenCalledTimes(2);
-});
-
-it("reads on every event on a page without live", () => {
-  const { onRefresh } = mountComponent();
-
-  publish();
-  publish();
-  expect(onRefresh).toHaveBeenCalledTimes(2);
-});

package/frontend-vue/tests/page-no-visible-blocks.test.ts

@@ -1,212 +0,0 @@
-// @vitest-environment jsdom
-import {
-  computed,
-  createSSRApp,
-  h,
-  inject,
-  onMounted,
-  onUnmounted,
-  provide,
-  ref,
-  toRef,
-  watch,
-  type FunctionalComponent,
-} from "vue";
-import { renderToString } from "vue/server-renderer";
-import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import CatchAllPage from "../layers/dms-layout/app/pages/[...slug].vue";
-import {
-  PAGE_FILL_HEIGHT_CLASSES,
-  providePageFillHeight,
-  usePageFillHeight,
-} from "../layers/dms-layout/app/composables/layout/usePageFillHeight";
-
-// The page's data refresh and the visit's navigation badges read the
-// realtime session and Inertia's page, which these tests do not run.
-vi.mock(
-  "../layers/dms-ui/app/build/composables/live/usePageDataRefresh",
-  () => ({ usePageDataRefresh: () => {} }),
-);
-vi.mock(
-  "../layers/dms-layout/app/build/composables/navigation/useVisitNavBadges",
-  () => ({ useVisitNavBadges: () => {} }),
-);
-vi.mock(
-  "../layers/dms-layout/app/build/composables/dev-reload/useDevReloadHolder",
-  async () => {
-    const { ref } = await import("vue");
-    return { useDevReloading: () => ref(false) };
-  },
-);
-
-interface PageLayoutFixture {
-  components: Record<string, { componentName: string }>;
-  allComponentsHidden?: boolean;
-}
-
-const EMPTY_TITLE_KEY = "page.no_visible_blocks.title";
-const EMPTY_DESCRIPTION_KEY = "page.no_visible_blocks.description";
-
-const pageLayout = ref<PageLayoutFixture | null>(null);
-const siteLayoutTree = ref<Record<string, unknown> | undefined>(undefined);
-const navigateDms = vi.fn();
-
-const EmptyState: FunctionalComponent<{
-  title: string;
-  description: string;
-  variant: string;
-}> = (props) =>
-  h("aside", { "data-variant": props.variant }, [
-    h("p", props.title),
-    h("p", props.description),
-  ]);
-EmptyState.props = ["title", "description", "variant"];
-
-const PageComponent: FunctionalComponent<{ componentId: string }> = (props) =>
-  h("section", { "data-component": props.componentId });
-PageComponent.props = ["componentId"];
-
-function installRuntime(): void {
-  const metadata = { fullId: "examples.overview", hasAccess: true };
-  const runtime: Record<string, unknown> = {
-    computed,
-    inject,
-    onMounted,
-    onUnmounted,
-    provide,
-    ref,
-    toRef,
-    watch,
-    HTTP_FORBIDDEN: 403,
-    HTTP_INTERNAL_SERVER_ERROR: 500,
-    HTTP_NOT_FOUND: 404,
-    PAGE_FILL_HEIGHT_CLASSES,
-    providePageFillHeight,
-    usePageFillHeight,
-    createDmsError: vi.fn(),
-    defineDmsPageMeta: vi.fn(),
-    firstAccessiblePagePath: vi.fn(),
-    navigateDms,
-    preloadPageLayoutComponents: vi.fn(),
-    providePageRealtime: vi.fn(),
-    resolveDmsComponent: () => "div",
-    runCustomValidation: vi.fn(),
-    showDmsError: vi.fn(),
-    validateRequiredQueryParams: vi.fn(),
-    useDefinedFunctions: () => ({ getFunction: () => undefined }),
-    useDmsRoute: () => ({ path: "/examples/overview", query: {} }),
-    useHomepage: () => "/",
-    useI18n: () => ({ t: (key: string) => key }),
-    usePageLayout: async () => ({ pageLayout }),
-    usePageRealtime: () => ({}),
-    usePermissions: () => ({
-      permissions: ref([]),
-      refreshIfStale: async () => {},
-    }),
-    useSessionRecovery: () => ({
-      loggedIn: ref(true),
-      reconcileSession: async () => {},
-      redirectToAuth: async () => {},
-    }),
-    useSiteLayout: () => ({
-      siteLayout: ref({ pages: {} }),
-      siteLayoutTree,
-      loadingError: ref(null),
-      loadSiteLayout: async () => {},
-      refreshIfStale: async () => {},
-      findMatchingRoute: () => ({ metadata, params: {} }),
-    }),
-  };
-  Object.entries(runtime).forEach(([name, value]) =>
-    vi.stubGlobal(name, value),
-  );
-}
-
-async function renderPage(): Promise<HTMLElement> {
-  const app = createSSRApp(() => h(CatchAllPage));
-  app.component("DmsEmptyState", EmptyState);
-  app.component("DmsRecursiveComponent", PageComponent);
-  const host = document.createElement("div");
-  host.innerHTML = await renderToString(app);
-  return host;
-}
-
-beforeEach(() => {
-  siteLayoutTree.value = undefined;
-  navigateDms.mockClear();
-  installRuntime();
-});
-
-/** The menu tree with the page, and a page nested under it. */
-function treeWithNestedPage(nestedHasAccess: boolean) {
-  const nested = {
-    id: "invites",
-    fullId: "examples.overview.invites",
-    fullSlug: "/examples/overview/invites",
-    layoutUrl: "/examples/overview/invites/pagelayout",
-    hasAccess: nestedHasAccess,
-    children: {},
-    childrenOrders: [],
-  };
-  const overview = {
-    id: "overview",
-    fullId: "examples.overview",
-    fullSlug: "/examples/overview",
-    layoutUrl: "/examples/overview/pagelayout",
-    hasAccess: false,
-    children: { invites: nested },
-    childrenOrders: ["invites"],
-  };
-  const examples = {
-    id: "examples",
-    fullId: "examples",
-    children: { overview },
-    childrenOrders: ["overview"],
-  };
-  return { children: { examples }, childrenOrders: ["examples"] };
-}
-
-afterEach(() => {
-  vi.unstubAllGlobals();
-});
-
-describe("a page served without any of its blocks", () => {
-  it("says there is nothing to show and who to ask", async () => {
-    pageLayout.value = { components: {}, allComponentsHidden: true };
-    const host = await renderPage();
-    const empty = host.querySelector("aside");
-    expect(empty?.getAttribute("data-variant")).toBe("no-access");
-    expect(empty?.textContent).toContain(EMPTY_TITLE_KEY);
-    expect(empty?.textContent).toContain(EMPTY_DESCRIPTION_KEY);
-    expect(host.querySelector(".dms-page-stack")).toBeNull();
-  });
-
-  it("stays put, even with a page nested under it the viewer can open", async () => {
-    pageLayout.value = { components: {}, allComponentsHidden: true };
-    siteLayoutTree.value = treeWithNestedPage(true);
-    const host = await renderPage();
-    expect(navigateDms).not.toHaveBeenCalled();
-    expect(host.querySelector("aside")).not.toBeNull();
-  });
-
-  it("draws the blocks it was served instead", async () => {
-    pageLayout.value = {
-      components: { stats: { componentName: "StatGroup" } },
-    };
-    const host = await renderPage();
-    expect(host.querySelector("aside")).toBeNull();
-    expect(host.querySelector("[data-component]")).not.toBeNull();
-  });
-
-  it("leaves a page that declares no block as it is", async () => {
-    pageLayout.value = { components: {} };
-    const host = await renderPage();
-    expect(host.querySelector("aside")).toBeNull();
-  });
-
-  it("stays quiet while the layout is still loading", async () => {
-    pageLayout.value = null;
-    const host = await renderPage();
-    expect(host.querySelector("aside")).toBeNull();
-  });
-});

package/frontend-vue/tests/page-realtime-remount.test.ts

@@ -1,185 +0,0 @@
-import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import {
-  computed,
-  effectScope,
-  nextTick,
-  onScopeDispose,
-  ref,
-  toValue,
-  watch,
-  type EffectScope,
-} from "vue";
-import type { UserRealtimeApi } from "../layers/dms-core/app/composables/realtime/useUserRealtime";
-
-const BASE_URL = "http://api";
-const USER_STREAM_URL = `${BASE_URL}/api/realtime/user`;
-const SUBSCRIBE_URL_PREFIX = `${BASE_URL}/api/realtime/subscribe/`;
-const UNSUBSCRIBE_URL = `${BASE_URL}/api/realtime/unsubscribe`;
-const PAGE_ID = "lang.translations";
-const OTHER_PAGE_ID = "lang.overview";
-const SESSION_ID = "session-1";
-
-type PageCall = () => void;
-
-interface FakeServer {
-  /** The page the server holds the session's topics for. */
-  page: string | null;
-  isHoldingCalls: boolean;
-  heldCalls: PageCall[];
-}
-
-const encoder = new TextEncoder();
-
-const openUserStream = () => {
-  const body = new ReadableStream<Uint8Array>({
-    start(controller) {
-      controller.enqueue(
-        encoder.encode(
-          `event: hello\ndata: ${JSON.stringify({ sessionId: SESSION_ID })}\n\n`,
-        ),
-      );
-    },
-  });
-  return { ok: true, status: 200, body };
-};
-
-const applyPageCall = (server: FakeServer, url: string): void => {
-  server.page =
-    url === UNSUBSCRIBE_URL ? null : url.slice(SUBSCRIBE_URL_PREFIX.length);
-};
-
-const installFetch = (server: FakeServer): void => {
-  globalThis.fetch = vi.fn(async (url: string) => {
-    if (url === USER_STREAM_URL) return openUserStream();
-    if (!server.isHoldingCalls) {
-      applyPageCall(server, url);
-      return { ok: true, status: 200 };
-    }
-    await new Promise<void>((resolve) =>
-      server.heldCalls.push(() => {
-        applyPageCall(server, url);
-        resolve();
-      }),
-    );
-    return { ok: true, status: 200 };
-  }) as unknown as typeof fetch;
-};
-
-const settle = async (): Promise<void> => {
-  for (let round = 0; round < 5; round += 1) {
-    await vi.advanceTimersByTimeAsync(0);
-    await nextTick();
-  }
-};
-
-const realFetch = globalThis.fetch;
-let loggedIn = ref(false);
-let server: FakeServer;
-let user: UserRealtimeApi;
-let mountPage: (pageId: string) => EffectScope;
-
-const releaseHeldCalls = async (): Promise<void> => {
-  server.isHoldingCalls = false;
-  while (server.heldCalls.length) {
-    server.heldCalls.shift()!();
-    await settle();
-  }
-};
-
-beforeEach(async () => {
-  vi.resetModules();
-  vi.useFakeTimers({ toFake: ["setTimeout", "clearTimeout"] });
-  vi.stubEnv("SSR", false);
-  vi.stubGlobal("ref", ref);
-  vi.stubGlobal("watch", watch);
-  vi.stubGlobal("computed", computed);
-  vi.stubGlobal("toValue", toValue);
-  vi.stubGlobal("onScopeDispose", onScopeDispose);
-  vi.stubGlobal("useDmsState", (_key: string, init: () => unknown) =>
-    ref(init()),
-  );
-  vi.stubGlobal("useDmsRuntimeConfig", () => ({
-    public: { dms: { baseURL: BASE_URL } },
-  }));
-  vi.stubGlobal("useDmsUserSession", () => ({ loggedIn }));
-  vi.stubGlobal("useSessionRecovery", () => ({
-    refreshSession: async () => true,
-    redirectToAuth: async () => {},
-  }));
-  server = { page: null, isHoldingCalls: false, heldCalls: [] };
-  installFetch(server);
-  loggedIn = ref(true);
-  const userModule = await import(
-    "../layers/dms-core/app/composables/realtime/useUserRealtime"
-  );
-  vi.stubGlobal("useUserRealtime", userModule.useUserRealtime);
-  const pageModule = await import(
-    "../layers/dms-core/app/composables/realtime/usePageRealtime"
-  );
-  user = userModule.useUserRealtime();
-  mountPage = (pageId) => {
-    const scope = effectScope(true);
-    scope.run(() => pageModule.usePageRealtime(pageId));
-    return scope;
-  };
-  await settle();
-});
-
-afterEach(async () => {
-  loggedIn.value = false;
-  await settle();
-  globalThis.fetch = realFetch;
-  vi.useRealTimers();
-  vi.unstubAllGlobals();
-  vi.unstubAllEnvs();
-});
-
-describe("usePageRealtime remount at the same path", () => {
-  it("keeps the page when the new instance mounts before the old one unmounts", async () => {
-    const previous = mountPage(PAGE_ID);
-    await settle();
-    expect(server.page).toBe(PAGE_ID);
-
-    const next = mountPage(PAGE_ID);
-    previous.stop();
-    await settle();
-
-    expect(user.pageId.value).toBe(PAGE_ID);
-    expect(server.page).toBe(PAGE_ID);
-    next.stop();
-    await settle();
-    expect(server.page).toBeNull();
-  });
-
-  it("re-subscribes when the new instance mounts while the old unsubscribe is in flight", async () => {
-    const previous = mountPage(PAGE_ID);
-    await settle();
-
-    server.isHoldingCalls = true;
-    previous.stop();
-    await settle();
-    const next = mountPage(PAGE_ID);
-    await settle();
-    await releaseHeldCalls();
-
-    expect(user.pageId.value).toBe(PAGE_ID);
-    expect(server.page).toBe(PAGE_ID);
-    next.stop();
-    await settle();
-  });
-
-  it("keeps the new page when navigating away unmounts the old one last", async () => {
-    const previous = mountPage(OTHER_PAGE_ID);
-    await settle();
-
-    const next = mountPage(PAGE_ID);
-    await settle();
-    previous.stop();
-    await settle();
-
-    expect(user.pageId.value).toBe(PAGE_ID);
-    expect(server.page).toBe(PAGE_ID);
-    next.stop();
-    await settle();
-  });
-});

package/frontend-vue/tests/page-record-label.test.ts

@@ -1,46 +0,0 @@
-/**
- * `usePageRecordLabel`, public: the label a record page's header ends its
- * breadcrumb with, held with its page's path so it never outlives the page,
- * and still reachable from its former `build/` path.
- */
-import { reactive, ref, type Ref } from "vue";
-import { beforeEach, expect, it, vi } from "vitest";
-
-const route = reactive({ path: "/modules/api/routes" });
-let sharedState: Map<string, Ref<unknown>>;
-
-vi.stubGlobal("useDmsRoute", () => route);
-vi.stubGlobal("useDmsState", <T>(key: string, init?: () => T): Ref<T> => {
-  if (!sharedState.has(key)) sharedState.set(key, ref(init?.()));
-  return sharedState.get(key) as Ref<T>;
-});
-
-const { usePageRecordLabel } = await import(
-  "../layers/dms-core/app/composables/page/usePageRecordLabel"
-);
-
-beforeEach(() => {
-  sharedState = new Map();
-  route.path = "/modules/api/routes";
-});
-
-it("reads the label set for the page on screen, shared between callers", () => {
-  const writer = usePageRecordLabel();
-  const reader = usePageRecordLabel();
-
-  writer.setLabel(route.path, "GET /api/invoices");
-
-  expect(reader.label.value).toBe("GET /api/invoices");
-});
-
-it("never shows a label on another page, and clears with no value", () => {
-  const { label, setLabel } = usePageRecordLabel();
-  setLabel(route.path, "GET /api/invoices");
-
-  route.path = "/modules/api/logs";
-  expect(label.value).toBeUndefined();
-
-  route.path = "/modules/api/routes";
-  setLabel(route.path, undefined);
-  expect(label.value).toBeUndefined();
-});