Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/openstatusHQ/openstatus. 🫖 Status page with uptime monitoring & API monitoring as code 🫖 openstatus.dev
bun drizzle-orm monitoring monitoring-as-code nextjs observability on-call open-source shadcn-ui status-page statuspage synthetic-monitoring tinybird turso uptime uptime-checker uptime-monitor
Something went wrong. Try again.
6.4 kB · 234 lines
TypeScript
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235import { type Duration, Effect, Schedule } from "effect";import type { z } from "zod";
import type { JsonValue } from "./types";
// "parse": body is not JSON (html, challenge page); "schema": valid JSON our// zod schema rejects — the split separates "page moved" from "our schema is stale".export type FetchErrorKind = | "http" | "parse" | "schema" | "network" | "timeout";
const KIND_LABELS: Record<FetchErrorKind, string> = { http: "fetch failed", parse: "non-JSON body", schema: "schema mismatch", network: "network error", timeout: "timeout",};
type FetchErrorInit = { url: string; fetcherName?: string; entryId?: string; httpStatus?: number; kind?: FetchErrorKind; cause?: Error;};
export class FetchError extends Error { readonly url: string; readonly fetcherName?: string; readonly entryId?: string; readonly httpStatus?: number; readonly kind?: FetchErrorKind;
constructor(init: FetchErrorInit) { const ctx = [init.fetcherName, init.entryId && `(${init.entryId})`] .filter(Boolean) .join(" ") || "FetchError"; const status = init.httpStatus ? `HTTP ${init.httpStatus}` : init.kind ? KIND_LABELS[init.kind] : "fetch failed"; super(`[${ctx}] ${status}: ${init.url}`, { cause: init.cause }); this.name = "FetchError"; this.url = init.url; this.fetcherName = init.fetcherName; this.entryId = init.entryId; this.httpStatus = init.httpStatus; this.kind = init.kind; }}
const DEFAULT_TIMEOUT: Duration.Input = "30000 millis";
export type FetchBaseOptions = { url: string; init?: Omit<RequestInit, "signal" | "headers"> & { headers?: Record<string, string>; }; timeout?: Duration.Input; fetcherName?: string; entryId?: string;};
const isRetryable = (err: FetchError): boolean => !( err.httpStatus !== undefined && err.httpStatus >= 400 && err.httpStatus < 500 );
const retryPolicy = { schedule: Schedule.exponential("100 millis").pipe(Schedule.jittered), times: 3, while: isRetryable,};
const buildFetchError = ( opts: FetchBaseOptions, extras: { httpStatus?: number; kind?: FetchErrorKind; cause?: Error },): FetchError => new FetchError({ url: opts.url, fetcherName: opts.fetcherName, entryId: opts.entryId, ...extras, });
const failWith = (opts: FetchBaseOptions, kind: FetchErrorKind) => (cause: unknown): FetchError => buildFetchError(opts, { kind, cause: cause instanceof Error ? cause : new Error(String(cause)), });
const doFetch = ( opts: FetchBaseOptions, defaultHeaders: Record<string, string>,): Effect.Effect<Response, FetchError> => Effect.tryPromise({ try: (signal) => fetch(opts.url, { ...opts.init, headers: { ...defaultHeaders, ...opts.init?.headers }, signal, }), catch: failWith(opts, "network"), }).pipe( Effect.timeoutOrElse({ duration: opts.timeout ?? DEFAULT_TIMEOUT, orElse: () => Effect.fail( buildFetchError(opts, { kind: "timeout", cause: new Error( `timeout after ${String(opts.timeout ?? DEFAULT_TIMEOUT)}`, ), }), ), }), Effect.flatMap((response) => response.ok ? Effect.succeed(response) : Effect.fail( buildFetchError(opts, { httpStatus: response.status, kind: "http", }), ), ), );
// The body read gets its own timeout: `doFetch`'s only covers up to headers,// so a stalled body stream would otherwise hang callers forever.const fetchBody = <T>( opts: FetchBaseOptions, defaultHeaders: Record<string, string>, read: (response: Response) => Effect.Effect<T, FetchError>,): Effect.Effect<T, FetchError> => doFetch(opts, defaultHeaders).pipe( Effect.retry(retryPolicy), Effect.flatMap((response) => read(response).pipe( Effect.timeoutOrElse({ duration: opts.timeout ?? DEFAULT_TIMEOUT, orElse: () => Effect.fail( buildFetchError(opts, { kind: "timeout", cause: new Error( `body read timeout after ${String(opts.timeout ?? DEFAULT_TIMEOUT)}`, ), }), ), }), ), ), );
const JSON_HEADERS = { "User-Agent": "OpenStatus-Directory/1.0", Accept: "application/json",};
// browser-like UA: some status pages reject non-browser User-Agentsconst TEXT_HEADERS = { "User-Agent": "Mozilla/5.0 (compatible; OpenStatus-Bot/1.0)",};
export const fetchJson = <T>( opts: FetchBaseOptions & { schema: z.ZodType<T> },): Effect.Effect<T, FetchError> => fetchBody(opts, JSON_HEADERS, (response) => Effect.tryPromise({ try: () => response.json(), catch: failWith(opts, "parse"), }).pipe( Effect.flatMap((json) => Effect.try({ try: () => opts.schema.parse(json), catch: failWith(opts, "schema"), }), ), ), );
// `response.json()` is typed `Promise<any>` by the platform lib; the cast pins// the boundary to a concrete JsonValue so callers never touch `any`/`unknown`.export const fetchJsonWithRaw = <T>( opts: FetchBaseOptions & { schema: z.ZodType<T> },): Effect.Effect<{ parsed: T; raw: JsonValue }, FetchError> => fetchBody(opts, JSON_HEADERS, (response) => Effect.tryPromise({ try: () => response.json() as Promise<JsonValue>, catch: failWith(opts, "parse"), }).pipe( Effect.flatMap((raw) => Effect.try({ try: () => ({ parsed: opts.schema.parse(raw), raw }), catch: failWith(opts, "schema"), }), ), ), );
export const fetchText = ( opts: FetchBaseOptions,): Effect.Effect<string, FetchError> => fetchBody(opts, TEXT_HEADERS, (response) => Effect.tryPromise({ try: () => response.text(), catch: failWith(opts, "network"), }), );
export const fetchTextWithUrl = ( opts: FetchBaseOptions,): Effect.Effect<{ text: string; finalUrl: string }, FetchError> => fetchBody(opts, TEXT_HEADERS, (response) => Effect.tryPromise({ try: async () => ({ text: await response.text(), finalUrl: response.url, }), catch: failWith(opts, "network"), }), );