James Brunton
ed58d90ab8
# Description of Changes Removes the feature flags for enabling policies on both the backend and frontend. We shouldn't be releasing another self-hosted release that doesn't include policies, so it makes sense to do this now. Builds that don't have the Processor will just not run policies because they won't have any. Beyond that, the API should always be available, but checks whether the user actually has the entitlements to run policies (whether they have credits/a payment method available)
2.5 KiB
Policies (editor)
Automation-backed document-enforcement policies. The editor side is
enforcement only: policies are configured in the admin portal
(src/portal/views/Policies.tsx); the editor runs enabled policies on
uploaded files, blocks the file's exit points while a run is in flight, and
badges files a policy has produced. Always on in the proprietary/SaaS builds;
the core (OSS) build has no implementation (usePoliciesEnabled stub = false),
and desktop additionally requires an active SaaS connection (runs bill through
the cloud). The single gate is components/policies/usePoliciesEnabled.ts.
Layout
| Path | Role |
|---|---|
types/policies.ts |
Type model (category, fields, state). |
data/policyDefinitions.tsx |
Static preset definitions for the catalog. Read through services/policyCatalog.ts (loadPolicyCatalog()), not directly. |
services/policyStorage.ts |
Local persistence (localStorage) of per-policy state + change events. |
hooks/usePolicies.ts |
Policy state + permission flag, consumed by the auto-run controller. |
hooks/usePolicyFileBadges.ts |
Per-file badge map (which policies produced/are enforcing a file) — drives the shared PolicyBadges row and the exit-point blocking. |
components/policies/usePoliciesEnabled.ts |
The single build/connection gate for mounting the auto-run controller. Core stub = false; desktop shadow adds the SaaS-connection check. |
components/policies/PolicyAutoRunController.tsx |
Headless: enforces enabled policies on every uploaded file. Mounted by RightSidebar. |
components/policies/usePolicyAutoRun.ts |
The auto-run engine: dispatch, polling, retry, output import, server reconcile. |
components/policies/policyRunStore.ts |
useSyncExternalStore store of run records (status, progress, outputs), persisted to localStorage. |
components/policies/enforcementQueue.ts |
Export-time enforcement queue used by services/policyExport.ts. |
components/policies/policyStatus.ts |
Category → accent-colour mapping shared by badges and export toasts. |
Enforcement UI lives with the surfaces it gates: PolicyEnforcementOverlay
(proprietary viewer), PolicyEnforcingOverlay (thumbnails + viewer overlay
body), and the shared PolicyBadges row (core/components/shared/).
Tests
policyRunStore.test.ts, usePolicyAutoRun.test.ts (+ .retry / .import
variants), hooks/usePolicyFileBadges.test.ts,
services/policyStorage.test.ts, and data/policyDefinitions.test.ts.