Files
accounted/lib/entitlements/has-capability.ts
T
Jakob Wennberg 4ac7b45c8a perf(layout): dashboard layout in two waves, nav flags as one RPC, local JWT verification (#1946)
The dashboard layout runs on every hard load, hard refresh, company switch
and the 16 router.refresh() sites, and loading.tsx cannot paint until it
resolves. It cost ~20 network calls in 4 sequential waves: a third
getUser() round trip to Supabase Auth (after the proxy's and the route
guard's), the company resolution, then 16 reads including four limit-1
probes whose only job is to decide whether to render the Webshop and
Körjournal nav rows, and an entitlements read that itself ran two waves.

- lib/auth/claims.ts: claimsPinned/userFromClaims extracted from
  require-auth.ts (unchanged) so the dashboard request context shares the
  exact pinning + mapping. getDashboardAuthContext verifies the JWT locally
  and falls back to getUser() only when claims are missing, unpinned or
  unverifiable: the proxy already performed the per-request revocation
  check before the layout runs (same semantics approved for routes on
  2026-07-23).
- Wave 1 (user-keyed, parallel with the company resolution): team
  membership, profile, user preferences and the memberships join, which
  now also supplies the active company's row and role, so the separate
  companies and company_members reads are gone.
- Wave 2 (company-keyed): settings, agent profile, the switcher's settings
  names, entitlements in ONE wave (getCompanyEntitlements takes the
  team_id the join already carries and runs the grants read alongside
  config + subscription), and get_dashboard_nav_flags().
- supabase/migrations/20260826120000_get_dashboard_nav_flags.sql:
  SECURITY INVOKER, STABLE, EXECUTE for authenticated only; RLS applies
  inside. lib/dashboard/nav-flags.ts wraps it with the pre-RPC four-probe
  fallback on PGRST202/42883/42501 (self-hosted not yet migrated, deploy
  ordering) and degrades to hidden rows on any other error.
- tests/pg/dashboard-nav-flags-rpc.pg.test.ts (6): fresh company, active vs
  pending WooCommerce, active Shopify, mileage trips, RLS for a member of
  another company, EXECUTE grants. Unit tests for the wrapper (RPC row,
  single-object payload, each fallback code, other errors) and for the
  entitlements teamId option.

~20 calls / 4 waves -> ~12 calls / 2 waves, 0 auth network calls.

Co-authored-by: Jakob Wennberg <311770904+jakobwennberg-oss@users.noreply.github.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-08-26 15:14:49 +02:00

464 lines
18 KiB
TypeScript

import type { SupabaseClient } from '@supabase/supabase-js'
import { NextResponse } from 'next/server'
import { isSelfHosted } from '@/lib/env/public-flags'
import { PAID_CAPABILITIES, type CapabilityKey } from './keys'
/**
* Entitlement gate: the single primitive behind the paywall ("non-payer loses
* functionality") AND the vision's modularity-out ("hide a module this company
* doesn't need"). Both are the same question: does this company hold the
* capability, fail-closed, resolved server-side?
*
* Two orthogonal axes, AND-ed together (see migration
* 20260628140000_capability_grants_and_metered_events):
* ENTITLEMENT: an unexpired capability_grant on the company OR its firm/team.
* ENABLEMENT : not explicitly disabled in company_capability_config (absent == enabled).
*
* Mirrors the shape of lib/sandbox/guard.ts so it drops in at the same call
* sites. The company is resolved by the CALLER (requireCompanyId for web, the
* validated API key for MCP): never taken from untrusted input here.
*/
/**
* Self-hosted deployments are all-on: the gate never withholds anything.
*
* Read through lib/env/public-flags: comparing process.env.NEXT_PUBLIC_* in
* place gets constant-folded out of the Docker build, which is exactly how
* every self-hosted install ended up running behind this paywall.
*/
/**
* Local development is all-on so every gated feature is testable without a
* subscription. Two triggers, both fail-safe for prod:
* - NODE_ENV === 'development' (i.e. `npm run dev`). NOT 'test': the
* entitlement suite must still exercise the real gate, and NOT
* 'production'.
* - DISABLE_PAYWALL === 'true': explicit escape hatch for a local
* production build. Never set this in a hosted environment.
*/
function isPaywallBypassed(): boolean {
// Self-hosted is genuinely all-on: never gate it.
if (isSelfHosted()) return true
// Escape hatch to exercise the REAL gate in local dev, where the paywall is
// otherwise all-on so every paid feature is testable without a subscription.
// Set FORCE_PAYWALL=true to see the paid/non-paid UX (nav hiding, page upsells)
// exactly as a non-payer would. Fail-safe: it can only make gating stricter, so
// it is harmless if it ever leaks into a hosted env. Wins over the dev bypass.
if (process.env.FORCE_PAYWALL === 'true') return false
return (
process.env.NODE_ENV === 'development' ||
process.env.DISABLE_PAYWALL === 'true'
)
}
const UUID_RE = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i
/**
* Only server-resolved UUIDs may be interpolated into the PostgREST `.or()`
* filter below: commas/dots/parens are filter syntax. companyId/teamId always
* come from the DB, but we validate at this boundary as defense in depth.
*/
function isUuid(v: string): boolean {
return UUID_RE.test(v)
}
const CAPABILITY_SCOPE_CHUNK_SIZE = 100
function chunksOf<T>(values: T[], size: number): T[][] {
const chunks: T[][] = []
for (let index = 0; index < values.length; index += size) {
chunks.push(values.slice(index, index + size))
}
return chunks
}
function grantIsActive(expiresAt: string | null, now: number): boolean {
return expiresAt === null || new Date(expiresAt).getTime() > now
}
/**
* Resolve a cron or batch work list before applying its processing limit.
*
* This is the bulk counterpart to hasCapability(): company grants and firm
* grants both cascade, expired grants do not, and an explicit company-level
* disable wins. Queries are chunked to keep PostgREST URLs bounded. Any query
* failure throws so background jobs report a failed run instead of silently
* treating every paying company as ineligible.
*/
export async function getCompanyIdsWithCapability(
supabase: SupabaseClient,
companyIds: readonly string[],
key: CapabilityKey,
): Promise<Set<string>> {
const validCompanyIds = [...new Set(companyIds.filter(isUuid))]
if (validCompanyIds.length === 0) return new Set()
if (isPaywallBypassed()) return new Set(validCompanyIds)
type CompanyScope = { id: string; team_id: string | null }
type GrantScope = {
company_id: string | null
team_id: string | null
expires_at: string | null
}
type DisabledConfig = { company_id: string }
const companies: CompanyScope[] = []
const disabledConfigs: DisabledConfig[] = []
for (const chunk of chunksOf(validCompanyIds, CAPABILITY_SCOPE_CHUNK_SIZE)) {
const [{ data: companyRows, error: companiesError }, { data: configRows, error: configError }] =
await Promise.all([
supabase.from('companies').select('id, team_id').in('id', chunk),
supabase
.from('company_capability_config')
.select('company_id')
.eq('capability_key', key)
.eq('enabled', false)
.in('company_id', chunk),
])
if (companiesError) throw new Error(`Failed to resolve capability company scopes: ${companiesError.message}`)
if (configError) throw new Error(`Failed to resolve capability config: ${configError.message}`)
companies.push(...((companyRows ?? []) as CompanyScope[]))
disabledConfigs.push(...((configRows ?? []) as DisabledConfig[]))
}
const teamIds = [...new Set(companies.map(company => company.team_id).filter((id): id is string => !!id))]
const grants: GrantScope[] = []
for (const chunk of chunksOf(validCompanyIds, CAPABILITY_SCOPE_CHUNK_SIZE)) {
const { data, error } = await supabase
.from('capability_grants')
.select('company_id, team_id, expires_at')
.eq('capability_key', key)
.in('company_id', chunk)
if (error) throw new Error(`Failed to resolve company capability grants: ${error.message}`)
grants.push(...((data ?? []) as GrantScope[]))
}
for (const chunk of chunksOf(teamIds, CAPABILITY_SCOPE_CHUNK_SIZE)) {
const { data, error } = await supabase
.from('capability_grants')
.select('company_id, team_id, expires_at')
.eq('capability_key', key)
.in('team_id', chunk)
if (error) throw new Error(`Failed to resolve firm capability grants: ${error.message}`)
grants.push(...((data ?? []) as GrantScope[]))
}
const now = Date.now()
const activeCompanyGrants = new Set<string>()
const activeTeamGrants = new Set<string>()
for (const grant of grants) {
if (!grantIsActive(grant.expires_at, now)) continue
if (grant.company_id) activeCompanyGrants.add(grant.company_id)
if (grant.team_id) activeTeamGrants.add(grant.team_id)
}
const disabledCompanyIds = new Set(disabledConfigs.map(config => config.company_id))
return new Set(
companies
.filter(company =>
!disabledCompanyIds.has(company.id) &&
(activeCompanyGrants.has(company.id) ||
(company.team_id !== null && activeTeamGrants.has(company.team_id))),
)
.map(company => company.id),
)
}
export async function hasCapability(
supabase: SupabaseClient,
companyId: string,
key: CapabilityKey,
): Promise<boolean> {
if (isPaywallBypassed()) return true
if (!isUuid(companyId)) return false // fail-closed: never interpolate a non-UUID
// Resolve the company's firm/team (firm-scoped grants cascade to clients).
const { data: company } = await supabase
.from('companies')
.select('team_id')
.eq('id', companyId)
.maybeSingle()
const rawTeamId = (company as { team_id: string | null } | null)?.team_id ?? null
const teamId = rawTeamId && isUuid(rawTeamId) ? rawTeamId : null
// ENTITLEMENT axis: any unexpired grant on the company or its team.
const scopeFilter = teamId
? `company_id.eq.${companyId},team_id.eq.${teamId}`
: `company_id.eq.${companyId}`
const { data: grants, error: grantsError } = await supabase
.from('capability_grants')
.select('expires_at')
.eq('capability_key', key)
.or(scopeFilter)
if (grantsError) return false // fail-closed on any read error
const now = Date.now()
const entitled = (grants ?? []).some((g) => {
const exp = (g as { expires_at: string | null }).expires_at
return grantIsActive(exp, now)
})
if (!entitled) return false
// ENABLEMENT axis: explicitly turned off for this company? (absence == enabled)
const { data: config } = await supabase
.from('company_capability_config')
.select('enabled')
.eq('company_id', companyId)
.eq('capability_key', key)
.maybeSingle()
if ((config as { enabled: boolean } | null)?.enabled === false) return false
return true
}
/** Bilingual paywall copy, shared by every transport (HTTP route, MCP tool, commit executor). */
export const CAPABILITY_BLOCKED_MESSAGE_SV =
'Den här funktionen kräver en betald prenumeration. Uppgradera för att fortsätta använda externa tjänster.'
export const CAPABILITY_BLOCKED_MESSAGE_EN =
'This feature requires a paid subscription. Upgrade to keep using external services.'
/**
* Standard bilingual 403 for a capability-blocked endpoint. Matches the
* sandbox/guard envelope so the UI surfaces the upsell consistently.
*/
export function capabilityBlockedResponse(key: CapabilityKey): NextResponse {
return NextResponse.json(
{
error: CAPABILITY_BLOCKED_MESSAGE_SV,
error_en: CAPABILITY_BLOCKED_MESSAGE_EN,
capability_blocked: true,
capability: key,
},
{ status: 403 },
)
}
export interface CapabilityBlockedError {
code: 'capability_blocked'
capability_blocked: true
capability: CapabilityKey
message_sv: string
message_en: string
}
/**
* Transport-free counterpart to capabilityBlockedResponse, for call sites that
* don't return a NextResponse: the MCP dispatcher (folded into the JSON-RPC
* `isError` envelope) and the pending-operation commit executor. Same copy and
* the same `capability_blocked: true` marker so every surface upsells alike.
*/
export function capabilityBlockedError(key: CapabilityKey): CapabilityBlockedError {
return {
code: 'capability_blocked',
capability_blocked: true,
capability: key,
message_sv: CAPABILITY_BLOCKED_MESSAGE_SV,
message_en: CAPABILITY_BLOCKED_MESSAGE_EN,
}
}
/**
* Convenience wrapper: check + return the 403 in one call. Returns the
* NextResponse to return from the route, or null when the company has the
* capability and the route should proceed.
*
* const blocked = await requireCapability(supabase, companyId, CAPABILITY.ai)
* if (blocked) return blocked
*/
export async function requireCapability(
supabase: SupabaseClient,
companyId: string,
key: CapabilityKey,
): Promise<NextResponse | null> {
if (await hasCapability(supabase, companyId, key)) return null
return capabilityBlockedResponse(key)
}
/**
* Where the company sits in the paid lifecycle, derived from the same grant
* rows that produce `capabilities`:
* 'paid' : an active non-trial grant (stripe/comp/manual/team).
* 'trial' : the trial is the sole source of paid access.
* 'lapsed_subscription' : no active grants, but a company_subscriptions row
* in a non-paying status: a churned payer, so copy
* says "abonnemang", not "provperiod".
* 'trial_expired' : no active grants, only expired trial rows.
* 'none' : no grant rows at all (effectively unreachable on
* hosted: every company is seeded with trial rows).
*/
export type EntitlementState =
| 'trial'
| 'trial_expired'
| 'lapsed_subscription'
| 'paid'
| 'none'
export interface CompanyEntitlements {
capabilities: CapabilityKey[]
/**
* Expiry of the company's trial, present only while the trial is the SOLE
* source of paid access: null once any non-trial grant (stripe/comp/team)
* is active, and null after the trial has lapsed. Drives the trial
* countdown touchpoint in the dashboard chrome.
*/
trialEndsAt: string | null
entitlementState: EntitlementState
/**
* When the lapsed trial ran out (latest trial expires_at), set only while
* entitlementState is 'trial_expired'. Drives the expired-trial notice.
*/
trialExpiredAt: string | null
}
/** company_subscriptions.status values that count as a live subscription. */
const PAYING_SUBSCRIPTION_STATUSES = ['active', 'trialing', 'past_due']
/**
* Resolve which PAID capabilities a company currently holds (entitled AND
* enabled) plus its trial state, in two queries. Used to seed the client
* CompanyContext so the UI can hide/disable/upsell gated features.
* Self-hosted holds everything.
*/
function normalizeTeamId(raw: string | null | undefined): string | null {
return raw && isUuid(raw) ? raw : null
}
function readGrants(supabase: SupabaseClient, companyId: string, teamId: string | null) {
const scopeFilter = teamId
? `company_id.eq.${companyId},team_id.eq.${teamId}`
: `company_id.eq.${companyId}`
return supabase
.from('capability_grants')
.select('capability_key, expires_at, source')
.in('capability_key', PAID_CAPABILITIES as unknown as string[])
.or(scopeFilter)
}
export interface GetCompanyEntitlementsOptions {
/**
* The company's team_id when the caller already has it (the dashboard
* layout reads it off the membership join): skips the companies lookup and
* lets the grants read run in the same wave as the other two, one round
* trip instead of two on the layout's critical path. Pass null for a
* company without a team.
*/
teamId?: string | null
}
export async function getCompanyEntitlements(
supabase: SupabaseClient,
companyId: string,
options: GetCompanyEntitlementsOptions = {},
): Promise<CompanyEntitlements> {
if (isPaywallBypassed()) {
return {
capabilities: [...PAID_CAPABILITIES],
trialEndsAt: null,
entitlementState: 'paid',
trialExpiredAt: null,
}
}
// Fail-closed: never interpolate a non-UUID.
if (!isUuid(companyId)) {
return { capabilities: [], trialEndsAt: null, entitlementState: 'none', trialExpiredAt: null }
}
// The disabled-config subtraction and the subscription-status read only
// need companyId, so they run in parallel with the team lookup: this
// function sits on the dashboard layout's critical path, where each
// serialized round-trip is latency. The subscription row (members-readable
// per RLS) distinguishes a churned payer from an expired trial: cancelled
// subscriptions have their stripe grants deleted, so the grants alone
// cannot tell the two apart.
const knownTeam = options.teamId !== undefined
const [{ data: company }, { data: configs }, { data: subscription }, earlyGrants] = await Promise.all([
knownTeam
? Promise.resolve({ data: { team_id: options.teamId } })
: supabase.from('companies').select('team_id').eq('id', companyId).maybeSingle(),
supabase
.from('company_capability_config')
.select('capability_key, enabled')
.eq('company_id', companyId)
.eq('enabled', false),
supabase
.from('company_subscriptions')
.select('status')
.eq('company_id', companyId)
.maybeSingle(),
// With the team known up front the grants read joins this wave.
knownTeam ? readGrants(supabase, companyId, normalizeTeamId(options.teamId)) : Promise.resolve(null),
])
const teamId = normalizeTeamId((company as { team_id: string | null } | null)?.team_id ?? null)
const { data: grants } = earlyGrants ?? (await readGrants(supabase, companyId, teamId))
const now = Date.now()
const entitled = new Set<string>()
// Latest trial expiry across ALL trial rows, expired ones included: this is
// what tells the UI the trial ENDED (ISO strings from the same column
// compare lexically).
let latestTrialExpiry: string | null = null
let hasActiveNonTrialGrant = false
for (const g of grants ?? []) {
const row = g as { capability_key: string; expires_at: string | null; source: string | null }
if (
row.source === 'trial' &&
row.expires_at &&
(!latestTrialExpiry || row.expires_at > latestTrialExpiry)
) {
latestTrialExpiry = row.expires_at
}
const active = row.expires_at === null || new Date(row.expires_at).getTime() > now
if (!active) continue
entitled.add(row.capability_key)
if (row.source !== 'trial') hasActiveNonTrialGrant = true
}
// Paying/comped companies are not "on trial" even if the seeded trial rows
// haven't expired yet: the countdown would nag someone who already converted.
const trialIsActive =
latestTrialExpiry !== null && new Date(latestTrialExpiry).getTime() > now
const trialEndsAt = !hasActiveNonTrialGrant && trialIsActive ? latestTrialExpiry : null
const subscriptionStatus = (subscription as { status: string | null } | null)?.status ?? null
let entitlementState: EntitlementState
let trialExpiredAt: string | null = null
if (hasActiveNonTrialGrant) {
entitlementState = 'paid'
} else if (trialEndsAt) {
entitlementState = 'trial'
} else if (subscriptionStatus && !PAYING_SUBSCRIPTION_STATUSES.includes(subscriptionStatus)) {
entitlementState = 'lapsed_subscription'
} else if (latestTrialExpiry) {
entitlementState = 'trial_expired'
trialExpiredAt = latestTrialExpiry
} else {
entitlementState = 'none'
}
if (entitled.size === 0) {
return { capabilities: [], trialEndsAt: null, entitlementState, trialExpiredAt }
}
// Subtract any explicitly-disabled (enablement axis).
for (const c of configs ?? []) {
entitled.delete((c as { capability_key: string }).capability_key)
}
return {
capabilities: PAID_CAPABILITIES.filter((k) => entitled.has(k)),
trialEndsAt,
entitlementState,
trialExpiredAt,
}
}
/** Capability list only; see getCompanyEntitlements for the full shape. */
export async function getCompanyCapabilities(
supabase: SupabaseClient,
companyId: string,
): Promise<CapabilityKey[]> {
return (await getCompanyEntitlements(supabase, companyId)).capabilities
}