feat: allow runtime debugging specific app(s)

[susnux]

• Resolves Allow debug logging that can be enabled / disabled #894

This allows setting a window global variable (__NC_LOGGER_DEBUG__)
to an array of app ids for which the logger will enforce the debug logging level.

#894 convinced me that this is really handy, I personally have also two use cases for this as debugging will be a lot easier then :)

[codecov]

Codecov Report

❌ Patch coverage is 75.86207% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.54%. Comparing base (64f252b) to head (e79fc17).

Files with missing lines	Patch %	Lines
lib/ConsoleLogger.ts	41.66%	6 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #908      +/-   ##
==========================================
- Coverage   98.46%   90.54%   -7.93%     
==========================================
  Files           4        5       +1     
  Lines          65       74       +9     
  Branches       13       16       +3     
==========================================
+ Hits           64       67       +3     
- Misses          0        6       +6     
  Partials        1        1              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[ShGKme]

Could you show what Max's or mine code example in that issue would look like with this implementation?

[ShGKme]

Does it mean there is no feature support like in the linked issue, but only per-app support?
So if you want to have a debug flag for a specific feature, you need to call it another app, correct?

[ShGKme]

In the issue the proposal was to have an object with boolean flags. It's quite convenient because:

1. You see the list of the flags that can be enabled/disabled
2. You can just toggle true/false

in contrast, with the array of strings:

1. You need to know the strings
2. There are no "add"/"remove" operations in the array. Only via conversion to a Set.

[ShGKme]

Also, why make it a __BUILD_TIME_CONST__ or _private_variable_ like and not a public?

[susnux]

Basically the idea is not to break existing loggers and need for refactoring your code base.
But instead allow to selectively enable debug logging for specific apps instead of all apps that would flood the logs.

Also, why make it a BUILD_TIME_CONST or private_variable like and not a public?

Reduce risks here to break anything as this is a global variable.
Alternative would be to move to OCA but then only OCA.Core would be kind of safe, as other name spaces could be used by an app (e.g. proposed OCA.Logger could be used by an app called logger).

[ShGKme]

Basically the idea is not to break existing loggers and need for refactoring your code base.

Was @max-nextcloud proposal breaking?

[susnux]

Like you have to create a new logger that what I meant (as described below I might have a different use case)

[susnux]

Maybe this is not 100% what you had in mind?
My use case is to enable debug for one app but ignore other apps.

Maybe this could be changed a bit to also allow "sub-loggers" if that is what you wanted:
Like

const scopedLogger = logger.getDebugLogger('scope')

// ...
scopedLogger.debug(...)

Where the implementation is just to pass scope to the sub-loggers context.scope state.

So that the usage would be (imagine global log level is warn):

logger.debug('debug foo')
scopedLogger.debug('bar')
// output: *no output because global state is only warning*

window.NC_LOGGER.app.scope = true
logger.debug('debug foo')
scopedLogger.debug('bar')
// output: 'debug foo'

// But also debug for all log messages of that app:
window.NC_LOGGER.app = true
logger.debug('debug foo')
scopedLogger.debug('bar')
// output: 'debug foo' 'bar'

Here the nice thing is this could also work without having to create many loggers per feature, but just pass context directly:

window.NC_LOGGER.my_app.dav = true

logger.debug('scoped', { scope: 'dav' })
logger.debug('non scoped')
// output: 'scoped'

[ShGKme]

Maybe this is not 100% what you had in mind?

• What I have in mind is Allow debug logging that can be enabled / disabled #894

The issue is about having an optional feature-specified debug logger, allowing your apps to have heavily logged features that can be optionally enabled.

That is also the same we would like to have in Talk, for example, because we need not "entire Talk" logging to be disabled, but specific parts. Same as Office apps, we have heavily used networking, for example.

[max-nextcloud]

Thanks for looking into this @susnux .

What you are laying out in #908 (comment)
sounds like it would cover all use cases.

I'm not sure how well this would work with prefilling the data structure for autocompletion:

window.NC_LOGGER.my_app.dav = true

We could set NC_LOGGER.my_app to false as soon as a logger for the app is created. But for the scope we would need to change that to { dav: false }. This would work nicely with autocomplete until one sets NC_LOGGER.my_app to true or false. But this is really just for convenience and I don't see any way around it without making it way more complex.

[susnux]

this would work nicely with autocomplete until one sets NC_LOGGER.my_app to true or false.

maybe just add then a .all scope