supabase/apps/studio/components/layouts/AppLayout/StatusPageBanner.utils.test.ts

import { describe, expect, it } from 'vitest'

import { getRelevantIncidentIds, shouldShowBanner } from './StatusPageBanner.utils'

const noCache = { id: 'no-cache', cache: null } as const
const noRestrictions = {
  id: 'no-restrictions',
  cache: { affected_regions: null, affects_project_creation: false },
}
const affectsCreation = {
  id: 'affects-creation',
  cache: { affected_regions: null, affects_project_creation: true },
}
const usEast1Only = {
  id: 'us-east-1-only',
  cache: { affected_regions: ['us-east-1'], affects_project_creation: false },
}
const usEast1AndCreation = {
  id: 'us-east-1-and-creation',
  cache: { affected_regions: ['us-east-1'], affects_project_creation: true },
}

describe('shouldShowBanner', () => {
  describe('no incidents', () => {
    it('does not show when there are no incidents', () => {
      expect(
        shouldShowBanner({ incidents: [], hasProjects: true, userRegions: new Set(['us-east-1']) })
      ).toBe(false)
    })
  })

  describe('user has no projects', () => {
    it('does not show when cache is absent', () => {
      expect(
        shouldShowBanner({ incidents: [noCache], hasProjects: false, userRegions: new Set() })
      ).toBe(false)
    })

    it('does not show when affects_project_creation is false', () => {
      expect(
        shouldShowBanner({
          incidents: [noRestrictions],
          hasProjects: false,
          userRegions: new Set(),
        })
      ).toBe(false)
    })

    it('shows when affects_project_creation is true and no region restriction', () => {
      expect(
        shouldShowBanner({
          incidents: [affectsCreation],
          hasProjects: false,
          userRegions: new Set(),
        })
      ).toBe(true)
    })

    it('does not show when affects_project_creation is true but there is a region restriction', () => {
      expect(
        shouldShowBanner({
          incidents: [usEast1AndCreation],
          hasProjects: false,
          userRegions: new Set(),
        })
      ).toBe(false)
    })
  })

  describe('user has projects, no region restriction', () => {
    it('shows when cache is absent', () => {
      expect(
        shouldShowBanner({
          incidents: [noCache],
          hasProjects: true,
          userRegions: new Set(['us-east-1']),
        })
      ).toBe(true)
    })

    it('shows when affected_regions is null', () => {
      expect(
        shouldShowBanner({
          incidents: [noRestrictions],
          hasProjects: true,
          userRegions: new Set(['us-east-1']),
        })
      ).toBe(true)
    })

    it('shows when affected_regions is an empty array', () => {
      expect(
        shouldShowBanner({
          incidents: [
            { id: 'test', cache: { affected_regions: [], affects_project_creation: false } },
          ],
          hasProjects: true,
          userRegions: new Set(['us-east-1']),
        })
      ).toBe(true)
    })
  })

  describe('user has projects, with region restriction', () => {
    it('shows when user has a primary database in an affected region', () => {
      expect(
        shouldShowBanner({
          incidents: [usEast1Only],
          hasProjects: true,
          userRegions: new Set(['us-east-1']),
        })
      ).toBe(true)
    })

    it('shows when user has a read replica in an affected region', () => {
      expect(
        shouldShowBanner({
          incidents: [
            {
              id: 'test',
              cache: { affected_regions: ['eu-west-1'], affects_project_creation: false },
            },
          ],
          hasProjects: true,
          userRegions: new Set(['us-east-1', 'eu-west-1']),
        })
      ).toBe(true)
    })

    it('shows when one of multiple affected regions matches', () => {
      expect(
        shouldShowBanner({
          incidents: [
            {
              id: 'test',
              cache: {
                affected_regions: ['us-east-1', 'ap-southeast-1'],
                affects_project_creation: false,
              },
            },
          ],
          hasProjects: true,
          userRegions: new Set(['ap-southeast-1']),
        })
      ).toBe(true)
    })

    it('does not show when user has no databases in any affected region', () => {
      expect(
        shouldShowBanner({
          incidents: [usEast1Only],
          hasProjects: true,
          userRegions: new Set(['eu-west-1', 'ap-southeast-1']),
        })
      ).toBe(false)
    })

    it('does not show when user has projects but no databases in affected region, even with affects_project_creation', () => {
      expect(
        shouldShowBanner({
          incidents: [usEast1AndCreation],
          hasProjects: true,
          userRegions: new Set(['eu-west-1']),
        })
      ).toBe(false)
    })
  })

  describe('multiple incidents', () => {
    it('shows when at least one incident matches even if others do not', () => {
      expect(
        shouldShowBanner({
          incidents: [usEast1Only, noRestrictions],
          hasProjects: true,
          userRegions: new Set(['eu-west-1']),
        })
      ).toBe(true)
    })

    it('does not show when no incident matches', () => {
      expect(
        shouldShowBanner({
          incidents: [usEast1Only, usEast1AndCreation],
          hasProjects: true,
          userRegions: new Set(['eu-west-1']),
        })
      ).toBe(false)
    })

    it('shows when any incident matches for a no-project user via affects_project_creation', () => {
      expect(
        shouldShowBanner({
          incidents: [usEast1Only, affectsCreation],
          hasProjects: false,
          userRegions: new Set(),
        })
      ).toBe(true)
    })
  })

  describe('hasUnknownRegions', () => {
    it('shows when regions are unknown and incident has a region restriction', () => {
      expect(
        shouldShowBanner({
          incidents: [usEast1Only],
          hasProjects: true,
          userRegions: new Set(),
          hasUnknownRegions: true,
        })
      ).toBe(true)
    })

    it('still applies no-projects check even when regions are unknown', () => {
      expect(
        shouldShowBanner({
          incidents: [usEast1Only],
          hasProjects: false,
          userRegions: new Set(),
          hasUnknownRegions: true,
        })
      ).toBe(false)
    })

    it('does not show for affects_project_creation with no projects when there is a region restriction, even when regions are unknown', () => {
      expect(
        shouldShowBanner({
          incidents: [usEast1AndCreation],
          hasProjects: false,
          userRegions: new Set(),
          hasUnknownRegions: true,
        })
      ).toBe(false)
    })
  })
})

