TanStack Query recipes

All recipes

Feed shared updates into your existing query cache.

Open recipe

GraphQL over WebSocket · Vite · Solid

Before you start

Start with an existing Vite · Solid app. Keep its renderer, routes and plugins. These files add one live view; Spinetab does not create your API.

Your schema exposes Subscription.queue: Queue! with Queue.open: Int!. Each event contains the complete queue value. Serve the graphql-transport-ws protocol at /graphql. Queries and mutations, if used, go to /graphql. This is a GraphQL endpoint, not a plain SSE or WebSocket feed.

The examples use same-origin URLs and declare anonymous: true: no token is supplied, although cookies still flow. For a separate API origin, use its URL and configure CORS or your application's proxy. For private data, add credentials and user scopes; never put a secret in these files.

1. Install

pnpm add spinetab graphql@^17.0.2 graphql-ws@^6.3.0 @tanstack/query-core@^5.104.0 @tanstack/solid-query@^5.104.0

Keep your framework's existing dependencies. See compatible versions if upgrading an older app.

2. Configure your app

Merge this addition into your configuration; preserve existing plugins and options. Restart the dev server afterwards. The plugin bundles the worker and discovers the adapters imported below.

vite.config.ts

import { spinetab } from "spinetab/vite";
import { defineConfig } from "vite";
import solid from "vite-plugin-solid";

export default defineConfig({ plugins: [solid(), spinetab()] });

3. Connect and render

Save these files together in src/recipe/.

The provider owns a fresh QueryClient. If your app already has a provider, render Queue beneath it instead of creating another one. The query uses skipToken to read live cache updates without fetching a competing snapshot. The bridge uses that same client's ["queue"] key.

reconcile: "latest" fits this full-state contract: the next complete event restores the displayed value after a gap. Use a refresh/merge policy for deltas or partial GraphQL results. Reconnecting alone does not reconstruct missed state.

src/recipe/live.ts

import { createSpinetab } from "spinetab";

export const spinetab = createSpinetab({ anonymous: true });

src/recipe/queue-types.ts

export type Queue = { open: number };
export type QueueView = { open?: number; problem?: string };

src/recipe/source.ts

import { parse } from "graphql";
import {
  type GraphqlDocument,
  type GraphqlResult,
  graphqlWs,
} from "spinetab/graphql-ws";
import type { Queue, QueueView } from "./queue-types";

const document: GraphqlDocument<
  { queue: Queue },
  Record<string, never>
> = parse("subscription Queue { queue { open } }");

export const queueSource = graphqlWs("/graphql").subscription({
  query: document,
});

export function selectQueue(
  result: GraphqlResult<{ queue: Queue }>,
): QueueView {
  return {
    open: result.data?.queue?.open,
    problem:
      result.errors?.map((error) => error.message).join("; ") ||
      (result.data?.queue ? undefined : "The server returned no queue."),
  };
}

src/recipe/feed.ts

import type { QueryClient } from "@tanstack/query-core";
import { bindQuery } from "spinetab/tanstack-query";
import { spinetab } from "./live";
import { queueSource, selectQueue } from "./source";

export function startQueue(
  queryClient: QueryClient,
  onError: (message: string) => void,
) {
  return bindQuery(spinetab, queueSource, {
    queryClient,
    queryKey: ["queue"],
    map: selectQueue,
    reconcile: "latest",
    onError: (error) => onError(error.message),
    onEvent: () => onError(""),
  });
}

src/recipe/Queue.tsx

import { createQuery, skipToken, useQueryClient } from "@tanstack/solid-query";
import { createSignal, onCleanup, onMount } from "solid-js";
import { startQueue } from "./feed";
import type { QueueView } from "./queue-types";

export default function Queue() {
  const client = useQueryClient();
  const queue = createQuery<QueueView>(() => ({
    queryKey: ["queue"],
    queryFn: skipToken,
  }));
  const [error, setError] = createSignal("");
  let binding: ReturnType<typeof startQueue> | undefined;
  onMount(() => {
    binding = startQueue(client, setError);
  });
  onCleanup(() => binding?.unsubscribe());
  const problem = () => error() || queue.data?.problem;
  return (
    <>
      {problem() ? (
        <p role="alert">{problem()}</p>
      ) : queue.data?.open === undefined ? (
        <p role="status">Loading queue…</p>
      ) : (
        <p>
          <output>{queue.data.open}</output> open
        </p>
      )}
    </>
  );
}

src/recipe/Recipe.tsx

import { QueryClient, QueryClientProvider } from "@tanstack/solid-query";
import Queue from "./Queue";

export default function Recipe() {
  const client = new QueryClient();
  return (
    <QueryClientProvider client={client}>
      <Queue />
    </QueryClientProvider>
  );
}

4. Mount the view

src/App.tsx

import Recipe from "./recipe/Recipe";
export default function App() {
  return <Recipe />;
}

Your existing entry point mounts App as usual. Keep its renderer plugin; no additional application provider is required beyond those shown.

Check the result

Open the page in two tabs of the same browser profile. Both should show advancing queue values. Matching subscriptions share upstream work when SharedWorker is available; fallback runs independently in each tab. Remove one view and the other should keep updating. Removing the last view releases its subscription; connection closure can follow the adapter's idle delay.

API options and advanced recovery · Authentication