Merge pull request #133 from github/asizikov/report-metadata-flow

Thread report metadata through pipeline

Author: asizikov

src/App.tsx

@@ -34,6 +34,7 @@ import {
 } from './pipeline/aicIncludedCredits'
 import { PRODUCT_BUDGET_COPILOT, PRODUCT_BUDGET_COPILOT_CLOUD_AGENT, PRODUCT_BUDGET_SPARK } from './pipeline/productClassification'
 import { runPipeline } from './pipeline/runPipeline'
+import type { ReportFormatMetadata } from './pipeline/reportAdapters'
 import { runBudgetSimulation, type BudgetSimulationResult } from './utils/budgetSimulation'
 import { EMPTY_BUDGET_VALUES, getDefaultBudgetValues, getUserSpendSegmentsByUsername, type BudgetField, type BudgetValues } from './utils/costManagementBudgets'
 import { calculateIndividualPlanUpgradeRecommendation, getIndividualLicenseMonthlyCost } from './utils/individualPlanUpgrade'
@@ -49,6 +50,7 @@ const ENTERPRISE_LICENSE_MONTHLY_COST = 39
 function App() {
   const [status, setStatus] = useState<Status>('idle')
   const [quickStats, setQuickStats] = useState<QuickStatsResult | null>(null)
+  const [reportMetadata, setReportMetadata] = useState<ReportFormatMetadata | null>(null)
   const [reportContext, setReportContext] = useState<ReportContextResult | null>(null)
   const [error, setError] = useState<string | null>(null)
   const [fileName, setFileName] = useState<string | null>(null)
@@ -79,6 +81,7 @@ function App() {
 
   const applyProcessedData = useCallback(({
     quickStats,
+    reportMetadata,
     reportContext,
     dailyUsageData,
     modelUsage,
@@ -88,6 +91,7 @@ function App() {
     userUsage,
   }: {
     quickStats: QuickStatsResult
+    reportMetadata: ReportFormatMetadata
     reportContext: ReportContextResult
     dailyUsageData: DailyUsageData[]
     modelUsage: ModelUsageResult
@@ -97,6 +101,7 @@ function App() {
     userUsage: UserUsageResult
   }) => {
     setQuickStats(quickStats)
+    setReportMetadata(reportMetadata)
     setReportContext(reportContext)
     setDailyUsageData(dailyUsageData)
     setModelUsage(modelUsage)
@@ -140,6 +145,7 @@ function App() {
         ...statsAggregator.result(),
         lineCount: pipelineResult.reportRowCount,
       },
+      reportMetadata: pipelineResult.reportMetadata,
       reportContext: contextAggregator.result(),
       dailyUsageData: dailyAggregator.result().dailyData,
       modelUsage: modelAggregator.result(),
@@ -168,6 +174,7 @@ function App() {
     setStatus(status)
     setError(null)
     setQuickStats(null)
+    setReportMetadata(null)
     setReportContext(null)
     setDailyUsageData([])
     setUserUsage(null)
@@ -476,7 +483,7 @@ function App() {
     }
   }
 
-  const hasReport = status === 'done' && fileName !== null
+  const hasReport = status === 'done' && fileName !== null && reportMetadata !== null
   const showSeatConfirmation = hasReport && seatConfirmationPending
   const rangeStart = reportContext?.startDate ?? null
   const rangeEnd = reportContext?.endDate ?? null

src/pipeline/reportAdapters.ts

@@ -54,8 +54,14 @@ const REPORT_ADAPTERS: Record<ReportFormat, UsageReportAdapter> = {
   'native-ai-credits': NATIVE_AI_CREDITS_REPORT_ADAPTER,
 }
 
-export function validateUsageReportHeader(header: TokenUsageHeader): void {
-  validateTokenUsageHeader(header)
+export function getDefaultSupportedUsageReportAdapter(): UsageReportAdapter {
+  return TRANSITION_PERIOD_BILLING_PREVIEW_REPORT_ADAPTER
+}
+
+export function validateUsageReportHeader(header: TokenUsageHeader): UsageReportAdapter {
+  const adapter = getDefaultSupportedUsageReportAdapter()
+  adapter.validateHeader(header)
+  return adapter
 }
 
 export function detectReportFormat(header: TokenUsageHeader, firstRecord: TokenUsageRecord): ReportFormat {

src/pipeline/runPipeline.test.ts

@@ -43,6 +43,12 @@ const NATIVE_AI_CREDITS_HEADER = [
   'aic_gross_amount',
 ].join(',')
 
+const TRANSITION_PERIOD_REPORT_METADATA = {
+  format: 'transition-period-billing-preview',
+  label: 'Transition Period Billing Preview report',
+  supported: true,
+}
+
 function createCsv(rows: string[][], header = HEADER): File {
   const body = [header, ...rows.map((row) => row.join(','))].join('\n')
   return new File([body], 'usage.csv', { type: 'text/csv' })
@@ -65,10 +71,19 @@ class CaptureAggregator implements Aggregator<TokenUsageRecord, TokenUsageRecord
 }
 
 describe('runPipeline', () => {
-  it('accepts a valid header-only report', async () => {
+  it('rejects reports without a header row', async () => {
+    const aggregator = new CaptureAggregator()
+    const file = new File(['\n\n'], 'usage.csv', { type: 'text/csv' })
+
+    await expect(runPipeline(file, [aggregator])).rejects.toThrow(InvalidReportError)
+    expect(aggregator.result()).toEqual([])
+  })
+
+  it('returns transition-period metadata for a valid header-only report', async () => {
     const aggregator = new CaptureAggregator()
 
     await expect(runPipeline(createCsv([]), [aggregator])).resolves.toEqual({
+      reportMetadata: TRANSITION_PERIOD_REPORT_METADATA,
       reportRowCount: 0,
       processedRowCount: 0,
     })
@@ -135,7 +150,7 @@ describe('runPipeline', () => {
     expect(aggregator.result()).toEqual([])
   })
 
-  it('filters and normalizes known normalization window rows before AIC allocation', async () => {
+  it('returns transition-period metadata while processing supported reports', async () => {
     const file = createCsv([
       ['2026-04-25', 'mona', 'copilot', 'copilot_premium_request', 'GPT-5', '0', 'requests', '0.04', '0', '0', '0', 'False', '300', '', '', '0', '0'],
       ['2026-04-25', 'mona', 'copilot', 'copilot_premium_request', 'GPT-5', '10', 'requests', '0.04', '0.40', '0', '0.40', 'False', '0', '', '', '100', '1.00'],
@@ -155,6 +170,7 @@ describe('runPipeline', () => {
       }),
     ])
     expect(result).toEqual({
+      reportMetadata: TRANSITION_PERIOD_REPORT_METADATA,
       reportRowCount: 2,
       processedRowCount: 1,
     })

src/pipeline/runPipeline.ts

@@ -1,17 +1,24 @@
 import type { Aggregator } from './aggregators/base'
 import { createAicIncludedCreditsAllocator, type AicIncludedCreditsOverrides } from './aicIncludedCredits'
 import {
+  InvalidReportError,
   parseTokenUsageHeader,
   parseNormalizedTokenUsageRecord,
   parseTokenUsageRecord,
   type TokenUsageHeader,
   type TokenUsageRecord,
 } from './parser'
-import { validateUsageReportFirstRecord, validateUsageReportHeader } from './reportAdapters'
+import {
+  validateUsageReportFirstRecord,
+  validateUsageReportHeader,
+  type ReportFormatMetadata,
+  type UsageReportAdapter,
+} from './reportAdapters'
 import { streamLines, type StreamProgress } from './streamer'
 
-async function validateFileFormat(file: File): Promise<void> {
+async function validateFileFormat(file: File): Promise<ReportFormatMetadata> {
   let header: TokenUsageHeader | null = null
+  let selectedAdapter: UsageReportAdapter | null = null
 
   for await (const line of streamLines(file)) {
     const trimmed = line.trimEnd()
@@ -21,13 +28,18 @@ async function validateFileFormat(file: File): Promise<void> {
 
     if (!header) {
       header = parseTokenUsageHeader(trimmed)
-      validateUsageReportHeader(header)
+      selectedAdapter = validateUsageReportHeader(header)
       continue
     }
 
-    validateUsageReportFirstRecord(header, parseTokenUsageRecord(trimmed, header))
-    return
+    return validateUsageReportFirstRecord(header, parseTokenUsageRecord(trimmed, header)).metadata
+  }
+
+  if (!selectedAdapter) {
+    throw new InvalidReportError()
   }
+
+  return selectedAdapter.metadata
 }
 
 export interface PipelineProgress {
@@ -45,6 +57,7 @@ export interface PipelineOptions {
 }
 
 export interface PipelineResult {
+  reportMetadata: ReportFormatMetadata
   reportRowCount: number
   processedRowCount: number
 }
@@ -78,7 +91,7 @@ export async function runPipeline(
   options?: PipelineOptions,
 ): Promise<PipelineResult> {
   const { includedCreditsOverrides = {}, progressResolution = 500, onProgress } = options ?? {}
-  await validateFileFormat(file)
+  const reportMetadata = await validateFileFormat(file)
   let lastProgressStage: PipelineProgress['stage'] | null = null
   let lastProgressPercent = -1
   let lastProgressTimestamp = 0
@@ -179,6 +192,7 @@ export async function runPipeline(
   }
 
   return {
+    reportMetadata,
     reportRowCount,
     processedRowCount: rowIndex,
   }