Add etc/no-assign-mutated-array rule

.eslintrc.js

@@ -102,6 +102,7 @@ module.exports = {
     camelcase: 'off',
     curly: ['error', 'all'],
     'etc/no-commented-out-code': 'error',
+    'etc/no-assign-mutated-array': 'error',
     'import/no-unresolved': 'off',
     'import/order': [
       'error',

extension/src/experiments/columns/collect/index.ts

@@ -15,6 +15,7 @@ import {
 } from '../../../cli/dvc/contract'
 import { standardizePath } from '../../../fileSystem/path'
 import { timestampColumn } from '../constants'
+import { sortCollectedArray } from '../../../util/array'
 
 const collectFromExperiment = (
   acc: ColumnAccumulator,
@@ -72,7 +73,7 @@ export const collectChanges = (data: ExperimentsOutput): string[] => {
   collectMetricAndParamChanges(changes, workspace, currentCommit)
   collectDepChanges(changes, workspace, currentCommit)
 
-  return changes.sort()
+  return sortCollectedArray(changes)
 }
 
 export const collectParamsFiles = (

extension/src/experiments/data/collect.test.ts

@@ -80,7 +80,10 @@ describe('collectFiles', () => {
       }
     } as ExperimentsOutput
 
-    expect(collectFiles(workspace, []).sort()).toStrictEqual([
+    const files = collectFiles(workspace, [])
+    files.sort()
+
+    expect(files).toStrictEqual([
       'further/nested/params.yaml',
       'logs.json',
       'metrics.json',

extension/src/experiments/model/filterBy/tree.ts

@@ -13,7 +13,11 @@ import { RegisteredCommands } from '../../../commands/external'
 import { InternalCommands } from '../../../commands/internal'
 import { sendViewOpenedTelemetryEvent } from '../../../telemetry'
 import { EventName } from '../../../telemetry/constants'
-import { definedAndNonEmpty, joinTruthyItems } from '../../../util/array'
+import {
+  definedAndNonEmpty,
+  joinTruthyItems,
+  sortCollectedArray
+} from '../../../util/array'
 import { createTreeView, getRootItem } from '../../../tree'
 import { Disposable } from '../../../class/dispose'
 
@@ -113,7 +117,7 @@ export class ExperimentsFilterByTree
         return this.getChildren(onlyRepo)
       }
 
-      return dvcRoots.sort((a, b) => a.localeCompare(b))
+      return sortCollectedArray(dvcRoots, (a, b) => a.localeCompare(b))
     }
 
     return []

extension/src/experiments/model/sortBy/tree.ts

@@ -7,6 +7,7 @@ import { sendViewOpenedTelemetryEvent } from '../../../telemetry'
 import { EventName } from '../../../telemetry/constants'
 import { InternalCommands } from '../../../commands/internal'
 import { Disposable } from '../../../class/dispose'
+import { sortCollectedArray } from '../../../util/array'
 
 export type SortItem = {
   dvcRoot: string
@@ -91,7 +92,7 @@ export class ExperimentsSortByTree
     return dvcRoots.some(
       dvcRoot => this.experiments.getRepository(dvcRoot).getSorts().length > 0
     )
-      ? dvcRoots.sort((a, b) => a.localeCompare(b))
+      ? sortCollectedArray(dvcRoots, (a, b) => a.localeCompare(b))
       : []
   }
 

extension/src/experiments/model/status/colors.ts

@@ -11,3 +11,6 @@ export const colorsList = [
 export type Color = (typeof colorsList)[number]
 
 export const copyOriginalColors = (): Color[] => [...colorsList]
+
+export const copyReverseOriginalColors = (): Color[] =>
+  [...colorsList].reverse()

extension/src/experiments/model/status/index.ts

@@ -23,7 +23,7 @@ const compareTimestamps = (a: Experiment, b: Experiment) =>
   getEpoch(b.Created) - getEpoch(a.Created)
 
 export const limitToMaxSelected = (experiments: Experiment[]) =>
-  experiments
+  [...experiments]
     .sort((a, b) => {
       if (a.status === b.status) {
         return compareTimestamps(a, b)

extension/src/experiments/model/tree.ts

@@ -16,7 +16,7 @@ import { getDataFromColumnPaths } from './util'
 import { WorkspaceExperiments } from '../workspace'
 import { sendViewOpenedTelemetryEvent } from '../../telemetry'
 import { EventName } from '../../telemetry/constants'
-import { definedAndNonEmpty } from '../../util/array'
+import { definedAndNonEmpty, sortCollectedArray } from '../../util/array'
 import {
   createTreeView,
   DecoratableTreeItemScheme,
@@ -176,7 +176,8 @@ export class ExperimentsTree
         const [onlyRepo] = dvcRoots
         return this.getChildren(onlyRepo)
       }
-      return dvcRoots.sort((a, b) => a.localeCompare(b))
+
+      return sortCollectedArray(dvcRoots, (a, b) => a.localeCompare(b))
     }
 
     return []

extension/src/fileSystem/index.ts

@@ -12,7 +12,7 @@ import {
 import { load } from 'js-yaml'
 import { Uri, workspace, window, commands, ViewColumn } from 'vscode'
 import { standardizePath } from './path'
-import { definedAndNonEmpty } from '../util/array'
+import { definedAndNonEmpty, sortCollectedArray } from '../util/array'
 import { Logger } from '../common/logger'
 import { gitPath } from '../cli/git/constants'
 import { createValidInteger } from '../util/number'
@@ -66,7 +66,8 @@ export const findDvcRootPaths = async (cwd: string): Promise<string[]> => {
   if (definedAndNonEmpty(subRoots)) {
     dvcRoots.push(...subRoots)
   }
-  return dvcRoots.sort()
+
+  return sortCollectedArray(dvcRoots)
 }
 
 export const findAbsoluteDvcRootPath = async (

extension/src/path/selection/tree.ts

@@ -12,7 +12,7 @@ import { WorkspacePlots } from '../../plots/workspace'
 import { Resource, ResourceLocator } from '../../resourceLocator'
 import { RegisteredCommands } from '../../commands/external'
 import { createTreeView } from '../../tree'
-import { definedAndNonEmpty } from '../../util/array'
+import { definedAndNonEmpty, sortCollectedArray } from '../../util/array'
 import { sendViewOpenedTelemetryEvent } from '../../telemetry'
 import { ViewOpenedEventName } from '../../telemetry/constants'
 import { Disposable } from '../../class/dispose'
@@ -179,7 +179,7 @@ export abstract class BasePathSelectionTree<
       return this.getChildren(onlyRepo)
     }
 
-    return dvcRoots.sort((a, b) => a.localeCompare(b))
+    return sortCollectedArray(dvcRoots, (a, b) => a.localeCompare(b))
   }
 
   private getChildElements(

extension/src/plots/data/collect.ts

@@ -4,7 +4,7 @@ import {
   PlotsOutputOrError
 } from '../../cli/dvc/contract'
 import { isDvcError } from '../../cli/dvc/reader'
-import { uniqueValues } from '../../util/array'
+import { sortCollectedArray, uniqueValues } from '../../util/array'
 import { isImagePlot, Plot, TemplatePlot } from '../webview/contract'
 
 const collectImageFile = (acc: string[], file: string): void => {
@@ -64,13 +64,16 @@ export const collectFiles = (
 export const collectMetricsFiles = (
   data: ExperimentsOutput,
   existingFiles: string[]
-): string[] =>
-  uniqueValues([
+): string[] => {
+  const metricsFiles = uniqueValues([
     ...Object.keys({
       ...data?.workspace?.baseline?.data?.metrics
     }).filter(Boolean),
     ...existingFiles
-  ]).sort()
+  ])
+
+  return sortCollectedArray(metricsFiles)
+}
 
 const collectRev = (acc: string[], rev: string): void => {
   if (rev !== EXPERIMENT_WORKSPACE_ID && !acc.includes(rev)) {
@@ -92,5 +95,5 @@ export const collectRevs = (
     collectRev(acc, mutableRevision)
   }
 
-  return [EXPERIMENT_WORKSPACE_ID, ...acc.sort()]
+  return [EXPERIMENT_WORKSPACE_ID, ...[...acc].sort()]
 }

extension/src/plots/multiSource/collect.ts

@@ -10,6 +10,7 @@ import {
 } from './constants'
 import { isImagePlot, Plot, TemplatePlot } from '../webview/contract'
 import { PlotsOutput } from '../../cli/dvc/contract'
+import { sortCollectedArray } from '../../util/array'
 
 const FIELD_SEPARATOR = '::'
 
@@ -163,7 +164,8 @@ const groupVariations = (
       lessValuesThanVariations,
       expectedOrder
     ),
-    valuesMatchVariations: valuesMatchVariations.sort(
+    valuesMatchVariations: sortCollectedArray(
+      valuesMatchVariations,
       (a, b) => expectedOrder.indexOf(a) - expectedOrder.indexOf(b)
     )
   }

extension/src/repository/model/tree.ts

@@ -209,7 +209,7 @@ export class RepositoriesTree
   }
 
   private sortDirectory(contents: PathItem[]) {
-    return contents.sort((a, b) => {
+    return [...contents].sort((a, b) => {
       const aIsDirectory = a.isDirectory
       if (aIsDirectory === b.isDirectory) {
         return a.resourceUri.fsPath.localeCompare(b.resourceUri.fsPath)
@@ -302,7 +302,10 @@ export class RepositoriesTree
           )
         }
 
-        const args = [dvcRoot, ...uniqueValues(tracked).sort()]
+        const uniqueTracked = uniqueValues(tracked)
+        uniqueTracked.sort()
+
+        const args = [dvcRoot, ...uniqueTracked]
 
         await tryThenMaybeForce(this.internalCommands, commandId, ...args)
       }

extension/src/setup/index.ts

@@ -226,8 +226,8 @@ export class Setup
 
   public async setRoots() {
     const nestedRoots = await this.findWorkspaceDvcRoots()
-    this.dvcRoots =
-      this.config.getFocusedProjects() || nestedRoots.flat().sort()
+    this.dvcRoots = this.config.getFocusedProjects() || nestedRoots.flat()
+    this.dvcRoots.sort()
 
     void this.sendDataToWebview()
     return this.setProjectAvailability()

extension/src/setup/quickPick.ts

@@ -1,3 +1,4 @@
+import { sortCollectedArray } from '../util/array'
 import { quickPickManyValues } from '../vscode/quickPick'
 import { Title } from '../vscode/title'
 import { Toast } from '../vscode/toast'
@@ -22,5 +23,6 @@ export const pickFocusedProjects = async (
     void Toast.showError('Cannot select 0 projects.')
     return
   }
-  return values.sort()
+
+  return sortCollectedArray(values)
 }

extension/src/test/e2e/extension.test.ts

@@ -13,6 +13,7 @@ import {
 } from './util.js'
 import { ExperimentsWebview } from './pageObjects/experimentsWebview.js'
 import { PlotsWebview } from './pageObjects/plotsWebview.js'
+import { sortCollectedArray } from '../../util/array.js'
 
 before('should finish loading the extension', async function () {
   this.timeout(240000)
@@ -190,6 +191,8 @@ describe('Source Control View', function () {
       }
     )
 
-    expect(expectedScmItemLabels.sort()).toStrictEqual(dvcTreeItemLabels.sort())
+    expect(sortCollectedArray(expectedScmItemLabels)).toStrictEqual(
+      sortCollectedArray(dvcTreeItemLabels)
+    )
   })
 })

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

@@ -1165,7 +1165,7 @@ suite('Experiments Test Suite', () => {
         .getSelectedRevisions()
         .map(({ id }) => id)
         .sort()
-      expect(selectExperimentIds).to.deep.equal(mockExperimentIds.sort())
+      mockExperimentIds.sort()
       expect(selectExperimentIds).to.deep.equal(mockExperimentIds)
     }).timeout(WEBVIEW_TEST_TIMEOUT)
 
@@ -1207,7 +1207,7 @@ suite('Experiments Test Suite', () => {
         .getSelectedRevisions()
         .map(({ id }) => id)
         .sort()
-      expect(selectExperimentIds).to.deep.equal(mockExperimentIds.sort())
+      expect(selectExperimentIds).to.deep.equal([...mockExperimentIds].sort())
       expect(mockShowPlots).to.be.calledOnce
       expect(mockShowPlots).to.be.calledWith(dvcDemoPath)
     }).timeout(WEBVIEW_TEST_TIMEOUT)

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

@@ -793,7 +793,9 @@ suite('Plots Test Suite', () => {
       expect(confusionMatrixDatapoints.length).to.be.greaterThan(0)
 
       expect(confusionMatrix.revisions?.length).to.equal(4)
-      expect(confusionMatrix.revisions?.sort()).to.deep.equal(expectedRevisions)
+      expect([...(confusionMatrix.revisions || [])].sort()).to.deep.equal(
+        expectedRevisions
+      )
 
       for (const entry of confusionMatrixDatapoints) {
         expect(expectedRevisions).to.include(entry.rev)

extension/src/util/array.ts

@@ -59,3 +59,11 @@ export const performSimpleOrderedUpdate = (
   ])
   return [...newOrder]
 }
+
+export const sortCollectedArray = <T>(
+  acc: T[],
+  callback?: (a: T, b: T) => number
+): T[] => {
+  acc.sort(callback)
+  return acc
+}

languageServer/src/textDocument.ts

@@ -99,18 +99,16 @@ const symbolScopeAt = (
       }
     }
   })
-  const symbolStack = (symbolsFound.filter(Boolean) as DocumentSymbol[]).sort(
-    (a, b) => {
-      const offA =
-        textDocument.offsetAt(a.range.end) -
-        textDocument.offsetAt(a.range.start)
-      const offB =
-        textDocument.offsetAt(b.range.end) -
-        textDocument.offsetAt(b.range.start)
-
-      return offB - offA // We want the tighter fits for last, so we can just pop them
-    }
-  )
+  const symbolStack = [
+    ...(symbolsFound.filter(Boolean) as DocumentSymbol[])
+  ].sort((a, b) => {
+    const offA =
+      textDocument.offsetAt(a.range.end) - textDocument.offsetAt(a.range.start)
+    const offB =
+      textDocument.offsetAt(b.range.end) - textDocument.offsetAt(b.range.start)
+
+    return offB - offA // We want the tighter fits for last, so we can just pop them
+  })
 
   return [...symbolStack]
 }

webview/src/test/tableDataFixture.ts

@@ -1,4 +1,4 @@
-import { copyOriginalColors } from 'dvc/src/experiments/model/status/colors'
+import { copyReverseOriginalColors } from 'dvc/src/experiments/model/status/colors'
 import {
   ExperimentStatus,
   Row,
@@ -60,10 +60,10 @@ export const setExperimentsAsSelected = (
   fixture: TableData,
   labelOrIds: string[]
 ) => {
-  let colors = copyOriginalColors().reverse()
+  let colors = copyReverseOriginalColors()
   const nextColor = () => {
     if (colors.length === 0) {
-      colors = copyOriginalColors().reverse()
+      colors = copyReverseOriginalColors()
     }
     return colors.pop()
   }

webview/src/util/ids.ts

@@ -12,4 +12,4 @@ export const createIDWithPrefixAndIndex = (
 export const getIDWithoutIndex = (id?: string) => id?.split(ID_SEPARATOR)[0]
 
 export const getIDIndex = (id: string) =>
-  Number.parseInt(id.split(ID_SEPARATOR).reverse()[0], 10)
+  Number.parseInt(id.split(ID_SEPARATOR).slice(-1)[0], 10)