tla-ts 0.0.3-dev.14337b3 → 0.0.3-dev.19a7038

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.
@@ -0,0 +1,29 @@
1
+ import type { Expression } from "./ast";
2
+ import { TlaEvaluationError } from "./errors";
3
+ import type { Value } from "./values";
4
+
5
+ // While TLC replays a failure, it gives each set, tuple or record it builds the expression that
6
+ // built it. A method of such a value that fails prepends that expression to the error's trace, and
7
+ // TLC reports the error as one it was unable to fingerprint.
8
+ export const valueSources: { current: WeakMap<object, Expression> | undefined } = {
9
+ current: undefined,
10
+ };
11
+
12
+ const fingerprintTraces = new WeakMap<TlaEvaluationError, Expression[]>();
13
+
14
+ export const getFingerprintTrace = (error: unknown) =>
15
+ error instanceof TlaEvaluationError ? fingerprintTraces.get(error) : undefined;
16
+
17
+ export const withSource = <T>(value: Value, run: () => T): T => {
18
+ const sources = valueSources.current;
19
+ if (!sources || typeof value !== "object") return run();
20
+ try {
21
+ return run();
22
+ } catch (error) {
23
+ const source = sources.get(value);
24
+ if (source && error instanceof TlaEvaluationError) {
25
+ fingerprintTraces.set(error, [source, ...(fingerprintTraces.get(error) ?? [])]);
26
+ }
27
+ throw error;
28
+ }
29
+ };
package/src/values.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  import { TlaEvaluationError, TlaModuleError } from "./errors";
2
2
  import { prettyPrint } from "./pretty-print";
3
+ import { valueSources, withSource } from "./value-sources";
3
4
 
4
5
  export interface ModelValue {
5
6
  kind: "ModelValue";
@@ -733,16 +734,17 @@ const compareSetLikeTlc = (left: ObjectValue, right: Value): number => {
733
734
  );
734
735
  };
735
736
 
736
- const compareLikeTlc = (left: Value, right: Value): number => {
737
- if (typeof left !== "object") {
738
- if (typeof right === typeof left) return compareValues(left, right);
739
- if (isModelValue(right)) return compareModelValueWith(right, left);
740
- throw new TlaEvaluationError(describeScalarMismatch(left, right, false));
741
- }
742
- if (left.kind === "ModelValue") return compareModelValue(left, right);
743
- if (isFunctionValue(left)) return compareFunctionLikeTlc(left, right);
744
- return compareSetLikeTlc(left, right);
745
- };
737
+ const compareLikeTlc = (left: Value, right: Value): number =>
738
+ withSource(left, () => {
739
+ if (typeof left !== "object") {
740
+ if (typeof right === typeof left) return compareValues(left, right);
741
+ if (isModelValue(right)) return compareModelValueWith(right, left);
742
+ throw new TlaEvaluationError(describeScalarMismatch(left, right, false));
743
+ }
744
+ if (left.kind === "ModelValue") return compareModelValue(left, right);
745
+ if (isFunctionValue(left)) return compareFunctionLikeTlc(left, right);
746
+ return compareSetLikeTlc(left, right);
747
+ });
746
748
 
747
749
  const equalsElementsLikeTlc = (left: Value[], right: Value[]) =>
748
750
  left.every((element, index) => equalsLikeTlc(element, right[index]));
@@ -830,16 +832,17 @@ const equalsSetLikeTlc = (left: ObjectValue, right: Value): boolean => {
830
832
  );
831
833
  };
832
834
 
