start-os/sdk/base/lib/util/getServiceInterface.ts

import { PackageId, ServiceInterfaceId, ServiceInterfaceType } from "../types"
import { knownProtocols } from "../interfaces/Host"
import { AddressInfo, Host, Hostname, HostnameInfo } from "../types"
import { Effects } from "../Effects"
import { DropGenerator, DropPromise } from "./Drop"
import { IpAddress, IPV6_LINK_LOCAL } from "./ip"
import { deepEqual } from "./deepEqual"
import { once } from "./once"

export type UrlString = string
export type HostId = string

const getHostnameRegex = /^(\w+:\/\/)?([^\/\:]+)(:\d{1,3})?(\/)?/
export const getHostname = (url: string): Hostname | null => {
  const founds = url.match(getHostnameRegex)?.[2]
  if (!founds) return null
  const parts = founds.split("@")
  const last = parts[parts.length - 1] as Hostname | null
  return last
}

type FilterKinds =
  | "onion"
  | "mdns"
  | "domain"
  | "ip"
  | "ipv4"
  | "ipv6"
  | "localhost"
  | "link-local"
export type Filter = {
  visibility?: "public" | "private"
  kind?: FilterKinds | FilterKinds[]
  predicate?: (h: HostnameInfo) => boolean
  exclude?: Filter
}

type VisibilityFilter<V extends "public" | "private"> = V extends "public"
  ? (HostnameInfo & { public: true }) | VisibilityFilter<Exclude<V, "public">>
  : V extends "private"
    ?
        | (HostnameInfo & { public: false })
        | VisibilityFilter<Exclude<V, "private">>
    : never
type KindFilter<K extends FilterKinds> = K extends "onion"
  ? (HostnameInfo & { kind: "onion" }) | KindFilter<Exclude<K, "onion">>
  : K extends "mdns"
    ?
        | (HostnameInfo & { kind: "ip"; hostname: { kind: "local" } })
        | KindFilter<Exclude<K, "mdns">>
    : K extends "domain"
      ?
          | (HostnameInfo & { kind: "ip"; hostname: { kind: "domain" } })
          | KindFilter<Exclude<K, "domain">>
      : K extends "ipv4"
        ?
            | (HostnameInfo & { kind: "ip"; hostname: { kind: "ipv4" } })
            | KindFilter<Exclude<K, "ipv4">>
        : K extends "ipv6"
          ?
              | (HostnameInfo & { kind: "ip"; hostname: { kind: "ipv6" } })
              | KindFilter<Exclude<K, "ipv6">>
          : K extends "ip"
            ? KindFilter<Exclude<K, "ip"> | "ipv4" | "ipv6">
            : never

type FilterReturnTy<F extends Filter> = F extends {
  visibility: infer V extends "public" | "private"
}
  ? VisibilityFilter<V> & FilterReturnTy<Omit<F, "visibility">>
  : F extends {
        kind: (infer K extends FilterKinds) | (infer K extends FilterKinds)[]
      }
    ? KindFilter<K> & FilterReturnTy<Omit<F, "kind">>
    : F extends {
          predicate: (h: HostnameInfo) => h is infer H extends HostnameInfo
        }
      ? H & FilterReturnTy<Omit<F, "predicate">>
      : F extends { exclude: infer E extends Filter } // MUST BE LAST
        ? HostnameInfo extends FilterReturnTy<E>
          ? HostnameInfo
          : Exclude<HostnameInfo, FilterReturnTy<E>>
        : HostnameInfo

const nonLocalFilter = {
  exclude: {
    kind: ["localhost", "link-local"] as ("localhost" | "link-local")[],
  },
} as const
const publicFilter = {
  visibility: "public",
} as const
const onionFilter = {
  kind: "onion",
} as const

type Formats = "hostname-info" | "urlstring" | "url"
type FormatReturnTy<
  F extends Filter,
  Format extends Formats,
> = Format extends "hostname-info"
  ? FilterReturnTy<F> | FormatReturnTy<F, Exclude<Format, "hostname-info">>
  : Format extends "url"
    ? URL | FormatReturnTy<F, Exclude<Format, "url">>
    : Format extends "urlstring"
      ? UrlString | FormatReturnTy<F, Exclude<Format, "urlstring">>
      : never

