zwave-js / zwave-js-ui / 22992250849

18%

push

github

fix: prevent logging to file when log is disabled (#4590)

- [x] Understand the issue: When "Log enabled" is off but "Log to file"
was previously enabled, log files are still created
- [x] Identify root cause in `api/lib/logger.ts`: The `customTransports`
function creates a file transport when `logToFile` is true, regardless
of whether `enabled` is false
- [x] Fix the `customTransports` function to not create file transport
when logging is disabled
- [x] Fix the incorrect hint text in Settings.vue
(`store/zwave-js-ui_%DATE%.log` should be `store/log/z-ui_%DATE%.log`)
- [x] Update tests to verify the fix
- [x] Run tests and linting to verify changes
- [x] Code review completed - no issues found
- [x] Security scan (CodeQL) completed - no issues found
- [x] Address PR feedback: Swap condition order to check `enabled`
before `logToFile`

<!-- START COPILOT ORIGINAL PROMPT -->



<details>

<summary>Original prompt</summary>

> 
> ----
> 
> *This section details on the original issue you should resolve*
> 
> <issue_title>Logging to file can occur while "Log enabled" is
off</issue_title>
> <issue_description>### Checklist
> 
> - [x] I am not using Home Assistant. Or: a developer has told me to
come here.
> - [x] I have checked the troubleshooting section and my problem is not
described there.
> - [x] I have read the changelog and my problem is not mentioned there.
> 
> ### Deploy method
> 
> Home Assistant Add-on
> 
> ### Z-Wave JS UI version
> 
> 11.12.0
> 
> ### ZwaveJS version
> 
> 15.21.0
> 
> ### Describe the bug
> 
> When "Log to file" is enabled under Settings -> General and "Log
enabled" is turned off, the "Log to file" option disappears, but remains
enabled, and new logs will be created in the store.
> 
> Also, and I'm not sure if this is Z-Wave JS App specific or not, the
text under the "Log to file" option incorrectly says "Store logs in a
file. Default: store/zwave-js-ui_%DATE%.log" The actual file names used
are more like store/log/z-ui_%DATE%... (continued)

335 of 445 branches covered (75.28%)

Branch coverage included in aggregate %.

1 of 1 new or added line in 1 file covered. (100.0%)

4054 of 23538 relevant lines covered (17.22%)

1.09 hits per line