@starci/eslint-canon-be 3.8.20 → 3.9.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/package.json +1 -1
- package/runtime/bundle.json +192 -0
- package/runtime/engine/by-code-unit.mjs +6 -6
- package/runtime/engine/model-config.mjs +98 -76
- package/runtime/engine/orca-config.mjs +22 -17
- package/runtime/engine/release-config.mjs +22 -18
- package/runtime/engine/removed-vocabulary.mjs +21 -20
- package/runtime/engine/resources-config.mjs +42 -35
- package/runtime/engine/runtime-root.mjs +11 -13
- package/runtime/engine/secrets.mjs +170 -102
- package/runtime/engine/sonar-config.mjs +16 -13
- package/runtime/engine/temp-root.mjs +3 -9
- package/runtime/knowledge/hfs/canon-pins.yaml +10 -10
- package/runtime/knowledge/hfs/rules.yaml +6 -6
- package/runtime/knowledge/hfs/slots.yaml +2 -2
- package/runtime/knowledge/sonar-gate.yaml +1 -1
- package/runtime/packages/hfs/templates/app/package-scripts/package.json +1 -1
- package/runtime/scripts/api/git/cat-file.mjs +0 -1
- package/runtime/scripts/api/git/config-get.mjs +1 -2
- package/runtime/scripts/api/git/diff.mjs +0 -1
- package/runtime/scripts/api/git/lib.mjs +32 -32
- package/runtime/scripts/api/git/ls-files.mjs +0 -1
- package/runtime/scripts/api/git/ls-tree.mjs +0 -1
- package/runtime/scripts/api/git/merge-base.mjs +2 -3
- package/runtime/scripts/api/git/remote.mjs +0 -1
- package/runtime/scripts/api/git/rev-parse-query.mjs +0 -1
- package/runtime/scripts/api/git/show.mjs +0 -1
- package/runtime/scripts/hfs/allows.mjs +37 -38
- package/runtime/scripts/hfs/architecture/ast-walks.mjs +180 -163
- package/runtime/scripts/hfs/architecture/automatic-gates.mjs +80 -73
- package/runtime/scripts/hfs/architecture/backend-app-files.mjs +88 -77
- package/runtime/scripts/hfs/architecture/backend.mjs +378 -357
- package/runtime/scripts/hfs/architecture/background-unowned.mjs +201 -187
- package/runtime/scripts/hfs/architecture/canon-clones.mjs +260 -209
- package/runtime/scripts/hfs/architecture/canon-jsx-clones.mjs +149 -116
- package/runtime/scripts/hfs/architecture/client-reaches-server.mjs +72 -68
- package/runtime/scripts/hfs/architecture/clones.mjs +212 -217
- package/runtime/scripts/hfs/architecture/config-unread.mjs +7 -9
- package/runtime/scripts/hfs/architecture/config.mjs +302 -268
- package/runtime/scripts/hfs/architecture/connection-map.mjs +258 -225
- package/runtime/scripts/hfs/architecture/constructor-deps.mjs +80 -71
- package/runtime/scripts/hfs/architecture/context-coupling.mjs +82 -77
- package/runtime/scripts/hfs/architecture/context-map.mjs +267 -234
- package/runtime/scripts/hfs/architecture/context-owner.mjs +73 -61
- package/runtime/scripts/hfs/architecture/context-platform-tables.mjs +47 -43
- package/runtime/scripts/hfs/architecture/context-transaction.mjs +54 -52
- package/runtime/scripts/hfs/architecture/contract-fixture-guard.mjs +113 -104
- package/runtime/scripts/hfs/architecture/contracts-readonly.mjs +288 -270
- package/runtime/scripts/hfs/architecture/contracts.mjs +408 -393
- package/runtime/scripts/hfs/architecture/cross-app-duplicate.mjs +50 -51
- package/runtime/scripts/hfs/architecture/dead-exports-bindings.mjs +143 -119
- package/runtime/scripts/hfs/architecture/dead-exports.mjs +286 -228
- package/runtime/scripts/hfs/architecture/default-deny.mjs +129 -110
- package/runtime/scripts/hfs/architecture/doc-language.mjs +24 -19
- package/runtime/scripts/hfs/architecture/entity-registry.mjs +20 -22
- package/runtime/scripts/hfs/architecture/entrypoint.mjs +47 -45
- package/runtime/scripts/hfs/architecture/error-codes.mjs +37 -35
- package/runtime/scripts/hfs/architecture/error-masked.mjs +55 -59
- package/runtime/scripts/hfs/architecture/fe-slot-allows.mjs +24 -23
- package/runtime/scripts/hfs/architecture/feature-shape.mjs +40 -38
- package/runtime/scripts/hfs/architecture/framework-pinned.mjs +21 -21
- package/runtime/scripts/hfs/architecture/frontend-block-render.mjs +106 -98
- package/runtime/scripts/hfs/architecture/frontend-grammar.mjs +153 -150
- package/runtime/scripts/hfs/architecture/frontend-routing.mjs +161 -149
- package/runtime/scripts/hfs/architecture/frontend-world-render.mjs +343 -305
- package/runtime/scripts/hfs/architecture/frontend-world.mjs +340 -294
- package/runtime/scripts/hfs/architecture/frontend.mjs +174 -184
- package/runtime/scripts/hfs/architecture/function-spec-providers.mjs +124 -106
- package/runtime/scripts/hfs/architecture/hfs-graph.mjs +52 -48
- package/runtime/scripts/hfs/architecture/hooks-are-hooks.mjs +81 -71
- package/runtime/scripts/hfs/architecture/i18n-keys.mjs +155 -141
- package/runtime/scripts/hfs/architecture/identity.mjs +141 -125
- package/runtime/scripts/hfs/architecture/index.mjs +272 -272
- package/runtime/scripts/hfs/architecture/injection-token-exported.mjs +45 -43
- package/runtime/scripts/hfs/architecture/jwt-ast.mjs +195 -176
- package/runtime/scripts/hfs/architecture/machine-ast.mjs +163 -155
- package/runtime/scripts/hfs/architecture/managed-scripts.mjs +19 -20
- package/runtime/scripts/hfs/architecture/module-per-transport.mjs +177 -172
- package/runtime/scripts/hfs/architecture/next-data-contract.mjs +100 -78
- package/runtime/scripts/hfs/architecture/next-data-inference.mjs +170 -154
- package/runtime/scripts/hfs/architecture/next-data-key.mjs +311 -275
- package/runtime/scripts/hfs/architecture/next-data-symbols.mjs +17 -17
- package/runtime/scripts/hfs/architecture/next-data.mjs +351 -334
- package/runtime/scripts/hfs/architecture/operation-contract-roots.mjs +39 -37
- package/runtime/scripts/hfs/architecture/owners.mjs +97 -98
- package/runtime/scripts/hfs/architecture/package-shape.mjs +56 -55
- package/runtime/scripts/hfs/architecture/presentation.mjs +138 -130
- package/runtime/scripts/hfs/architecture/reachability.mjs +258 -241
- package/runtime/scripts/hfs/architecture/register-once.mjs +152 -139
- package/runtime/scripts/hfs/architecture/registration.mjs +301 -267
- package/runtime/scripts/hfs/architecture/required-files.mjs +172 -167
- package/runtime/scripts/hfs/architecture/route-files-thin.mjs +85 -77
- package/runtime/scripts/hfs/architecture/schema-owner.mjs +206 -181
- package/runtime/scripts/hfs/architecture/server-action.mjs +48 -48
- package/runtime/scripts/hfs/architecture/side-boundary.mjs +2 -5
- package/runtime/scripts/hfs/architecture/source-names-shape.mjs +261 -259
- package/runtime/scripts/hfs/architecture/source-names.mjs +304 -278
- package/runtime/scripts/hfs/architecture/sql-keys.mjs +277 -194
- package/runtime/scripts/hfs/architecture/sql-owner.mjs +236 -194
- package/runtime/scripts/hfs/architecture/sql-returning.mjs +46 -45
- package/runtime/scripts/hfs/architecture/sql-token-forms.mjs +86 -74
- package/runtime/scripts/hfs/architecture/sql-tokens.mjs +456 -341
- package/runtime/scripts/hfs/architecture/staged-consumers.mjs +35 -30
- package/runtime/scripts/hfs/architecture/surface.mjs +64 -74
- package/runtime/scripts/hfs/architecture/symbols.mjs +209 -216
- package/runtime/scripts/hfs/architecture/test-world-files.mjs +165 -155
- package/runtime/scripts/hfs/architecture/tiers.mjs +161 -154
- package/runtime/scripts/hfs/architecture/transport-owner.mjs +155 -149
- package/runtime/scripts/hfs/architecture/type-context.mjs +255 -250
- package/runtime/scripts/hfs/architecture/typescript.mjs +358 -318
- package/runtime/scripts/hfs/architecture/unit-spec-providers.mjs +110 -92
- package/runtime/scripts/hfs/declaration-shape.mjs +140 -103
- package/runtime/scripts/hfs/declaration-slots.mjs +64 -61
- package/runtime/scripts/hfs/edition-slots.mjs +43 -40
- package/runtime/scripts/hfs/linear-text.mjs +20 -20
- package/runtime/scripts/hfs/param-names.mjs +6 -11
- package/runtime/scripts/hfs/path-findings.mjs +120 -100
- package/runtime/scripts/hfs/repo-identity.mjs +55 -42
- package/runtime/scripts/hfs/rule-catalog.mjs +353 -257
- package/runtime/scripts/hfs/rule-params-shape.mjs +60 -47
- package/runtime/scripts/hfs/rules/database-migrations.mjs +428 -388
- package/runtime/scripts/hfs/rules/fe-no-tests.mjs +37 -36
- package/runtime/scripts/hfs/rules/read.mjs +19 -15
- package/runtime/scripts/hfs/rules/secrets.mjs +1 -1
- package/runtime/scripts/hfs/rules/spec-placement.mjs +12 -13
- package/runtime/scripts/hfs/slot-app-view.mjs +69 -74
- package/runtime/scripts/hfs/slot-classify.mjs +42 -38
- package/runtime/scripts/hfs/slot-errors.mjs +8 -7
- package/runtime/scripts/hfs/slot-imports.mjs +70 -63
- package/runtime/scripts/hfs/slot-manifest-shape.mjs +74 -52
- package/runtime/scripts/hfs/slot-match.mjs +122 -111
- package/runtime/scripts/hfs/slot-path.mjs +0 -2
- package/runtime/scripts/hfs/slot-required.mjs +65 -59
- package/runtime/scripts/hfs/slot-semantic-problems.mjs +138 -112
- package/runtime/scripts/hfs/slot-side-problems.mjs +23 -19
- package/runtime/scripts/hfs/slots.mjs +175 -152
- package/runtime/scripts/hfs/test-world-slot.mjs +0 -1
- package/runtime/scripts/hfs/trailing-slashes.mjs +4 -4
- package/runtime/scripts/hfs/typescript-programs.mjs +66 -69
- package/runtime/scripts/hfs/view.mjs +38 -40
- package/runtime/scripts/lib/dockerfile.mjs +131 -114
- package/runtime/scripts/lib/env.mjs +3 -6
- package/runtime/scripts/lib/event-contract.mjs +73 -78
- package/runtime/scripts/lib/git.mjs +15 -16
- package/runtime/scripts/lib/glob.mjs +23 -14
- package/runtime/scripts/lib/grammar-lint.mjs +33 -37
- package/runtime/scripts/lib/i18n.mjs +32 -35
- package/runtime/scripts/lib/in-order.mjs +57 -38
- package/runtime/scripts/lib/json-clone.mjs +45 -36
- package/runtime/scripts/lib/json.mjs +26 -14
- package/runtime/scripts/lib/language.mjs +133 -129
- package/runtime/scripts/lib/list.mjs +9 -14
- package/runtime/scripts/lib/mutation-fence.mjs +10 -5
- package/runtime/scripts/lib/path-key.mjs +53 -38
- package/runtime/scripts/lib/read-text.mjs +30 -17
- package/runtime/scripts/lib/regex.mjs +1 -2
- package/runtime/scripts/lib/same-text.mjs +0 -1
- package/runtime/scripts/lib/sops-envelope.mjs +148 -120
- package/runtime/scripts/lib/stack-services.mjs +128 -129
- package/runtime/scripts/lib/ts-analysis.mjs +28 -26
- package/runtime/scripts/lib/ts-ast.mjs +36 -42
- package/runtime/scripts/lib/walk.mjs +33 -27
- package/runtime/scripts/lib/yaml-cached.mjs +4 -4
|
@@ -5,7 +5,6 @@ import { DEFAULT_ENVIRONMENT, STACKS_DIRECTORY, STATEFUL_KINDS, namesOfService,
|
|
|
5
5
|
import { unwrapEach } from './ast-walks.mjs';
|
|
6
6
|
import { hasAnyFlag, nameText, sourceLocation } from '../../lib/ts-ast.mjs';
|
|
7
7
|
import { byCodeUnit } from '../../lib/list.mjs';
|
|
8
|
-
|
|
9
8
|
/**
|
|
10
9
|
* R47 `test-world-files` (BE_TEST_TOPOLOGY). Judgements over the test world, read through slots, the repository's own
|
|
11
10
|
* stack definition (`.starcistacks/<env>`, scripts/lib/stack-services.mjs) and the world's declaration
|
|
@@ -33,7 +32,6 @@ import { byCodeUnit } from '../../lib/list.mjs';
|
|
|
33
32
|
* nothing else of it.
|
|
34
33
|
*/
|
|
35
34
|
export const TEST_WORLD_FILES_RULE_IDS = ['BE_TEST_TOPOLOGY'];
|
|
36
|
-
|
|
37
35
|
const RULE = 'BE_TEST_TOPOLOGY';
|
|
38
36
|
const WORLD_SLOT = 'be.tests.world';
|
|
39
37
|
const FAKES_DIRECTORY = 'fakes/';
|
|
@@ -42,193 +40,205 @@ const DEFINE = 'defineTestWorld';
|
|
|
42
40
|
const NAMED_FORM = `export const { useTestWorld, useSandbox } = ${DEFINE}({ ... })`;
|
|
43
41
|
const defaultEnvironment = DEFAULT_ENVIRONMENT;
|
|
44
42
|
const KEBAB = /^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/;
|
|
45
|
-
|
|
46
43
|
const unwrap = (ts, node) => unwrapEach(ts, node, [ts.isParenthesizedExpression, ts.isAsExpression, ts.isSatisfiesExpression]);
|
|
47
|
-
const propertyOf = (ts, literal, key) => literal.properties.find(property => ts.isPropertyAssignment(property) && nameText(ts, property.name) === key)?.initializer ?? null;
|
|
44
|
+
const propertyOf = (ts, literal, key) => literal.properties.find((property) => ts.isPropertyAssignment(property) && nameText(ts, property.name) === key)?.initializer ?? null;
|
|
48
45
|
const isExported = (ts, statement) => (statement.modifiers ?? []).some(modifier => modifier.kind === ts.SyntaxKind.ExportKeyword);
|
|
49
|
-
|
|
50
46
|
/** The object literal of `defineTestWorld(<object literal>)`, or null. */
|
|
51
47
|
function defineLiteral(ts, expression) {
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
48
|
+
const call = unwrap(ts, expression);
|
|
49
|
+
if (!call || !ts.isCallExpression(call) || !ts.isIdentifier(call.expression) || call.expression.text !== DEFINE)
|
|
50
|
+
return null;
|
|
51
|
+
const [first] = call.arguments;
|
|
52
|
+
const literal = first ? unwrap(ts, first) : null;
|
|
53
|
+
return literal && ts.isObjectLiteralExpression(literal) ? literal : null;
|
|
57
54
|
}
|
|
58
|
-
|
|
59
55
|
/** The declaration of the world: the object literal of an exported `const` initialized by `defineTestWorld({ ... })`, or null. */
|
|
60
56
|
function configLiteral(ts, sourceFile) {
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
57
|
+
for (const statement of sourceFile.statements) {
|
|
58
|
+
if (!ts.isVariableStatement(statement) || !isExported(ts, statement))
|
|
59
|
+
continue;
|
|
60
|
+
if (!hasAnyFlag(statement.declarationList.flags, ts.NodeFlags.Const))
|
|
61
|
+
continue;
|
|
62
|
+
for (const declaration of statement.declarationList.declarations) {
|
|
63
|
+
const literal = declaration.initializer ? defineLiteral(ts, declaration.initializer) : null;
|
|
64
|
+
if (literal)
|
|
65
|
+
return literal;
|
|
66
|
+
}
|
|
67
67
|
}
|
|
68
|
-
|
|
69
|
-
return null;
|
|
68
|
+
return null;
|
|
70
69
|
}
|
|
71
|
-
|
|
72
70
|
/** `stack` as the environment it names: the last segment of `".starcistacks/<env>"`; null when absent or not a literal. */
|
|
73
71
|
function environmentOf(ts, literal) {
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
72
|
+
const node = literal ? propertyOf(ts, literal, 'stack') : null;
|
|
73
|
+
const value = node ? unwrap(ts, node) : null;
|
|
74
|
+
if (!value || !ts.isStringLiteralLike(value))
|
|
75
|
+
return null;
|
|
76
|
+
return value.text.split(/[\\/]+/u).filter(Boolean).findLast(Boolean) ?? null;
|
|
78
77
|
}
|
|
79
|
-
|
|
80
78
|
/** The keys of the declaration's `fakes` object literal, with their positions. */
|
|
81
79
|
function fakeEntriesOf(ts, sourceFile, literal) {
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
80
|
+
const node = literal ? propertyOf(ts, literal, 'fakes') : null;
|
|
81
|
+
const value = node ? unwrap(ts, node) : null;
|
|
82
|
+
if (!value || !ts.isObjectLiteralExpression(value))
|
|
83
|
+
return [];
|
|
84
|
+
return value.properties
|
|
85
|
+
.map(property => ({ name: nameText(ts, property.name), ...sourceLocation(sourceFile, property) }))
|
|
86
|
+
.filter((entry) => Boolean(entry.name));
|
|
87
|
+
}
|
|
90
88
|
/** The `fakedBy` entry of one `stacks` property, or null when the property does not declare one. */
|
|
91
89
|
function fakedByEntry(ts, sourceFile, property) {
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
90
|
+
if (!ts.isPropertyAssignment(property))
|
|
91
|
+
return null;
|
|
92
|
+
const body = unwrap(ts, property.initializer);
|
|
93
|
+
if (!body || !ts.isObjectLiteralExpression(body))
|
|
94
|
+
return null;
|
|
95
|
+
const fake = propertyOf(ts, body, 'fakedBy');
|
|
96
|
+
if (!fake)
|
|
97
|
+
return null;
|
|
98
|
+
const reason = propertyOf(ts, body, 'reason');
|
|
99
|
+
return {
|
|
100
|
+
service: nameText(ts, property.name),
|
|
101
|
+
fake: ts.isStringLiteralLike(fake) ? fake.text : '',
|
|
102
|
+
reason: reason && ts.isStringLiteralLike(reason) ? reason.text.trim() : '',
|
|
103
|
+
...sourceLocation(sourceFile, property),
|
|
104
|
+
};
|
|
105
|
+
}
|
|
106
106
|
/** The `stacks` entries that declare `fakedBy`: [{service, fake, reason, line, column}]; a value the reader cannot read statically has an empty fake and reason. */
|
|
107
107
|
function fakedByOf(ts, sourceFile, literal) {
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
108
|
+
const node = literal ? propertyOf(ts, literal, 'stacks') : null;
|
|
109
|
+
const value = node ? unwrap(ts, node) : null;
|
|
110
|
+
if (!value || !ts.isObjectLiteralExpression(value))
|
|
111
|
+
return [];
|
|
112
|
+
return value.properties.map(property => fakedByEntry(ts, sourceFile, property)).filter((entry) => entry !== null);
|
|
112
113
|
}
|
|
113
|
-
|
|
114
114
|
function registerFakeProvider(fakeProviders, relative, file) {
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
115
|
+
if (!relative.startsWith(FAKES_DIRECTORY))
|
|
116
|
+
return;
|
|
117
|
+
const [provider, ...rest] = relative.slice(FAKES_DIRECTORY.length).split('/');
|
|
118
|
+
if (provider !== undefined && rest.length > 0 && !fakeProviders.has(provider))
|
|
119
|
+
fakeProviders.set(provider, file);
|
|
118
120
|
}
|
|
119
|
-
|
|
120
121
|
function isRoleFileAtRoot(relative, suffixes) {
|
|
121
|
-
|
|
122
|
-
|
|
122
|
+
const parts = relative.slice(0, -'.ts'.length).split('.');
|
|
123
|
+
return !relative.includes('/') && parts.length >= 2 && parts.every(part => KEBAB.test(part)) && suffixes.includes(parts.at(-1) ?? '');
|
|
123
124
|
}
|
|
124
|
-
|
|
125
125
|
function collectWorldFiles(resolver, tree, suffixes, violations) {
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
}
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
}
|
|
158
|
-
|
|
126
|
+
const fakeProviders = new Map();
|
|
127
|
+
let worldRoot = null;
|
|
128
|
+
let files = 0;
|
|
129
|
+
for (const file of [...tree.files].sort(byCodeUnit)) {
|
|
130
|
+
if (!file.endsWith('.ts'))
|
|
131
|
+
continue;
|
|
132
|
+
const verdict = allowsFile(resolver, file);
|
|
133
|
+
if (verdict?.slot !== WORLD_SLOT)
|
|
134
|
+
continue;
|
|
135
|
+
files += 1;
|
|
136
|
+
worldRoot ??= file.slice(0, file.length - verdict.relative.length);
|
|
137
|
+
registerFakeProvider(fakeProviders, verdict.relative, file);
|
|
138
|
+
if (verdict.allowed || isRoleFileAtRoot(verdict.relative, suffixes))
|
|
139
|
+
continue;
|
|
140
|
+
violations.push({
|
|
141
|
+
ruleId: RULE, path: file, line: 1, column: 1,
|
|
142
|
+
message: `${file} is not allowed in the test world; src/tests/world/ holds only ${verdict.allows.join(', ')} and role-suffixed files (<name>.<role>.ts) at its root. Move it to fakes/ or kit/ (be.tests.world.kit), give it a role suffix, or delete it.`,
|
|
143
|
+
slot: verdict.slot,
|
|
144
|
+
});
|
|
145
|
+
}
|
|
146
|
+
return { fakeProviders, worldRoot, files };
|
|
147
|
+
}
|
|
148
|
+
function worldDeclaration(graph, ts, worldRoot, violations) {
|
|
149
|
+
const configPath = worldRoot === null ? null : `${worldRoot}${CONFIG_FILE}`;
|
|
150
|
+
const configFile = configPath === null ? null : graph.files.get(configPath) ?? null;
|
|
151
|
+
const literal = configFile ? configLiteral(ts, configFile.sourceFile) : null;
|
|
152
|
+
if (configFile && !literal) {
|
|
153
|
+
violations.push({
|
|
154
|
+
ruleId: RULE, path: configPath, line: 1, column: 1, slot: WORLD_SLOT,
|
|
155
|
+
message: `${configPath} declares no world the machine can read. Declare it in the one named form \`${NAMED_FORM}\` (an exported const of a ${DEFINE} call with an object literal, imported from @starci/test-world); a default export is refused by R89 and is not read.`,
|
|
156
|
+
});
|
|
157
|
+
}
|
|
158
|
+
return { configPath, configFile, literal };
|
|
159
|
+
}
|
|
159
160
|
function stackServices(config, environments) {
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
161
|
+
const services = [];
|
|
162
|
+
for (const environment of environments) {
|
|
163
|
+
let stack = null;
|
|
164
|
+
// The stack is the app root's .starcistacks: the side folder the machine judges reads its app's (locateDeclaration).
|
|
165
|
+
try {
|
|
166
|
+
stack = readStack({ root: locateDeclaration(config.root).appRoot, environment });
|
|
167
|
+
}
|
|
168
|
+
catch {
|
|
169
|
+
stack = null;
|
|
170
|
+
}
|
|
171
|
+
for (const service of stack?.services ?? [])
|
|
172
|
+
if (service.role !== 'service' && !services.some(known => known.name === service.name))
|
|
173
|
+
services.push({ ...service, environment });
|
|
174
|
+
}
|
|
175
|
+
return services;
|
|
176
|
+
}
|
|
170
177
|
function statefulWhy(service) {
|
|
171
|
-
|
|
172
|
-
|
|
178
|
+
if (STATEFUL_KINDS.has(service.kind))
|
|
179
|
+
return `a ${service.kind} holds data the app reads back`;
|
|
180
|
+
return service.persistent ? 'the stack gives it a persistent volume' : null;
|
|
173
181
|
}
|
|
174
|
-
|
|
175
182
|
function reportDeclaredFakeProblems(declared, services, fakeProviders, fakeEntries, configPath, stackHint, violations) {
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
183
|
+
for (const entry of declared) {
|
|
184
|
+
const service = services.find(candidate => candidate.name === entry.service);
|
|
185
|
+
const problems = [];
|
|
186
|
+
if (!service)
|
|
187
|
+
problems.push(`${stackHint} declares no service ${entry.service}`);
|
|
188
|
+
else if (statefulWhy(service))
|
|
189
|
+
problems.push(`${service.name} is stateful (${statefulWhy(service)}) and always runs real`);
|
|
190
|
+
if (!fakeProviders.has(entry.fake) && !fakeEntries.some(fake => fake.name === entry.fake))
|
|
191
|
+
problems.push(`there is no fakes entry and no fakes/${entry.fake || '<fake>'}/ folder of that name`);
|
|
192
|
+
if (entry.reason === '')
|
|
193
|
+
problems.push('the reason is empty');
|
|
194
|
+
if (problems.length > 0) {
|
|
195
|
+
violations.push({
|
|
196
|
+
ruleId: RULE, path: configPath, line: entry.line, column: entry.column, slot: WORLD_SLOT,
|
|
197
|
+
message: `${configPath} declares ${entry.service} as faked by ${entry.fake || '(no fake)'}, but ${problems.join('; ')}. The exception covers only stateless compute that needs special hardware or an external model, with a reason; everything else in the stack runs real.`,
|
|
198
|
+
});
|
|
199
|
+
}
|
|
188
200
|
}
|
|
189
|
-
}
|
|
190
201
|
}
|
|
191
|
-
|
|
192
202
|
function worldFakes(fakeProviders, fakeEntries, configPath) {
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
203
|
+
return [
|
|
204
|
+
...[...fakeProviders].map(([provider, file]) => ({ name: provider, path: file, line: 1, column: 1, what: `fakes/${provider}/` })),
|
|
205
|
+
...fakeEntries.filter(entry => !fakeProviders.has(entry.name)).map(entry => ({ name: entry.name, path: configPath, line: entry.line, column: entry.column, what: `the fakes entry ${entry.name}` })),
|
|
206
|
+
].sort((a, b) => a.name.localeCompare(b.name));
|
|
197
207
|
}
|
|
198
|
-
|
|
199
208
|
function reportServiceFakes(fakes, services, declared, configPath, stackHint, violations) {
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
+
for (const fake of fakes) {
|
|
210
|
+
const service = services.find(candidate => namesOfService(candidate).includes(fake.name));
|
|
211
|
+
if (!service)
|
|
212
|
+
continue;
|
|
213
|
+
if (declared.some(entry => entry.service === service.name && entry.fake === fake.name))
|
|
214
|
+
continue; // judged on its stacks entry above
|
|
215
|
+
const why = statefulWhy(service);
|
|
216
|
+
let reason = `${service.name} is stateful (${why}), so no exception applies. `;
|
|
217
|
+
if (!why) {
|
|
218
|
+
const worldConfig = configPath ?? `${CONFIG_FILE} in the world`;
|
|
219
|
+
reason = `Only stateless compute that needs special hardware or an external model may be faked, and only when ${worldConfig} declares it in its stacks entry ({ fakedBy, reason }). `;
|
|
220
|
+
}
|
|
221
|
+
violations.push({
|
|
222
|
+
ruleId: RULE, path: fake.path, line: fake.line, column: fake.column, slot: WORLD_SLOT,
|
|
223
|
+
message: `${fake.what} fakes ${service.name} (${service.image}), which ${stackHint} declares: a service of the repository's own stack runs real in the test world. ${reason}Delete the fake and let the world run the real service; fakes are otherwise only for external SaaS the team does not operate.`,
|
|
224
|
+
});
|
|
209
225
|
}
|
|
210
|
-
violations.push({
|
|
211
|
-
ruleId: RULE, path: fake.path, line: fake.line, column: fake.column, slot: WORLD_SLOT,
|
|
212
|
-
message: `${fake.what} fakes ${service.name} (${service.image}), which ${stackHint} declares: a service of the repository's own stack runs real in the test world. ${reason}Delete the fake and let the world run the real service; fakes are otherwise only for external SaaS the team does not operate.`,
|
|
213
|
-
});
|
|
214
|
-
}
|
|
215
226
|
}
|
|
216
|
-
|
|
217
227
|
export function checkTestWorldFiles(input) {
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
228
|
+
const { config, graph, ts, resolver, tree } = checkerScope(input);
|
|
229
|
+
const suffixes = graph.resolver.ruleParams()?.suffixes ?? [];
|
|
230
|
+
const violations = [];
|
|
231
|
+
const { fakeProviders, worldRoot, files } = collectWorldFiles(resolver, tree, suffixes, violations);
|
|
232
|
+
const { configPath, configFile, literal } = worldDeclaration(graph, ts, worldRoot, violations);
|
|
233
|
+
const environments = [(literal ? environmentOf(ts, literal) : null) ?? defaultEnvironment];
|
|
234
|
+
const services = stackServices(config, environments);
|
|
235
|
+
const stackHint = `${STACKS_DIRECTORY}/${environments.join(', ')}`;
|
|
236
|
+
const worldSource = configFile?.sourceFile;
|
|
237
|
+
const declared = literal && worldSource ? fakedByOf(ts, worldSource, literal) : [];
|
|
238
|
+
const fakeEntries = literal && worldSource ? fakeEntriesOf(ts, worldSource, literal) : [];
|
|
239
|
+
reportDeclaredFakeProblems(declared, services, fakeProviders, fakeEntries, configPath, stackHint, violations);
|
|
240
|
+
// Every fake the world runs: the repository's fakes/<provider>/ folders and the fakes entries of the declaration.
|
|
241
|
+
const fakes = worldFakes(fakeProviders, fakeEntries, configPath);
|
|
242
|
+
reportServiceFakes(fakes, services, declared, configPath, stackHint, violations);
|
|
243
|
+
return { violations, coverage: { status: 'checked', files } };
|
|
234
244
|
}
|