feat: support configuration of output request logger options in .httpyac config (AnWeber/httpyac#467)

Author: AnWeber

CHANGELOG.md

@@ -1,3 +1,14 @@
+## [unreleased]
+
+### Features
+
+- support configuration of output request logger options in .httpyac config (Anweber/httpyac#467)
+- calculate average of timings for repeat (httpyac/httpyac.github.io#69)
+
+### Fixes
+
+- use `env` as default env dirname (Anweber/vscode-httpyac#198)
+
 ## [6.4.6]  (2023-06-09)
 
 ### Fixes

package.json

@@ -711,6 +711,11 @@
               "default": true,
               "description": "log response headers"
             },
+            "timings": {
+              "type": "boolean",
+              "default": false,
+              "description": "log timings"
+            },
             "responseBodyPrettyPrint": {
               "type": "boolean",
               "default": false,
@@ -1360,6 +1365,10 @@
         "fileMatch": ".httpyac.json",
         "url": "./schemas/httpyac-schema.json"
       },
+      {
+        "fileMatch": "httpyac.config.json",
+        "url": "./schemas/httpyac-schema.json"
+      },
       {
         "fileMatch": "http-client.env.json",
         "url": "./schemas/http-client.env-schema.json"

schemas/httpyac-schema.json

@@ -42,6 +42,57 @@
             },
             "supportAnsiColors": {
               "type": "boolean"
+            },
+            "options": {
+              "type": "object",
+              "properties": {
+                "useShort": {
+                  "type": "boolean",
+                  "default": false,
+                  "description": "log only request line and status line"
+                },
+                "requestOutput": {
+                  "type": "boolean",
+                  "default": true,
+                  "description": "log request"
+                },
+                "requestHeaders": {
+                  "type": "boolean",
+                  "default": true,
+                  "description": "log request headers"
+                },
+                "requestBodyLength": {
+                  "type": "number",
+                  "default": 1024,
+                  "description": "log request body character length"
+                },
+                "responseHeaders": {
+                  "type": "boolean",
+                  "default": true,
+                  "description": "log response headers"
+                },
+                "timings": {
+                  "type": "boolean",
+                  "default": false,
+                  "description": "log timings"
+                },
+                "responseBodyPrettyPrint": {
+                  "type": "boolean",
+                  "default": false,
+                  "description": "use pretty print output if available"
+                },
+                "responseBodyLength": {
+                  "type": "number",
+                  "default": 1024,
+                  "description": "log response body character length"
+                },
+                "onlyFailed": {
+                  "type": "boolean",
+                  "default": false,
+                  "description": "log only requests with failed tests"
+                }
+              },
+              "additionalProperties": false
             }
           },
           "additionalProperties": false
@@ -141,7 +192,13 @@
     },
     "LogLevel": {
       "type": "number",
-      "enum": [0, 2, 5, 10, 100]
+      "enum": [
+        0,
+        2,
+        5,
+        10,
+        100
+      ]
     },
     "Variables": {
       "type": "object",
@@ -166,4 +223,4 @@
       "additionalProperties": false
     }
   }
-}
+}

src/config.ts

@@ -45,7 +45,7 @@ export interface ResourceConfig {
   envDirName?: string;
   rootDir?: string;
   logLevel?: string;
-  logOutputChannelOptions?: httpyac.utils.RequestLoggerFactoryOptions;
+  logOutputChannelOptions?: httpyac.RequestLoggerFactoryOptions;
   logRequest?: boolean;
   useRegionScopedVariables?: boolean;
 }

src/documentStore.ts

@@ -1,13 +1,12 @@
 import {
   getConfigSetting,
   getEnvironmentConfig,
-  getResourceConfig,
   allHttpDocumentSelector,
   outputDocumentSelector,
   watchConfigSettings,
 } from './config';
 import { DocumentStore as IDocumentStore } from './extensionApi';
-import { getOutputChannel, logToOutputChannelFactory, logStream } from './io';
+import { logToOutputChannelFactory } from './io';
 import * as utils from './utils';
 import * as httpyac from 'httpyac';
 import * as vscode from 'vscode';
@@ -227,35 +226,6 @@ export class DocumentStore extends utils.DisposeProvider implements IDocumentSto
             logMethod: logToOutputChannelFactory('Console'),
           });
         }
