Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

3.3 KB
Raw Blame
import { describe, expect, test } from 'vitest'

import type { ConnectionStringPooler } from '../Connect.types'
import { resolveOrmConnectionScenario } from '../OrmConnection.utils'
import type { DeploymentMode } from '@/hooks/misc/useDeploymentMode'

const platform: DeploymentMode = { isPlatform: true, isCli: false, isSelfHosted: false }
const cli: DeploymentMode = { isPlatform: false, isCli: true, isSelfHosted: false }
const selfHosted: DeploymentMode = { isPlatform: false, isCli: false, isSelfHosted: true }

const makePooler = (overrides: Partial<ConnectionStringPooler> = {}): ConnectionStringPooler => ({
  transactionShared: 'postgresql://shared:6543/postgres',
  sessionShared: 'postgresql://shared:5432/postgres',
  ipv4SupportedForDedicatedPooler: false,
  direct: 'postgresql://direct:5432/postgres',
  ...overrides,
})

describe('resolveOrmConnectionScenario', () => {
  test('resolves cli for CLI deployments', () => {
    const scenario = resolveOrmConnectionScenario({
      connectionStringPooler: makePooler(),
      deploymentMode: cli,
      isHighAvailability: false,
    })
    expect(scenario).toBe('cli')
  })

  test('resolves self-hosted for self-hosted deployments', () => {
    const scenario = resolveOrmConnectionScenario({
      connectionStringPooler: makePooler(),
      deploymentMode: selfHosted,
      isHighAvailability: false,
    })
    expect(scenario).toBe('self-hosted')
  })

  test('resolves high-availability for HA projects on platform', () => {
    const scenario = resolveOrmConnectionScenario({
      connectionStringPooler: makePooler(),
      deploymentMode: platform,
      isHighAvailability: true,
    })
    expect(scenario).toBe('high-availability')
  })

  test('cli wins over the HA flag', () => {
    const scenario = resolveOrmConnectionScenario({
      connectionStringPooler: makePooler(),
      deploymentMode: cli,
      isHighAvailability: true,
    })
    expect(scenario).toBe('cli')
  })

  test('resolves dedicated-pooler when the dedicated pooler exists and IPv4 is supported', () => {
    const scenario = resolveOrmConnectionScenario({
      connectionStringPooler: makePooler({
        transactionDedicated: 'postgresql://dedicated:6543/postgres',
        sessionDedicated: 'postgresql://dedicated:5432/postgres',
        ipv4SupportedForDedicatedPooler: true,
      }),
      deploymentMode: platform,
      isHighAvailability: false,
    })
    expect(scenario).toBe('dedicated-pooler')
  })

  test('resolves shared-pooler-with-dedicated-alternative when the dedicated pooler exists without IPv4 support', () => {
    const scenario = resolveOrmConnectionScenario({
      connectionStringPooler: makePooler({
        transactionDedicated: 'postgresql://dedicated:6543/postgres',
        sessionDedicated: 'postgresql://dedicated:5432/postgres',
        ipv4SupportedForDedicatedPooler: false,
      }),
      deploymentMode: platform,
      isHighAvailability: false,
    })
    expect(scenario).toBe('shared-pooler-with-dedicated-alternative')
  })

  test('falls back to shared-pooler when there is no dedicated pooler', () => {
    const scenario = resolveOrmConnectionScenario({
      connectionStringPooler: makePooler(),
      deploymentMode: platform,
      isHighAvailability: false,
    })
    expect(scenario).toBe('shared-pooler')
  })
})