chore: named callbacks ADR

[cmwylie19]

Description

Pepr is a system of callbacks that produce logs. The callbacks are anonymous, so debugging which log comes from which callback can be confusing unless you manually write a name in the log message from within the callback. This consideration needs an ADR.

Related Issue

Fixes #675

Relates to #

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Other (security config, docs update, etc)

Checklist before merging

• Test, docs, adr added or updated as needed
• Contributor Guide Steps followed

[jeff-mccoy]

Could you show a compete example of what this would look like?

[cmwylie19]

Was chatting with @brandtkeller about a Lula use-case where they need to validate that certain policies exist and it seems like this could be a useful mechanism to tell a compliance tool what a binding is responsible for.

When(a.Pod)
  .IsCreatedOrUpdated()
  .Validate(po => {
  // reject is running as root, or is privileged, etc
   })
  .Alias("reject:pods:runAsRoot:privileged:runAsGroup<10:allowPrivilegeEscalation")

going to go ahead and get this prioritized because the Lula team needs it.

[cmwylie19]

We need to verify that we are able to inject the name of the .Alias into logs of the callback function.

If it were possible it would need to be done with the Log object

const Log = pino({
  transport,
  timestamp: pinoTimeFunction,
});

and import that into the mutate processor and set

Log.prefix = the bindings alias

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.71%. Comparing base (26b4e95) to head (9028c61).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #676   +/-   ##
=======================================
  Coverage   85.71%   85.71%           
=======================================
  Files          26       26           
  Lines        1008     1008           
  Branches      212      197   -15     
=======================================
  Hits          864      864           
- Misses        133      142    +9     
+ Partials       11        2    -9     

see 3 files with indirect coverage changes

[schaeferka]

The new Alias function matches what is described in the ADR

[schaeferka]

Accepted

[cmwylie19]

approved, just changed status to accepted!