effect-view/packages/effect-fc-next/src/Query.ts

import { type Cause, type Context, Duration, Effect, Equal, type Equivalence, Exit, Fiber, Option, Pipeable, Predicate, type Scope, Semaphore, Stream, SubscriptionRef } from "effect"
import { AsyncResult } from "effect/unstable/reactivity"
import * as Lens from "./Lens.js"
import * as QueryClient from "./QueryClient.js"
import * as Subscribable from "./Subscribable.js"


export const QueryTypeId: unique symbol = Symbol.for("@effect-fc/Query/Query")
export type QueryTypeId = typeof QueryTypeId

export interface Query<in out K, in out A, in out E = never, in out R = never>
extends Pipeable.Pipeable {
    readonly [QueryTypeId]: QueryTypeId

    readonly context: Context.Context<Scope.Scope | QueryClient.QueryClient | R>
    readonly f: (key: K) => Effect.Effect<A, E, R>
    readonly keyEquivalence: Equivalence.Equivalence<K>

    readonly staleTime: Duration.Duration
    readonly refreshOnWindowFocus: boolean

    readonly latestKey: Subscribable.Subscribable<Option.Option<K>>
    readonly fiber: Subscribable.Subscribable<Option.Option<Fiber.Fiber<A, E>>>
    readonly state: Subscribable.Subscribable<QueryState<K, A, E>>
    readonly latestFinalState: Subscribable.Subscribable<Option.Option<FinalQueryState<K, A, E>>>

    readonly run: Effect.Effect<void>
    fetch(key: K): Effect.Effect<FinalQueryState<K, A, E>, Cause.NoSuchElementError>
    fetchSubscribable(key: K): Effect.Effect<Subscribable.Subscribable<QueryState<K, A, E>>, Cause.NoSuchElementError>
    readonly refresh: Effect.Effect<FinalQueryState<K, A, E>, Cause.NoSuchElementError>
    readonly refreshSubscribable: Effect.Effect<Subscribable.Subscribable<QueryState<K, A, E>>, Cause.NoSuchElementError>

    readonly invalidateCache: Effect.Effect<void>
    invalidateCacheEntry(key: K): Effect.Effect<void>
}

export interface QueryState<in out K, in out A, in out E = never> {
    readonly key: K
    readonly result: AsyncResult.AsyncResult<A, E>
}

export interface FinalQueryState<in out K, in out A, in out E = never> {
    readonly key: K
    readonly result: AsyncResult.Success<A, E> | AsyncResult.Failure<A, E>
}

export const isQuery = (u: unknown): u is Query<unknown, unknown, unknown, unknown> => Predicate.hasProperty(u, QueryTypeId)


