hoppscotch/packages/hoppscotch-common/src/services/tab/tab.ts

import { refWithControl } from "@vueuse/core"
import { Service } from "dioc"
import * as E from "fp-ts/Either"
import { v4 as uuidV4 } from "uuid"
import {
  ComputedRef,
  computed,
  nextTick,
  reactive,
  ref,
  shallowReadonly,
  watch,
} from "vue"
import { HoppRESTDocument } from "~/helpers/rest/document"
import {
  HoppTab,
  PersistableTabState,
  TabService as TabServiceInterface,
} from "."

import { NewWorkspaceService } from "../new-workspace"
import { Handle, HandleRef } from "../new-workspace/handle"
import { WorkspaceRequest } from "../new-workspace/workspace"

export abstract class TabService<Doc>
  extends Service
  implements TabServiceInterface<Doc>
{
  private workspaceService = this.bind(NewWorkspaceService)

  protected tabMap = reactive(new Map<string, HoppTab<Doc>>())
  protected tabOrdering = ref<string[]>(["test"])

  public currentTabID = refWithControl("test", {
    onBeforeChange: (newTabID) => {
      if (!newTabID || !this.tabMap.has(newTabID)) {
        console.warn(
          `Tried to set current tab id to an invalid value. (value: ${newTabID})`
        )

        // Don't allow change
        return false
      }
    },
  })

  public currentActiveTab = computed(() => {
    return this.tabMap.get(this.currentTabID.value)!
  }) // Guaranteed to not be undefined

  protected watchCurrentTabID() {
    watch(
      this.tabOrdering,
      (newOrdering) => {
        if (
          !this.currentTabID.value ||
          !newOrdering.includes(this.currentTabID.value)
        ) {
          this.setActiveTab(newOrdering[newOrdering.length - 1]) // newOrdering should always be non-empty
        }
      },
      { deep: true }
    )
  }

  public createNewTab(document: Doc, switchToIt = true): HoppTab<Doc> {
    const id = this.generateNewTabID()

    const tab: HoppTab<Doc> = { id, document }

    this.tabMap.set(id, tab)
    this.tabOrdering.value.push(id)

    if (switchToIt) {
      this.setActiveTab(id)
    }

    return tab
  }

  public getTabs(): HoppTab<Doc>[] {
    return Array.from(this.tabMap.values())
  }

  public getActiveTab(): HoppTab<Doc> | null {
    return this.tabMap.get(this.currentTabID.value) ?? null
  }

  public setActiveTab(tabID: string): void {
    this.currentTabID.value = tabID
  }

  public async loadTabsFromPersistedState(
    data: PersistableTabState<Doc>
  ): Promise<void> {
    if (data) {
      this.tabMap.clear()
      this.tabOrdering.value = []

      for (const doc of data.orderedDocs) {
        let requestHandle: Handle<WorkspaceRequest> | null = null
        let resolvedTabDoc = doc.doc

        // TODO: Account for GQL
        const { saveContext } = doc.doc as HoppRESTDocument

        if (saveContext?.originLocation === "workspace-user-collection") {
          const { providerID, requestID, workspaceID } = saveContext

          if (!providerID || !workspaceID || !requestID) {
            continue
          }

          const workspaceHandleResult =
            await this.workspaceService.getWorkspaceHandle(
              providerID!,
              workspaceID!
            )

          if (E.isLeft(workspaceHandleResult)) {
            continue
          }

          const workspaceHandle = workspaceHandleResult.right.get()

          if (workspaceHandle.value.type === "invalid") {
            continue
          }

          const requestHandleResult =
            await this.workspaceService.getRequestHandle(
              workspaceHandle,
              requestID!
            )

          if (E.isRight(requestHandleResult)) {
            requestHandle = requestHandleResult.right

            const { originLocation } = saveContext

            resolvedTabDoc = {
              ...resolvedTabDoc,
              saveContext: {
                originLocation,
                requestHandle,
              },
            }
          }
        }

        this.tabMap.set(doc.tabID, {
          id: doc.tabID,
          document: resolvedTabDoc,
        })

        this.tabOrdering.value.push(doc.tabID)
      }

      this.setActiveTab(data.lastActiveTabID)
    }
  }
  public getActiveTabs(): Readonly<ComputedRef<HoppTab<Doc>[]>> {
    return shallowReadonly(
      computed(() =>
        this.tabOrdering.value.map((x) => this.tabMap.get(x) as HoppTab<Doc>)
      )
    )
  }

  public getTabRef(tabID: string) {
    return computed({
      get: () => {
        const result = this.tabMap.get(tabID)

        if (result === undefined) throw new Error(`Invalid tab id: ${tabID}`)

        return result
      },
      set: (value) => {
        return this.tabMap.set(tabID, value)
      },
    })
  }

  public updateTab(tabUpdate: HoppTab<Doc>) {
    if (!this.tabMap.has(tabUpdate.id)) {
      console.warn(
        `Cannot update tab as tab with that tab id does not exist (id: ${tabUpdate.id})`
      )
    }

    this.tabMap.set(tabUpdate.id, tabUpdate)
  }

  public updateTabOrdering(fromIndex: number, toIndex: number) {
    this.tabOrdering.value.splice(
      toIndex,
      0,
      this.tabOrdering.value.splice(fromIndex, 1)[0]
    )

    return this.tabOrdering.value
  }

  public closeTab(tabID: string) {
    if (!this.tabMap.has(tabID)) {
      console.warn(
        `Tried to close a tab which does not exist (tab id: ${tabID})`
      )
      return
    }

    if (this.tabOrdering.value.length === 1) {
      console.warn(
        `Tried to close the only tab open, which is not allowed. (tab id: ${tabID})`
      )
      return
    }

    this.tabOrdering.value.splice(this.tabOrdering.value.indexOf(tabID), 1)

    nextTick(() => {
      this.tabMap.delete(tabID)
    })
  }

  public closeOtherTabs(tabID: string) {
    if (!this.tabMap.has(tabID)) {
      console.warn(
        `The tab to close other tabs does not exist (tab id: ${tabID})`
      )
      return
    }

    this.tabOrdering.value = [tabID]

    this.tabMap.forEach((_, id) => {
      if (id !== tabID) this.tabMap.delete(id)
    })

    this.currentTabID.value = tabID
  }

  public getPersistedDocument(tabDoc: Doc): Doc {
    const { saveContext } = tabDoc as HoppRESTDocument

    if (saveContext?.originLocation !== "workspace-user-collection") {
      return tabDoc
    }

    // TODO: Investigate why requestHandle is available unwrapped here
    const requestHandle = saveContext.requestHandle as
      | HandleRef<WorkspaceRequest>["value"]
      | undefined

    if (!requestHandle) {
      return tabDoc
    }

    if (requestHandle.type === "invalid") {
      // eslint-disable-next-line @typescript-eslint/no-unused-vars
      const { requestHandle, ...rest } = saveContext

      // Return the document without the handle
      return {
        ...tabDoc,
        saveContext: rest,
      }
    }

    const { providerID, workspaceID, requestID } = requestHandle.data

    // Return the document without the handle
    return {
      ...tabDoc,
      saveContext: {
        originLocation: "workspace-user-collection",
        requestID,
        providerID,
        workspaceID,
      },
    }
  }

  public persistableTabState = computed<PersistableTabState<Doc>>(() => ({
    lastActiveTabID: this.currentTabID.value,
    orderedDocs: this.tabOrdering.value.map((tabID) => {
      const tab = this.tabMap.get(tabID)! // tab ordering is guaranteed to have value for this key

      return {
        tabID: tab.id,
        doc: this.getPersistedDocument(tab.document),
      }
    }),
  }))

  public getTabsRefTo(func: (tab: HoppTab<Doc>) => boolean) {
    return Array.from(this.tabMap.values())
      .filter(func)
      .map((tab) => this.getTabRef(tab.id))
  }

  private generateNewTabID() {
    while (true) {
      const id = uuidV4()

      if (!this.tabMap.has(id)) return id
    }
  }
}