refactor: track endo changes

Agoric · Feb 28, 2023 · 2870ec2 · 2870ec2
1 parent 0e039d9
commit 2870ec2
Show file tree

Hide file tree

Showing 8 changed files with 261 additions and 135 deletions.
diff --git a/packages/store/src/keys/checkKey.js b/packages/store/src/keys/checkKey.js
@@ -309,7 +309,7 @@ harden(makeCopyBag);
 /**
  * @template K
  * @param {Iterable<K>} elementIter
- * @returns {CopySet<K>}
+ * @returns {CopyBag<K>}
  */
 export const makeCopyBagFromElements = elementIter => {
   // This fullOrder contains history dependent state. It is specific
@@ -432,7 +432,7 @@ export const getCopyMapEntries = m => {
   const {
     payload: { keys, values },
   } = m;
-  const { length } = keys;
+  const { length } = /** @type {Array} */ (keys);
   return Far('CopyMap entries iterable', {
     [Symbol.iterator]: () => {
       let i = 0;

diff --git a/packages/store/src/keys/merge-bag-operators.js b/packages/store/src/keys/merge-bag-operators.js
@@ -185,6 +185,11 @@ harden(merge);
 
 // We should be able to use this for iterIsSuperset as well.
 // The generalization is free.
+/**
+ * @template T
+ * @param {Iterable<[T,bigint,bigint]>} xyi
+ * @returns {boolean}
+ */
 const bagIterIsSuperbag = xyi => {
   for (const [_m, xc, yc] of xyi) {
     if (xc < yc) {
@@ -197,6 +202,11 @@ const bagIterIsSuperbag = xyi => {
 
 // We should be able to use this for iterIsDisjoint as well.
 // The code is identical.
+/**
+ * @template T
+ * @param {Iterable<[T,bigint,bigint]>} xyi
+ * @returns {boolean}
+ */
 const bagIterIsDisjoint = xyi => {
   for (const [_m, xc, yc] of xyi) {
     if (xc >= 1n && yc >= 1n) {
@@ -209,6 +219,11 @@ const bagIterIsDisjoint = xyi => {
 
 // We should be able to use this for iterCompare as well.
 // The generalization is free.
+/**
+ * @template T
+ * @param {Iterable<[T,bigint,bigint]>} xyi
+ * @returns {KeyComparison}
+ */
 const bagIterCompare = xyi => {
   let loneY = false;
   let loneX = false;
@@ -236,15 +251,27 @@ const bagIterCompare = xyi => {
   }
 };
 
+/**
+ * @template T
+ * @param {[T,bigint,bigint][]} xyi
+ * @returns {[T,bigint][]}
+ */
 const bagIterUnion = xyi => {
+  /** @type {[T,bigint][]} */
   const result = [];
   for (const [m, xc, yc] of xyi) {
     result.push([m, xc + yc]);
   }
   return result;
 };
 
+/**
+ * @template T
+ * @param {Iterable<[T,bigint,bigint]>} xyi
+ * @returns {[T,bigint][]}
+ */
 const bagIterIntersection = xyi => {
+  /** @type {[T,bigint][]} */
   const result = [];
   for (const [m, xc, yc] of xyi) {
     const mc = xc <= yc ? xc : yc;
@@ -253,7 +280,13 @@ const bagIterIntersection = xyi => {
   return result;
 };
 
+/**
+ * @template T
+ * @param {Iterable<[T,bigint,bigint]>} xyi
+ * @returns {[T,bigint][]}
+ */
 const bagIterDisjointSubtract = xyi => {
+  /** @type {[T,bigint][]} */
   const result = [];
   for (const [m, xc, yc] of xyi) {
     const mc = xc - yc;

diff --git a/packages/store/src/keys/merge-set-operators.js b/packages/store/src/keys/merge-set-operators.js
@@ -175,6 +175,11 @@ const iterIsSuperset = xyi => {
   return true;
 };
 
+/**
+ * @template T
+ * @param {Iterable<[T,bigint,bigint]>} xyi
+ * @returns {boolean}
+ */
 const iterIsDisjoint = xyi => {
   for (const [_m, xc, yc] of xyi) {
     if (xc >= 1n && yc >= 1n) {
@@ -185,6 +190,11 @@ const iterIsDisjoint = xyi => {
   return true;
 };
 
+/**
+ * @template T
+ * @param {Iterable<[T,bigint,bigint]>} xyi
+ * @returns {KeyComparison}
+ */
 const iterCompare = xyi => {
   let loneY = false;
   let loneX = false;
@@ -212,6 +222,11 @@ const iterCompare = xyi => {
   }
 };
 
+/**
+ * @template T
+ * @param {Iterable<[T,bigint,bigint]>} xyi
+ * @returns {T[]}
+ */
 const iterUnion = xyi => {
   const result = [];
   for (const [m, xc, yc] of xyi) {
@@ -227,6 +242,11 @@ const iterUnion = xyi => {
   return result;
 };
 
+/**
+ * @template T
+ * @param {Iterable<[T,bigint,bigint]>} xyi
+ * @returns {T[]}
+ */
 const iterDisjointUnion = xyi => {
   const result = [];
   for (const [m, xc, yc] of xyi) {
@@ -241,6 +261,11 @@ const iterDisjointUnion = xyi => {
   return result;
 };
 
+/**
+ * @template T
+ * @param {Iterable<[T,bigint,bigint]>} xyi
+ * @returns {T[]}
+ */
 const iterIntersection = xyi => {
   const result = [];
   for (const [m, xc, yc] of xyi) {
@@ -252,6 +277,11 @@ const iterIntersection = xyi => {
   return result;
 };
 
+/**
+ * @template T
+ * @param {Iterable<[T,bigint,bigint]>} xyi
+ * @returns {T[]}
+ */
 const iterDisjointSubtract = xyi => {
   const result = [];
   for (const [m, xc, yc] of xyi) {

diff --git a/packages/store/src/patterns/patternMatchers.js b/packages/store/src/patterns/patternMatchers.js
@@ -124,6 +124,11 @@ const checkIsWellFormedWithLimit = (
   );
 };
 
+/**
+ * @param {unknown} specimen
+ * @param {number} decimalDigitsLimit
+ * @param {Checker} check
+ */
 const checkDecimalDigitsLimit = (specimen, decimalDigitsLimit, check) => {
   if (
     Math.floor(Math.log10(Math.abs(Number(specimen)))) + 1 <=
@@ -821,7 +826,10 @@ const makePatternKit = () => {
       const { decimalDigitsLimit } = limit(limits);
       return (
         checkKind(specimen, 'bigint', check) &&
-        check(specimen >= 0n, X`${specimen} - Must be non-negative`) &&
+        check(
+          /** @type {bigint} */ (specimen) >= 0n,
+          X`${specimen} - Must be non-negative`,
+        ) &&
         checkDecimalDigitsLimit(specimen, decimalDigitsLimit, check)
       );
     },
@@ -845,7 +853,8 @@ const makePatternKit = () => {
       const { stringLengthLimit } = limit(limits);
       return (
         checkKind(specimen, 'string', check) &&
-        (specimen.length <= stringLengthLimit ||
+        // eslint-disable-next-line prettier/prettier -- JSDoc requires these parentheses!
+          (/** @type {string} */ (specimen).length <= stringLengthLimit ||
           check(
             false,
             X`string ${specimen} must not be bigger than ${stringLengthLimit}`,
@@ -890,7 +899,7 @@ const makePatternKit = () => {
         payload,
         harden([]),
         check,
-        'match:bigint payload',
+        'match:symbol payload',
       ),
 
     getRankCover: (_matchPayload, _encodePassable) =>
@@ -1054,7 +1063,8 @@ const makePatternKit = () => {
       const { arrayLengthLimit } = limit(limits);
       return (
         checkKind(specimen, 'copyArray', check) &&
-        (specimen.length <= arrayLengthLimit ||
+        // eslint-disable-next-line prettier/prettier -- JSDoc requires these parentheses!
+        (/** @type {Array} */ (specimen).length <= arrayLengthLimit ||
           check(
             false,
             X`Array length ${specimen.length} must be <= limit ${arrayLengthLimit}`,
@@ -1081,7 +1091,7 @@ const makePatternKit = () => {
       return (
         checkKind(specimen, 'copySet', check) &&
         check(
-          specimen.payload.length < numSetElementsLimit,
+          /** @type {Array} */ (specimen.payload).length < numSetElementsLimit,
           X`Set must not have more than ${q(numSetElementsLimit)} elements: ${
             specimen.payload.length
           }`,
@@ -1112,7 +1122,8 @@ const makePatternKit = () => {
       return (
         checkKind(specimen, 'copyBag', check) &&
         check(
-          specimen.payload.length <= numUniqueBagElementsLimit,
+          /** @type {Array} */ (specimen.payload).length <=
+            numUniqueBagElementsLimit,
           X`Bag must not have more than ${q(
             numUniqueBagElementsLimit,
           )} unique elements: ${specimen}`,
@@ -1152,7 +1163,8 @@ const makePatternKit = () => {
       return (
         checkKind(specimen, 'copyMap', check) &&
         check(
-          specimen.payload.keys.length <= numMapEntriesLimit,
+          /** @type {Array} */ (specimen.payload.keys).length <=
+            numMapEntriesLimit,
           X`CopyMap must have no more than ${q(
             numMapEntriesLimit,
           )} entries: ${specimen}`,
@@ -1254,6 +1266,10 @@ const makePatternKit = () => {
       );
     },
 
+    /**
+     * @param {Array} splitArray
+     * @param {Checker} check
+     */
     checkIsWellFormed: (splitArray, check) => {
       if (
         passStyleOf(splitArray) === 'copyArray' &&
@@ -1362,6 +1378,10 @@ const makePatternKit = () => {
       );
     },
 
+    /**
+     * @param {Array} splitArray
+     * @param {Checker} check
+     */
     checkIsWellFormed: (splitArray, check) => {
       if (
         passStyleOf(splitArray) === 'copyArray' &&

diff --git a/packages/store/src/stores/scalarWeakMapStore.js b/packages/store/src/stores/scalarWeakMapStore.js
@@ -61,7 +61,7 @@ export const makeWeakMapStoreMethods = (
       if (isCopyMap(entries)) {
         entries = getCopyMapEntries(entries);
       }
-      for (const [key, value] of entries) {
+      for (const [key, value] of /** @type {Iterable<[K, V]>} */ (entries)) {
         // Don't assert that the key either does or does not exist.
         assertKVOkToAdd(key, value);
         jsmap.set(key, value);

diff --git a/packages/store/src/stores/scalarWeakSetStore.js b/packages/store/src/stores/scalarWeakSetStore.js
@@ -45,7 +45,7 @@ export const makeWeakSetStoreMethods = (
       if (isCopySet(keys)) {
         keys = getCopySetKeys(keys);
       }
-      for (const key of keys) {
+      for (const key of /** @type {Iterable<K>} */ (keys)) {
         assertKeyOkToAdd(key);
         jsset.add(key);
       }