byterover-cli 3.10.0 → 3.10.2

package/node_modules/@tanstack/query-core/src/mutation.ts

@@ -0,0 +1,419 @@
+import { notifyManager } from './notifyManager'
+import { Removable } from './removable'
+import { createRetryer } from './retryer'
+import type {
+  DefaultError,
+  MutationFunctionContext,
+  MutationMeta,
+  MutationOptions,
+  MutationStatus,
+} from './types'
+import type { MutationCache } from './mutationCache'
+import type { MutationObserver } from './mutationObserver'
+import type { Retryer } from './retryer'
+import type { QueryClient } from './queryClient'
+
+// TYPES
+
+interface MutationConfig<TData, TError, TVariables, TOnMutateResult> {
+  client: QueryClient
+  mutationId: number
+  mutationCache: MutationCache
+  options: MutationOptions<TData, TError, TVariables, TOnMutateResult>
+  state?: MutationState<TData, TError, TVariables, TOnMutateResult>
+}
+
+export interface MutationState<
+  TData = unknown,
+  TError = DefaultError,
+  TVariables = unknown,
+  TOnMutateResult = unknown,
+> {
+  context: TOnMutateResult | undefined
+  data: TData | undefined
+  error: TError | null
+  failureCount: number
+  failureReason: TError | null
+  isPaused: boolean
+  status: MutationStatus
+  variables: TVariables | undefined
+  submittedAt: number
+}
+
+interface FailedAction<TError> {
+  type: 'failed'
+  failureCount: number
+  error: TError | null
+}
+
+interface PendingAction<TVariables, TOnMutateResult> {
+  type: 'pending'
+  isPaused: boolean
+  variables?: TVariables
+  context?: TOnMutateResult
+}
+
+interface SuccessAction<TData> {
+  type: 'success'
+  data: TData
+}
+
+interface ErrorAction<TError> {
+  type: 'error'
+  error: TError
+}
+
+interface PauseAction {
+  type: 'pause'
+}
+
+interface ContinueAction {
+  type: 'continue'
+}
+
+export type Action<TData, TError, TVariables, TOnMutateResult> =
+  | ContinueAction
+  | ErrorAction<TError>
+  | FailedAction<TError>
+  | PendingAction<TVariables, TOnMutateResult>
+  | PauseAction
+  | SuccessAction<TData>
+
+// CLASS
+
+export class Mutation<
+  TData = unknown,
+  TError = DefaultError,
+  TVariables = unknown,
+  TOnMutateResult = unknown,
+> extends Removable {
+  state: MutationState<TData, TError, TVariables, TOnMutateResult>
+  options!: MutationOptions<TData, TError, TVariables, TOnMutateResult>
+  readonly mutationId: number
+
+  #client: QueryClient
+  #observers: Array<
+    MutationObserver<TData, TError, TVariables, TOnMutateResult>
+  >
+  #mutationCache: MutationCache
+  #retryer?: Retryer<TData>
+
+  constructor(
+    config: MutationConfig<TData, TError, TVariables, TOnMutateResult>,
+  ) {
+    super()
+
+    this.#client = config.client
+    this.mutationId = config.mutationId
+    this.#mutationCache = config.mutationCache
+    this.#observers = []
+    this.state = config.state || getDefaultState()
+
+    this.setOptions(config.options)
+    this.scheduleGc()
+  }
+
+  setOptions(
+    options: MutationOptions<TData, TError, TVariables, TOnMutateResult>,
+  ): void {
+    this.options = options
+
+    this.updateGcTime(this.options.gcTime)
+  }
+
+  get meta(): MutationMeta | undefined {
+    return this.options.meta
+  }
+
+  addObserver(observer: MutationObserver<any, any, any, any>): void {
+    if (!this.#observers.includes(observer)) {
+      this.#observers.push(observer)
+
+      // Stop the mutation from being garbage collected
+      this.clearGcTimeout()
+
+      this.#mutationCache.notify({
+        type: 'observerAdded',
+        mutation: this,
+        observer,
+      })
+    }
+  }
+
+  removeObserver(observer: MutationObserver<any, any, any, any>): void {
+    this.#observers = this.#observers.filter((x) => x !== observer)
+
+    this.scheduleGc()
+
+    this.#mutationCache.notify({
+      type: 'observerRemoved',
+      mutation: this,
+      observer,
+    })
+  }
+
+  protected optionalRemove() {
+    if (!this.#observers.length) {
+      if (this.state.status === 'pending') {
+        this.scheduleGc()
+      } else {
+        this.#mutationCache.remove(this)
+      }
+    }
+  }
+
+  continue(): Promise<unknown> {
+    return (
+      this.#retryer?.continue() ??
+      // continuing a mutation assumes that variables are set, mutation must have been dehydrated before
+      this.execute(this.state.variables!)
+    )
+  }
+
+  async execute(variables: TVariables): Promise<TData> {
+    const onContinue = () => {
+      this.#dispatch({ type: 'continue' })
+    }
+
+    const mutationFnContext = {
+      client: this.#client,
+      meta: this.options.meta,
+      mutationKey: this.options.mutationKey,
+    } satisfies MutationFunctionContext
+
+    this.#retryer = createRetryer({
+      fn: () => {
+        if (!this.options.mutationFn) {
+          return Promise.reject(new Error('No mutationFn found'))
+        }
+
+        return this.options.mutationFn(variables, mutationFnContext)
+      },
+      onFail: (failureCount, error) => {
+        this.#dispatch({ type: 'failed', failureCount, error })
+      },
+      onPause: () => {
+        this.#dispatch({ type: 'pause' })
+      },
+      onContinue,
+      retry: this.options.retry ?? 0,
+      retryDelay: this.options.retryDelay,
+      networkMode: this.options.networkMode,
+      canRun: () => this.#mutationCache.canRun(this),
+    })
+
+    const restored = this.state.status === 'pending'
+    const isPaused = !this.#retryer.canStart()
+
+    try {
+      if (restored) {
+        // Dispatch continue action to unpause restored mutation
+        onContinue()
+      } else {
+        this.#dispatch({ type: 'pending', variables, isPaused })
+        // Notify cache callback
+        if (this.#mutationCache.config.onMutate) {
+          await this.#mutationCache.config.onMutate(
+            variables,
+            this as Mutation<unknown, unknown, unknown, unknown>,
+            mutationFnContext,
+          )
+        }
+        const context = await this.options.onMutate?.(
+          variables,
+          mutationFnContext,
+        )
+        if (context !== this.state.context) {
+          this.#dispatch({
+            type: 'pending',
+            context,
+            variables,
+            isPaused,
+          })
+        }
+      }
+      const data = await this.#retryer.start()
+
+      // Notify cache callback
+      await this.#mutationCache.config.onSuccess?.(
+        data,
+        variables,
+        this.state.context,
+        this as Mutation<unknown, unknown, unknown, unknown>,
+        mutationFnContext,
+      )
+
+      await this.options.onSuccess?.(
+        data,
+        variables,
+        this.state.context!,
+        mutationFnContext,
+      )
+
+      // Notify cache callback
+      await this.#mutationCache.config.onSettled?.(
+        data,
+        null,
+        this.state.variables,
+        this.state.context,
+        this as Mutation<unknown, unknown, unknown, unknown>,
+        mutationFnContext,
+      )
+
+      await this.options.onSettled?.(
+        data,
+        null,
+        variables,
+        this.state.context,
+        mutationFnContext,
+      )
+
+      this.#dispatch({ type: 'success', data })
+      return data
+    } catch (error) {
+      try {
+        // Notify cache callback
+        await this.#mutationCache.config.onError?.(
+          error as any,
+          variables,
+          this.state.context,
+          this as Mutation<unknown, unknown, unknown, unknown>,
+          mutationFnContext,
+        )
+      } catch (e) {
+        void Promise.reject(e)
+      }
+
+      try {
+        await this.options.onError?.(
+          error as TError,
+          variables,
+          this.state.context,
+          mutationFnContext,
+        )
+      } catch (e) {
+        void Promise.reject(e)
+      }
+
+      try {
+        // Notify cache callback
+        await this.#mutationCache.config.onSettled?.(
+          undefined,
+          error as any,
+          this.state.variables,
+          this.state.context,
+          this as Mutation<unknown, unknown, unknown, unknown>,
+          mutationFnContext,
+        )
+      } catch (e) {
+        void Promise.reject(e)
+      }
+
+      try {
+        await this.options.onSettled?.(
+          undefined,
+          error as TError,
+          variables,
+          this.state.context,
+          mutationFnContext,
+        )
+      } catch (e) {
+        void Promise.reject(e)
+      }
+
+      this.#dispatch({ type: 'error', error: error as TError })
+      throw error
+    } finally {
+      this.#mutationCache.runNext(this)
+    }
+  }
+
+  #dispatch(action: Action<TData, TError, TVariables, TOnMutateResult>): void {
+    const reducer = (
+      state: MutationState<TData, TError, TVariables, TOnMutateResult>,
+    ): MutationState<TData, TError, TVariables, TOnMutateResult> => {
+      switch (action.type) {
+        case 'failed':
+          return {
+            ...state,
+            failureCount: action.failureCount,
+            failureReason: action.error,
+          }
+        case 'pause':
+          return {
+            ...state,
+            isPaused: true,
+          }
+        case 'continue':
+          return {
+            ...state,
+            isPaused: false,
+          }
+        case 'pending':
+          return {
+            ...state,
+            context: action.context,
+            data: undefined,
+            failureCount: 0,
+            failureReason: null,
+            error: null,
+            isPaused: action.isPaused,
+            status: 'pending',
+            variables: action.variables,
+            submittedAt: Date.now(),
+          }
+        case 'success':
+          return {
+            ...state,
+            data: action.data,
+            failureCount: 0,
+            failureReason: null,
+            error: null,
+            status: 'success',
+            isPaused: false,
+          }
+        case 'error':
+          return {
+            ...state,
+            data: undefined,
+            error: action.error,
+            failureCount: state.failureCount + 1,
+            failureReason: action.error,
+            isPaused: false,
+            status: 'error',
+          }
+      }
+    }
+    this.state = reducer(this.state)
+
+    notifyManager.batch(() => {
+      this.#observers.forEach((observer) => {
+        observer.onMutationUpdate(action)
+      })
+      this.#mutationCache.notify({
+        mutation: this,
+        type: 'updated',
+        action,
+      })
+    })
+  }
+}
+
+export function getDefaultState<
+  TData,
+  TError,
+  TVariables,
+  TOnMutateResult,
+>(): MutationState<TData, TError, TVariables, TOnMutateResult> {
+  return {
+    context: undefined,
+    data: undefined,
+    error: null,
+    failureCount: 0,
+    failureReason: null,
+    isPaused: false,
+    status: 'idle',
+    variables: undefined,
+    submittedAt: 0,
+  }
+}