export type Filled<F extends Filter = {}> = {
  hostnames: HostnameInfo[]

  toUrls: (h: HostnameInfo) => {
    url: UrlString | null
    sslUrl: UrlString | null
  }

  format: <Format extends Formats = "urlstring">(
    format?: Format,
  ) => FormatReturnTy<{}, Format>[]

  filter: <NewFilter extends Filter>(
    filter: NewFilter,
  ) => Filled<NewFilter & Filter>

  nonLocal: Filled<typeof nonLocalFilter & Filter>
  public: Filled<typeof publicFilter & Filter>
  onion: Filled<typeof onionFilter & Filter>
}
export type FilledAddressInfo = AddressInfo & Filled
export type ServiceInterfaceFilled = {
  id: string
  /** The title of this field to be displayed */
  name: string
  /** Human readable description, used as tooltip usually */
  description: string
  /** Whether or not to mask the URIs for this interface. Useful if the URIs contain sensitive information, such as a password, macaroon, or API key */
  masked: boolean
  /** Information about the host for this binding */
  host: Host | null
  /** URI information */
  addressInfo: FilledAddressInfo | null
  /** Indicates if we are a ui/p2p/api for the kind of interface that this is representing */
  type: ServiceInterfaceType
}
const either =
  <A>(...args: ((a: A) => boolean)[]) =>
  (a: A) =>
    args.some((x) => x(a))
const negate =
  <A>(fn: (a: A) => boolean) =>
  (a: A) =>
    !fn(a)
