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?

[btlghrants]

"LogAs" seems kinda limited to me. 🤔

We talked about this being a general purpose feature that could / would (essentially) carry a label for any given callback around throughout the Pepr system, right? As it stands, the only place we're currently showing callback function names is in the log messages but that's not all we think can / will be done with this IMO, and I'd like to try to avoid handicapping ourselves by giving it an overly limiting name.

What would you say to naming this something that hinted at a more general usage? Something like:

• Alias()
• Designation()
• Handle()
• or maybe simply, As()

All of those give a good sense of what we want this new func to be thought of as without necessarily limiting it to logs.

[cmwylie19]

Interesting prospect here, not opposed by any means. Where else other than logs do you see this name being used?

[cmwylie19]

We like Alias because a user who has not read the docs is most likely to interpret this as a name.

• Pepr Sync

[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