Merge pull request #20 from github/improve/billing-logic-tests

Add billing logic test coverage

Author: asizikov

.github/workflows/deploy.yml

@@ -4,6 +4,9 @@ on:
   push:
     branches:
       - main
+  pull_request:
+    branches:
+      - main
 
 permissions:
   contents: read
@@ -19,10 +22,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Setup Node.js
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: '20'
           cache: 'npm'
@@ -33,18 +36,24 @@ jobs:
       - name: Lint
         run: npm run lint
 
+      - name: Test
+        run: npm run test
+
       - name: Build
         run: npm run build
 
       - name: Setup Pages
+        if: github.event_name == 'push'
         uses: actions/configure-pages@v5
 
       - name: Upload artifact
+        if: github.event_name == 'push'
         uses: actions/upload-pages-artifact@v3
         with:
           path: ./dist
 
   deploy:
+    if: github.event_name == 'push'
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}

README.md

@@ -22,7 +22,7 @@ A web application for previewing and comparing your future GitHub Copilot bills
 ## Getting Started
 
 ### Prerequisites
-- Node.js 18+
+- Node.js 20+
 - npm or yarn
 
 ### Installation
@@ -47,6 +47,12 @@ npm run build
 
 The production build will be created in the `dist/` directory.
 
+### Test
+
+```bash
+npm run test
+```
+
 ### Preview Production Build
 
 ```bash
@@ -60,7 +66,7 @@ npm run preview
 3. The app will parse the report and compare request-based and AI Credits-based billing signals
 4. Explore the visualizations and data views to preview how future bills may look after the AI Credits transition
 
-Sample reports are available in the `examples/` directory. Older examples without `aic_quantity` still load, but AI Credits will remain `0` for those rows.
+If you don't have your own data yet, export a GitHub Copilot billing CSV from your organization that matches the current format, including the `aic_quantity` and `aic_gross_amount` columns.
 
 ## CSV Report Format
 
@@ -82,8 +88,6 @@ The application expects CSV files with the following required columns:
 - `organization` - Organization slug
 - `cost_center_name` - Optional cost center identifier
 
-Newer exports may also include these AI Credit columns:
-
 - `aic_quantity` - AI Credits for the same usage row
 - `aic_gross_amount` - AI Credit gross cost for the same usage row
 

docs/report-format.md

@@ -21,20 +21,12 @@ Source examples: files in `examples/`. Some existing sample exports still use th
 | `total_monthly_quota` | number | Monthly quota for the user or plan applicable to the row. |
 | `organization` | string | Organization slug associated with the usage. |
 | `cost_center_name` | string | Optional cost center or tagging field. |
-## Optional AI Credit columns
-
-| Column | Status | Notes |
-| --- | --- | --- |
 | `aic_quantity` | Present in newer previews | Same usage converted to AI Credits. |
 | `aic_gross_amount` | Present in newer previews | Used for AI Credit gross cost when present. |
-| `total_input_tokens` | Legacy / optional | Older token-oriented export field; ignored by the app. |
-| `total_output_tokens` | Legacy / optional | Older token-oriented export field; ignored by the app. |
-| `total_cache_creation_tokens` | Legacy / optional | Older token-oriented export field; ignored by the app. |
-| `total_cache_read_tokens` | Legacy / optional | Older token-oriented export field; ignored by the app. |
 
 ## Notes
 - Header row is single-lined; subsequent rows are usage records. Values are comma-separated, double-quoted where needed.
 - Monetary fields are decimals. `aic_quantity` may also be fractional.
 - The app streams the file, treats the first row as the header, and counts subsequent data rows without loading the entire file into memory.
-- Current calculations support both row types: on `requests` rows, `quantity` and `applied_cost_per_quantity` describe PRU usage while `aic_quantity` and `aic_gross_amount` remain reference/comparison values and stay `0` when those AI Credit fields are absent; on `ai-units` rows, Premium Requests and generic PRU gross/discount/net totals are counted as `0`, while AI Credits and AI Credit gross cost are taken from the AI-specific fields (`aic_quantity` / `aic_gross_amount`, with fallback to `quantity` / `gross_amount` only when those AI-specific fields are absent).
-- Reports without `aic_quantity` still load, but AI Credit summaries will display `0`.
+- Current calculations support both row types: on `requests` rows, `quantity` and `applied_cost_per_quantity` describe PRU usage while `aic_quantity` and `aic_gross_amount` remain reference/comparison values; on `ai-units` rows, Premium Requests and generic PRU gross/discount/net totals are counted as `0`, while AI Credits and AI Credit gross cost are taken from the AI-specific fields (`aic_quantity` / `aic_gross_amount`), with fallback to `quantity` / `gross_amount` only when those AI-specific fields are present but blank.
+- The current app expects the current CSV format, including `aic_quantity` and `aic_gross_amount`.