Potential fix for config options crash (microsoft#6889)

* Potential fix for config options crash * Fix problem with json stringifying a map
judej · Jan 3, 2024 · 38b51fa · 38b51fa
1 parent bd13735
commit 38b51fa
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/packages/pyright-internal/src/backgroundAnalysisBase.ts b/packages/pyright-internal/src/backgroundAnalysisBase.ts
@@ -18,6 +18,7 @@ import {
     InitializationData,
     LogData,
     createConfigOptionsFrom,
+    createJsonObjectFrom,
     getBackgroundWaiter,
     run,
 } from './backgroundThreadBase';
@@ -55,7 +56,8 @@ export class BackgroundAnalysisBase {
     }
 
     setConfigOptions(configOptions: ConfigOptions) {
-        this.enqueueRequest({ requestType: 'setConfigOptions', data: configOptions });
+        const passable = createJsonObjectFrom(configOptions);
+        this.enqueueRequest({ requestType: 'setConfigOptions', data: passable });
     }
 
     setTrackedFiles(fileUris: Uri[]) {
@@ -219,7 +221,7 @@ export class BackgroundAnalysisBase {
             }
 
             default:
-                debug.fail(`${msg.requestType} is not expected`);
+                debug.fail(`${msg.requestType} is not expected. Message structure: ${JSON.stringify(msg)}`);
         }
     }
 
@@ -453,7 +455,7 @@ export abstract class BackgroundAnalysisRunnerBase extends BackgroundThreadBase
             }
 
             default: {
-                debug.fail(`${msg.requestType} is not expected`);
+                debug.fail(`${msg.requestType} is not expected. Message structure: ${JSON.stringify(msg)}`);
             }
         }
     }

diff --git a/packages/pyright-internal/src/backgroundThreadBase.ts b/packages/pyright-internal/src/backgroundThreadBase.ts
@@ -93,6 +93,13 @@ export class BackgroundThreadBase {
     }
 }
 
+export function createJsonObjectFrom(configOptions: ConfigOptions): any {
+    return {
+        ...JSON.parse(JSON.stringify(configOptions)),
+        defineConstant: configOptions.defineConstant, // This is the only field that can't be stringified.
+    };
+}
+
 export function createConfigOptionsFrom(jsonObject: any): ConfigOptions {
     const configOptions = new ConfigOptions(Uri.fromJsonObj(jsonObject.projectRoot));
     const getFileSpec = (fileSpec: any): FileSpec => {