|
| 1 | +<?php |
| 2 | + |
| 3 | +declare(strict_types = 1); |
| 4 | + |
| 5 | +namespace ScriptDevelopment\PhpstanWarroomRules\Rules; |
| 6 | + |
| 7 | +use Illuminate\Database\Eloquent\Builder as EloquentBuilder; |
| 8 | +use Illuminate\Database\Query\Builder as QueryBuilder; |
| 9 | +use PhpParser\Node; |
| 10 | +use PhpParser\Node\Expr; |
| 11 | +use PhpParser\Node\Expr\MethodCall; |
| 12 | +use PhpParser\Node\Expr\StaticCall; |
| 13 | +use PhpParser\Node\Identifier; |
| 14 | +use PhpParser\Node\Scalar\String_; |
| 15 | +use PHPStan\Analyser\Scope; |
| 16 | +use PHPStan\Rules\Rule; |
| 17 | +use PHPStan\Rules\RuleErrorBuilder; |
| 18 | +use PHPStan\Type\ObjectType; |
| 19 | + |
| 20 | +use function in_array; |
| 21 | +use function mb_stripos; |
| 22 | + |
| 23 | +/** |
| 24 | + * Forbids `Builder->truncate()` calls where the fluent chain's most recent |
| 25 | + * `table()` invocation targets a Log-named table (string-literal first |
| 26 | + * argument containing `"log"` / `"logs"`, case-insensitive substring match). |
| 27 | + * |
| 28 | + * Doctrine source: ADR-0001 §Append-only — audit records have no UPDATE, no |
| 29 | + * DELETE; `truncate()` is the bluntest delete and bypasses Eloquent events, |
| 30 | + * observers, and audit triggers entirely. |
| 31 | + * |
| 32 | + * Sibling rule to `LogRule`. Shares the `logRule.logModification` identifier |
| 33 | + * so consumer `phpstan.neon` `ignoreErrors` entries cover the whole |
| 34 | + * append-only doctrine with one entry. Closes the structural gap deliberately |
| 35 | + * deferred from PR #7 (issue #8): `LogRule` matches on Log-named class |
| 36 | + * receivers, but `DB::table('logs')->truncate()` carries no Log-named class |
| 37 | + * reference — the receiver is `Illuminate\Database\Query\Builder` (or |
| 38 | + * `Illuminate\Database\Eloquent\Builder` for `Model::query()->truncate()`), |
| 39 | + * and the "Log-ness" lives in a string-literal argument to a prior `table()` |
| 40 | + * call in the same fluent chain. |
| 41 | + * |
| 42 | + * Detection (all three must hold to fire): |
| 43 | + * 1. The `MethodCall` name is `truncate`. |
| 44 | + * 2. The receiver type is a (subtype of) `Illuminate\Database\Query\Builder` |
| 45 | + * or `Illuminate\Database\Eloquent\Builder` — type-based via |
| 46 | + * `ObjectType::isSuperTypeOf()`, not property-name string matching. |
| 47 | + * 3. Walking back through the chain, the most recent `table()` or `from()` |
| 48 | + * call (whether `MethodCall` like `$db->table('x')` or `StaticCall` like |
| 49 | + * `DB::table('x')`) has a `Scalar\String_` first argument whose value |
| 50 | + * matches `'log'` / `'logs'` case-insensitively. Both `table()` and |
| 51 | + * `from()` are recognised because Eloquent\Builder chains naturally |
| 52 | + * hop through `from()` while Query\Builder chains hop through |
| 53 | + * `table()` — same intent, different fluent vocabulary. |
| 54 | + * |
| 55 | + * Variable table names (`$t = 'logs'; DB::table($t)->truncate()`) are out of |
| 56 | + * scope — would require value-flow analysis. Acceptable miss; rely on |
| 57 | + * reviewer + consumer-side `phpstan.neon` `ignoreErrors`. |
| 58 | + * |
| 59 | + * Substring matching is intentionally broad. False positives on tables named |
| 60 | + * `catalog`, `blog`, `terminology`, or domain tables that include `log` in |
| 61 | + * the name should be suppressed per-territory via `phpstan.neon` |
| 62 | + * `ignoreErrors`, scoped to the offending path. Same convention as `LogRule`. |
| 63 | + * |
| 64 | + * @implements Rule<MethodCall> |
| 65 | + */ |
| 66 | +final class LogBuilderTruncateRule implements Rule |
| 67 | +{ |
| 68 | + private const string QUERY_BUILDER_FQCN = QueryBuilder::class; |
| 69 | + |
| 70 | + private const string ELOQUENT_BUILDER_FQCN = EloquentBuilder::class; |
| 71 | + |
| 72 | + private const array LOG_NEEDLES = ['log', 'logs']; |
| 73 | + |
| 74 | + private const array TABLE_SETTING_METHODS = ['table', 'from']; |
| 75 | + |
| 76 | + public function getNodeType(): string |
| 77 | + { |
| 78 | + return MethodCall::class; |
| 79 | + } |
| 80 | + |
| 81 | + public function processNode(Node $node, Scope $scope): array |
| 82 | + { |
| 83 | + if (!$node->name instanceof Identifier || $node->name->toString() !== 'truncate') { |
| 84 | + return []; |
| 85 | + } |
| 86 | + |
| 87 | + if (!$this->receiverIsBuilder($node, $scope)) { |
| 88 | + return []; |
| 89 | + } |
| 90 | + |
| 91 | + if (!$this->chainTargetsLogNamedTable($node->var)) { |
| 92 | + return []; |
| 93 | + } |
| 94 | + |
| 95 | + return [ |
| 96 | + RuleErrorBuilder::message('Logs should not be updated or deleted.') |
| 97 | + ->identifier('logRule.logModification') |
| 98 | + ->build(), |
| 99 | + ]; |
| 100 | + } |
| 101 | + |
| 102 | + /** |
| 103 | + * Type-based receiver gate: `$scope->getType($node->var)` must be a |
| 104 | + * (subtype of) `Illuminate\Database\Query\Builder` or |
| 105 | + * `Illuminate\Database\Eloquent\Builder`. Mirrors the canonical pattern |
| 106 | + * in `EnforceAuditSnapshotOnRetryRule::receiverIsConnectionInterface()`. |
| 107 | + */ |
| 108 | + private function receiverIsBuilder(MethodCall $node, Scope $scope): bool |
| 109 | + { |
| 110 | + $receiverType = $scope->getType($node->var); |
| 111 | + $queryBuilderType = new ObjectType(self::QUERY_BUILDER_FQCN); |
| 112 | + |
| 113 | + if ($queryBuilderType->isSuperTypeOf($receiverType)->yes()) { |
| 114 | + return true; |
| 115 | + } |
| 116 | + |
| 117 | + $eloquentBuilderType = new ObjectType(self::ELOQUENT_BUILDER_FQCN); |
| 118 | + |
| 119 | + return $eloquentBuilderType->isSuperTypeOf($receiverType)->yes(); |
| 120 | + } |
| 121 | + |
| 122 | + /** |
| 123 | + * Walk back through the fluent chain looking for the most recent |
| 124 | + * `table()` or `from()` call (`MethodCall` or `StaticCall`). Inspect its |
| 125 | + * first argument: fire on a Log-named `Scalar\String_`; otherwise |
| 126 | + * (variable, concat, function call) do not fire. If no table-setting |
| 127 | + * call is found in the chain, do not fire. |
| 128 | + */ |
| 129 | + private function chainTargetsLogNamedTable(Expr $receiver): bool |
| 130 | + { |
| 131 | + $current = $receiver; |
| 132 | + |
| 133 | + while ($current instanceof MethodCall || $current instanceof StaticCall) { |
| 134 | + if ( |
| 135 | + $current->name instanceof Identifier |
| 136 | + && in_array($current->name->toString(), self::TABLE_SETTING_METHODS, true) |
| 137 | + ) { |
| 138 | + return $this->firstArgIsLogNamedString($current); |
| 139 | + } |
| 140 | + |
| 141 | + if ($current instanceof MethodCall) { |
| 142 | + $current = $current->var; |
| 143 | + |
| 144 | + continue; |
| 145 | + } |
| 146 | + |
| 147 | + // StaticCall is a root — its arguments are inspected above; if |
| 148 | + // its name is not `table` the chain has no earlier hops to walk. |
| 149 | + return false; |
| 150 | + } |
| 151 | + |
| 152 | + return false; |
| 153 | + } |
| 154 | + |
| 155 | + private function firstArgIsLogNamedString(MethodCall|StaticCall $call): bool |
| 156 | + { |
| 157 | + if (!isset($call->args[0]) || !$call->args[0] instanceof Node\Arg) { |
| 158 | + return false; |
| 159 | + } |
| 160 | + |
| 161 | + $value = $call->args[0]->value; |
| 162 | + |
| 163 | + if (!$value instanceof String_) { |
| 164 | + return false; |
| 165 | + } |
| 166 | + |
| 167 | + foreach (self::LOG_NEEDLES as $needle) { |
| 168 | + if (mb_stripos($value->value, $needle) !== false) { |
| 169 | + return true; |
| 170 | + } |
| 171 | + } |
| 172 | + |
| 173 | + return false; |
| 174 | + } |
| 175 | +} |
0 commit comments