export class QueryImpl<in out K, in out A, in out E = never, in out R = never>
extends Pipeable.Class implements Query<K, A, E, R> {
    readonly [QueryTypeId]: QueryTypeId = QueryTypeId

    constructor(
        readonly context: Context.Context<Scope.Scope | QueryClient.QueryClient | R>,
        readonly f: (key: K) => Effect.Effect<A, E, R>,
        readonly keyEquivalence: Equivalence.Equivalence<K>,

        readonly staleTime: Duration.Duration,
        readonly refreshOnWindowFocus: boolean,

        readonly latestKey: Lens.Lens<Option.Option<K>>,
        readonly fiber: Lens.Lens<Option.Option<Fiber.Fiber<A, E>>>,
        readonly state: Lens.Lens<QueryState<K, A, E>>,
        readonly latestFinalState: Lens.Lens<Option.Option<FinalQueryState<K, A, E>>>,

        readonly runSemaphore: Semaphore.Semaphore,
    ) {
        super()
    }

    get run(): Effect.Effect<void> {
        return Effect.promise(() => import("@effect/platform-browser")).pipe(
            Effect.flatMap(({ BrowserStream }) => this.refreshOnWindowFocus
                ? Stream.runForEach(
                    BrowserStream.fromEventListenerWindow("focus"),
                    () => this.refreshSubscribable,
                )
                : Effect.void
            ),
            Effect.catchDefect(() => Effect.void),
            Effect.ignore,
            this.runSemaphore.withPermits(1),
            Effect.provide(this.context),
        )
    }

    get interrupt(): Effect.Effect<void> {
        return Effect.flatMap(Lens.get(this.fiber), Option.match({
            onSome: Fiber.interrupt,
            onNone: () => Effect.void,
        }))
    }

    fetch(key: K): Effect.Effect<FinalQueryState<K, A, E>, Cause.NoSuchElementError> {
        return this.interrupt.pipe(
            Effect.andThen(Lens.set(this.latestKey, Option.some(key))),
            Effect.andThen(this.startCached({
                key,
                result: AsyncResult.initial(false)
            })),
            Effect.flatMap(state => this.watch(state)),
            Effect.provide(this.context),
        )
    }

    fetchSubscribable(key: K): Effect.Effect<
        Subscribable.Subscribable<QueryState<K, A, E>>,
        Cause.NoSuchElementError
    > {
        return this.interrupt.pipe(
            Effect.andThen(Lens.set(this.latestKey, Option.some(key))),
            Effect.andThen(this.startCached({
                key,
                result: AsyncResult.initial(false)
            })),
            Effect.tap(state => Effect.forkScoped(this.watch(state))),
            Effect.provide(this.context),
        )
    }

    get refresh(): Effect.Effect<FinalQueryState<K, A, E>, Cause.NoSuchElementError> {
        return this.interrupt.pipe(
            Effect.andThen(Effect.Do),
            Effect.bind("latestKey", () => Effect.flatMap(Lens.get(this.latestKey), Effect.fromOption)),
            Effect.bind("latestFinalState", () => Lens.get(this.latestFinalState)),
            Effect.bind("subscribable", ({ latestKey, latestFinalState }) =>
                this.startCached(Option.getOrElse(latestFinalState, () => ({
                    key: latestKey,
                    result: AsyncResult.initial(true),
                })))
            ),
            Effect.flatMap(({ subscribable }) => this.watch(subscribable)),
            Effect.provide(this.context),
        )
    }

    get refreshSubscribable(): Effect.Effect<
        Subscribable.Subscribable<QueryState<K, A, E>>,
        Cause.NoSuchElementError
    > {
        return this.interrupt.pipe(
            Effect.andThen(Effect.Do),
            Effect.bind("latestKey", () => Effect.flatMap(Lens.get(this.latestKey), Effect.fromOption)),
            Effect.bind("latestFinalState", () => Lens.get(this.latestFinalState)),
            Effect.bind("subscribable", ({ latestKey, latestFinalState }) =>
                this.startCached(Option.getOrElse(latestFinalState, () => ({
                    key: latestKey,
                    result: AsyncResult.initial(true),
                })))
            ),
            Effect.tap(({ subscribable }) => Effect.forkScoped(this.watch(subscribable))),
            Effect.map(({ subscribable }) => subscribable),
            Effect.provide(this.context),
        )
    }

    startCached(
        previous: QueryState<K, A, E>,
    ): Effect.Effect<
        Subscribable.Subscribable<QueryState<K, A, E>>,
        Cause.NoSuchElementError,
        Scope.Scope | QueryClient.QueryClient | R
    > {
        return Effect.flatMap(this.getCacheEntry(previous.key), Option.match({
            onSome: entry => Effect.flatMap(
                QueryClient.isQueryClientCacheEntryStale(entry),
                isStale => isStale
                    ? this.start({
                        key: previous.key,
                        result: entry.result as AsyncResult.AsyncResult<A, E>,
                    })
                    : Effect.succeed(Subscribable.make({
                        get: Effect.succeed({
                            key: previous.key,
                            result: entry.result as AsyncResult.AsyncResult<A, E>,
                        }),
                        get changes() {
                            return Stream.make({
                                key: previous.key,
                                result: entry.result as AsyncResult.AsyncResult<A, E>,
                            })
                        },
                    })),
            ),
            onNone: () => this.start(previous),
        }))
    }

    start(
        previous: QueryState<K, A, E>,
    ): Effect.Effect<
        Subscribable.Subscribable<QueryState<K, A, E>>,
        never,
        Scope.Scope | R
    > {
        return Effect.gen({ self: this }, function*() {
            const subscribable = Lens.fromSubscriptionRef(yield* SubscriptionRef.make(previous))

            const fiber = yield* Effect.forkScoped(Effect.andThen(
                Lens.update(subscribable, previous => AsyncResult.match(previous.result, {
                    onInitial: () => ({
                        key: previous.key,
                        result: AsyncResult.initial(true),
                    }),
                    onSuccess: result => ({
                        key: previous.key,
                        result: AsyncResult.success(result.value, {
                            waiting: true,
                        }),
                    }),
                    onFailure: result => ({
                        key: previous.key,
                        result: AsyncResult.failure(result.cause, {
                            waiting: true,
                            previousSuccess: result.previousSuccess,
                        }),
                    }),
                })),

                Effect.onExit(this.f(previous.key), exit => Lens.update(
                    subscribable,
                    previous => Exit.match(exit, {
                        onSuccess: v => ({
                            key: previous.key,
                            result: AsyncResult.success(v),
                        }),
                        onFailure: c => AsyncResult.match(previous.result, {
                            onInitial: () => ({
                                key: previous.key,
                                result: AsyncResult.failure(c),
                            }),
                            onSuccess: v => ({
                                key: previous.key,
                                result: AsyncResult.failure(c, {
                                    previousSuccess: Option.some(v),
                                }),
                            }),
                            onFailure: v => ({
                                key: previous.key,
                                result: AsyncResult.failure(c, {
                                    previousSuccess: v.previousSuccess,
                                }),
                            }),
                        }),
                    }),
                ).pipe(
                    Effect.andThen(Effect.all([
                        Effect.fiberId,
                        Lens.get(this.fiber),
                    ])),
                    Effect.flatMap(([fiberId, fiber]) => Option.match(fiber, {
                        onSome: v => fiberId === v.id
                            ? Lens.set(this.fiber, Option.none())
                            : Effect.void,
                        onNone: () => Effect.void,
                    })),
                )),
            ))

            yield* Lens.set(this.fiber, Option.some(fiber))
            return subscribable
        })
    }

    watch(
        subscribable: Subscribable.Subscribable<QueryState<K, A, E>>
    ): Effect.Effect<FinalQueryState<K, A, E>, never, QueryClient.QueryClient> {
        return subscribable.get.pipe(
            Effect.flatMap(initial => Stream.runFoldEffect(
                subscribable.changes,
                () => initial,
                (_, state) => Effect.as(Lens.set(this.state, state), state),
            ) as Effect.Effect<FinalQueryState<K, A, E>>),
            Effect.tap(state => Lens.set(this.latestFinalState, Option.some(state))),
            Effect.tap(state => AsyncResult.isSuccess(state.result)
                ? this.setCacheEntry(state.key, state.result)
                : Effect.void
            ),
        )
    }

    makeCacheKey(key: K): QueryClient.QueryClientCacheKey {
        return new QueryClient.QueryClientCacheKey(key, this.f as (key: unknown) => Effect.Effect<unknown, unknown, unknown>)
    }

    getCacheEntry(
        key: K
    ): Effect.Effect<Option.Option<QueryClient.QueryClientCacheEntry>, never, QueryClient.QueryClient> {
        return Effect.andThen(
            Effect.all([
                Effect.succeed(this.makeCacheKey(key)),
                QueryClient.QueryClient,
            ]),
            ([key, client]) => client.getCacheEntry(key),
        )
    }

    setCacheEntry(
        key: K,
        result: AsyncResult.Success<A, E>,
    ): Effect.Effect<QueryClient.QueryClientCacheEntry, never, QueryClient.QueryClient> {
        return Effect.flatMap(
            Effect.all([
                Effect.succeed(this.makeCacheKey(key)),
                QueryClient.QueryClient,
            ]),
            ([key, client]) => client.setCacheEntry(key, result, this.staleTime),
        )
    }

    get invalidateCache(): Effect.Effect<void> {
        return QueryClient.QueryClient.pipe(
            Effect.andThen(client => client.invalidateCacheEntries(this.f as (key: unknown) => Effect.Effect<unknown, unknown, unknown>)),
            Effect.provide(this.context),
        )
    }

    invalidateCacheEntry(key: K): Effect.Effect<void> {
        return Effect.all([
            Effect.succeed(this.makeCacheKey(key)),
            QueryClient.QueryClient,
        ]).pipe(
            Effect.andThen(([key, client]) => client.invalidateCacheEntry(key)),
            Effect.provide(this.context),
        )
    }
}