-        const resourceConfig = getResourceConfig(context.httpFile.fileName);
-        if (resourceConfig.logRequest) {
-          const outputChannelLogResponse = httpyac.utils.requestLoggerFactory(
-            (arg: string) => {
-              const requestChannel = getOutputChannel('Request', 'http');
-              requestChannel.appendLine(arg);
-            },
-            resourceConfig.logOutputChannelOptions || {
-              requestOutput: true,
-              requestHeaders: true,
-              requestBodyLength: 1024,
-              responseHeaders: true,
-              responseBodyLength: 1024,
-            }
-          );
-          const logContextStream = context.logStream;
-          context.logStream = async (type, message) => {
-            await logStream(type, message);
-            if (logContextStream) {
-              await logContextStream?.(type, message);
-            }
-          };
-          const logResponse = context.logResponse;
-          context.logResponse = async (response, httpRegion) => {
-            await outputChannelLogResponse(response, httpRegion);
-            await logResponse?.(response, httpRegion);
-          };
-        }
-
         if (!context.config) {
           context.config = config;
         }

src/plugin/index.ts

@@ -1,2 +1,3 @@
 export * from './bailOnFailedTestInterceptor';
-export * from './vscodeHttpyacPLugin';
+export * from './outputChannelProvider';
+export * from './vscodeHttpyacPlugin';

src/plugin/outputChannelProvider.ts

@@ -0,0 +1,52 @@
+import * as httpyac from 'httpyac';
+import { ResourceConfig, getResourceConfig } from '../config';
+import { getOutputChannel, logStream } from '../io';
+
+
+export async function provideOutputChannelLogger(_env: string[] | undefined, context: httpyac.VariableProviderContext): Promise<httpyac.Variables> {
+
+  if (context.config && isProcessorContext(context)) {
+    const resourceConfig = getResourceConfig(context.httpFile.fileName);
+    if (resourceConfig.logRequest) {
+      const outputChannelLogResponse = httpyac.utils.requestLoggerFactory((arg: string) => {
+        const requestChannel = getOutputChannel('Request', 'http');
+        requestChannel.appendLine(arg);
+      }, getRequestLoggerOptions(resourceConfig, context.config));
+      const logContextStream = context.logStream;
+      context.logStream = async (type, message) => {
+        await logStream(type, message);
+        if (logContextStream) {
+          await logContextStream?.(type, message);
+        }
+      };
+      const logResponse = context.logResponse;
+      context.logResponse = async (response, httpRegion) => {
+        await outputChannelLogResponse(response, httpRegion);
+        await logResponse?.(response, httpRegion);
+      };
+    }
+  }
+
+  return {}
+}
+
+function isProcessorContext(context: unknown): context is httpyac.ProcessorContext {
+  const guard = context as httpyac.ProcessorContext;
+  return !!guard?.config;
+}
+
+function getRequestLoggerOptions(
+  resourceConfig: ResourceConfig,
+  config: httpyac.EnvironmentConfig
+): httpyac.RequestLoggerFactoryOptions | undefined {
+  if (resourceConfig.logOutputChannelOptions || config.log?.options) {
+    return Object.assign({}, resourceConfig.logOutputChannelOptions, config.log?.options);
+  }
+  return {
+    requestOutput: true,
+    requestHeaders: true,
+    requestBodyLength: 1024,
+    responseHeaders: true,
+    responseBodyLength: 1024,
+  };
+}

src/plugin/vscodeHttpyacPLugin.ts src/plugin/vscodeHttpyacPlugin.ts

@@ -1,8 +1,10 @@
 import { HttpyacHooksApi, io } from 'httpyac';
 import { bailOnFailedTestInterceptor } from './bailOnFailedTestInterceptor';
+import { provideOutputChannelLogger } from './outputChannelProvider';
 import * as vscode from 'vscode';
 
 export function registerVscodePlugins(api: HttpyacHooksApi) {
   api.hooks.execute.addInterceptor(bailOnFailedTestInterceptor);
+  api.hooks.provideVariables.addHook('provideOutputChannelLogger', provideOutputChannelLogger);
   io.javascriptProvider.require.vscode = vscode;
 }