zammad/app/frontend/shared/stores/session.ts

// Copyright (C) 2012-2024 Zammad Foundation, https://zammad-foundation.org/

import { cloneDeep } from 'lodash-es'
import { defineStore } from 'pinia'
import { computed, effectScope, ref } from 'vue'

import useFingerprint from '#shared/composables/useFingerprint.ts'
import { useCurrentUserLazyQuery } from '#shared/graphql/queries/currentUser.api.ts'
import { useSessionLazyQuery } from '#shared/graphql/queries/session.api.ts'
import { useCurrentUserUpdatesSubscription } from '#shared/graphql/subscriptions/currentUserUpdates.api.ts'
import type {
  CurrentUserQuery,
  CurrentUserQueryVariables,
  CurrentUserUpdatesSubscription,
  CurrentUserUpdatesSubscriptionVariables,
  SessionAfterAuth,
  SessionQuery,
  SessionQueryVariables,
} from '#shared/graphql/types.ts'
import {
  QueryHandler,
  SubscriptionHandler,
} from '#shared/server/apollo/handler/index.ts'
import type { RequiredPermission } from '#shared/types/permission.ts'
import type { UserData } from '#shared/types/store.ts'
import hasPermission from '#shared/utils/hasPermission.ts'
import log from '#shared/utils/log.ts'
import testFlags from '#shared/utils/testFlags.ts'

import { useLocaleStore } from './locale.ts'

import type { JsonValue } from 'type-fest'

let sessionQuery: QueryHandler<SessionQuery, SessionQueryVariables>

const getSessionQuery = () => {
  if (sessionQuery) return sessionQuery

  const { fingerprint } = useFingerprint()

  const scope = effectScope()
  scope.run(() => {
    sessionQuery = new QueryHandler(
      useSessionLazyQuery({
        fetchPolicy: 'network-only',
        context: {
          error: {
            logLevel: 'silent',
          },
          headers: {
            'X-Browser-Fingerprint': fingerprint.value,
          },
        },
      }),
      {
        errorShowNotification: false,
      },
    )
  })

  return sessionQuery
}

let currentUserQuery: QueryHandler<CurrentUserQuery, CurrentUserQueryVariables>

const getCurrentUserQuery = () => {
  if (currentUserQuery) return currentUserQuery

  const scope = effectScope()
  scope.run(() => {
    currentUserQuery = new QueryHandler(
      useCurrentUserLazyQuery({ fetchPolicy: 'network-only' }),
    )
  })

  return currentUserQuery
}

export const useSessionStore = defineStore(
  'session',
  () => {
    const id = ref<Maybe<string>>(null)
    const afterAuth = ref<Maybe<SessionAfterAuth>>(null)
    const initialized = ref(false)
    const locale = useLocaleStore()

    const checkSession = async (): Promise<string | null> => {
      const sessionQuery = getSessionQuery()
      const { data: result } = await sessionQuery.query()

      // Refresh the current sessionId state.
      id.value = result?.session.id || null
      afterAuth.value = result?.session.afterAuth || null

      return id.value
    }

    const user = ref<Maybe<UserData>>(null)

    // In case of unauthenticated users, current user ID may be an empty string.
    //   Use with care.
    const userId = computed(() => user.value?.id || '')

    let currentUserUpdateSubscription: SubscriptionHandler<
      CurrentUserUpdatesSubscription,
      CurrentUserUpdatesSubscriptionVariables
    >
    const getCurrentUser = async (): Promise<Maybe<UserData>> => {
      if (currentUserQuery && !user.value) {
        currentUserQuery.start()
      }

      const userQuery = getCurrentUserQuery()

      const { data: result } = await userQuery.query()

      user.value = cloneDeep(result?.currentUser) || null

      log.debug('currentUserUpdate', user.value)

      // Check if the locale is different, then a update is needed.
      const userLocale = user.value?.preferences?.locale as string | undefined

      if (
        userLocale &&
        (!locale.localeData || userLocale !== locale.localeData.locale)
      ) {
        await locale.setLocale(userLocale)
      }

      if (user.value) {
        if (!currentUserUpdateSubscription) {
          const scope = effectScope()
          scope.run(() => {
            currentUserUpdateSubscription = new SubscriptionHandler(
              useCurrentUserUpdatesSubscription(() => ({
                userId: userId.value,
              })),
            )

            currentUserUpdateSubscription.onResult((result) => {
              const updatedUser = result.data?.userUpdates.user
              if (!updatedUser) {
                testFlags.set('useCurrentUserUpdatesSubscription.subscribed')
              } else {
                user.value = updatedUser
              }
            })
          })
        } else {
          currentUserUpdateSubscription.start()
        }

        testFlags.set('useSessionUserStore.getCurrentUser.loaded')
      }

      return user.value
    }

    const resetCurrentSession = () => {
      if (currentUserUpdateSubscription) currentUserUpdateSubscription.stop()
      if (currentUserQuery) currentUserQuery.stop()

      id.value = null
      user.value = null
    }

    const userHasPermission = (
      requiredPermission: RequiredPermission,
    ): boolean => {
      return hasPermission(
        requiredPermission,
        user.value?.permissions?.names || [],
      )
    }

    const setUserPreference = (key: string, value: JsonValue) => {
      if (!user.value) return

      user.value.preferences[key] = value

      return user.value
    }

    return {
      id,
      afterAuth,
      initialized,
      checkSession,
      user,
      userId,
      getCurrentUser,
      resetCurrentSession,
      hasPermission: userHasPermission,
      setUserPreference,
    }
  },
  {
    requiresAuth: false,
  },
)