Logger constants refactored, format argument added, better formatting of failed (non) equality assertions

[skelly37]

Description

I have (hopefully) simplified the log.nu internal structure and added customizable log format for all log commands

User-Facing Changes

• Replaced constants with env records for:
  • ansi (newly added)
  • log level
  • prefix
  • short prefix
• Added format argument to all log commands
• Assertions for (not) equality (equal, not equal, greater, lesser...) now put left and right values inside ' quotes, so the assertions for strings are more meaningful
• Documented the %-formatting of log messages

Tests + Formatting

After Submitting

[skelly37]

I think that lib.rs or mod.nu does some nasty stuff to the env, so now the log.nu is not parsed correctly. The feature seems to work correctly. Could anyone help me?

[skelly37]

TODO:

• Tests for correctness of default env values (e.g. $env.LOG_LEVEL.CRITICAL == 50)
• Tests proving that log * commands can be affected by modifying env (e.g. modifying $env.LOG_FORMAT affects the output)
• Tests proving correctness of the --format flag
• Tests for the updated log custom
• Documentation for the %-formatting of logs (e.g. %MSG%)
• Update annotations for --help
• Probably do something about mod.nu, lib.rs and env_exporter.nu workaround
• Think about some unification possibilites regarding exported log custom & internal log-formatted
• Self-review
• Remove draft 😅

[amtoine]

i did not have a close look at everything:

• the env_reporter.nu file
• the log.nu module
• the tests

wanted to make sure this was ok before moving too far in the PR 😉

[amtoine]

@skelly37
this looks better to me so i'll let you finish the PR 😌

try to keep it not too big if possible, to make the review as easy as possible 🤞

[skelly37]

@skelly37
this looks better to me so i'll let you finish the PR 😌

try to keep it not too big if possible, to make the review as easy as possible 🤞

Sure, you see the TODO

Only last test case and self-review are left :)

[amtoine]

Sure, you see the TODO

Only last test case and self-review are left :)

ohhh yes, great 😊

[skelly37]

@amtoine I think it's ready for review. I suggest reading log.nu in IDE instead of github diff, as it was deeply refactored and needs reading it as a whole :)

[amtoine]

doing it right now... ♻️

[amtoine]

coooool, thanks for this quite big refactoring, i think it looks better and i like the use of env variables better ✨

a few remarks

• a thread about the errors in std log custom
• in the tests, could we have a single now, format-message and run-command instead of duplicating them across test modules?
• a thread about logger_env_test_config.nu

we're close 🤞

[skelly37]

Regarding the code duplication: I have moved now and format-message to a separate file, but I think that the command runners differ too much to actually benefit from moving them to one place.

[amtoine]

Regarding the code duplication: I have moved now and format-message to a separate file, but I think that the command runners differ too much to actually benefit from moving them to one place.

great that looks better 😌

i've refactored the error a tiny bit

• it's in a command so that all the same errors look the same
• it looks like the following now, instead of having all the values and tips on the same "error" line at the top

> use std
> std log custom "msg" "%MSG%" 21
Error:   × Cannot deduce level prefix for given log level: 21.
   ╭─[entry #2:1:1]
 1 │ std log custom "msg" "%MSG%" 21
   ·                              ─┬
   ·                               ╰── Invalid log level.
        Available log levels in $env.LOG_LEVEL:
            CRITICAL: 50
            ERROR: 40
            WARNING: 30
            INFO: 20
            DEBUG: 10

   ╰────

[amtoine]

woopsie, my bad, that's a dumb error => working on it... ♻️

[skelly37]

Thanks for the patch & review, @amtoine!

With my last commit I think we're ready, aren't we? 😋

[amtoine]

Thanks for the patch & review, @amtoine!

anytime 😌

With my last commit I think we're ready, aren't we? yum

yeah, i think this is in good shape 😋

let's land this 🥳