Reorganize repo structure and standards references
This commit is contained in:
1 parent
3cb93a81be
commit
be2054274d
5885 files changed
+2588
-195
No files matched your search
@@ -0,0 +1,125 @@
|
||||
/**
|
||||
* Phase 10 Task #68 — DSGVO bulk-ops user-FK map.
|
||||
*
|
||||
* Enumerates every Prisma model that holds a foreign key (or a logical
|
||||
* reference) to `User.id`. Each entry declares an explicit cascade
|
||||
* strategy used by the deletion pipeline (`dsgvo-deletion.ts`) and the
|
||||
* export pipeline (`dsgvo-export.ts`).
|
||||
*
|
||||
* Strategies:
|
||||
*
|
||||
* • `hard-delete` — delete rows when the user is deleted. Used
|
||||
* for join tables, ephemeral data and rows
|
||||
* with no retention requirement.
|
||||
*
|
||||
* • `pseudonymize` — keep the row but null/replace the user FK
|
||||
* with the deterministic pseudonym. Used for
|
||||
* retention-bound rows such as AuditEvents,
|
||||
* help-desk tickets and historical analytics
|
||||
* where regulatory or business intent
|
||||
* requires the record to survive deletion.
|
||||
*
|
||||
* • `retain-tombstone` — keep the row but set the FK to NULL
|
||||
* (existing schema-level `onDelete: SetNull`
|
||||
* handles the column update). Used when the
|
||||
* row outlives the user but no audit reference
|
||||
* is required.
|
||||
*
|
||||
* The companion test (`user-fk-map.test.ts`) asserts that the grep over
|
||||
* `prisma/schema/*.prisma` finds exactly the relations enumerated here.
|
||||
* If a future migration adds a new User-FK without updating this map,
|
||||
* the test fails and the cascade silently leaking PII is blocked at
|
||||
* CI time.
|
||||
*/
|
||||
|
||||
export type DsgvoCascadeStrategy = "hard-delete" | "pseudonymize" | "retain-tombstone";
|
||||
|
||||
export interface UserFkMapEntry {
|
||||
/** Prisma model name (matches `model X { ... }`). */
|
||||
model: string;
|
||||
/** Foreign-key column on `model` that references `User.id`. */
|
||||
column: string;
|
||||
/** Cascade strategy applied by the deletion worker. */
|
||||
strategy: DsgvoCascadeStrategy;
|
||||
/** Schema source file (debug/audit aid). */
|
||||
source: string;
|
||||
/** Whether this table is included in the personal-data export bundle. */
|
||||
includeInExport: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sorted alphabetically by `model` + `column` so diffs against future
|
||||
* additions stay reviewable.
|
||||
*/
|
||||
export const USER_FK_MAP: ReadonlyArray<UserFkMapEntry> = Object.freeze([
|
||||
{ model: "AdminUser", column: "userId", strategy: "hard-delete", source: "accounts.prisma", includeInExport: true },
|
||||
{ model: "AnalyticsUniqueVisitor", column: "userId", strategy: "pseudonymize", source: "analytics.prisma", includeInExport: false },
|
||||
{ model: "ApiKey", column: "createdByUserId", strategy: "hard-delete", source: "core.prisma", includeInExport: true },
|
||||
{ model: "App", column: "installedByUserId", strategy: "retain-tombstone", source: "appsEngine.prisma", includeInExport: true },
|
||||
{ model: "AppSyncRun", column: "createdByUserId", strategy: "retain-tombstone", source: "appsEngine.prisma", includeInExport: false },
|
||||
// AuditEvent has no FK relation in the schema (actorId is a free
|
||||
// string column) — we list it here as a *logical* reference. The
|
||||
// pseudonymization strategy is mandatory: SOC2-CC6.1 requires the
|
||||
// audit trail to survive user deletion, only its PII fields are
|
||||
// rewritten.
|
||||
{ model: "AuditEvent", column: "actorId", strategy: "pseudonymize", source: "core.prisma", includeInExport: true },
|
||||
{ model: "Credit", column: "userId", strategy: "pseudonymize", source: "subscriptions.prisma", includeInExport: true },
|
||||
{ model: "DeviceToken", column: "userId", strategy: "hard-delete", source: "notifications.prisma", includeInExport: false },
|
||||
{ model: "EmailRead", column: "userId", strategy: "hard-delete", source: "email.prisma", includeInExport: true },
|
||||
{ model: "EntityView", column: "createdByUserId", strategy: "hard-delete", source: "entityBuilder.prisma", includeInExport: true },
|
||||
{ model: "EntityView", column: "userId", strategy: "hard-delete", source: "entityBuilder.prisma", includeInExport: true },
|
||||
{ model: "Event", column: "userId", strategy: "pseudonymize", source: "core.prisma", includeInExport: true },
|
||||
{ model: "Feedback", column: "userId", strategy: "pseudonymize", source: "helpDesk.prisma", includeInExport: true },
|
||||
{ model: "FormulaLog", column: "userId", strategy: "pseudonymize", source: "entityBuilder.prisma", includeInExport: false },
|
||||
{ model: "Group", column: "createdByUserId", strategy: "retain-tombstone", source: "permissions.prisma", includeInExport: true },
|
||||
{ model: "GroupUser", column: "userId", strategy: "hard-delete", source: "permissions.prisma", includeInExport: true },
|
||||
{ model: "ImpersonationAudit", column: "actorUserId", strategy: "pseudonymize", source: "accounts.prisma", includeInExport: true },
|
||||
{ model: "ImpersonationAudit", column: "targetUserId", strategy: "pseudonymize", source: "accounts.prisma", includeInExport: true },
|
||||
{ model: "KnowledgeBaseArticle", column: "createdByUserId", strategy: "pseudonymize", source: "knowledgeBase.prisma", includeInExport: true },
|
||||
{ model: "Log", column: "userId", strategy: "pseudonymize", source: "core.prisma", includeInExport: true },
|
||||
{ model: "MagicLinkToken", column: "userId", strategy: "hard-delete", source: "accounts.prisma", includeInExport: false },
|
||||
{ model: "MetricLog", column: "userId", strategy: "pseudonymize", source: "core.prisma", includeInExport: false },
|
||||
{ model: "NotificationDelivery", column: "userId", strategy: "pseudonymize", source: "notifications.prisma", includeInExport: true },
|
||||
{ model: "OnboardingSession", column: "userId", strategy: "hard-delete", source: "onboarding.prisma", includeInExport: true },
|
||||
{ model: "Portal", column: "createdByUserId", strategy: "retain-tombstone", source: "portals.prisma", includeInExport: true },
|
||||
{ model: "Row", column: "createdByUserId", strategy: "pseudonymize", source: "entityBuilder.prisma", includeInExport: true },
|
||||
{ model: "RowComment", column: "createdByUserId", strategy: "pseudonymize", source: "entityBuilder.prisma", includeInExport: true },
|
||||
{ model: "RowCommentReaction", column: "createdByUserId", strategy: "hard-delete", source: "entityBuilder.prisma", includeInExport: true },
|
||||
{ model: "RowPermission", column: "userId", strategy: "hard-delete", source: "entityBuilder.prisma", includeInExport: true },
|
||||
{ model: "RowTask", column: "assignedToUserId", strategy: "retain-tombstone", source: "entityBuilder.prisma", includeInExport: true },
|
||||
{ model: "RowTask", column: "completedByUserId", strategy: "retain-tombstone", source: "entityBuilder.prisma", includeInExport: true },
|
||||
{ model: "RowTask", column: "createdByUserId", strategy: "pseudonymize", source: "entityBuilder.prisma", includeInExport: true },
|
||||
{ model: "Site", column: "createdByUserId", strategy: "retain-tombstone", source: "sites.prisma", includeInExport: true },
|
||||
{ model: "SupportTicket", column: "userId", strategy: "pseudonymize", source: "helpDesk.prisma", includeInExport: true },
|
||||
{ model: "TenantIpAddress", column: "userId", strategy: "hard-delete", source: "accounts.prisma", includeInExport: true },
|
||||
{ model: "TenantUser", column: "userId", strategy: "hard-delete", source: "accounts.prisma", includeInExport: true },
|
||||
{ model: "TenantUserInvitation", column: "acceptedByUserId", strategy: "retain-tombstone", source: "accounts.prisma", includeInExport: true },
|
||||
{ model: "TenantUserInvitation", column: "createdUserId", strategy: "retain-tombstone", source: "accounts.prisma", includeInExport: true },
|
||||
{ model: "TenantUserInvitation", column: "fromUserId", strategy: "retain-tombstone", source: "accounts.prisma", includeInExport: true },
|
||||
{ model: "TenantUserInvitation", column: "revokedByUserId", strategy: "retain-tombstone", source: "accounts.prisma", includeInExport: true },
|
||||
// Auth session/device artifacts (R-P2b). They already declare
|
||||
// `onDelete: Cascade`, so hard-delete is the matching DSGVO strategy; not user
|
||||
// content, so excluded from export.
|
||||
{ model: "TrustedDevice", column: "userId", strategy: "hard-delete", source: "auth.prisma", includeInExport: false },
|
||||
{ model: "UserNotificationPreference", column: "userId", strategy: "hard-delete", source: "notifications.prisma", includeInExport: true },
|
||||
{ model: "UserRole", column: "userId", strategy: "hard-delete", source: "permissions.prisma", includeInExport: true },
|
||||
{ model: "UserSession", column: "userId", strategy: "hard-delete", source: "auth.prisma", includeInExport: false },
|
||||
{ model: "Workflow", column: "createdByUserId", strategy: "retain-tombstone", source: "workflows.prisma", includeInExport: true },
|
||||
{ model: "WorkflowCredential", column: "userId", strategy: "retain-tombstone", source: "workflows.prisma", includeInExport: true },
|
||||
{ model: "WorkflowExecution", column: "createdByUserId", strategy: "pseudonymize", source: "workflows.prisma", includeInExport: false },
|
||||
{ model: "WorkflowVariable", column: "userId", strategy: "retain-tombstone", source: "workflows.prisma", includeInExport: true },
|
||||
]);
|
||||
|
||||
export const USER_FK_MAP_BY_STRATEGY = Object.freeze({
|
||||
hardDelete: USER_FK_MAP.filter((e) => e.strategy === "hard-delete"),
|
||||
pseudonymize: USER_FK_MAP.filter((e) => e.strategy === "pseudonymize"),
|
||||
retainTombstone: USER_FK_MAP.filter((e) => e.strategy === "retain-tombstone"),
|
||||
});
|
||||
|
||||
export function getUserFkEntriesForExport(): readonly UserFkMapEntry[] {
|
||||
return USER_FK_MAP.filter((entry) => entry.includeInExport);
|
||||
}
|
||||
|
||||
export function findUserFkEntry(model: string, column: string): UserFkMapEntry | undefined {
|
||||
return USER_FK_MAP.find((entry) => entry.model === model && entry.column === column);
|
||||
}
|
||||
Reference in new issue
Block a user