Merge branch 'main' of github.mathworks.com:development/matlab-language-server

Author: dklilley

src/lifecycle/MatlabCommunicationManager.d.ts

@@ -21,11 +21,12 @@ declare class MatlabCommunicationManager {
      * @param launchCommand The command with which MATLAB is launched
      * @param launchArguments The arguments with which MATLAB is launched
      * @param logDirectory The directory in which MATLAB should log data
+     * @param environmentVariables The additional set of environment variables which needs to be passed to the MATLAB process
      *
      * @returns Information about the new MATLAB process and the connection to it.
      * Returns null if the MATLAB process cannot be started.
      */
-    launchNewMatlab(launchCommand: string, launchArguments: string[], logDirectory: string): MatlabProcessInfo | null;
+    launchNewMatlab(launchCommand: string, launchArguments: string[], logDirectory: string, environmentVariables?: NodeJS.ProcessEnv): MatlabProcessInfo | null;
     /**
      * Attempts to connect to an existing instance of MATLAB at the given URL.
      *

src/lifecycle/MatlabCommunicationManager.js

@@ -14,6 +14,7 @@ import * as os from 'os'
 import * as path from 'path'
 import { EventEmitter } from 'events'
 import { checkIfMatlabDeprecated } from "../utils/DeprecationUtils";
+import { getProxyEnvironmentVariables } from "../utils/ProxyUtils";
 
 interface MatlabStartupInfo {
     pid: number
@@ -84,7 +85,10 @@ export async function launchNewMatlab (): Promise<MatlabSession> {
         // Launch MATLAB process
         Logger.log('Launching MATLAB...')
         const { command, args } = await getMatlabLaunchCommand(outFile)
-        const matlabProcessInfo = MatlabCommunicationManager.launchNewMatlab(command, args, Logger.logDir)
+        const envVars: NodeJS.ProcessEnv = {
+            ...getProxyEnvironmentVariables()
+        } 
+        const matlabProcessInfo = MatlabCommunicationManager.launchNewMatlab(command, args, Logger.logDir, envVars)
 
         if (matlabProcessInfo == null) {
             // Error occurred while spawning MATLAB process

src/lifecycle/MatlabSession.ts

@@ -20,8 +20,11 @@ import FoldingSupportProvider from './providers/folding/FoldingSupportProvider'
 import ClientConnection from './ClientConnection'
 import PathResolver from './providers/navigation/PathResolver'
 import Indexer from './indexing/Indexer'
+import { cacheAndClearProxyEnvironmentVariables } from './utils/ProxyUtils'
 
 export async function startServer () {
+    cacheAndClearProxyEnvironmentVariables()
+
     // Create a connection for the server
     const connection = ClientConnection.getConnection()
 

src/server.ts

@@ -0,0 +1,54 @@
+// Copyright 2024 The MathWorks, Inc.
+
+interface ProxyEnvironmentVariables {
+    HTTP_PROXY?: string
+    HTTPS_PROXY?: string
+    NO_PROXY?: string
+}
+
+const proxyEnvironmentVariables: ProxyEnvironmentVariables = {}
+
+/**
+ * Workaround for connection issue with proxy environments: cache values for HTTP_PROXY,
+ * HTTPS_PROXY, and NO_PROXY environment variables, then delete variables from environment.
+ */
+export function cacheAndClearProxyEnvironmentVariables (): void {
+    const http_proxy = process.env.HTTP_PROXY ?? process.env.http_proxy
+    const https_proxy = process.env.HTTPS_PROXY ?? process.env.https_proxy
+    const no_proxy = process.env.NO_PROXY ?? process.env.no_proxy
+    delete process.env.HTTP_PROXY
+    delete process.env.http_proxy
+    delete process.env.HTTPS_PROXY
+    delete process.env.https_proxy
+    delete process.env.NO_PROXY
+    delete process.env.no_proxy
+
+    if (http_proxy != null) {
+        proxyEnvironmentVariables.HTTP_PROXY = http_proxy
+    }
+    if (https_proxy != null) {
+        proxyEnvironmentVariables.HTTPS_PROXY = https_proxy
+    }
+    if (no_proxy != null) {
+        proxyEnvironmentVariables.NO_PROXY = no_proxy
+    }
+}
+
+/**
+ * Determines if running within a proxy environment.
+ * 
+ * @returns True if within a proxy environment, false otherwise
+ */
+export function isProxyEnvironment (): boolean {
+    return Object.keys(proxyEnvironmentVariables).length > 0
+}
+
+/**
+ * Gets any proxy environment variables and their values that had been set prior to
+ * `cacheAndClearProxyEnvironmentVariables` being called.
+ * 
+ * @returns An object containing any proxy-related environment variables and their values
+ */
+export function getProxyEnvironmentVariables (): ProxyEnvironmentVariables {
+    return proxyEnvironmentVariables
+}