tla-ts 0.0.3-dev.31e0776 → 0.0.3-dev.3504663

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.
Files changed (48) hide show
  1. package/dist/index.cjs +1 -1
  2. package/dist/index.d.cts +50 -22
  3. package/dist/index.d.ts +50 -22
  4. package/dist/index.js +1 -1
  5. package/dist/parallel-worker.cjs +1 -1
  6. package/dist/parallel-worker.js +2 -2
  7. package/dist/parallel.cjs +1 -1
  8. package/dist/parallel.js +2 -2
  9. package/dist/run-cli.cjs +14 -12
  10. package/dist/run-cli.js +22 -20
  11. package/dist/transfer.cjs +38 -21
  12. package/dist/transfer.js +38 -21
  13. package/package.json +1 -1
  14. package/src/ast.ts +11 -1
  15. package/src/builtins.ts +9 -3
  16. package/src/check.ts +357 -79
  17. package/src/codegen.ts +6 -3
  18. package/src/config.ts +224 -170
  19. package/src/environment.ts +90 -40
  20. package/src/errors.ts +89 -1
  21. package/src/evaluate.ts +182 -26
  22. package/src/exit-codes.ts +22 -3
  23. package/src/fingerprints.ts +2 -1
  24. package/src/instances.ts +1 -1
  25. package/src/levels.ts +173 -37
  26. package/src/live-check.ts +132 -70
  27. package/src/liveness.ts +117 -22
  28. package/src/parallel-worker.ts +2 -2
  29. package/src/parallel.ts +2 -2
  30. package/src/parser.ts +71 -19
  31. package/src/resolve.ts +429 -52
  32. package/src/run-cli.ts +59 -11
  33. package/src/sany-lexer.ts +615 -0
  34. package/src/sany-parse-error.ts +3143 -0
  35. package/src/spec-description.ts +1 -2
  36. package/src/standard-modules.ts +54 -45
  37. package/src/subexpressions.ts +25 -13
  38. package/src/substitution-levels.ts +38 -17
  39. package/src/successors.ts +121 -34
  40. package/src/symmetry.ts +16 -6
  41. package/src/tableau.ts +51 -24
  42. package/src/tlc-module.ts +6 -6
  43. package/src/tlc-modules.ts +4 -0
  44. package/src/tlc-order.ts +8 -4
  45. package/src/tlc-random.ts +9 -6
  46. package/src/tlc-summary.ts +20 -5
  47. package/src/value-sources.ts +29 -0
  48. package/src/values.ts +222 -57