const unique = <A>(values: A[]) => Array.from(new Set(values))
export const addressHostToUrl = (
  { scheme, sslScheme, username, suffix }: AddressInfo,
  hostname: HostnameInfo,
): { url: UrlString | null; sslUrl: UrlString | null } => {
  const res = []
  const fmt = (scheme: string | null, host: HostnameInfo, port: number) => {
    const excludePort =
      scheme &&
      scheme in knownProtocols &&
      port === knownProtocols[scheme as keyof typeof knownProtocols].defaultPort
    let hostname
    if (host.kind === "onion") {
      hostname = host.hostname.value
    } else if (host.kind === "ip") {
      if (host.hostname.kind === "domain") {
        hostname = host.hostname.value
      } else if (host.hostname.kind === "ipv6") {
        hostname = IPV6_LINK_LOCAL.contains(host.hostname.value)
          ? `[${host.hostname.value}%${host.hostname.scopeId}]`
          : `[${host.hostname.value}]`
      } else {
        hostname = host.hostname.value
      }
    }
    return `${scheme ? `${scheme}://` : ""}${
      username ? `${username}@` : ""
    }${hostname}${excludePort ? "" : `:${port}`}${suffix}`
  }
  let url = null
  if (hostname.hostname.port !== null) {
    url = fmt(scheme, hostname, hostname.hostname.port)
  }
  let sslUrl = null
  if (hostname.hostname.sslPort !== null) {
    sslUrl = fmt(sslScheme, hostname, hostname.hostname.sslPort)
  }

  return { url, sslUrl }
}

function filterRec(
  hostnames: HostnameInfo[],
  filter: Filter,
  invert: boolean,
): HostnameInfo[] {
  if (filter.predicate) {
    const pred = filter.predicate
    hostnames = hostnames.filter((h) => invert !== pred(h))
  }
  if (filter.visibility === "public")
    hostnames = hostnames.filter(
      (h) => invert !== (h.kind === "onion" || h.public),
    )
  if (filter.visibility === "private")
    hostnames = hostnames.filter(
      (h) => invert !== (h.kind !== "onion" && !h.public),
    )
  if (filter.kind) {
    const kind = new Set(
      Array.isArray(filter.kind) ? filter.kind : [filter.kind],
    )
    if (kind.has("ip")) {
      kind.add("ipv4")
      kind.add("ipv6")
    }
    hostnames = hostnames.filter(
      (h) =>
        invert !==
        ((kind.has("onion") && h.kind === "onion") ||
          (kind.has("mdns") &&
            h.kind === "ip" &&
            h.hostname.kind === "local") ||
          (kind.has("domain") &&
            h.kind === "ip" &&
            h.hostname.kind === "domain") ||
          (kind.has("ipv4") && h.kind === "ip" && h.hostname.kind === "ipv4") ||
          (kind.has("ipv6") && h.kind === "ip" && h.hostname.kind === "ipv6") ||
          (kind.has("localhost") &&
            ["localhost", "127.0.0.1", "::1"].includes(h.hostname.value)) ||
          (kind.has("link-local") &&
            h.kind === "ip" &&
            h.hostname.kind === "ipv6" &&
            IPV6_LINK_LOCAL.contains(IpAddress.parse(h.hostname.value)))),
    )
  }

  if (filter.exclude) return filterRec(hostnames, filter.exclude, !invert)

  return hostnames
}

export const filledAddress = (
  host: Host,
  addressInfo: AddressInfo,
): FilledAddressInfo => {
  const toUrls = addressHostToUrl.bind(null, addressInfo)
  const toUrlArray = (h: HostnameInfo) => {
    const u = toUrls(h)
    return [u.url, u.sslUrl].filter((u) => u !== null)
  }
  const hostnames = host.hostnameInfo[addressInfo.internalPort] ?? []

  function filledAddressFromHostnames<F extends Filter>(
    hostnames: HostnameInfo[],
  ): Filled<F> & AddressInfo {
    const getNonLocal = once(() =>
      filledAddressFromHostnames<typeof nonLocalFilter & F>(
        filterRec(hostnames, nonLocalFilter, false),
      ),
    )
    const getPublic = once(() =>
      filledAddressFromHostnames<typeof publicFilter & F>(
        filterRec(hostnames, publicFilter, false),
      ),
    )
    const getOnion = once(() =>
      filledAddressFromHostnames<typeof onionFilter & F>(
        filterRec(hostnames, onionFilter, false),
      ),
    )
    return {
      ...addressInfo,
      hostnames,
      toUrls,
      format: <Format extends Formats = "urlstring">(format?: Format) => {
        let res: FormatReturnTy<{}, Format>[] = hostnames as any
        if (format === "hostname-info") return res
        const urls = hostnames.flatMap(toUrlArray)
        if (format === "url") res = urls.map((u) => new URL(u)) as any
        else res = urls as any
        return res
      },
      filter: <NewFilter extends Filter>(filter: NewFilter) => {
        return filledAddressFromHostnames<NewFilter & F>(
          filterRec(hostnames, filter, false),
        )
      },
      get nonLocal(): Filled<typeof nonLocalFilter & F> {
        return getNonLocal()
      },
      get public(): Filled<typeof publicFilter & F> {
        return getPublic()
      },
      get onion(): Filled<typeof onionFilter & F> {
        return getOnion()
      },
    }
  }

  return filledAddressFromHostnames<{}>(hostnames)
}

const makeInterfaceFilled = async ({
  effects,
  id,
  packageId,
  callback,
}: {
  effects: Effects
  id: string
  packageId?: string
  callback?: () => void
}) => {
  const serviceInterfaceValue = await effects.getServiceInterface({
    serviceInterfaceId: id,
    packageId,
    callback,
  })
  if (!serviceInterfaceValue) {
    return null
  }
  const hostId = serviceInterfaceValue.addressInfo.hostId
  const host = await effects.getHostInfo({
    packageId,
    hostId,
    callback,
  })

  const interfaceFilled: ServiceInterfaceFilled = {
    ...serviceInterfaceValue,
    host,
    addressInfo: host
      ? filledAddress(host, serviceInterfaceValue.addressInfo)
      : null,
  }
  return interfaceFilled
}

export class GetServiceInterface<Mapped = ServiceInterfaceFilled | null> {
  constructor(
    readonly effects: Effects,
    readonly opts: { id: string; packageId?: string },
    readonly map: (interfaces: ServiceInterfaceFilled | null) => Mapped,
    readonly eq: (a: Mapped, b: Mapped) => boolean,
  ) {}

  /**
   * Returns the requested service interface. Reruns the context from which it has been called if the underlying value changes
   */
  async const() {
    let abort = new AbortController()
    const watch = this.watch(abort.signal)
    const res = await watch.next()
    if (this.effects.constRetry) {
      watch.next().then(() => {
        abort.abort()
        this.effects.constRetry && this.effects.constRetry()
      })
    }
    return res.value
  }
  /**
   * Returns the requested service interface. Does nothing if the value changes
   */
  async once() {
    const { id, packageId } = this.opts
    const interfaceFilled = await makeInterfaceFilled({
      effects: this.effects,
      id,
      packageId,
    })

    return this.map(interfaceFilled)
  }

  private async *watchGen(abort?: AbortSignal) {
    let prev = null as { value: Mapped } | null
    const { id, packageId } = this.opts
    const resolveCell = { resolve: () => {} }
    this.effects.onLeaveContext(() => {
      resolveCell.resolve()
    })
    abort?.addEventListener("abort", () => resolveCell.resolve())
    while (this.effects.isInContext && !abort?.aborted) {
      let callback: () => void = () => {}
      const waitForNext = new Promise<void>((resolve) => {
        callback = resolve
        resolveCell.resolve = resolve
      })
      const next = this.map(
        await makeInterfaceFilled({
          effects: this.effects,
          id,
          packageId,
          callback,
        }),
      )
      if (!prev || !this.eq(prev.value, next)) {
        yield next
      }
      await waitForNext
    }
    return new Promise<never>((_, rej) => rej(new Error("aborted")))
  }

  /**
   * Watches the requested service interface. Returns an async iterator that yields whenever the value changes
   */
  watch(abort?: AbortSignal): AsyncGenerator<Mapped, never, unknown> {
    const ctrl = new AbortController()
    abort?.addEventListener("abort", () => ctrl.abort())
    return DropGenerator.of(this.watchGen(ctrl.signal), () => ctrl.abort())
  }

  /**
   * Watches the requested service interface. Takes a custom callback function to run whenever the value changes
   */
  onChange(
    callback: (
      value: Mapped | null,
      error?: Error,
    ) => { cancel: boolean } | Promise<{ cancel: boolean }>,
  ) {
    ;(async () => {
      const ctrl = new AbortController()
      for await (const value of this.watch(ctrl.signal)) {
        try {
          const res = await callback(value)
          if (res.cancel) {
            ctrl.abort()
            break
          }
        } catch (e) {
          console.error(
            "callback function threw an error @ GetServiceInterface.onChange",
            e,
          )
        }
      }
    })()
      .catch((e) => callback(null, e))
      .catch((e) =>
        console.error(
          "callback function threw an error @ GetServiceInterface.onChange",
          e,
        ),
      )
  }

  /**
   * Watches the requested service interface. Returns when the predicate is true
   */
  waitFor(pred: (value: Mapped) => boolean): Promise<Mapped> {
    const ctrl = new AbortController()
    return DropPromise.of(
      Promise.resolve().then(async () => {
        for await (const next of this.watchGen(ctrl.signal)) {
          if (pred(next)) {
            return next
          }
        }
        throw new Error("context left before predicate passed")
      }),
      () => ctrl.abort(),
    )
  }
}

export function getOwnServiceInterface(
  effects: Effects,
  id: ServiceInterfaceId,
): GetServiceInterface
export function getOwnServiceInterface<Mapped>(
  effects: Effects,
  id: ServiceInterfaceId,
  map: (interfaces: ServiceInterfaceFilled | null) => Mapped,
  eq?: (a: Mapped, b: Mapped) => boolean,
): GetServiceInterface<Mapped>
export function getOwnServiceInterface<Mapped>(
  effects: Effects,
  id: ServiceInterfaceId,
  map?: (interfaces: ServiceInterfaceFilled | null) => Mapped,
  eq?: (a: Mapped, b: Mapped) => boolean,
): GetServiceInterface<Mapped> {
  return new GetServiceInterface(
    effects,
    { id },
    map ?? ((a) => a as Mapped),
    eq ?? ((a, b) => deepEqual(a, b)),
  )
}

export function getServiceInterface(
  effects: Effects,
  opts: { id: ServiceInterfaceId; packageId: PackageId },
): GetServiceInterface
export function getServiceInterface<Mapped>(
  effects: Effects,
  opts: { id: ServiceInterfaceId; packageId: PackageId },
  map: (interfaces: ServiceInterfaceFilled | null) => Mapped,
  eq?: (a: Mapped, b: Mapped) => boolean,
): GetServiceInterface<Mapped>
export function getServiceInterface<Mapped>(
  effects: Effects,
  opts: { id: ServiceInterfaceId; packageId: PackageId },
  map?: (interfaces: ServiceInterfaceFilled | null) => Mapped,
  eq?: (a: Mapped, b: Mapped) => boolean,
): GetServiceInterface<Mapped> {
  return new GetServiceInterface(
    effects,
    opts,
    map ?? ((a) => a as Mapped),
    eq ?? ((a, b) => deepEqual(a, b)),
  )
}