Add config for updating max amount of table head depth (#2436)

Author: julieg18

README.md

@@ -150,6 +150,7 @@ These are the VS Code [settings] available for the Extension:
 | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `dvc.dvcPath`                          | Path or shell command to the DVC binary. Required unless Microsoft's [Python extension] is installed and the `dvc` package found in its environment. |
 | `dvc.pythonPath`                       | Path to the desired Python interpreter to use with DVC. Required when using a virtual environment.                                                   |
+| `dvc.expTableHeadMaxLayers`            | Maximum depth of experiment table head rows (minimum is 3).                                                                                          |
 | `dvc.doNotShowWalkthroughAfterInstall` | Do not prompt to show the Get Started page after installing. Useful for pre-configured development environments                                      |
 | `dvc.doNotRecommendRedHatExtension`    | Do not prompt to install the Red Hat YAML extension, which helps with DVC YAML schema validation (`dvc.yaml` and `.dvc` files).                      |
 | `dvc.doNotShowCliUnavailable`          | Do not warn when the workspace contains a DVC project but the DVC binary is unavailable.                                                             |

extension/package.json

@@ -554,6 +554,12 @@
           "type": "string",
           "default": null
         },
+        "dvc.expTableHeadMaxLayers": {
+          "title": "%config.expTableHeadMaxLayers.title%",
+          "description": "%config.expTableHeadMaxLayers.description%",
+          "type": "number",
+          "default": 5
+        },
         "dvc.pythonPath": {
           "title": "%config.pythonPath.title%",
           "description": "%config.pythonPath.description%",

extension/package.nls.json

@@ -84,6 +84,8 @@
   "config.doNotShowUnableToFilter.title": "Do not warn before disabling auto-apply filters to experiment selection.",
   "config.dvcPath.description": "Path or shell command to the DVC binary. Required unless Microsoft's Python extension is installed and the `dvc` package found in its environment.",
   "config.dvcPath.title": "DVC Path (or shell command)",
+  "config.expTableHeadMaxLayers.title": "Maximum depth of Experiment table head rows",
+  "config.expTableHeadMaxLayers.description": "Minimum is three.",
   "config.pythonPath.description": "Path to the desired Python interpreter to use with DVC. Required when using a virtual environment. Overrides any other extension's settings for this extension's purposes.",
   "config.pythonPath.title": "Python Interpreter"
 }

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

@@ -9,6 +9,8 @@ import workspaceChangesFixture from '../../../test/fixtures/expShow/workspaceCha
 import uncommittedDepsFixture from '../../../test/fixtures/expShow/uncommittedDeps'
 import { ExperimentsOutput } from '../../../cli/dvc/reader'
 
+jest.mock('../../../vscode/config')
+
 describe('collectColumns', () => {
   it('should return a value equal to the columns fixture when given the output fixture', () => {
     const columns = collectColumns(outputFixture)

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

@@ -1,21 +1,23 @@
 import { Column, ColumnType } from '../../webview/contract'
 import { Value } from '../../../cli/dvc/reader'
+import { ConfigKey, getConfigValue } from '../../../vscode/config'
+import { INITIAL_TABLE_HEAD_MAX_LAYERS } from '../consts'
 
 export type ColumnAccumulator = Record<string, Column>
 
-export const limitAncestorDepth = (
-  ancestors: string[],
-  sep: string,
-  limit = 5
-) => {
+export const limitAncestorDepth = (ancestors: string[], sep: string) => {
   const [path, ...rest] = ancestors
   /*
     The depth is only limited for the middle of the path array.
     The first and final layer are excluded, and the
     concatenated layer itself counts as one; because of this, we must subtract 3
     from what we want the final layer count to be.
   */
-  const convertedLimit = limit - 3
+  const collectedLimit =
+    Number(getConfigValue(ConfigKey.EXP_TABLE_HEAD_MAX_LAYERS)) ||
+    INITIAL_TABLE_HEAD_MAX_LAYERS
+
+  const convertedLimit = (collectedLimit >= 3 ? collectedLimit : 3) - 3
   if (rest.length <= convertedLimit) {
     return ancestors
   }

extension/src/experiments/columns/consts.ts

@@ -0,0 +1 @@
+export const INITIAL_TABLE_HEAD_MAX_LAYERS = 5

extension/src/experiments/columns/model.test.ts

@@ -16,6 +16,8 @@ import {
   columns as dataTypesColumns
 } from '../../test/fixtures/expShow/dataTypes'
 
+jest.mock('../../vscode/config')
+
 describe('ColumnsModel', () => {
   const exampleDvcRoot = 'test'
 

extension/src/experiments/index.ts

@@ -1,4 +1,10 @@
-import { Event, EventEmitter, Memento } from 'vscode'
+import {
+  ConfigurationChangeEvent,
+  Event,
+  EventEmitter,
+  Memento,
+  workspace
+} from 'vscode'
 import omit from 'lodash.omit'
 import { addStarredToColumns } from './columns/like'
 import { setContextForEditorTitleIcons } from './context'
@@ -32,6 +38,7 @@ import { Title } from '../vscode/title'
 import { createTypedAccumulator } from '../util/object'
 import { pickPaths } from '../path/selection/quickPick'
 import { Toast } from '../vscode/toast'
+import { ConfigKey } from '../vscode/config'
 
 export const ExperimentsScale = {
   ...omit(ColumnType, 'TIMESTAMP'),
@@ -123,6 +130,14 @@ export class Experiments extends BaseRepository<TableData> {
       })
     )
 
+    this.dispose.track(
+      workspace.onDidChangeConfiguration((event: ConfigurationChangeEvent) => {
+        if (event.affectsConfiguration(ConfigKey.EXP_TABLE_HEAD_MAX_LAYERS)) {
+          this.cliData.update()
+        }
+      })
+    )
+
     this.webviewMessages = this.createWebviewMessageHandler()
     this.setupInitialData()
     this.watchActiveEditor()

extension/src/vscode/config.ts

@@ -5,6 +5,7 @@ export enum ConfigKey {
   DO_NOT_SHOW_CLI_UNAVAILABLE = 'dvc.doNotShowCliUnavailable',
   DO_NOT_SHOW_WALKTHROUGH_AFTER_INSTALL = 'dvc.doNotShowWalkthroughAfterInstall',
   DO_NOT_SHOW_UNABLE_TO_FILTER = 'dvc.doNotShowUnableToFilter',
+  EXP_TABLE_HEAD_MAX_LAYERS = 'dvc.expTableHeadMaxLayers',
   DVC_PATH = 'dvc.dvcPath',
   PYTHON_PATH = 'dvc.pythonPath'
 }