Start TensorBoard sessions with user-level python.tensorBoard.logDirectory (#15588)

Author: joyceerhl

news/1 Enhancements/15476.md

@@ -0,0 +1 @@
+Add optional user-level `python.tensorBoard.logDirectory` setting. When starting a TensorBoard session, use this setting if it is present instead of prompting the user to select a log directory.

package.json

@@ -1650,6 +1650,11 @@
                     "default": "",
                     "scope": "resource"
                 },
+                "python.tensorBoard.logDirectory": {
+                    "type": "string",
+                    "description": "Set this setting to your preferred TensorBoard log directory to skip log directory prompt when starting TensorBoard.",
+                    "scope": "application"
+                },
                 "python.terminal.activateEnvironment": {
                     "type": "boolean",
                     "default": true,

src/client/common/configSettings.ts

@@ -40,6 +40,7 @@ import {
     ILoggingSettings,
     IPythonSettings,
     ISortImportSettings,
+    ITensorBoardSettings,
     ITerminalSettings,
     IWorkspaceSymbolSettings,
     LoggingLevelSettingType,
@@ -119,6 +120,8 @@ export class PythonSettings implements IPythonSettings {
 
     public autoComplete!: IAutoCompleteSettings;
 
+    public tensorBoard: ITensorBoardSettings | undefined;
+
     public testing!: ITestingSettings;
 
     public terminal!: ITerminalSettings;
@@ -582,6 +585,7 @@ export class PythonSettings implements IPythonSettings {
         }
 
         this.insidersChannel = pythonSettings.get<ExtensionChannels>('insidersChannel')!;
+        this.tensorBoard = pythonSettings.get<ITensorBoardSettings>('tensorBoard');
     }
 
     // eslint-disable-next-line class-methods-use-this

src/client/common/types.ts

@@ -212,6 +212,11 @@ export interface IPythonSettings {
     readonly defaultInterpreterPath: string;
     readonly logging: ILoggingSettings;
     readonly useIsolation: boolean;
+    readonly tensorBoard: ITensorBoardSettings | undefined;
+}
+
+export interface ITensorBoardSettings {
+    readonly logDirectory: string | undefined;
 }
 export interface ISortImportSettings {
     readonly path: string;

src/client/tensorBoard/tensorBoardSession.ts

@@ -74,7 +74,7 @@ export class TensorBoardSession {
         if (!tensorBoardWasInstalled) {
             return;
         }
-        const logDir = await this.askUserForLogDir();
+        const logDir = await this.getLogDirectory();
         if (!logDir) {
             return;
         }
@@ -251,7 +251,15 @@ export class TensorBoardSession {
     // Display a quickpick asking the user to acknowledge our autopopulated log directory or
     // select a new one using the file picker. Default this to the folder that is open in
     // the editor, if any, then the directory that the active text editor is in, if any.
-    private async askUserForLogDir(): Promise<string | undefined> {
+    private async getLogDirectory(): Promise<string | undefined> {
+        // See if the user told us to always use a specific log directory
+        const setting = this.workspaceService.getConfiguration('python.tensorBoard');
+        const settingValue = setting.get<string>('logDirectory');
+        if (settingValue) {
+            traceInfo(`Using log directory specified by python.tensorBoard.logDirectory setting: ${settingValue}`);
+            return settingValue;
+        }
+        // No log directory in settings. Ask the user which directory to use
         const logDir = this.autopopulateLogDirectoryPath();
         const useCurrentWorkingDirectory = TensorBoard.useCurrentWorkingDirectory();
         const selectAFolder = TensorBoard.selectAFolder();

src/test/tensorBoard/tensorBoardSession.test.ts

@@ -2,7 +2,7 @@ import { assert } from 'chai';
 import Sinon, * as sinon from 'sinon';
 import { SemVer } from 'semver';
 import { anything } from 'ts-mockito';
-import { IApplicationShell, ICommandManager } from '../../client/common/application/types';
+import { workspace, WorkspaceConfiguration } from 'vscode';
 import {
     IExperimentService,
     IInstaller,
@@ -11,6 +11,7 @@ import {
     ProductInstallStatus,
 } from '../../client/common/types';
 import { Common, TensorBoard } from '../../client/common/utils/localize';
+import { IApplicationShell, ICommandManager } from '../../client/common/application/types';
 import { IServiceManager } from '../../client/ioc/types';
 import { TensorBoardEntrypoint, TensorBoardEntrypointTrigger } from '../../client/tensorBoard/constants';
 import { TensorBoardSession } from '../../client/tensorBoard/tensorBoardSession';
@@ -43,6 +44,8 @@ suite('TensorBoard session creation', async () => {
     let commandManager: ICommandManager;
     let experimentService: IExperimentService;
     let installer: IInstaller;
+    let initialValue: string | undefined;
+    let workspaceConfiguration: WorkspaceConfiguration;
 
     suiteSetup(function () {
         if (process.env.CI_PYTHON_VERSION === '2.7') {
@@ -69,9 +72,13 @@ suite('TensorBoard session creation', async () => {
         applicationShell = serviceManager.get<IApplicationShell>(IApplicationShell);
         commandManager = serviceManager.get<ICommandManager>(ICommandManager);
         installer = serviceManager.get<IInstaller>(IInstaller);
+        workspaceConfiguration = workspace.getConfiguration('python.tensorBoard');
+        initialValue = workspaceConfiguration.get('logDirectory');
+        await workspaceConfiguration.update('logDirectory', undefined, true);
     });
 
     teardown(async () => {
+        await workspaceConfiguration.update('logDirectory', initialValue, true);
         await closeActiveWindows();
         sandbox.restore();
     });
@@ -408,4 +415,24 @@ suite('TensorBoard session creation', async () => {
             assert.ok(session.panel?.visible, 'Webview panel not shown, expected successful session creation');
         });
     });
+    test('If python.tensorBoard.logDirectory is provided, do not prompt user to pick a log directory', async () => {
+        const selectDirectoryStub = sandbox
+            .stub(applicationShell, 'showQuickPick')
+            .resolves({ label: TensorBoard.useCurrentWorkingDirectory() });
+        errorMessageStub = sandbox.stub(applicationShell, 'showErrorMessage');
+        await workspaceConfiguration.update('logDirectory', 'logs/fit', true);
+
+        const session = (await commandManager.executeCommand(
+            'python.launchTensorBoard',
+            TensorBoardEntrypoint.palette,
+            TensorBoardEntrypointTrigger.palette,
+        )) as TensorBoardSession;
+
+        assert.ok(session.panel?.visible, 'Expected successful session creation but webpanel not shown');
+        assert.ok(errorMessageStub.notCalled, 'Expected successful session creation but error message was shown');
+        assert.ok(
+            selectDirectoryStub.notCalled,
+            'Prompted user to select log directory although setting was specified',
+        );
+    });
 });