package/src/run-cli.ts CHANGED
@@ -10,23 +10,25 @@ import {
10
10
  import { spawnSync } from "node:child_process";
11
11
  import { basename, delimiter, dirname, join, resolve } from "node:path";
12
12
  import { availableParallelism } from "node:os";
13
- import type { CheckResult, CheckStatus, TraceStep } from "./check";
13
+ import type { CheckResult, CheckStatus, Replay, TraceStep } from "./check";
14
14
  import { defineCommand, type ParsedArgs } from "./cli-options";
15
15
  import { parseConfig } from "./config";
16
16
  import {
17
+ createSanyError,
17
18
  getErrorExitCode,
18
19
  TlaConfigError,
19
20
  TlaError,
20
21
  TlaEvaluationError,
21
22
  TlaProofError,
22
23
  TlaSyntaxError,
24
+ type SanyReport,
23
25
  } from "./errors";
24
26
  import { EXIT_STATUS } from "./exit-codes";
25
27
  import type { LineRange } from "./obligation-generate";
26
28
  import { getAtPrefix, getLocusText } from "./obligation-expression";
27
29
  import { formatSummary, getObligations, WHOLE_MODULE, type ModuleObligations } from "./obligations";
28
30
  import { check } from "./parallel";
29
- import { parseModule } from "./parser";
31
+ import { parseModuleFile } from "./sany-parse-error";
30
32
  import type { StateDump } from "./state-graph";
31
33
  import {
32
34
  formatProbability,
@@ -135,14 +137,42 @@ const getTemporalHeadline = (names: string[]) =>
135
137
  ? `Error: Temporal property ${names[0]} was violated.\n`
136
138
  : `Error: Temporal properties ${names.slice(0, -1).join(", ")}${names.length > 2 ? "," : ""} and ${names[names.length - 1]} were violated.\n`;
137
139
 
140
+ const getFrames = (callStack: string[]) =>
141
+ callStack.map((frame, index) => `${index}. ${frame}\n`).join("");
142
+
143
+ const printCallStack = (frames: string) =>
144
+ console.log(
145
+ `Error: The error occurred when TLC was evaluating the nested\nexpressions at the following positions:\n${frames ? `${frames}\n` : " The error call stack is empty.\n"}`,
146
+ );
147
+
148
+ const printReplay = (replay: Replay) => {
149
+ replay.output.forEach((line) => console.log(line));
150
+ const frames = getFrames(replay.callStack ?? []);
151
+ const fingerprint = replay.fingerprint;
152
+ if (replay.isBeforeError) {
153
+ if (frames) printCallStack(frames);
154
+ } else if (replay.callStack && fingerprint) {
155
+ const sources = fingerprint.sources.map((source) => `${source}\n`).join("");
156
+ console.log(
157
+ `Error: TLC was unable to fingerprint.\n\nFingerprint Stack Trace:\n${frames ? `${frames}\n` : sources}\nReason:\n${fingerprint.reason}`,
158
+ );
159
+ } else if (replay.callStack) {
160
+ printCallStack(frames);
161
+ }
162
+ };
163
+
138
164
  const printResult = (result: CheckResult) => {
139
165
  if (result.failure) {
166
+ const replay = result.failure.replay;
167
+ if (replay?.isBeforeError) printReplay(replay);
140
168
  console.log(`Error: ${result.failure.message}`);
141
169
  if (result.failure.initialState) {
142
170
  console.log("While working on the initial state:");
143
171
  printState(result.failure.initialState);
144
172
  }
145
173
  printTrace(result.failure.trace);
174
+ if (replay && !replay.isBeforeError) printReplay(replay);
175
+ if (result.failure.isWithoutStatistics) return;
146
176
  } else if (result.violation) {
147
177
  const violation = result.violation;
148
178
  const name = violation.name;
@@ -217,10 +247,16 @@ const checkSpec = async (specPath: string, args: ParsedArgs) => {
217
247
  }
218
248
  const source = readFileSync(specPath, "utf8");
219
249
  const fileName = basename(specPath, ".tla");
220
- const moduleName = parseModule(source).name;
250
+ const moduleName = parseModuleFile(source, fileName).name;
221
251
  if (moduleName !== fileName) {
222
- throw new TlaSyntaxError(
223
- `File name '${fileName}' does not match the name '${moduleName}' of the top level module it contains.`,
252
+ throw createSanyError(
253
+ [
254
+ {
255
+ location: "Unknown location",
256
+ message: `File name '${fileName}' does not match the name '${moduleName}' of the top level module it contains.`,
257
+ },
258
+ ],
259
+ true,
224
260
  );
225
261
  }
226
262
  const configPath =
@@ -286,21 +322,33 @@ const checkSpec = async (specPath: string, args: ParsedArgs) => {
286
322
  return result.failure?.exitCode ?? EXIT_CODES[result.status];
287
323
  };
288
324
 
289
- // TLC prints the errors it raises itself. tla-ts names the others, such as a module SANY rejects.
290
- const printError = (error: TlaError) => {
325
+ const formatSanyErrors = (report: SanyReport) =>
326
+ `*** Errors: ${report.errors.length}\n\n${report.errors.map((error) => `${error.location}\n\n${error.message}\n\n`).join("\n")}`;
327
+
328
+ // TLC prints the errors it raises itself, and SANY's report of a spec it rejects. tla-ts names the
329
+ // others, such as a module it cannot parse.
330
+ const printError = (error: TlaError, path?: string) => {
291
331
  if (error instanceof TlaConfigError || error instanceof TlaEvaluationError) {
292
332
  return console.log(`Error: ${error.message}`);
293
333
  }
294
- console.error(`${error.name}: ${error.message}`);
334
+ const report = error instanceof TlaSyntaxError ? error.sany : undefined;
335
+ if (!report || path === undefined) return console.error(`${error.name}: ${error.message}`);
336
+ if (report.parseError !== undefined) console.log(report.parseError);
337
+ console.log(
338
+ report.isFatal
339
+ ? `\nFatal errors while parsing TLA+ spec in file ${basename(path, ".tla")}\n\n${report.errors.map((item) => `${item.location}\n\n${item.message}\n`).join("")}${formatSanyErrors(report)}\n`
340
+ : `Semantic errors:\n\n${formatSanyErrors(report)}`,
341
+ );
342
+ console.log("Error: Parsing or semantic analysis failed.");
295
343
  };
296
344
 
297
345
  // Prints a TlaError and returns its exit code.
298
- const reportErrors = async (run: () => number | Promise<number>) => {
346
+ const reportErrors = async (run: () => number | Promise<number>, path?: string) => {
299
347
  try {
300
348
  return await run();
301
349
  } catch (error) {
302
350
  if (!(error instanceof TlaError)) throw error;
303
- printError(error);
351
+ printError(error, path);
304
352
  return getErrorExitCode(error);
305
353
  }
306
354
  };
@@ -311,7 +359,7 @@ const runEach = async (paths: string[], runPath: (path: string) => number | Prom
311
359
  const exitCodes: number[] = [];
312
360
  for (const [index, path] of paths.entries()) {
313
361
  if (index > 0) console.log("");
314
- exitCodes.push(await reportErrors(() => runPath(path)));
362
+ exitCodes.push(await reportErrors(() => runPath(path), path));
315
363
  }
316
364
  return exitCodes.find((exitCode) => exitCode !== EXIT_STATUS.success) ?? EXIT_STATUS.success;
317
365
  };