feat(cap): add warnOnMissingContext config key to silence warn logs

Fixes #12

Author: Xstoudi

.changeset/free-drinks-swim.md

@@ -0,0 +1,5 @@
+---
+"@adogrove/adonis-auditing": minor
+---
+
+Add `warnOnMissingContext` config key to silence missing http context warning logs

docs/packages/auditing/configuration/general-configuration.md

@@ -6,6 +6,7 @@ Auditing configuration is located in the `config/auditing.ts` file. By default,
 import { defineConfig } from '@adogrove/adonis-auditing/setup'
 
 export default defineConfig({
+  warnOnMissingContext: true,
   userResolver: () => import('#audit_resolvers/user_resolver'),
   resolvers: {
     ip_address: () => import('#audit_resolvers/ip_address_resolver'),
@@ -15,8 +16,11 @@ export default defineConfig({
 })
 ```
 
-## User resolver
+## `warnOnMissingContext`
+When set to `true` (default), the auditing manager will log a warning when it cannot get the current context. This can happen if `asyncLocalStorage` is not enabled.
+
+## `userResolver`
 User resolver, under the `userResolver` key, is a special resolver that is used to resolve the user who is responsible for the action. By default, it is set to `() => import('#audit_resolvers/user_resolver')`. You can change it to your custom resolver if needed.
 
-## Resolvers
+## `resolvers`
 Resolvers, under the `resolvers` key, are used to resolve complementary metadata for the audit log. By default, there are three resolvers: `ip_address`, `user_agent`, and `url`. You can add your custom resolvers if needed. 

packages/auditing/src/define_config.ts

@@ -14,6 +14,7 @@ export function defineConfig(
       }),
     )
     return {
+      warnOnMissingContext: config.warnOnMissingContext ?? true,
       userResolver: new userResolver.default(),
       resolvers: Object.fromEntries(resolversMap),
     }

packages/auditing/src/manager.ts

@@ -10,10 +10,13 @@ export default class AuditingManager implements AuditingService {
 
   async getUserForContext(): Promise<{ id: string; type: string } | null> {
     const ctx = HttpContext.get()
-    if (!ctx) {
-      this.logger.warn(
-        'Cannot get current context, did you forget to enable asyncLocalStorage?',
-      )
+    if (ctx === null) {
+      if (this.config.warnOnMissingContext) {
+        this.logger.warn(
+          'Cannot get current context, did you forget to enable asyncLocalStorage?',
+        )
+      }
+
       return null
     }
 
@@ -22,10 +25,13 @@ export default class AuditingManager implements AuditingService {
 
   async getMetadataForContext(): Promise<Record<string, unknown>> {
     const ctx = HttpContext.get()
-    if (!ctx) {
-      this.logger.warn(
-        'Cannot get current context, did you forget to enable asyncLocalStorage?',
-      )
+    if (ctx === null) {
+      if (this.config.warnOnMissingContext) {
+        this.logger.warn(
+          'Cannot get current context, did you forget to enable asyncLocalStorage?',
+        )
+      }
+
       return {}
     }
 

packages/auditing/src/types.ts

@@ -9,11 +9,13 @@ export interface Resolver {
 }
 
 export interface AuditingConfig {
+  warnOnMissingContext?: boolean
   userResolver: () => Promise<{ default: new () => UserResolver }>
   resolvers: Record<string, () => Promise<{ default: new () => Resolver }>>
 }
 
 export interface ResolvedAuditingConfig {
+  warnOnMissingContext: boolean
   userResolver: UserResolver
   resolvers: Record<string, Resolver>
 }

packages/auditing/stubs/config.stub

@@ -4,6 +4,7 @@
 import { defineConfig } from '@adogrove/adonis-auditing'
 
 export default defineConfig({
+  warnOnMissingContext: true,
   userResolver: () => import('#audit_resolvers/user_resolver'),
   resolvers: {
     ip_address: () => import('#audit_resolvers/ip_address_resolver'),