only clear mod component debug logs if logValues is enabled

pixiebrix · Oct 3, 2024 · 9ad3f0f · 9ad3f0f
1 parent 5926ec2
commit 9ad3f0f
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 16 deletions.
diff --git a/src/contentScript/contentScriptPlatform.ts b/src/contentScript/contentScriptPlatform.ts
@@ -270,11 +270,17 @@ class ContentScriptPlatform extends PlatformBase {
 
   override get debugger(): PlatformProtocol["debugger"] {
     return {
-      async clear(componentId: UUID): Promise<void> {
-        await Promise.all([
-          traces.clear(componentId),
-          clearModComponentDebugLogs(componentId),
-        ]);
+      async clear(
+        componentId: UUID,
+        { logValues }: { logValues: boolean },
+      ): Promise<void> {
+        const clearPromises = [traces.clear(componentId)];
+
+        if (logValues) {
+          clearPromises.push(clearModComponentDebugLogs(componentId));
+        }
+
+        await Promise.all(clearPromises);
       },
       traces: {
         enter: traces.addEntry,

diff --git a/src/extensionPages/extensionPagePlatform.ts b/src/extensionPages/extensionPagePlatform.ts
@@ -69,11 +69,17 @@ class ExtensionPagePlatform extends PlatformBase {
   // Support tracing for bricks run in the sidebar and clearing logs in Page Editor/Extension Console. See PanelBody.tsx
   override get debugger(): PlatformProtocol["debugger"] {
     return {
-      async clear(componentId: UUID): Promise<void> {
-        await Promise.all([
-          traces.clear(componentId),
-          clearModComponentDebugLogs(componentId),
-        ]);
+      async clear(
+        componentId: UUID,
+        { logValues }: { logValues: boolean },
+      ): Promise<void> {
+        const clearPromises = [traces.clear(componentId)];
+
+        if (logValues) {
+          clearPromises.push(clearModComponentDebugLogs(componentId));
+        }
+
+        await Promise.all(clearPromises);
       },
       traces: {
         enter: traces.addEntry,

diff --git a/src/platform/platformTypes/debuggerProtocol.ts b/src/platform/platformTypes/debuggerProtocol.ts
@@ -39,7 +39,10 @@ export interface DebuggerProtocol {
    *
    * @param componentId the mod component id
    */
-  clear: (componentId: UUID) => Promise<void>;
+  clear: (
+    componentId: UUID,
+    { logValues }: { logValues: boolean },
+  ) => Promise<void>;
 
   traces: TraceProtocol;
 }
diff --git a/src/runtime/reducePipeline.ts b/src/runtime/reducePipeline.ts
@@ -257,6 +257,14 @@ type RunBrickOptions = CommonOptions & {
   trace: TraceMetadata;
 };
 
+async function getLogValues(
+  logValues: RunBrickOptions["logValues"] | undefined,
+): Promise<boolean> {
+  const globalLoggingConfig = await getLoggingConfig();
+
+  return logValues ?? globalLoggingConfig.logValues ?? false;
+}
+
 /**
  * Get the lexical environment for running a pipeline. Currently, we're just tracking on the pipeline arg itself.
  * https://en.wikipedia.org/wiki/Closure_(computer_programming)
@@ -456,11 +464,9 @@ async function renderBrickArg(
 ): Promise<RenderedArgs> {
   const { config, type } = resolvedConfig;
 
-  const globalLoggingConfig = await getLoggingConfig();
-
   const {
     // If logValues not provided explicitly, default to the global setting
-    logValues = globalLoggingConfig.logValues ?? false,
+    logValues = await getLogValues(options.logValues),
     logger,
     explicitArg,
     explicitDataFlow,
@@ -637,7 +643,6 @@ async function applyReduceDefaults({
   Partial<ReduceOptions>,
   "modComponentRef"
 >): Promise<ReduceOptions> {
-  const globalLoggingConfig = await getLoggingConfig();
   const logger = providedLogger ?? new ConsoleLogger();
 
   return {
@@ -652,7 +657,7 @@ async function applyReduceDefaults({
     explicitDataFlow: false,
     extendModVariable: false,
     // If logValues not provided explicitly, default to the global setting
-    logValues: logValues ?? globalLoggingConfig.logValues ?? false,
+    logValues: await getLogValues(logValues),
     // For stylistic consistency, default here instead of destructured parameters
     branches: [],
     // NOTE: do not set runId here. It should be set by the starter brick explicitly, or implicitly generated
@@ -960,6 +965,7 @@ export async function reduceModComponentPipeline(
       // `await` promise to avoid race condition where the calls here delete entries from this call to reducePipeline
       await platform.debugger.clear(
         partialOptions.modComponentRef.modComponentId,
+        { logValues: await getLogValues(partialOptions.logValues) },
       );
     } catch {
       // NOP