export declare namespace make {
    export interface Options<K, A, E = never, R = never> {
        readonly f: (key: K) => Effect.Effect<A, E, R>
        readonly keyEquivalence?: Equivalence.Equivalence<K>,
        readonly staleTime?: Duration.Input
        readonly refreshOnWindowFocus?: boolean
    }
}

export const make = Effect.fnUntraced(function* <K, A, E = never, R = never>(
    options: make.Options<K, A, E, R>
): Effect.fn.Return<
    Query<K, A, E, R>,
    Cause.NoSuchElementError,
    Scope.Scope | QueryClient.QueryClient | R
> {
    const client = yield* QueryClient.QueryClient

    return new QueryImpl(
        yield* Effect.context<Scope.Scope | QueryClient.QueryClient | R>(),
        options.f,
        options.keyEquivalence ?? Equal.asEquivalence(),

        options.staleTime ? yield* Effect.fromOption(Duration.fromInput(options.staleTime)) : client.defaultStaleTime,
        options.refreshOnWindowFocus ?? client.defaultRefreshOnWindowFocus,

        Lens.fromSubscriptionRef(yield* SubscriptionRef.make(Option.none<K>())),
        Lens.fromSubscriptionRef(yield* SubscriptionRef.make(Option.none<Fiber.Fiber<A, E>>())),
        Lens.fromSubscriptionRef(yield* SubscriptionRef.make<AsyncResult.AsyncResult<A, E>>(AsyncResult.initial())),
        Lens.fromSubscriptionRef(yield* SubscriptionRef.make(Option.none<AsyncResult.Success<A, E> | AsyncResult.Failure<A, E>>())),

        yield* Semaphore.make(1),
    )
})

export const service = <K, A, E = never, R = never>(
    options: make.Options<K, A, E, R>
): Effect.Effect<
    Query<K, A, E, R>,
    Cause.NoSuchElementError,
    Scope.Scope | QueryClient.QueryClient | R
> => Effect.tap(
    make(options),
    query => Effect.forkScoped(query.run),
)