tla-ts 0.0.3-dev.cf3b82c → 0.0.3-dev.d9ff6f2

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/src/run-cli.ts CHANGED
@@ -14,12 +14,14 @@ import type { CheckResult, CheckStatus, 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";
@@ -143,6 +145,14 @@ const printResult = (result: CheckResult) => {
143
145
  printState(result.failure.initialState);
144
146
  }
145
147
  printTrace(result.failure.trace);
148
+ const replay = result.failure.replay;
149
+ replay?.output.forEach((line) => console.log(line));
150
+ if (replay?.callStack) {
151
+ const frames = replay.callStack.map((frame, index) => `${index}. ${frame}\n`).join("");
152
+ console.log(
153
+ `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"}`,
154
+ );
155
+ }
146
156
  } else if (result.violation) {
147
157
  const violation = result.violation;
148
158
  const name = violation.name;
@@ -219,8 +229,14 @@ const checkSpec = async (specPath: string, args: ParsedArgs) => {
219
229
  const fileName = basename(specPath, ".tla");
220
230
  const moduleName = parseModule(source).name;
221
231
  if (moduleName !== fileName) {
222
- throw new TlaSyntaxError(
223
- `File name '${fileName}' does not match the name '${moduleName}' of the top level module it contains.`,
232
+ throw createSanyError(
233
+ [
234
+ {
235
+ location: "Unknown location",
236
+ message: `File name '${fileName}' does not match the name '${moduleName}' of the top level module it contains.`,
237
+ },
238
+ ],
239
+ true,
224
240
  );
225
241
  }
226
242
  const configPath =
@@ -286,21 +302,32 @@ const checkSpec = async (specPath: string, args: ParsedArgs) => {
286
302
  return result.failure?.exitCode ?? EXIT_CODES[result.status];
287
303
  };
288
304
 
289
- // TLC prints the errors it raises itself. tla-ts names the others, such as a module SANY rejects.
290
- const printError = (error: TlaError) => {
305
+ const formatSanyErrors = (report: SanyReport) =>
306
+ `*** Errors: ${report.errors.length}\n\n${report.errors.map((error) => `${error.location}\n\n${error.message}\n\n`).join("\n")}`;
307
+
308
+ // TLC prints the errors it raises itself, and SANY's report of a spec it rejects. tla-ts names the
309
+ // others, such as a module it cannot parse.
310
+ const printError = (error: TlaError, path?: string) => {
291
311
  if (error instanceof TlaConfigError || error instanceof TlaEvaluationError) {
292
312
  return console.log(`Error: ${error.message}`);
293
313
  }
294
- console.error(`${error.name}: ${error.message}`);
314
+ const report = error instanceof TlaSyntaxError ? error.sany : undefined;
315
+ if (!report || path === undefined) return console.error(`${error.name}: ${error.message}`);
316
+ console.log(
317
+ report.isFatal
318
+ ? `\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`
319
+ : `Semantic errors:\n\n${formatSanyErrors(report)}`,
320
+ );
321
+ console.log("Error: Parsing or semantic analysis failed.");
295
322
  };
296
323
 
297
324
  // Prints a TlaError and returns its exit code.
298
- const reportErrors = async (run: () => number | Promise<number>) => {
325
+ const reportErrors = async (run: () => number | Promise<number>, path?: string) => {
299
326
  try {
300
327
  return await run();
301
328
  } catch (error) {
302
329
  if (!(error instanceof TlaError)) throw error;
303
- printError(error);
330
+ printError(error, path);
304
331
  return getErrorExitCode(error);
305
332
  }
306
333
  };
@@ -311,7 +338,7 @@ const runEach = async (paths: string[], runPath: (path: string) => number | Prom
311
338
  const exitCodes: number[] = [];
312
339
  for (const [index, path] of paths.entries()) {
313
340
  if (index > 0) console.log("");
314
- exitCodes.push(await reportErrors(() => runPath(path)));
341
+ exitCodes.push(await reportErrors(() => runPath(path), path));
315
342
  }
316
343
  return exitCodes.find((exitCode) => exitCode !== EXIT_STATUS.success) ?? EXIT_STATUS.success;
317
344
  };
@@ -7,13 +7,12 @@ import {
7
7
  } from "./ast";
8
8
  import type { ModelConfig } from "./config";
9
9
  import type { InstanceAction } from "./environment";
10
- import { TlaError } from "./errors";
10
+ import { formatRange, TlaError } from "./errors";
11
11
  import {
12
12
  bindDefinitions,
13
13
  bindOperatorArguments,
14
14
  evaluate,
15
15
  forEachBinding,
16
- formatRange,
17
16
  getDefinition,
18
17
  isConstantLevel,
19
18
  lookupScope,
package/src/successors.ts CHANGED
@@ -113,11 +113,30 @@ const holds = (expression: Expression, context: Context, value = evaluate(expres
113
113
  const isAssignmentOperator = (operator: string) =>
114
114
  operator === "=" || operator === "\\in" || operator === "\\subseteq";
115
115
 
116
+ const tracedRunners = new WeakMap<Environment, WeakMap<Expression, Runner>[]>();
117
+
118
+ const getRunners = (environment: Environment, isInit: boolean) => {
119
+ if (!environment.trace) return isInit ? initRunners : nextRunners;
120
+ const runners = tracedRunners.get(environment) ?? [new WeakMap(), new WeakMap()];
121
+ tracedRunners.set(environment, runners);
122
+ return runners[isInit ? 0 : 1];
123
+ };
124
+
116
125
  const getRunner = (expression: Expression, environment: Environment, isInit: boolean): Runner => {
117
- const runners = isInit ? initRunners : nextRunners;
126
+ const runners = getRunners(environment, isInit);
118
127
  const cached = runners.get(expression);
119
128
  if (cached) return cached;
120
- const runner = compileAction(expression, environment, isInit);
129
+ const compiled = compileAction(expression, environment, isInit);
130
+ const trace = environment.trace;
131
+ // TLC's CallStackTool keeps an action's expression on the stack while the rest of the action runs.
132
+ const runner: Runner = trace
133
+ ? (run, scope, partial, action, isFixed, onComplete) => {
134
+ const depth = trace.length;
135
+ trace.push(expression);
136
+ compiled(run, scope, partial, action, isFixed, onComplete);
137
+ trace.length = depth;
138
+ }
139
+ : compiled;
121
140
  runners.set(expression, runner);
122
141
  return runner;
123
142
  };
@@ -201,6 +220,23 @@ const getUnchangedIndices = (
201
220
  return getUnchangedIndices(definition.body, environment, visited);
202
221
  };
203
222
 
223
+ // TLC's CallStackTool keeps each expression that UNCHANGED takes apart on the stack.
224
+ const getUnchangedFrames = (expression: Expression, environment: Environment): Expression[] => {
225
+ if (expression.kind === "Tuple") {
226
+ return [
227
+ expression,
228
+ ...expression.elements.flatMap((element) => getUnchangedFrames(element, environment)),
229
+ ];
230
+ }
231
+ const definition =
232
+ expression.kind === "Identifier" && !environment.variableIndex.has(expression.name)
233
+ ? getZeroArityBody(expression.name, environment)
234
+ : undefined;
235
+ return definition
236
+ ? [expression, ...getUnchangedFrames(definition.body, environment)]
237
+ : [expression];
238
+ };
239
+
204
240
  const ACTION_KINDS = new Set([
205
241
  "Label",
206
242
  "And",
@@ -333,6 +369,7 @@ const compileConjunction = (
333
369
  ): Runner => {
334
370
  const conjuncts = operands.map((operand) => toConjunct(operand, environment, isInit));
335
371
  const evaluators: (Evaluator | undefined)[] = conjuncts.map(() => undefined);
372
+ const trace = environment.trace;
336
373
  const runFrom = (
337
374
  start: number,
338
375
  run: Run,
@@ -353,6 +390,12 @@ const compileConjunction = (
353
390
  return;
354
391
  }
355
392
  const conjunct = conjuncts[index];
393
+ if (trace) {
394
+ trace.push(conjunct.expression);
395
+ if (conjunct.expression.kind === "Unchanged") {
396
+ trace.push(...getUnchangedFrames(conjunct.expression.expression, environment));
397
+ }
398
+ }
356
399
  if (conjunct.kind === "Guard") {
357
400
  context ??= getContext(run, scope, current);
358
401
  const evaluator = (evaluators[index] ??= getEntryEvaluator(
@@ -771,7 +814,8 @@ const compileAction = (
771
814
  }
772
815
  };
773
816
  }
774
- const hoisted = isInit ? undefined : getHoistedGuards(expression, environment);
817
+ const hoisted =
818
+ isInit || environment.trace ? undefined : getHoistedGuards(expression, environment);
775
819
  if (hoisted) {
776
820
  const rest = compileConjunction(hoisted.rest, environment, isInit);
777
821
  return (run, scope, partial, action, isFixed, onComplete) => {
package/src/values.ts CHANGED
@@ -1635,7 +1635,9 @@ export const isElementOf = (element: Value, set: Value): boolean => {
1635
1635
  case "FunctionSet": {
1636
1636
  if (!isFunctionValue(element)) {
1637
1637
  if (isModelValue(element)) return false;
1638
- throw new TlaEvaluationError(describeMembership(element, set));
1638
+ throw new TlaEvaluationError(
1639
+ `Attempted to check if \n${formatValue(element)}\nwhich is not a TLC function value, is in the set of functions:\n${prettyPrint(formatValue(set))}`,
1640
+ );
1639
1641
  }
1640
1642
  const functionValue = toFiniteFunction(element);
1641
1643
  const low = getIntervalLow(functionValue.domain);