Way to disable printf-style feature temporarily

Open
#976 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
tooling

Research direction

Start with the printf-style formatter described in the README's Formatters section and trace how debug log arguments are processed. Reproduce the LIKE example and evaluate the requested per-call opt-out against the existing logging API. Done means a supported way to keep percent-prefixed SQL text literal without breaking current printf formatting.

Written by the indexing model from the issue text.

Description

We are seeing some interesting side-effect of the printf-style feature outlined here: https://github.com/sequelize/sequelize/issues/17448

Long story short, we are using debug to print SQL queries that are executed against database servers and whenever people use a like or ilike query in combination with % at the beginning, it sometimes happens that the logs show NaN. This happens when the search term starts with any of the printf-style characters, e.g. for something like SELECT * FROM foo WHERE name LIKE %fauzi%. The logs will then contain NaNauzi.

Would it be possible to force a debug log statement to ignore any printf formatting?

Something like:

const log = debug('sql')

log("%fauzi%", { printfFormatting: false})
Dominant language
JavaScript
Stars
11.5k
Forks
992
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from debug-js/debug

All issues in debug-js/debug

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.