Merge pull request #3574 from mwiencek/wbt-0.9

Upgrade weight-balanced-tree to v0.9.0

Author: mwiencek

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ on:
       - translations
 
 env:
-  TESTS_IMAGE_TAG: v-2025-06-12
+  TESTS_IMAGE_TAG: v-2025-06-16
 
 jobs:
   build-tests-image:

eslint.config.mjs

@@ -1040,6 +1040,7 @@ export default [
       'root/static/scripts/edit/components/ExternalLinkAttributeDialog.js',
       'root/static/scripts/edit/components/Multiselect.js',
       'root/static/scripts/edit/components/withLoadedTypeInfo.js',
+      'root/static/scripts/edit/utility/compactEntityJson.js',
       'root/static/scripts/edit/utility/reducerWithErrorHandling.js',
       'root/static/scripts/edit/utility/subfieldErrors.js',
       'root/static/scripts/guess-case/MB/GuessCase/Main.js',
@@ -1063,7 +1064,6 @@ export default [
       'root/static/scripts/url/edit.js',
       'root/user/UserProfile.js',
       'root/utility/chooseLayoutComponent.js',
-      'root/utility/compactEntityJson.js',
       'root/utility/tableColumns.js',
     ],
     rules: {

package.json

@@ -67,7 +67,7 @@
     "terser-webpack-plugin": "5.3.14",
     "webpack": "5.99.9",
     "webpack-node-externals": "3.0.0",
-    "weight-balanced-tree": "0.7.1",
+    "weight-balanced-tree": "0.9.0",
     "whatwg-fetch": "3.6.20",
     "yargs": "3.10.0"
   },

root/static/scripts/edit/externalLinks.js

@@ -14,10 +14,6 @@ import ko from 'knockout';
 import * as React from 'react';
 import * as ReactDOMClient from 'react-dom/client';
 
-import {
-  compactEntityJson,
-  decompactEntityJson,
-} from '../../../utility/compactEntityJson.js';
 import invariant from '../../../utility/invariant.js';
 import {
   EMPTY_PARTIAL_DATE,
@@ -60,6 +56,10 @@ import RelationshipPendingEditsWarning
 import RemoveButton from './components/RemoveButton.js';
 import URLInputPopover from './components/URLInputPopover.js';
 import withLoadedTypeInfo from './components/withLoadedTypeInfo.js';
+import {
+  compactEntityJson,
+  decompactEntityJson,
+} from './utility/compactEntityJson.js';
 import isPositiveInteger from './utility/isPositiveInteger.js';
 import isShortenedUrl from './utility/isShortenedUrl.js';
 import {stripAttributes} from './utility/linkPhrase.js';

root/utility/compactEntityJson.js …cripts/edit/utility/compactEntityJson.jsroot/utility/compactEntityJson.js renamed to root/static/scripts/edit/utility/compactEntityJson.js root/utility/compactEntityJson.js renamed to root/static/scripts/edit/utility/compactEntityJson.js

@@ -24,6 +24,8 @@ const functionToString: () => string =
   Function.prototype.toString;
 const objectCtorString: string = functionToString.call(Object);
 
+const UNDEFINED_INDEX = -1;
+
 function _indexValue(
   value: mixed,
   indexCache: Map<mixed, number>,
@@ -96,10 +98,13 @@ function _indexValue(
     }
     case 'bigint':
     case 'function':
-    case 'symbol':
-    case 'undefined': {
+    case 'symbol': {
       throw new Error(`Cannot convert ${typeof value} to JSON`);
     }
+    case 'undefined': {
+      // Handled via `UNDEFINED_INDEX`.
+      throw new Error('Unreachable');
+    }
   }
 
   result[index] = compactValue;
@@ -110,7 +115,9 @@ export function compactEntityJson(
   value: mixed,
 ): $ReadOnlyArray<mixed> {
   const result: Array<mixed> = [];
-  _indexValue(value, new Map(), result);
+  const indexCache = new Map<mixed, number>();
+  indexCache.set(undefined, UNDEFINED_INDEX);
+  _indexValue(value, indexCache, result);
   return result;
 }
 
@@ -125,6 +132,9 @@ export function decompactEntityJson(
   function _decompactIndex(
     index: number,
   ): mixed {
+    if (index === UNDEFINED_INDEX) {
+      return undefined;
+    }
     const value = compactedArray[index];
     if (typeof value === 'object' && value !== null) {
       const resolvedValue = resolved[index];

root/static/scripts/relationship-editor/components/DialogAttributes.js

@@ -165,9 +165,9 @@ export function createInitialState(
 
 function getLinkAttributesFromState(
   attributesList: DialogAttributesT,
-): tree.ImmutableTree<LinkAttrT> | null {
+): tree.ImmutableTree<LinkAttrT> {
   return attributesList.reduce((
-    accum: tree.ImmutableTree<LinkAttrT> | null,
+    accum: tree.ImmutableTree<LinkAttrT>,
     attributeState,
   ) => {
     switch (attributeState.control) {
@@ -235,7 +235,7 @@ function getLinkAttributesFromState(
       }
     }
     return accum;
-  }, null);
+  }, tree.empty);
 }
 
 export function reducer(

root/static/scripts/relationship-editor/components/DialogPreview.js

@@ -35,7 +35,7 @@ const createRelationshipTFromState = (
   const hasDates = linkType ? linkType.has_dates : true;
 
   return {
-    attributes: tree.toArray(relationship.attributes),
+    attributes: tree.toArray(relationship.attributes ?? tree.empty),
     backward,
     begin_date: hasDates ? relationship.begin_date : null,
     editsPending: relationship.editsPending,

root/static/scripts/relationship-editor/components/RelationshipDialogContent.js

@@ -182,7 +182,9 @@ export function createInitialState(props: PropsT): RelationshipDialogStateT {
   return {
     attributes: createDialogAttributesState(
       linkType,
-      getAttributeRootIdMap(tree.toArray(relationship.attributes)),
+      getAttributeRootIdMap(
+        tree.toArray(relationship.attributes ?? tree.empty),
+      ),
     ),
     backward,
     datePeriod: createDialogDatePeriodState(relationship),

root/static/scripts/relationship-editor/components/RelationshipEditor.js

@@ -18,7 +18,6 @@ import {
   onConflictUseGivenValue,
 } from 'weight-balanced-tree/update';
 
-import {decompactEntityJson} from '../../../../utility/compactEntityJson.js';
 import {INSTRUMENT_ROOT_ID, VOCAL_ROOT_ID} from '../../common/constants.js';
 import MB from '../../common/MB.js';
 import {
@@ -32,6 +31,7 @@ import {
   hasSessionStorage,
   sessionStorageWrapper,
 } from '../../common/utility/storage.js';
+import {decompactEntityJson} from '../../edit/utility/compactEntityJson.js';
 import reducerWithErrorHandling
   from '../../edit/utility/reducerWithErrorHandling.js';
 import {
@@ -183,9 +183,9 @@ export function createInitialState(
   const newState: {...RelationshipEditorStateT} = {
     dialogLocation: null,
     entity: source,
-    existingRelationshipsBySource: null,
+    existingRelationshipsBySource: tree.empty,
     reducerError: null,
-    relationshipsBySource: null,
+    relationshipsBySource: tree.empty,
   };
 
   if (source.relationships) {

root/static/scripts/relationship-editor/components/RelationshipItem.js

@@ -138,7 +138,7 @@ component _RelationshipItem(
     return bracketedText(
       displayLinkAttributesText(getPhraseAndExtraAttributesText(
         linkType,
-        tree.toArray(relationship.attributes),
+        tree.toArray(relationship.attributes ?? tree.empty),
         backward ? 'reverse_link_phrase' : 'link_phrase',
         canBeOrdered /* forGrouping */,
       )[1]),