833
- const equalsLikeTlc = (left: Value, right: Value): boolean => {
834
- if (typeof left !== "object") {
835
- if (typeof right === typeof left) return left === right;
836
- if (isModelValue(right)) return equalsModelValueWith(right, left);
837
- throw new TlaEvaluationError(describeScalarMismatch(left, right, true));
838
- }
839
- if (left.kind === "ModelValue") return equalsModelValue(left, right);
840
- if (isFunctionValue(left)) return equalsFunctionLikeTlc(left, right);
841
- return equalsSetLikeTlc(left, right);
842
- };
835
+ const equalsLikeTlc = (left: Value, right: Value): boolean =>
836
+ withSource(left, () => {
837
+ if (typeof left !== "object") {
838
+ if (typeof right === typeof left) return left === right;
839
+ if (isModelValue(right)) return equalsModelValueWith(right, left);
840
+ throw new TlaEvaluationError(describeScalarMismatch(left, right, true));
841
+ }
842
+ if (left.kind === "ModelValue") return equalsModelValue(left, right);
843
+ if (isFunctionValue(left)) return equalsFunctionLikeTlc(left, right);
844
+ return equalsSetLikeTlc(left, right);
845
+ });
843
846
 
844
847
  // TLC's ValueVec.sort, which inserts each element into the sorted prefix by binary search.
