Plot experiments in the order they were selected (#2137)

* order plot revisions by selected color

* add text to the test to prevent regressions

Author: mattseddon

extension/src/experiments/model/index.ts

@@ -23,7 +23,11 @@ import {
 } from './status'
 import { collectFlatExperimentParams } from './modify/collect'
 import { Experiment, Row } from '../webview/contract'
-import { definedAndNonEmpty, reorderListSubset } from '../../util/array'
+import {
+  definedAndNonEmpty,
+  reorderListSubset,
+  reorderObjectList
+} from '../../util/array'
 import { ExperimentsOutput } from '../../cli/reader'
 import { setContextValue } from '../../vscode/context'
 import { hasKey } from '../../util/object'
@@ -592,6 +596,10 @@ export class ExperimentsModel extends ModelWithPersistence {
       }
     }
 
-    return acc
+    return reorderObjectList<SelectedExperimentWithColor>(
+      copyOriginalColors(),
+      acc,
+      'displayColor'
+    )
   }
 }

extension/src/test/suite/experiments/index.test.ts

@@ -1247,11 +1247,17 @@ suite('Experiments Test Suite', () => {
       const selected = testRepository
         .getSelectedExperiments()
         .map(({ displayColor, id }) => ({ displayColor, id }))
-      expect(selected).to.deep.equal([
-        { displayColor: colors[1], id: 'test-branch' },
+      expect(
+        selected,
+        'should retain the order that the experiments were selected in'
+      ).to.deep.equal([
         {
           displayColor: colors[0],
           id: 'exp-83425'
+        },
+        {
+          displayColor: colors[1],
+          id: 'test-branch'
         }
       ])
     })

extension/src/util/array.ts

@@ -21,7 +21,8 @@ export const sameContents = (
   otherArray: (null | string | number | undefined)[]
 ) => isEqual(array.sort(), otherArray.sort())
 
-export const reorderObjectList = <T extends { [key: string]: unknown }>(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const reorderObjectList = <T extends { [key: string]: any }>(
   order: string[],
   items: T[],
   compareKey: string