Add logging to detect if function app dir doesn't change (#758)

ejizba · web-flow · commit 48d991438f66 · 2024-09-10T14:19:05.000-07:00
diff --git a/src/AppContext.ts b/src/AppContext.ts
@@ -15,6 +15,10 @@ export interface LegacyRegisteredFunction extends RegisteredFunction {
 }
 
 export class AppContext {
+    functionAppDirectory: string | null | undefined;
+    constructor(functionAppDirectory: string | null | undefined) {
+        this.functionAppDirectory = functionAppDirectory;
+    }
     packageJson: PackageJson = {};
     /**
      * this hook data will be passed to (and set by) all hooks in all scopes
diff --git a/src/WorkerContext.ts b/src/WorkerContext.ts
@@ -10,7 +10,7 @@ import { IEventStream } from './GrpcClient';
 import { InvocationLogContext, LogHookContext } from './hooks/LogHookContext';
 
 class WorkerContext {
-    app = new AppContext();
+    app = new AppContext(undefined);
     defaultProgrammingModel?: ProgrammingModel;
 
     /**
@@ -54,8 +54,8 @@ class WorkerContext {
         }
     }
 
-    resetApp(): void {
-        this.app = new AppContext();
+    resetApp(functionAppDirectory: string | null | undefined): void {
+        this.app = new AppContext(functionAppDirectory);
         this.app.programmingModel = this.defaultProgrammingModel;
     }
 
diff --git a/src/eventHandlers/FunctionEnvironmentReloadHandler.ts b/src/eventHandlers/FunctionEnvironmentReloadHandler.ts
@@ -10,6 +10,7 @@ import { getWorkerMetadata } from './getWorkerMetadata';
 import LogCategory = rpc.RpcLog.RpcLogCategory;
 import LogLevel = rpc.RpcLog.Level;
 import CapabilitiesUpdateStrategy = rpc.FunctionEnvironmentReloadResponse.CapabilitiesUpdateStrategy;
+import * as path from 'path';
 
 /**
  * Environment variables from the current process
@@ -27,7 +28,27 @@ export class FunctionEnvironmentReloadHandler extends EventHandler<
     }
 
     async handleEvent(msg: rpc.IFunctionEnvironmentReloadRequest): Promise<rpc.IFunctionEnvironmentReloadResponse> {
-        worker.resetApp();
+        if (!msg.functionAppDirectory) {
+            worker.log({
+                message: `FunctionEnvironmentReload functionAppDirectory is not defined`,
+                level: LogLevel.Debug,
+                logCategory: LogCategory.System,
+            });
+        }
+
+        if (
+            worker.app.functionAppDirectory &&
+            msg.functionAppDirectory &&
+            isPathEqual(worker.app.functionAppDirectory, msg.functionAppDirectory)
+        ) {
+            worker.log({
+                message: `FunctionEnvironmentReload functionAppDirectory has not changed`,
+                level: LogLevel.Debug,
+                logCategory: LogCategory.System,
+            });
+        }
+
+        worker.resetApp(msg.functionAppDirectory);
 
         const response = this.getDefaultResponse(msg);
 
@@ -63,3 +84,7 @@ export class FunctionEnvironmentReloadHandler extends EventHandler<
         return response;
     }
 }
+
+function isPathEqual(path1: string, path2: string): boolean {
+    return path.relative(path1, path2) === '';
+}
diff --git a/src/eventHandlers/WorkerInitHandler.ts b/src/eventHandlers/WorkerInitHandler.ts
@@ -27,6 +27,15 @@ export class WorkerInitHandler extends EventHandler<'workerInitRequest', 'worker
     }
 
     async handleEvent(msg: rpc.IWorkerInitRequest): Promise<rpc.IWorkerInitResponse> {
+        if (!msg.functionAppDirectory) {
+            worker.log({
+                message: `WorkerInit functionAppDirectory is not defined`,
+                level: LogLevel.Debug,
+                logCategory: LogCategory.System,
+            });
+        }
+        worker.app.functionAppDirectory = msg.functionAppDirectory;
+
         const response = this.getDefaultResponse(msg);
 
         worker.log({
diff --git a/test/eventHandlers/FunctionEnvironmentReloadHandler.test.ts b/test/eventHandlers/FunctionEnvironmentReloadHandler.test.ts
@@ -38,7 +38,11 @@ describe('FunctionEnvironmentReloadHandler', () => {
                 functionAppDirectory: null,
             },
         });
-        await stream.assertCalledWith(msg.envReload.reloadEnvVarsLog(2), msg.envReload.response);
+        await stream.assertCalledWith(
+            msg.envReload.funcAppDirNotDefined,
+            msg.envReload.reloadEnvVarsLog(2),
+            msg.envReload.response
+        );
         expect(process.env.hello).to.equal('world');
         expect(process.env.SystemDrive).to.equal('Q:');
         expect(process.env.PlaceholderVariable).to.be.undefined;
@@ -56,7 +60,11 @@ describe('FunctionEnvironmentReloadHandler', () => {
                 functionAppDirectory: null,
             },
         });
-        await stream.assertCalledWith(msg.envReload.reloadEnvVarsLog(2), msg.envReload.response);
+        await stream.assertCalledWith(
+            msg.envReload.funcAppDirNotDefined,
+            msg.envReload.reloadEnvVarsLog(2),
+            msg.envReload.response
+        );
         expect(process.env.hello).to.equal('world');
         expect(process.env.SystemDrive).to.equal('Q:');
         expect(process.env.PlaceholderVariable).to.be.undefined;
@@ -80,7 +88,11 @@ describe('FunctionEnvironmentReloadHandler', () => {
                 functionAppDirectory: null,
             },
         });
-        await stream.assertCalledWith(msg.envReload.reloadEnvVarsLog(0), msg.envReload.response);
+        await stream.assertCalledWith(
+            msg.envReload.funcAppDirNotDefined,
+            msg.envReload.reloadEnvVarsLog(0),
+            msg.envReload.response
+        );
         expect(process.env).to.be.empty;
     });
 
@@ -92,7 +104,11 @@ describe('FunctionEnvironmentReloadHandler', () => {
                 functionAppDirectory: null,
             },
         });
-        await stream.assertCalledWith(msg.envReload.reloadEnvVarsLog(0), msg.envReload.response);
+        await stream.assertCalledWith(
+            msg.envReload.funcAppDirNotDefined,
+            msg.envReload.reloadEnvVarsLog(0),
+            msg.envReload.response
+        );
 
         stream.addTestMessage({
             requestId: 'testReqId',
@@ -108,7 +124,11 @@ describe('FunctionEnvironmentReloadHandler', () => {
                 functionAppDirectory: null,
             },
         });
-        await stream.assertCalledWith(msg.envReload.reloadEnvVarsLog(0), msg.envReload.response);
+        await stream.assertCalledWith(
+            msg.envReload.funcAppDirNotDefined,
+            msg.envReload.reloadEnvVarsLog(0),
+            msg.envReload.response
+        );
     });
 
     it('reloads environment variable and keeps cwd without functionAppDirectory', async () => {
@@ -123,7 +143,11 @@ describe('FunctionEnvironmentReloadHandler', () => {
                 functionAppDirectory: null,
             },
         });
-        await stream.assertCalledWith(msg.envReload.reloadEnvVarsLog(2), msg.envReload.response);
+        await stream.assertCalledWith(
+            msg.envReload.funcAppDirNotDefined,
+            msg.envReload.reloadEnvVarsLog(2),
+            msg.envReload.response
+        );
         expect(process.env.hello).to.equal('world');
         expect(process.env.SystemDrive).to.equal('Q:');
         expect(process.cwd() == cwd);
@@ -181,6 +205,7 @@ describe('FunctionEnvironmentReloadHandler', () => {
             },
         });
         await stream.assertCalledWith(
+            msg.envReload.funcAppDirNotChanged,
             msg.envReload.reloadEnvVarsLog(0),
             msg.envReload.changingCwdLog(testAppPath),
             msg.envReload.response
diff --git a/test/eventHandlers/TestEventStream.ts b/test/eventHandlers/TestEventStream.ts
@@ -102,7 +102,7 @@ export class TestEventStream extends EventEmitter implements IEventStream {
         await fs.writeFile(testPackageJsonPath, '{}');
 
         worker._hostVersion = undefined;
-        worker.resetApp();
+        worker.resetApp(this.originalCwd);
 
         // minor delay so that it's more likely extraneous messages are associated with this test as opposed to leaking into the next test
         await new Promise((resolve) => setTimeout(resolve, 20));
diff --git a/test/eventHandlers/msg.ts b/test/eventHandlers/msg.ts
@@ -193,6 +193,14 @@ export namespace msg {
             return msg.infoLog(`Changing current working directory to ${dir}`);
         }
 
+        export const funcAppDirNotDefined = msg.debugLog(
+            'FunctionEnvironmentReload functionAppDirectory is not defined'
+        );
+
+        export const funcAppDirNotChanged = msg.debugLog(
+            'FunctionEnvironmentReload functionAppDirectory has not changed'
+        );
+
         export const response = new RegExpStreamingMessage(
             {
                 requestId: 'testReqId',

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ import { IEventStream } from './GrpcClient';`
`10`	`10`	`import { InvocationLogContext, LogHookContext } from './hooks/LogHookContext';`
`11`	`11`
`12`	`12`	`class WorkerContext {`
`13`		`- app = new AppContext();`
	`13`	`+ app = new AppContext(undefined);`
`14`	`14`	`defaultProgrammingModel?: ProgrammingModel;`
`15`	`15`
`16`	`16`	`/**`
`@@ -54,8 +54,8 @@ class WorkerContext {`
`54`	`54`	`}`
`55`	`55`	`}`
`56`	`56`
`57`		`- resetApp(): void {`
`58`		`- this.app = new AppContext();`
	`57`	`+ resetApp(functionAppDirectory: string \| null \| undefined): void {`
	`58`	`+ this.app = new AppContext(functionAppDirectory);`
`59`	`59`	`this.app.programmingModel = this.defaultProgrammingModel;`
`60`	`60`	`}`
`61`	`61`
Original file line number	Diff line number	Diff line change
`@@ -193,6 +193,14 @@ export namespace msg {`
`193`	`193`	return msg.infoLog(`Changing current working directory to ${dir}`);
`194`	`194`	`}`
`195`	`195`
	`196`	`+ export const funcAppDirNotDefined = msg.debugLog(`
	`197`	`+ 'FunctionEnvironmentReload functionAppDirectory is not defined'`
	`198`	`+ );`
	`199`	`+`
	`200`	`+ export const funcAppDirNotChanged = msg.debugLog(`
	`201`	`+ 'FunctionEnvironmentReload functionAppDirectory has not changed'`
	`202`	`+ );`
	`203`	`+`
`196`	`204`	`export const response = new RegExpStreamingMessage(`
`197`	`205`	`{`
`198`	`206`	`requestId: 'testReqId',`