Website: add support for new usage statistics#42923
Conversation
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
Claude Code Review
This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.
Tip: disable this comment in your organization's Code Review settings.
There was a problem hiding this comment.
Pull request overview
Adds new Windows conditional access–related usage metrics to the fleetdm.com website’s usage analytics ingestion path, so incoming statistics from Fleet can be persisted for later reporting/analysis.
Changes:
- Extended the
HistoricalUsageSnapshotmodel with four new boolean attributes for conditional access metrics. - Updated the
receive-usage-analyticswebhook controller to accept (and default) the new metrics in the inbound payload.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/api/models/HistoricalUsageSnapshot.js | Adds four required boolean columns to persist the new usage statistics. |
| website/api/controllers/webhooks/receive-usage-analytics.js | Accepts the new metrics as webhook inputs with false defaults and stores them with the snapshot. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
WalkthroughThe changes add four new boolean fields related to conditional access configuration to the usage analytics tracking system. These fields ( 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@website/api/models/HistoricalUsageSnapshot.js`:
- Around line 54-57: The HistoricalUsageSnapshot model now requires four new
boolean attributes (oktaConditionalAccessConfigured,
entraConditionalAccessConfigured, conditionalAccessBypassDisabled,
conditionalAccessEnabled); add a DB migration that alters the
historical_usage_snapshot table to add these four columns with appropriate NOT
NULL boolean types and sensible default values (so existing rows are backfilled)
before merging; ensure the migration file name references the change, the schema
matches the Sails model attribute names, and run/test the migration against a
staging DB to confirm HistoricalUsageSnapshot.create(...) will succeed in
production with migrate: 'safe'.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 5fbf3ede-cbb7-4d7c-ba01-8d98bea128ee
📒 Files selected for processing (2)
website/api/controllers/webhooks/receive-usage-analytics.jswebsite/api/models/HistoricalUsageSnapshot.js
| oktaConditionalAccessConfigured: {required: true, type: 'boolean'}, | ||
| conditionalAccessEnabled: {required: true, type: 'boolean'}, | ||
| conditionalAccessBypassDisabled: {required: true, type: 'boolean'}, | ||
| entraConditionalAccessConfigured: {required: true, type: 'boolean'}, |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== Locate migration/schema files =="
fd -i 'migrat|schema|sql'
echo
echo "== Find references to new fields outside model/controller =="
rg -n --no-heading 'oktaConditionalAccessConfigured|entraConditionalAccessConfigured|conditionalAccessBypassDisabled|conditionalAccessEnabled' \
-g '!website/api/models/HistoricalUsageSnapshot.js' \
-g '!website/api/controllers/webhooks/receive-usage-analytics.js'
echo
echo "== Check migration/schema files for the 4 new columns =="
rg -n --no-heading 'oktaConditionalAccessConfigured|entraConditionalAccessConfigured|conditionalAccessBypassDisabled|conditionalAccessEnabled' \
--iglob '*migrat*' --iglob '*schema*' --iglob '*.sql'Repository: fleetdm/fleet
Length of output: 14874
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== Check schema.sql for historical_usage_snapshot table =="
rg -A 30 'CREATE TABLE.*historical_usage_snapshot' server/datastore/mysql/schema.sql
echo
echo "== List recent migration files (last 10) =="
ls -t server/datastore/mysql/migrations/tables/*.go | head -10
echo
echo "== Check the most recent migration file for these fields =="
LATEST_MIGRATION=$(ls -t server/datastore/mysql/migrations/tables/*.go | grep -v test | head -1)
echo "Latest migration: $LATEST_MIGRATION"
echo "Content preview:"
head -50 "$LATEST_MIGRATION"
echo
echo "== Search for any migration mentioning conditional access =="
rg -l 'conditional' server/datastore/mysql/migrations/tables/Repository: fleetdm/fleet
Length of output: 115
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== Check website directory structure for migrations/database files =="
find website -type f -name '*migrat*' -o -name '*schema*' -o -name '*.sql' 2>/dev/null | head -20
echo
echo "== Read the actual HistoricalUsageSnapshot.js file =="
cat -n website/api/models/HistoricalUsageSnapshot.js
echo
echo "== Read the webhook controller file =="
cat -n website/api/controllers/webhooks/receive-usage-analytics.jsRepository: fleetdm/fleet
Length of output: 10338
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== Check for Sails.js migrations directory in website =="
find website -type d -name migrations 2>/dev/null
echo
echo "== Check for Sails.js config files =="
find website/config -type f 2>/dev/null | head -20
echo
echo "== Search for auto-migrate or migrate config =="
rg -l 'migrate|autoMigrations' website/config/ 2>/dev/null || echo "Not found in config"
echo
echo "== Check if there's a .sailsrc or other Sails config =="
find website -maxdepth 2 -type f \( -name '.sailsrc*' -o -name 'app.js' -o -name 'package.json' \) 2>/dev/null
echo
echo "== Check website package.json for version and config =="
cat website/package.json | grep -A 5 -E '"sails"|"version"' | head -20Repository: fleetdm/fleet
Length of output: 1422
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== Check Sails.js models config for migration strategy =="
cat -n website/config/models.js
echo
echo "== Check Sails.js datastores config =="
cat -n website/config/datastores.js
echo
echo "== Check .sailsrc config =="
cat website/.sailsrcRepository: fleetdm/fleet
Length of output: 11393
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== Check production environment config =="
cat -n website/config/env/production.js | head -100
echo
echo "== Look for any migration tooling or scripts =="
find website -type f -name '*migrat*' 2>/dev/null
echo
echo "== Check if there are any SQL or schema backup files =="
find website -type f \( -name '*.sql' -o -name '*schema*' \) 2>/dev/nullRepository: fleetdm/fleet
Length of output: 7395
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== Check bootstrap.js for any schema setup =="
cat -n website/config/bootstrap.js
echo
echo "== Search for any recent changes to migration/schema files =="
git log --oneline --all -- '*migrat*' '*schema*' | head -20
echo
echo "== Look for any database dump or seed files =="
find website -type f -name '*.sql' -o -name '*seed*' -o -name '*dump*' 2>/dev/nullRepository: fleetdm/fleet
Length of output: 7513
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== Check the commit that added new usage statistics =="
git show 09c8f558 --stat
echo
echo "== Get full diff for that commit =="
git show 09c8f558 --name-statusRepository: fleetdm/fleet
Length of output: 50371
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== Check which files were added/modified in commit 09c8f558 =="
git show 09c8f558 --name-only | grep -E '(migrat|schema|\.sql|HistoricalUsageSnapshot)' | head -30Repository: fleetdm/fleet
Length of output: 1645
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== Get specific files changed in the commit (more targeted) =="
git diff-tree --no-commit-id --name-only -r 09c8f558 | grep -E 'website.*' | head -20
echo
echo "== Check if there's a migration file for these fields =="
git diff 09c8f558~1..09c8f558 -- website/ | grep -A 5 -B 5 'oktaConditionalAccess\|entraConditionalAccess\|conditionalAccessBypass' | head -50Repository: fleetdm/fleet
Length of output: 119
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== List files in the website/api directory =="
git show 09c8f558:website/api/models/HistoricalUsageSnapshot.js 2>/dev/null | head -60 || echo "File may not exist in that commit"
echo
echo "== Check the actual diff for HistoricalUsageSnapshot =="
git log --all --oneline -- website/api/models/HistoricalUsageSnapshot.js | head -5
echo
echo "== Show recent changes to HistoricalUsageSnapshot =="
git log -p --all -- website/api/models/HistoricalUsageSnapshot.js | grep -A 30 -B 5 'oktaConditionalAccess\|entraConditionalAccess' | head -80Repository: fleetdm/fleet
Length of output: 4042
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== Check if website has a db/ directory with migrations =="
find website -type d -name 'db' -o -type d -name 'database' -o -type d -name 'migrations' 2>/dev/null
echo
echo "== Look for any SQL setup files in website =="
find website -name '*.sql' 2>/dev/null
echo
echo "== Check Sails.js bootstrap or database initialization =="
grep -r 'HistoricalUsageSnapshot' website/config/ 2>/dev/null || echo "No bootstrap config found for model"
echo
echo "== Check if migration/initialization happens in database setup =="
ls -la website/config/env/ | grep -E 'production|development'
echo
echo "== Look for any database-related hooks =="
find website -type f -name '*hook*' 2>/dev/null | head -10Repository: fleetdm/fleet
Length of output: 1430
Ensure the database migration exists for these four required columns before merge.
Lines 54–57 add four required model attributes. In production, Sails.js runs with migrate: 'safe' (see website/config/env/production.js line 93), which disables auto-migrations to prevent accidental data loss. If the historical_usage_snapshot table lacks these columns when the analytics webhook calls HistoricalUsageSnapshot.create(...), the database INSERT will fail at runtime.
Verify that a database migration adds all four columns (oktaConditionalAccessConfigured, entraConditionalAccessConfigured, conditionalAccessBypassDisabled, conditionalAccessEnabled) with appropriate defaults for existing rows before deployment.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@website/api/models/HistoricalUsageSnapshot.js` around lines 54 - 57, The
HistoricalUsageSnapshot model now requires four new boolean attributes
(oktaConditionalAccessConfigured, entraConditionalAccessConfigured,
conditionalAccessBypassDisabled, conditionalAccessEnabled); add a DB migration
that alters the historical_usage_snapshot table to add these four columns with
appropriate NOT NULL boolean types and sensible default values (so existing rows
are backfilled) before merging; ensure the migration file name references the
change, the schema matches the Sails model attribute names, and run/test the
migration against a staging DB to confirm HistoricalUsageSnapshot.create(...)
will succeed in production with migrate: 'safe'.
Closes: #42049 Changes: - Added four attributes to the HistoricalUsageSnapshot model: `oktaConditionalAccessConfigured`, `conditionalAccessEnabled`, `conditionalAccessBypassDisabled`, and `entraConditionalAccessConfigured` - Added the new usage statistics as inputs to the receive-usage-analytics webhook > Note: Before this PR can be merged, the website's database needs to be migrated to add the new columns. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added tracking for conditional access configuration states across Okta and Entra platforms, including bypass and enablement status. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Closes: #42049
Changes:
oktaConditionalAccessConfigured,conditionalAccessEnabled,conditionalAccessBypassDisabled, andentraConditionalAccessConfiguredSummary by CodeRabbit