describe('getRelevantIncidentIds', () => {
  it('returns empty array when there are no incidents', () => {
    expect(
      getRelevantIncidentIds({ incidents: [], hasProjects: true, userRegions: new Set() })
    ).toEqual([])
  })

  it('returns empty array when no incidents are relevant to the user', () => {
    expect(
      getRelevantIncidentIds({
        incidents: [usEast1Only],
        hasProjects: true,
        userRegions: new Set(['eu-west-1']),
      })
    ).toEqual([])
  })

  it('returns the ID of a single relevant incident', () => {
    expect(
      getRelevantIncidentIds({
        incidents: [noRestrictions],
        hasProjects: true,
        userRegions: new Set(['us-east-1']),
      })
    ).toEqual(['no-restrictions'])
  })

  it('returns IDs of all relevant incidents', () => {
    const euWest1Only = {
      id: 'eu-west-1-only',
      cache: { affected_regions: ['eu-west-1'], affects_project_creation: false },
    }
    const apSoutheast1Only = {
      id: 'ap-southeast-1-only',
      cache: { affected_regions: ['ap-southeast-1'], affects_project_creation: false },
    }

    expect(
      getRelevantIncidentIds({
        incidents: [euWest1Only, apSoutheast1Only],
        hasProjects: true,
        userRegions: new Set(['eu-west-1', 'ap-southeast-1']),
      })
    ).toEqual(expect.arrayContaining(['ap-southeast-1-only', 'eu-west-1-only']))
  })

  it('excludes incidents irrelevant to the user from the result', () => {
    // User is in eu-west-1; us-east-1-only incident should not be included
    expect(
      getRelevantIncidentIds({
        incidents: [usEast1Only, noRestrictions],
        hasProjects: true,
        userRegions: new Set(['eu-west-1']),
      })
    ).toEqual(['no-restrictions'])
  })

  describe('user has no projects', () => {
    it('includes incidents with affects_project_creation', () => {
      expect(
        getRelevantIncidentIds({
          incidents: [affectsCreation],
          hasProjects: false,
          userRegions: new Set(),
        })
      ).toEqual(['affects-creation'])
    })

    it('excludes incidents without affects_project_creation', () => {
      expect(
        getRelevantIncidentIds({
          incidents: [noRestrictions, usEast1Only],
          hasProjects: false,
          userRegions: new Set(),
        })
      ).toEqual([])
    })
  })

  describe('hasUnknownRegions', () => {
    it('includes region-restricted incidents when regions are unknown', () => {
      expect(
        getRelevantIncidentIds({
          incidents: [usEast1Only],
          hasProjects: true,
          userRegions: new Set(),
          hasUnknownRegions: true,
        })
      ).toEqual(['us-east-1-only'])
    })

    it('still excludes incidents for no-project users even when regions are unknown', () => {
      expect(
        getRelevantIncidentIds({
          incidents: [usEast1Only],
          hasProjects: false,
          userRegions: new Set(),
          hasUnknownRegions: true,
        })
      ).toEqual([])
    })
  })
})