package/node_modules/@tanstack/query-core/src/mutationCache.ts

@@ -0,0 +1,244 @@
+import { notifyManager } from './notifyManager'
+import { Mutation } from './mutation'
+import { matchMutation, noop } from './utils'
+import { Subscribable } from './subscribable'
+import type { MutationObserver } from './mutationObserver'
+import type {
+  DefaultError,
+  MutationFunctionContext,
+  MutationOptions,
+  NotifyEvent,
+} from './types'
+import type { QueryClient } from './queryClient'
+import type { Action, MutationState } from './mutation'
+import type { MutationFilters } from './utils'
+
+// TYPES
+
+interface MutationCacheConfig {
+  onError?: (
+    error: DefaultError,
+    variables: unknown,
+    onMutateResult: unknown,
+    mutation: Mutation<unknown, unknown, unknown>,
+    context: MutationFunctionContext,
+  ) => Promise<unknown> | unknown
+  onSuccess?: (
+    data: unknown,
+    variables: unknown,
+    onMutateResult: unknown,
+    mutation: Mutation<unknown, unknown, unknown>,
+    context: MutationFunctionContext,
+  ) => Promise<unknown> | unknown
+  onMutate?: (
+    variables: unknown,
+    mutation: Mutation<unknown, unknown, unknown>,
+    context: MutationFunctionContext,
+  ) => Promise<unknown> | unknown
+  onSettled?: (
+    data: unknown | undefined,
+    error: DefaultError | null,
+    variables: unknown,
+    onMutateResult: unknown,
+    mutation: Mutation<unknown, unknown, unknown>,
+    context: MutationFunctionContext,
+  ) => Promise<unknown> | unknown
+}
+
+interface NotifyEventMutationAdded extends NotifyEvent {
+  type: 'added'
+  mutation: Mutation<any, any, any, any>
+}
+interface NotifyEventMutationRemoved extends NotifyEvent {
+  type: 'removed'
+  mutation: Mutation<any, any, any, any>
+}
+
+interface NotifyEventMutationObserverAdded extends NotifyEvent {
+  type: 'observerAdded'
+  mutation: Mutation<any, any, any, any>
+  observer: MutationObserver<any, any, any>
+}
+
+interface NotifyEventMutationObserverRemoved extends NotifyEvent {
+  type: 'observerRemoved'
+  mutation: Mutation<any, any, any, any>
+  observer: MutationObserver<any, any, any>
+}
+
+interface NotifyEventMutationObserverOptionsUpdated extends NotifyEvent {
+  type: 'observerOptionsUpdated'
+  mutation?: Mutation<any, any, any, any>
+  observer: MutationObserver<any, any, any, any>
+}
+
+interface NotifyEventMutationUpdated extends NotifyEvent {
+  type: 'updated'
+  mutation: Mutation<any, any, any, any>
+  action: Action<any, any, any, any>
+}
+
+export type MutationCacheNotifyEvent =
+  | NotifyEventMutationAdded
+  | NotifyEventMutationRemoved
+  | NotifyEventMutationObserverAdded
+  | NotifyEventMutationObserverRemoved
+  | NotifyEventMutationObserverOptionsUpdated
+  | NotifyEventMutationUpdated
+
+type MutationCacheListener = (event: MutationCacheNotifyEvent) => void
+
+// CLASS
+
+export class MutationCache extends Subscribable<MutationCacheListener> {
+  #mutations: Set<Mutation<any, any, any, any>>
+  #scopes: Map<string, Array<Mutation<any, any, any, any>>>
+  #mutationId: number
+
+  constructor(public config: MutationCacheConfig = {}) {
+    super()
+    this.#mutations = new Set()
+    this.#scopes = new Map()
+    this.#mutationId = 0
+  }
+
+  build<TData, TError, TVariables, TOnMutateResult>(
+    client: QueryClient,
+    options: MutationOptions<TData, TError, TVariables, TOnMutateResult>,
+    state?: MutationState<TData, TError, TVariables, TOnMutateResult>,
+  ): Mutation<TData, TError, TVariables, TOnMutateResult> {
+    const mutation = new Mutation({
+      client,
+      mutationCache: this,
+      mutationId: ++this.#mutationId,
+      options: client.defaultMutationOptions(options),
+      state,
+    })
+
+    this.add(mutation)
+
+    return mutation
+  }
+
+  add(mutation: Mutation<any, any, any, any>): void {
+    this.#mutations.add(mutation)
+    const scope = scopeFor(mutation)
+    if (typeof scope === 'string') {
+      const scopedMutations = this.#scopes.get(scope)
+      if (scopedMutations) {
+        scopedMutations.push(mutation)
+      } else {
+        this.#scopes.set(scope, [mutation])
+      }
+    }
+    this.notify({ type: 'added', mutation })
+  }
+
+  remove(mutation: Mutation<any, any, any, any>): void {
+    if (this.#mutations.delete(mutation)) {
+      const scope = scopeFor(mutation)
+      if (typeof scope === 'string') {
+        const scopedMutations = this.#scopes.get(scope)
+        if (scopedMutations) {
+          if (scopedMutations.length > 1) {
+            const index = scopedMutations.indexOf(mutation)
+            if (index !== -1) {
+              scopedMutations.splice(index, 1)
+            }
+          } else if (scopedMutations[0] === mutation) {
+            this.#scopes.delete(scope)
+          }
+        }
+      }
+    }
+
+    // Currently we notify the removal even if the mutation was already removed.
+    // Consider making this an error or not notifying of the removal depending on the desired semantics.
+    this.notify({ type: 'removed', mutation })
+  }
+
+  canRun(mutation: Mutation<any, any, any, any>): boolean {
+    const scope = scopeFor(mutation)
+    if (typeof scope === 'string') {
+      const mutationsWithSameScope = this.#scopes.get(scope)
+      const firstPendingMutation = mutationsWithSameScope?.find(
+        (m) => m.state.status === 'pending',
+      )
+      // we can run if there is no current pending mutation (start use-case)
+      // or if WE are the first pending mutation (continue use-case)
+      return !firstPendingMutation || firstPendingMutation === mutation
+    } else {
+      // For unscoped mutations there are never any pending mutations in front of the
+      // current mutation
+      return true
+    }
+  }
+
+  runNext(mutation: Mutation<any, any, any, any>): Promise<unknown> {
+    const scope = scopeFor(mutation)
+    if (typeof scope === 'string') {
+      const foundMutation = this.#scopes
+        .get(scope)
+        ?.find((m) => m !== mutation && m.state.isPaused)
+
+      return foundMutation?.continue() ?? Promise.resolve()
+    } else {
+      return Promise.resolve()
+    }
+  }
+
+  clear(): void {
+    notifyManager.batch(() => {
+      this.#mutations.forEach((mutation) => {
+        this.notify({ type: 'removed', mutation })
+      })
+      this.#mutations.clear()
+      this.#scopes.clear()
+    })
+  }
+
+  getAll(): Array<Mutation> {
+    return Array.from(this.#mutations)
+  }
+
+  find<
+    TData = unknown,
+    TError = DefaultError,
+    TVariables = any,
+    TOnMutateResult = unknown,
+  >(
+    filters: MutationFilters,
+  ): Mutation<TData, TError, TVariables, TOnMutateResult> | undefined {
+    const defaultedFilters = { exact: true, ...filters }
+
+    return this.getAll().find((mutation) =>
+      matchMutation(defaultedFilters, mutation),
+    ) as Mutation<TData, TError, TVariables, TOnMutateResult> | undefined
+  }
+
+  findAll(filters: MutationFilters = {}): Array<Mutation> {
+    return this.getAll().filter((mutation) => matchMutation(filters, mutation))
+  }
+
+  notify(event: MutationCacheNotifyEvent) {
+    notifyManager.batch(() => {
+      this.listeners.forEach((listener) => {
+        listener(event)
+      })
+    })
+  }
+
+  resumePausedMutations(): Promise<unknown> {
+    const pausedMutations = this.getAll().filter((x) => x.state.isPaused)
+
+    return notifyManager.batch(() =>
+      Promise.all(
+        pausedMutations.map((mutation) => mutation.continue().catch(noop)),
+      ),
+    )
+  }
+}
+
+function scopeFor(mutation: Mutation<any, any, any, any>) {
+  return mutation.options.scope?.id
+}