Files
supabase/apps/docs/features/helpers.fn.ts
Charis 4e916fc16a feat(graphql): add paginated errors collection query (#36149)
* feat(graphql): add paginated errors collection query

- Add new GraphQL query field 'errors' with cursor-based pagination

- Add UUID id column to content.error table for cursor pagination

- Implement error collection resolver with forward/backward pagination

- Add comprehensive test suite for pagination functionality

- Update database types and schema to support new error collection

- Add utility functions for handling collection queries and errors

- Add seed data for testing pagination scenarios

This change allows clients to efficiently paginate through error codes using cursor-based pagination, supporting both forward and backward traversal. The implementation follows the Relay connection specification and includes proper error handling and type safety.

* docs(graphql): add comprehensive GraphQL architecture documentation

Add detailed documentation for the docs GraphQL endpoint architecture, including:
- Modular query pattern and folder structure
- Step-by-step guide for creating new top-level queries
- Best practices for error handling, field optimization, and testing
- Code examples for schemas, models, resolvers, and tests

* feat(graphql): add service filtering to errors collection query

Enable filtering error codes by Supabase service in the GraphQL errors collection:
- Add optional service argument to errors query resolver
- Update error model to support service-based filtering in database queries
- Maintain pagination compatibility with service filtering
- Add comprehensive tests for service filtering with and without pagination

* feat(graphql): add service filtering and fix cursor encoding for errors collection

- Add service parameter to errors GraphQL query for filtering by Supabase service
- Implement base64 encoding/decoding for pagination cursors in error resolver
- Fix test cursor encoding to match resolver implementation
- Update GraphQL schema snapshot to reflect new service filter field

* docs(graphql): fix codegen instruction
2025-06-09 10:24:17 -04:00

161 lines
4.5 KiB
TypeScript

import { extractMessageFromAnyError, MultiError } from '~/app/api/utils'
const EMPTY_ARRAY = new Array(0)
export function getEmptyArray() {
return EMPTY_ARRAY
}
export function deepFilterRec<T extends object>(
arr: Array<T>,
recKey: string,
filterFn: (item: T) => boolean
): Array<T> {
return arr.reduce((acc, elem) => {
if (!filterFn(elem)) return acc
if (recKey in elem && elem[recKey as keyof T]) {
const newSubitems = deepFilterRec(elem[recKey as keyof T] as Array<T>, recKey, filterFn)
const newElem = { ...elem, [recKey]: newSubitems }
if (newSubitems.length > 0 || filterFn(elem)) acc.push(newElem)
} else {
acc.push(elem)
}
return acc
}, [] as Array<T>)
}
export async function pluckPromise<T, K extends keyof T>(promise: Promise<T>, key: K) {
const data = await promise
return data[key]
}
export class Result<Ok, Error> {
constructor(private internal: { data: Ok; error: null } | { data: null; error: Error }) {}
static ok<Error = unknown, Ok = unknown>(data: Ok): Result<Ok, Error> {
return new Result<Ok, Error>({ data, error: null })
}
static error<Ok = unknown, Error = unknown>(error: Error): Result<Ok, Error> {
return new Result<Ok, Error>({ data: null, error })
}
static tryCatchSync<Ok, Error, Args extends Array<unknown>>(
fn: (...args: Args) => Ok,
onError: (error: unknown) => Error,
...args: Args
): Result<Ok, Error> {
try {
return Result.ok(fn(...args))
} catch (error: unknown) {
return Result.error(onError(error))
}
}
static async tryCatch<Ok, Error, Args extends Array<unknown>>(
fn: (...args: Args) => Promise<Ok>,
onError: (error: unknown) => Error,
...args: Args
): Promise<Result<Ok, Error>> {
try {
return Result.ok(await fn(...args))
} catch (error: unknown) {
return Result.error(onError(error))
}
}
static async tryCatchFlat<
Ok,
Args extends Array<unknown> = [],
OuterError = unknown,
InnerError = unknown,
>(
fn: (...args: Args) => Promise<Result<Ok, InnerError>>,
onError: (error: unknown) => OuterError | InnerError,
...args: Args
): Promise<Result<Ok, OuterError | InnerError>> {
try {
return await fn(...args)
} catch (error: unknown) {
return Result.error(onError(error))
}
}
static transposeArray<Ok, Error>(
array: Array<Result<Ok, Error>>
): Result<Array<Ok>, MultiError<Error>> {
let data: Array<Ok> = new Array(array.length)
let error: MultiError | null = null
for (const result of array) {
if (result.isOk()) {
data.push(result.internal.data!)
} else {
;(error ??= new MultiError('MultiError:')).appendError(
extractMessageFromAnyError(error),
result.internal.error
)
}
}
if (error) return Result.error(error)
return Result.ok(data)
}
isOk(): this is Result<Ok, never> {
return this.internal.error == null
}
map<Mapped>(fn: (data: Ok) => Mapped): Result<Mapped, Error> {
if (this.isOk()) return Result.ok(fn(this.internal.data!))
return this as unknown as Result<Mapped, Error>
}
mapError<MappedError>(fn: (error: Error) => MappedError): Result<Ok, MappedError> {
if (this.isOk()) return this as unknown as Result<Ok, MappedError>
return Result.error(fn(this.internal.error!))
}
flatMap<Mapped>(fn: (data: Ok) => Result<Mapped, Error>): Result<Mapped, Error> {
if (this.isOk()) return fn(this.internal.data!)
return this as unknown as Result<Mapped, Error>
}
flatMapAsync<Mapped>(
fn: (data: Ok) => Promise<Result<Mapped, Error>>
): Promise<Result<Mapped, Error>> {
if (this.isOk()) return fn(this.internal.data!)
return Promise.resolve(this as unknown as Result<Mapped, Error>)
}
match<Mapped, MappedError>(
onOk: (data: Ok) => Mapped,
onError: (error: Error) => MappedError
): Mapped | MappedError {
if (this.isOk()) return onOk(this.internal.data!)
return onError(this.internal.error!)
}
unwrap(): Ok {
if (!this.isOk()) {
throw new Error(`Unwrap called on Err: ${this.internal.error}`, {
cause: this.internal.error,
})
}
return this.internal.data!
}
join<OtherOk, OtherError>(
other: Result<OtherOk, OtherError>
): Result<[Ok, OtherOk], [Error, OtherError]> {
if (!this.isOk() || !other.isOk())
return Result.error([this.internal.error, other.internal.error]) as Result<
[Ok, OtherOk],
[Error, OtherError]
>
return Result.ok([this.internal.data!, other.internal.data!])
}
}