Extend scope of "python.tensorBoard.logDirectory" and support variable substitution (microsoft#20103)

Fixes microsoft/vscode-jupyter#8802

Credit: @PillarsZhang
[patch-by-zhang](https://github.com/PillarsZhang/vscode-python/tree/patch-by-zhang)

Co-authored-by: Evan Philip <[email protected]>

Author: evanphilip

package.json

@@ -1023,7 +1023,7 @@
                 "python.tensorBoard.logDirectory": {
                     "default": "",
                     "description": "%python.tensorBoard.logDirectory.description%",
-                    "scope": "application",
+                    "scope": "resource",
                     "type": "string"
                 },
                 "python.terminal.activateEnvInCurrentTerminal": {

src/client/common/configSettings.ts

@@ -504,7 +504,13 @@ export class PythonSettings implements IPythonSettings {
                   optOutFrom: [],
               };
 
-        this.tensorBoard = pythonSettings.get<ITensorBoardSettings>('tensorBoard');
+        const tensorBoardSettings = systemVariables.resolveAny(
+            pythonSettings.get<ITensorBoardSettings>('tensorBoard'),
+        )!;
+        this.tensorBoard = tensorBoardSettings || { logDirectory: '' };
+        if (this.tensorBoard.logDirectory) {
+            this.tensorBoard.logDirectory = getAbsolutePath(this.tensorBoard.logDirectory, workspaceRoot);
+        }
     }
 
     // eslint-disable-next-line class-methods-use-this

src/client/common/types.ts

@@ -205,7 +205,7 @@ export interface IPythonSettings {
 }
 
 export interface ITensorBoardSettings {
-    readonly logDirectory: string | undefined;
+    logDirectory: string | undefined;
 }
 export interface ISortImportSettings {
     readonly path: string;

src/client/tensorBoard/tensorBoardSession.ts

@@ -35,6 +35,7 @@ import {
     ProductInstallStatus,
     Product,
     IPersistentState,
+    IConfigurationService,
 } from '../common/types';
 import { createDeferred, sleep } from '../common/utils/async';
 import { Common, TensorBoard } from '../common/utils/localize';
@@ -100,6 +101,7 @@ export class TensorBoardSession {
         private readonly applicationShell: IApplicationShell,
         private readonly globalMemento: IPersistentState<ViewColumn>,
         private readonly multiStepFactory: IMultiStepInputFactory,
+        private readonly configurationService: IConfigurationService,
     ) {}
 
     public get onDidDispose(): Event<TensorBoardSession> {
@@ -341,10 +343,10 @@ export class TensorBoardSession {
     // the editor, if any, then the directory that the active text editor is in, if any.
     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');
+        const settings = this.configurationService.getSettings();
+        const settingValue = settings.tensorBoard?.logDirectory;
         if (settingValue) {
-            traceInfo(`Using log directory specified by python.tensorBoard.logDirectory setting: ${settingValue}`);
+            traceInfo(`Using log directory resolved by python.tensorBoard.logDirectory setting: ${settingValue}`);
             return settingValue;
         }
         // No log directory in settings. Ask the user which directory to use

src/client/tensorBoard/tensorBoardSessionProvider.ts

@@ -9,7 +9,13 @@ import { IApplicationShell, ICommandManager, IWorkspaceService } from '../common
 import { Commands } from '../common/constants';
 import { ContextKey } from '../common/contextKey';
 import { IPythonExecutionFactory } from '../common/process/types';
-import { IDisposableRegistry, IInstaller, IPersistentState, IPersistentStateFactory } from '../common/types';
+import {
+    IDisposableRegistry,
+    IInstaller,
+    IPersistentState,
+    IPersistentStateFactory,
+    IConfigurationService,
+} from '../common/types';
 import { IMultiStepInputFactory } from '../common/utils/multiStepInput';
 import { IInterpreterService } from '../interpreter/contracts';
 import { traceError, traceInfo } from '../logging';
@@ -42,6 +48,7 @@ export class TensorBoardSessionProvider implements IExtensionSingleActivationSer
         @inject(IPythonExecutionFactory) private readonly pythonExecFactory: IPythonExecutionFactory,
         @inject(IPersistentStateFactory) private stateFactory: IPersistentStateFactory,
         @inject(IMultiStepInputFactory) private readonly multiStepFactory: IMultiStepInputFactory,
+        @inject(IConfigurationService) private readonly configurationService: IConfigurationService,
     ) {
         this.preferredViewGroupMemento = this.stateFactory.createGlobalPersistentState<ViewColumn>(
             PREFERRED_VIEWGROUP,
@@ -102,6 +109,7 @@ export class TensorBoardSessionProvider implements IExtensionSingleActivationSer
                 this.applicationShell,
                 this.preferredViewGroupMemento,
                 this.multiStepFactory,
+                this.configurationService,
             );
             newSession.onDidChangeViewState(() => this.updateTensorBoardSessionContext(), this, this.disposables);
             newSession.onDidDispose((e) => this.didDisposeSession(e), this, this.disposables);