Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation and Case Sensitivity #28

Open
shellscape opened this issue Oct 2, 2020 · 2 comments
Open

Documentation and Case Sensitivity #28

shellscape opened this issue Oct 2, 2020 · 2 comments
Labels
good first issue Good for newcomers

Comments

@shellscape
Copy link

One of the things that threw me for a loop while giving the redact feature a spin in pino was the fact that it's not documented whether or not the redaction paths are case sensitive.

It turns out that they are. That makes it extremely burdensome to construct a comprehensive list for redacting logs across a wide organization. Consider socialsecuritynumber and the variations possible:

socialsecuritynumber
socialSecuritynumber
socialsecurityNumber
socialSecurityNumber

The argument here might be "well this is a code quality issue that should be caught or prevented," and that would be well justified. But across large orgs with varying teams, varying levels of skill, oversight, and caring, asserting code quality isn't a reasonable assertion.

First and foremost, the documentation needs to be updated to reflect the current state - paths are case-sensitive.

I'd love to see some consideration given to allowing for the search to be case-insensitive.

@mcollina
Copy link
Collaborator

mcollina commented Oct 2, 2020

Would you like to send a Pull Request to address this issue? Remember to add unit tests.

@jsumners jsumners added the good first issue Good for newcomers label Oct 2, 2020
@shellscape
Copy link
Author

(for reference only, cross-linking my reply here pinojs/pino#915 (comment) which is relevant to the ask)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants