ui/e2e/tests/flight_selection_persistence.e2e.ts

import { test, expect } from '@playwright/test'

// AZ-463 — e2e companion for flight selection persistence + memory soaks.
//
// AC-1 (FT-P-16): selectFlight() issues `PUT /api/annotations/settings/user`
//                 with the new `selectedFlightId`. Asserted at the wire.
// AC-2 (FT-P-17): On boot, when user-settings carries `selectedFlightId`, the
//                 SPA renders that flight as initially selected — no user
//                 click needed.
// AC-3 (NFT-RES-LIM-07): 100 sequential select(A) → select(B) cycles. The
//                        active EventSource count never exceeds 1 at the end
//                        of any cycle. Tagged `@long-running` per the spec.
// AC-4 (NFT-RES-LIM-06): 1-hour live-GPS SSE soak; heap at t=3600 s within
//                        10 % of t=60 s. Chromium-only (Firefox lacks
//                        `performance.memory`). Tagged `@long-running`.
//
// AC-3 + AC-4 are gated by `RUN_LONG_RUNNING=1` so the regular suite-e2e
// lane stays under the 60 s test timeout. Set the env var in the dev/stage
// pipeline that owns the soak budget.

const LONG_RUNNING = process.env.RUN_LONG_RUNNING === '1'

test.describe('AZ-463 — flight selection persistence (e2e companion)', () => {
  test('AC-1 (FT-P-16) — selectFlight issues PUT /api/annotations/settings/user', async ({ page }) => {
    const puts: { url: string; body: string | null }[] = []
    await page.route('**/api/annotations/settings/user', async (route) => {
      const req = route.request()
      if (req.method() === 'PUT') {
        puts.push({ url: req.url(), body: req.postData() })
      }
      await route.continue()
    })

    await page.goto('/flights')

    // Drive a selection through the UI. The flight list renders cards; the
    // first card is enough to fire the persistence wire.
    const firstFlight = page.locator('[data-testid^="flight-card"], .cursor-pointer').first()
    if (!(await firstFlight.isVisible({ timeout: 5000 }).catch(() => false))) {
      test.skip(true, 'Suite seed has no flights to select')
    }
    await firstFlight.click({ timeout: 5000 }).catch(() => null)

    await page
      .waitForFunction((target) => target > 0, puts.length, { timeout: 5000 })
      .catch(() => null)

    expect(puts.length).toBeGreaterThan(0)
    for (const p of puts) {
      expect(p.url).toContain('/api/annotations/settings/user')
      expect(p.body).not.toBeNull()
      const parsed = JSON.parse(p.body as string) as Record<string, unknown>
      expect(parsed).toHaveProperty('selectedFlightId')
      expect(typeof parsed.selectedFlightId === 'string' || parsed.selectedFlightId === null).toBe(true)
    }
  })

  test('AC-2 (FT-P-17) — selected-flight rehydrates on boot', async ({ page }) => {
    // Watch the GETs the SPA fires on cold boot. The contract: after
    // user-settings returns a non-null `selectedFlightId`, the SPA fetches
    // /api/flights/<id> and renders that flight as selected (visible in the
    // header dropdown / top bar).
    const flightFetches: string[] = []
    await page.route('**/api/flights/*', async (route) => {
      flightFetches.push(route.request().url())
      await route.continue()
    })

    await page.goto('/')

    // The seed must have a `selectedFlightId` set for the test user. If the
    // seed is missing, report the gap rather than silently passing.
    await page
      .waitForFunction(
        (count) => count > 0,
        flightFetches.length,
        { timeout: 5000 },
      )
      .catch(() => null)
    if (flightFetches.length === 0) {
      test.skip(true, 'Suite seed user has no `selectedFlightId` set')
    }

    expect(flightFetches.length).toBeGreaterThan(0)
  })

  test(
    'AC-3 (NFT-RES-LIM-07 @long-running) — 100 sequential selections cap EventSource count',
    async ({ page, browserName }) => {
      if (!LONG_RUNNING) {
        test.skip(true, 'Long-running soak; set RUN_LONG_RUNNING=1 to enable')
      }
      // Chromium / Firefox both expose performance entries we use below.
      void browserName

      await page.goto('/flights')

      const flightCards = page.locator('[data-testid^="flight-card"], .cursor-pointer')
      const cardCount = await flightCards.count().catch(() => 0)
      if (cardCount < 2) {
        test.skip(true, 'Soak requires at least two flights in the suite seed')
      }

      // Instrument EventSource at the page boundary so we can observe the
      // active-source count. SPA opens an EventSource on flight selection
      // (live-GPS); the contract is that selecting a different flight closes
      // the previous one.
      await page.addInitScript(() => {
        type Win = Window & {
          __activeES?: number
          __maxES?: number
          __EventSource?: typeof EventSource
        }
        const w = window as Win
        w.__activeES = 0
        w.__maxES = 0
        w.__EventSource = window.EventSource
        const Wrapped = function (
          this: EventSource,
          url: string | URL,
          init?: EventSourceInit,
        ): EventSource {
          const inst = new (w.__EventSource as typeof EventSource)(url, init)
          w.__activeES = (w.__activeES ?? 0) + 1
          w.__maxES = Math.max(w.__maxES ?? 0, w.__activeES ?? 0)
          const origClose = inst.close.bind(inst)
          inst.close = function close(): void {
            w.__activeES = Math.max(0, (w.__activeES ?? 1) - 1)
            origClose()
          }
          return inst
        }
        Wrapped.prototype = (w.__EventSource as { prototype: object }).prototype
        Wrapped.CONNECTING = 0
        Wrapped.OPEN = 1
        Wrapped.CLOSED = 2
        ;(window as unknown as { EventSource: unknown }).EventSource = Wrapped
      })

      // 100 cycles: select card[0] → wait → select card[1] → wait → repeat.
      for (let i = 0; i < 100; i += 1) {
        const a = flightCards.nth(0)
        const b = flightCards.nth(1)
        await a.click().catch(() => null)
        await page.waitForTimeout(50)
        await b.click().catch(() => null)
        await page.waitForTimeout(50)
      }

      const max = await page.evaluate(() => {
        type Win = Window & { __maxES?: number; __activeES?: number }
        const w = window as Win
        return { max: w.__maxES ?? 0, end: w.__activeES ?? 0 }
      })
      expect(max.max).toBeLessThanOrEqual(2)
      expect(max.end).toBeLessThanOrEqual(1)
    },
  )

  test(
    'AC-4 (NFT-RES-LIM-06 @long-running) — 1 hour SSE soak; heap stays within 10 % of t=60 s',
    async ({ page, browserName }) => {
      if (!LONG_RUNNING) {
        test.skip(true, 'Long-running soak; set RUN_LONG_RUNNING=1 to enable')
      }
      if (browserName !== 'chromium') {
        test.skip(true, 'performance.memory is Chromium-only')
      }

      // Set the test timeout high enough for the 1 h soak.
      test.setTimeout(70 * 60 * 1000)

      await page.goto('/flights')
      const firstFlight = page.locator('[data-testid^="flight-card"], .cursor-pointer').first()
      if (!(await firstFlight.isVisible({ timeout: 5000 }).catch(() => false))) {
        test.skip(true, 'Suite seed has no flights for soak')
      }
      await firstFlight.click()

      const readHeap = (): Promise<number> =>
        page.evaluate(() => {
          type WithMem = Performance & { memory?: { usedJSHeapSize: number } }
          const p = performance as WithMem
          return p.memory?.usedJSHeapSize ?? 0
        })

      // Warm-up: t = 60 s baseline.
      await page.waitForTimeout(60 * 1000)
      const baseline = await readHeap()
      expect(baseline).toBeGreaterThan(0)

      // Soak: t = 3600 s.
      await page.waitForTimeout(3540 * 1000)
      const final = await readHeap()
      const ratio = final / baseline
      // Spec: within 10 % of baseline. Allow modest fixture growth + GC noise.
      expect(ratio).toBeGreaterThan(0.5)
      expect(ratio).toBeLessThanOrEqual(1.1)
    },
  )
})