@prisma-next/sql-runtime 0.3.0-dev.6 → 0.3.0-dev.63

package/src/plugins/lints.ts

@@ -0,0 +1,204 @@
+import type { ExecutionPlan, PlanMeta } from '@prisma-next/contract/types';
+import type { Plugin, PluginContext } from '@prisma-next/runtime-executor';
+import { evaluateRawGuardrails } from '@prisma-next/runtime-executor';
+import type {
+  DeleteAst,
+  QueryAst,
+  SelectAst,
+  UpdateAst,
+} from '@prisma-next/sql-relational-core/ast';
+import { ifDefined } from '@prisma-next/utils/defined';
+
+const QUERY_AST_KINDS = new Set(['select', 'insert', 'update', 'delete']);
+
+function isSqlQueryAst(ast: unknown): ast is QueryAst {
+  if (ast === null || typeof ast !== 'object' || !('kind' in ast)) return false;
+  const kind = (ast as { kind: string }).kind;
+  return typeof kind === 'string' && QUERY_AST_KINDS.has(kind);
+}
+
+export interface LintsOptions {
+  readonly severities?: {
+    readonly selectStar?: 'warn' | 'error';
+    readonly noLimit?: 'warn' | 'error';
+    readonly deleteWithoutWhere?: 'warn' | 'error';
+    readonly updateWithoutWhere?: 'warn' | 'error';
+    readonly readOnlyMutation?: 'warn' | 'error';
+    readonly unindexedPredicate?: 'warn' | 'error';
+  };
+  readonly fallbackWhenAstMissing?: 'raw' | 'skip';
+}
+
+export interface LintFinding {
+  readonly code: `LINT.${string}`;
+  readonly severity: 'error' | 'warn';
+  readonly message: string;
+  readonly details?: Record<string, unknown>;
+}
+
+function lintError(code: string, message: string, details?: Record<string, unknown>) {
+  const error = new Error(message) as Error & {
+    code: string;
+    category: 'LINT';
+    severity: 'error';
+    details?: Record<string, unknown>;
+  };
+  Object.defineProperty(error, 'name', {
+    value: 'RuntimeError',
+    configurable: true,
+  });
+  return Object.assign(error, {
+    code,
+    category: 'LINT' as const,
+    severity: 'error' as const,
+    details,
+  });
+}
+
+function evaluateAstLints(ast: QueryAst, meta: PlanMeta): LintFinding[] {
+  const findings: LintFinding[] = [];
+
+  if (ast.kind === 'delete') {
+    const deleteAst = ast as DeleteAst;
+    if (deleteAst.where === undefined) {
+      findings.push({
+        code: 'LINT.DELETE_WITHOUT_WHERE',
+        severity: 'error',
+        message:
+          'DELETE without WHERE clause blocks execution to prevent accidental full-table deletion',
+        details: { table: deleteAst.table.name },
+      });
+    }
+  }
+
+  if (ast.kind === 'update') {
+    const updateAst = ast as UpdateAst;
+    if (updateAst.where === undefined) {
+      findings.push({
+        code: 'LINT.UPDATE_WITHOUT_WHERE',
+        severity: 'error',
+        message:
+          'UPDATE without WHERE clause blocks execution to prevent accidental full-table update',
+        details: { table: updateAst.table.name },
+      });
+    }
+  }
+
+  if (ast.kind === 'select') {
+    const selectAst = ast as SelectAst;
+    if (selectAst.limit === undefined) {
+      findings.push({
+        code: 'LINT.NO_LIMIT',
+        severity: 'warn',
+        message: 'Unbounded SELECT may return large result sets',
+        details: { table: selectAst.from.name },
+      });
+    }
+    const hasSelectAllIntent =
+      selectAst.selectAllIntent !== undefined ||
+      (meta.annotations as { selectAllIntent?: unknown })?.selectAllIntent !== undefined;
+    if (hasSelectAllIntent) {
+      const table =
+        selectAst.selectAllIntent?.table ??
+        (meta.annotations as { selectAllIntent?: { table?: string } })?.selectAllIntent?.table;
+      findings.push({
+        code: 'LINT.SELECT_STAR',
+        severity: 'warn',
+        message: 'Query selects all columns via selectAll intent',
+        ...ifDefined('details', table !== undefined ? { table } : undefined),
+      });
+    }
+  }
+
+  return findings;
+}
+
+function getConfiguredSeverity(code: string, options?: LintsOptions): 'warn' | 'error' | undefined {
+  const severities = options?.severities;
+  if (!severities) return undefined;
+
+  switch (code) {
+    case 'LINT.SELECT_STAR':
+      return severities.selectStar;
+    case 'LINT.NO_LIMIT':
+      return severities.noLimit;
+    case 'LINT.DELETE_WITHOUT_WHERE':
+      return severities.deleteWithoutWhere;
+    case 'LINT.UPDATE_WITHOUT_WHERE':
+      return severities.updateWithoutWhere;
+    case 'LINT.READ_ONLY_MUTATION':
+      return severities.readOnlyMutation;
+    case 'LINT.UNINDEXED_PREDICATE':
+      return severities.unindexedPredicate;
+    default:
+      return undefined;
+  }
+}
+
+/**
+ * AST-first lint plugin for SQL plans. When `plan.ast` is a SQL QueryAst, inspects
+ * the AST structurally. When `plan.ast` is missing, falls back to raw heuristic
+ * guardrails or skips linting depending on `fallbackWhenAstMissing`.
+ *
+ * Rules (AST-based):
+ * - DELETE without WHERE: blocks execution (configurable severity, default error)
+ * - UPDATE without WHERE: blocks execution (configurable severity, default error)
+ * - Unbounded SELECT: warn/error (severity from noLimit)
+ * - SELECT * intent: warn/error (severity from selectStar)
+ *
+ * Fallback: When ast is missing, `fallbackWhenAstMissing: 'raw'` uses heuristic
+ * SQL parsing; `'skip'` skips all lints. Default is `'raw'`.
+ */
+export function lints<TContract = unknown, TAdapter = unknown, TDriver = unknown>(
+  options?: LintsOptions,
+): Plugin<TContract, TAdapter, TDriver> {
+  const fallback = options?.fallbackWhenAstMissing ?? 'raw';
+
+  return Object.freeze({
+    name: 'lints',
+
+    async beforeExecute(plan: ExecutionPlan, ctx: PluginContext<TContract, TAdapter, TDriver>) {
+      if (isSqlQueryAst(plan.ast)) {
+        const findings = evaluateAstLints(plan.ast, plan.meta);
+
+        for (const lint of findings) {
+          const configuredSeverity = getConfiguredSeverity(lint.code, options);
+          const effectiveSeverity = configuredSeverity ?? lint.severity;
+
+          if (effectiveSeverity === 'error') {
+            throw lintError(lint.code, lint.message, lint.details);
+          }
+          if (effectiveSeverity === 'warn') {
+            ctx.log.warn({
+              code: lint.code,
+              message: lint.message,
+              details: lint.details,
+            });
+          }
+        }
+        return;
+      }
+
+      if (fallback === 'skip') {
+        return;
+      }
+
+      const evaluation = evaluateRawGuardrails(plan);
+      for (const lint of evaluation.lints) {
+        const configuredSeverity = getConfiguredSeverity(lint.code, options);
+        const effectiveSeverity = configuredSeverity ?? lint.severity;
+
+        if (effectiveSeverity === 'error') {
+          throw lintError(lint.code, lint.message, lint.details);
+        }
+        if (effectiveSeverity === 'warn') {
+          ctx.log.warn({
+            code: lint.code,
+            message: lint.message,
+            details: lint.details,
+          });
+        }
+      }
+    },
+  });
+}