Skip to content

Open-source status page, incident response and uptime monitoring

3.1 KB
Raw Blame
import type { AppRouter } from "@openstatus/api";
import * as Sentry from "@sentry/nextjs";
import type { HTTPHeaders, TRPCLink } from "@trpc/client";
import { httpBatchStreamLink, loggerLink } from "@trpc/client";
import superjson from "superjson";

import { isExpectedNotFound } from "./error";

/**
 * tRPC logger link that reports failed queries to Sentry directly instead of
 * letting captureConsoleIntegration scrape tRPC's styled console.error format
 * string (which surfaces as noise like "%c << query #1 %c...%c %O").
 *
 * Only the operation `path` is attached — never `input`, which can carry
 * secrets (page passwords, subscriber tokens, emails).
 */
export const sentryLoggerLink = (): TRPCLink<AppRouter> =>
  loggerLink<AppRouter>({
    enabled: (opts) =>
      process.env.NODE_ENV === "development" ||
      (opts.direction === "down" && opts.result instanceof Error),
    logger: (opts) => {
      if (opts.direction === "down" && opts.result instanceof Error) {
        if (isExpectedNotFound(opts.result, opts.context.expectNotFound)) {
          return;
        }
        Sentry.captureException(opts.result, {
          extra: { path: opts.path },
        });
        if (process.env.NODE_ENV === "development") {
          console.warn("[tRPC error]", opts.path, opts.result);
        }
        return;
      }
      if (process.env.NODE_ENV === "development") {
        console.log(opts);
      }
    },
  });

/**
 * Filter out requests that don't come from our tRPC clients.
 * Our server and client links always set `x-trpc-source`.
 * This is a convention filter for bots/crawlers, not a security boundary —
 * the header is trivially spoofable. Auth is enforced by protectedProcedure.
 */
export function guardTRPCSource(req: Request): Response | null {
  const source = req.headers.get("x-trpc-source");
  if (source !== "server" && source !== "client") {
    return new Response(null, { status: 401 });
  }
  return null;
}

const getBaseUrl = () => {
  if (typeof window !== "undefined") return "";
  // Note: dashboard has its own tRPC API routes
  if (process.env.VERCEL_URL) return "https://app.openstatus.dev"; // Vercel
  // Dev runs on 3001 (`PORT` in the dev script), Docker on 3000.
  return `http://localhost:${process.env.PORT || 3000}`; // Local dev and Docker (internal calls)
};

// The whole tRPC surface is served from a single Node.js endpoint — there is
// no longer an Edge/Node split, so all calls go to one link.
// Streaming rather than plain batching: a batch mixing cheap queries with a
// slow Tinybird pipe would otherwise deliver none of them until the slowest
// one settles. Note this makes per-procedure errors arrive in-band on a 200 —
// `sentryLoggerLink` above is what still reports them.
export const endingLink =
  (opts?: {
    fetch?: typeof fetch;
    headers?: HTTPHeaders | (() => HTTPHeaders | Promise<HTTPHeaders>);
  }): TRPCLink<AppRouter> =>
  (runtime) =>
    httpBatchStreamLink<AppRouter>({
      headers: opts?.headers,
      fetch: opts?.fetch,
      transformer: superjson,
      url: `${getBaseUrl()}/api/trpc/lambda`,
    })(runtime);