845
848
  const sortLikeTlc = (elements: Value[]) => {
@@ -1196,6 +1199,41 @@ const advanceCombination = (indices: number[], length: number) => {
1196
1199
  return false;
1197
1200
  };
1198
1201
 
1202
+ // TLC enumerates SUBSET S lazily, by size and then in the order of S, so a quantifier that finds
1203
+ // its witness early never builds the rest. For a power set too large to build, the elements are
1204
+ // computed in that order as a loop reads them.
1205
+ export const getLazySubsets = (value: Value): Value[] | undefined => {
1206
+ if (typeof value !== "object" || value.kind !== "Subset" || isOverriddenSet(value.base)) {
1207
+ return undefined;
1208
+ }
1209
+ const base = toFiniteSet(value.base).elements;
1210
+ if (base.length <= MAXIMUM_ENUMERATED_SUBSET_BASE) return undefined;
1211
+ const cursor = { index: -1, indices: [0] };
1212
+ const getSubset = (index: number) => {
1213
+ if (index <= cursor.index) cursor.index = -1;
1214
+ while (cursor.index < index) {
1215
+ if (cursor.index === -1) cursor.indices = [];
1216
+ else if (!advanceCombination(cursor.indices, base.length)) {
1217
+ cursor.indices = Array.from({ length: cursor.indices.length + 1 }, (_, item) => item);
1218
+ }
1219
+ cursor.index++;
1220
+ }
1221
+ return createSortedSet(cursor.indices.map((item) => base[item]));
1222
+ };
1223
+ const length = 2 ** base.length;
1224
+ const isIndex = (property: string | symbol) =>
1225
+ typeof property === "string" && /^\d+$/.test(property) && Number(property) < length;
1226
+ return new Proxy<Value[]>([], {
1227
+ get: (target, property, receiver) => {
1228
+ if (property === "length") return length;
1229
+ return isIndex(property)
1230
+ ? getSubset(Number(property))
1231
+ : Reflect.get(target, property, receiver);
1232
+ },
1233
+ has: (target, property) => isIndex(property) || Reflect.has(target, property),
1234
+ });
1235
+ };
1236
+
1199
1237
  const getSortedSubsets = (base: Value[]) => {
1200
1238
  const subsets: Value[] = [];
1201
1239
  for (let size = 0; size <= base.length; size++) {
@@ -1288,7 +1326,7 @@ const enumerateSet = (value: Value): Value[] => {
1288
1326
  case "SetOperation": {
1289
1327
  if (
1290
1328
  value.operator === "\\cup" &&
1291
- (isOverriddenSet(value.left) || isOverriddenSet(value.right))
1329
+ (!isTlcEnumerable(value.left) || !isTlcEnumerable(value.right))
1292
1330
  ) {
1293
1331
  throw new TlaEvaluationError(
1294
1332
  `Attempted to enumerate S \\cup T when S:\n${formatValue(value.left)}\nand T:\n${formatValue(value.right)}\nare not both enumerable`,
@@ -1296,14 +1334,14 @@ const enumerateSet = (value: Value): Value[] => {
1296
1334
  }
1297
1335
  if (
1298
1336
  value.operator === "\\cap" &&
1299
- isOverriddenSet(value.left) &&
1300
- isOverriddenSet(value.right)
1337
+ !isTlcEnumerable(value.left) &&
1338
+ !isTlcEnumerable(value.right)
1301
1339
  ) {
1302
1340
  throw new TlaEvaluationError(
1303
1341
  `Attempted to enumerate S \\cap T when neither S:\n${formatValue(value.left)}\nnor T:\n${formatValue(value.right)}\nis enumerable`,
1304
1342
  );
1305
1343
  }
1306
- if (value.operator === "\\" && isOverriddenSet(value.left)) {
1344
+ if (value.operator === "\\" && !isTlcEnumerable(value.left)) {
1307
1345
  throw new TlaEvaluationError(
1308
1346
  `Attempted to enumerate S \\ T when S:\n${formatValue(value.left)}\nis not enumerable.`,
1309
1347
  );
@@ -1338,7 +1376,10 @@ export const toFiniteSet = (value: Value): SetValue => {
1338
1376
  const cached = typeof value === "object" ? finiteSets.get(value) : undefined;
1339
1377
  if (cached) return cached;
1340
1378
  const set =
1341
- (typeof value === "object" ? comparedSets.get(value) : undefined) ?? enumerateFiniteSet(value);
1379
+ (typeof value === "object" ? comparedSets.get(value) : undefined) ??
1380
+ (valueSources.current
1381
+ ? withSource(value, () => enumerateFiniteSet(value))
1382
+ : enumerateFiniteSet(value));
1342
1383
  if (typeof value === "object") finiteSets.set(value, set);
1343
1384
  return set;
1344
1385
  };
@@ -1387,14 +1428,14 @@ export const getStreamedElements = (value: Value): Value[] => {
1387
1428
  }
1388
1429
  if (value.kind !== "SetOperation") return toFiniteSet(value).elements;
1389
1430
  if (value.operator === "\\cup") {
1390
- return isOverriddenSet(value.left) || isOverriddenSet(value.right)
1431
+ return !isTlcEnumerable(value.left) || !isTlcEnumerable(value.right)
1391
1432
  ? toFiniteSet(value).elements
1392
1433
  : [...getStreamedElements(value.left), ...getStreamedElements(value.right)];
1393
1434
  }
1394
1435
  const isLeftEnumerated = value.operator === "\\" || isEnumerable(value.left);
1395
1436
  const enumerated = isLeftEnumerated ? value.left : value.right;
1396
1437
  const other = isLeftEnumerated ? value.right : value.left;
1397
- if (isOverriddenSet(enumerated)) return toFiniteSet(value).elements;
1438
+ if (!isTlcEnumerable(enumerated)) return toFiniteSet(value).elements;
1398
1439
  return getStreamedElements(enumerated).filter(
1399
1440
  (element) => isElementOf(element, other) === (value.operator === "\\cap"),
1400
1441
  );
@@ -1597,6 +1638,12 @@ const describeNonSetMembership = (element: Value, value: Value) => {
1597
1638
  return `${prefix} function ${formatValue(value)}`;
1598
1639
  };
1599
1640
 
1641
+ // TLC checks membership in a set that another set holds through the inner set's own method.
1642
+ const isElementOfSet = (element: Value, set: Value) =>
1643
+ valueSources.current
1644
+ ? withSource(set, () => isElementOf(element, set))
1645
+ : isElementOf(element, set);
1646
+
1600
1647
  export const isElementOf = (element: Value, set: Value): boolean => {
1601
1648
  if (!isSetValue(set)) throw new TlaEvaluationError(describeNonSetMembership(element, set));
1602
1649
  switch (set.kind) {
@@ -1605,10 +1652,10 @@ export const isElementOf = (element: Value, set: Value): boolean => {
1605
1652
  return findIndex(set.elements, element) !== -1;
1606
1653
  } catch (error) {
1607
1654
  if (!(error instanceof TlaEvaluationError)) throw error;
1608
- return isElementOfLikeTlc(element, set.elements);
1655
+ return withSource(set, () => isElementOfLikeTlc(element, set.elements));
1609
1656
  }
1610
1657
  case "MixedSet":
1611
- return isElementOfLikeTlc(element, set.elements);
1658
+ return withSource(set, () => isElementOfLikeTlc(element, set.elements));
1612
1659
  case "Interval":
1613
1660
  if (typeof element === "number") return element >= set.low && element <= set.high;
1614
1661
  if (set.low <= set.high && !isModelValue(element)) {
@@ -1630,12 +1677,18 @@ export const isElementOf = (element: Value, set: Value): boolean => {
1630
1677
  return set.name !== "Nat" || (typeof element === "number" && element >= 0);
1631
1678
  }
1632
1679
  case "Subset":
1633
- if (!isSetValue(element)) throw new TlaEvaluationError(describeMembership(element, set));
1634
- return toFiniteSet(element).elements.every((item) => isElementOf(item, set.base));
1680
+ if (!isTlcEnumerable(element)) {
1681
+ throw new TlaEvaluationError(
1682
+ `Attempted to check if the non-enumerable value\n${prettyPrint(formatValue(element))}\nis element of\n${prettyPrint(formatValue(set))}`,
1683
+ );
1684
+ }
1685
+ return toFiniteSet(element).elements.every((item) => isElementOfSet(item, set.base));
1635
1686
  case "FunctionSet": {
1636
1687
  if (!isFunctionValue(element)) {
1637
1688
  if (isModelValue(element)) return false;
1638
- throw new TlaEvaluationError(describeMembership(element, set));
1689
+ throw new TlaEvaluationError(
1690
+ `Attempted to check if \n${formatValue(element)}\nwhich is not a TLC function value, is in the set of functions:\n${prettyPrint(formatValue(set))}`,
1691
+ );
1639
1692
  }
1640
1693
  const functionValue = toFiniteFunction(element);
1641
1694
  const low = getIntervalLow(functionValue.domain);
@@ -1646,7 +1699,7 @@ export const isElementOf = (element: Value, set: Value): boolean => {
1646
1699
  { kind: "Interval", low, high: low + functionValue.domain.length - 1 },
1647
1700
  set.domain,
1648
1701
  );
1649
- return isDomain && functionValue.range.every((item) => isElementOf(item, set.range));
1702
+ return isDomain && functionValue.range.every((item) => isElementOfSet(item, set.range));
1650
1703
  }
1651
1704
  case "RecordSet": {
1652
1705
  const functionValue = isFunctionValue(element) ? toFiniteFunction(element) : undefined;
@@ -1660,7 +1713,7 @@ export const isElementOf = (element: Value, set: Value): boolean => {
1660
1713
  functionValue.domain.length === set.names.length &&
1661
1714
  set.names.every((name, index) => {
1662
1715
  const position = findIndex(functionValue.domain, name);
1663
- return position !== -1 && isElementOf(functionValue.range[position], set.sets[index]);
1716
+ return position !== -1 && isElementOfSet(functionValue.range[position], set.sets[index]);
1664
1717
  })
1665
1718
  );
1666
1719
  }
@@ -1677,24 +1730,24 @@ export const isElementOf = (element: Value, set: Value): boolean => {
1677
1730
  }
1678
1731
  return (
1679
1732
  elements.length === set.factors.length &&
1680
- elements.every((item, index) => isElementOf(item, set.factors[index]))
1733
+ elements.every((item, index) => isElementOfSet(item, set.factors[index]))
1681
1734
  );
1682
1735
  }
1683
1736
  case "FilteredSet":
1684
- return isElementOf(element, set.base) && set.test(element);
1737
+ return isElementOfSet(element, set.base) && set.test(element);
1685
1738
  case "Union":
1686
1739
  if (!isTlcEnumerable(set.base)) {
1687
1740
  throw new TlaEvaluationError(
1688
1741
  `Attempted to check if:\n ${formatValue(element)}\nis an element of the non-enumerable set:\n ${formatUnion(set)}`,
1689
1742
  );
1690
1743
  }
1691
- return toFiniteSet(set.base).elements.some((inner) => isElementOf(element, inner));
1744
+ return toFiniteSet(set.base).elements.some((inner) => isElementOfSet(element, inner));
1692
1745
  case "SetOperation":
1693
1746
  if (set.operator === "\\cup")
1694
- return isElementOf(element, set.left) || isElementOf(element, set.right);
1747
+ return isElementOfSet(element, set.left) || isElementOfSet(element, set.right);
1695
1748
  return (
1696
- isElementOf(element, set.left) &&
1697
- isElementOf(element, set.right) === (set.operator === "\\cap")
1749
+ isElementOfSet(element, set.left) &&
1750
+ isElementOfSet(element, set.right) === (set.operator === "\\cap")
1698
1751
  );
1699
1752
  case "SequenceSet": {
1700
1753
  const elements = getSequenceElements(element);
@@ -1941,10 +1994,15 @@ const getElementContribution = (element: Value) =>
1941
1994
  const getEntryContribution = (key: Value, value: Value) =>
1942
1995
  finalizeHash((Math.imul(getValueHash(key), 0x27d4eb2d) + getValueHash(value)) | 0);
1943
1996
 
1997
+ const unenumeratedSets = { isHashed: false };
1998
+
1944
1999
  const computeValueHash = (value: ObjectValue) => {
1945
2000
  if (value.kind === "ModelValue") return finalizeHash(combineHash(hashString(value.name), 0x6d));
1946
2001
  if (isSetValue(value)) {
1947
- if (!isEnumerable(value)) return hashString(getValueKey(value));
2002
+ if (!isEnumerable(value)) {
2003
+ unenumeratedSets.isHashed = true;
2004
+ return hashString(getValueKey(value));
2005
+ }
1948
2006
  const elements = toFiniteSet(value).elements;
1949
2007
  let hash = SET_HASH_SEED;
1950
2008
  for (let index = 0; index < elements.length; index++) {
@@ -1976,6 +2034,25 @@ export const getValueHash = (value: Value): number => {
1976
2034
  return hash;
1977
2035
  };
1978
2036
 
2037
+ const fingerprintLikeTlc = (value: Value): void => {
2038
+ if (typeof value !== "object" || value.kind === "ModelValue") return;
2039
+ if (isOverriddenSet(value)) {
2040
+ throw new TlaEvaluationError(
2041
+ `TLC has found a state in which the value of a variable contains ${formatValue(value)}`,
2042
+ );
2043
+ }
2044
+ if (isSetValue(value)) return toFiniteSet(value).elements.forEach(fingerprintLikeTlc);
2045
+ const functionValue = toFiniteFunction(value);
2046
+ functionValue.domain.forEach(fingerprintLikeTlc);
2047
+ functionValue.range.forEach(fingerprintLikeTlc);
2048
+ };
2049
+
2050
+ // TLC enumerates every set in a state to fingerprint it, so it fails on a set it can't enumerate.
2051
+ // A state holds one only if hashing it met one, so states go unchecked until then.
2052
+ export const assertFingerprintable = (state: Value[]) => {
2053
+ if (unenumeratedSets.isHashed) state.forEach(fingerprintLikeTlc);
2054
+ };
2055
+
1979
2056
  const valueFingerprints = new WeakMap<ObjectValue, number>();
1980
2057
 
1981
2058
  const finalizeFingerprint = (hash: number) => {
@@ -2002,7 +2079,10 @@ const getEntryFingerprint = (key: Value, value: Value) =>
2002
2079
  const computeValueFingerprint = (value: ObjectValue) => {
2003
2080
  if (value.kind === "ModelValue") return finalizeFingerprint(fingerprintString(value.name) ^ 0x3c);
2004
2081
  if (isSetValue(value)) {
2005
- if (!isEnumerable(value)) return fingerprintString(getValueKey(value));
2082
+ if (!isEnumerable(value)) {
2083
+ unenumeratedSets.isHashed = true;
2084
+ return fingerprintString(getValueKey(value));
2085
+ }
2006
2086
  const elements = toFiniteSet(value).elements;
2007
2087
  let fingerprint = 0x1b873593;
2008
2088
  for (let index = 0; index < elements.length; index++) {