zammad/app/frontend/shared/utils/testFlags.ts

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

import { Mutex } from 'async-mutex'

class TestFlags {
  // @ts-expect-error this is not called in production
  private mutex: Mutex

  // @ts-expect-error this is not called in production
  private flags: Map<string, boolean>

  constructor() {
    if (VITE_TEST_MODE) {
      this.mutex = new Mutex()
      this.flags = new Map()
    }
  }

  get(flag: string, skipClearing = false): boolean {
    if (!VITE_TEST_MODE) return false
    const flagValue = !!this.flags.get(flag)
    if (!skipClearing) this.clear(flag)
    return flagValue
  }

  async set(flag: string): Promise<void> {
    if (!VITE_TEST_MODE) return
    await this.mutex.runExclusive(() => {
      this.flags.set(flag, true)
      if (import.meta.env.VITE_DEBUG_TEST_FLAGS) {
        console.log('[testFlags] set flag "%s"', flag)
      }
    })
  }

  async clear(flag: string): Promise<void> {
    if (!VITE_TEST_MODE) return
    await this.mutex.runExclusive(() => {
      this.flags.delete(flag)
    })
  }
}

const testFlags = new TestFlags()

declare global {
  interface Window {
    testFlags: TestFlags
  }
}

if (VITE_TEST_MODE) {
  // Register globally for access from Capybara/Selenium.
  window.testFlags = testFlags
}

export default testFlags