feat: add logging macro

[TropicalDog17]

• [x] resolves #187
• [x] follows contribution guide
• [x] code change includes tests

Guide to be added in README.md of the logging package

Prequiste for using log! macro for a package:

• import this as a dependency in Scarb.toml

  [dependencies]
  `raito_macros = { path = "../macros" }`

• add the features in Scarb.toml

  [features]
  default = [log_level_none]
  log_level_none = []
  log_level_trace = []
  log_level_debug = []

• add the logging.cairo(must be this name) file to the package root, like the package/consensus

# packages/consensus/src/logging.cairo
#[cfg(feature: 'log_level_trace')]
pub const LOG_LEVEL_TRACE: bool = true;

#[cfg(feature: 'log_level_trace')]
pub const LOG_LEVEL_DEBUG: bool = true;

#[cfg(feature: 'log_level_debug')]
pub const LOG_LEVEL_TRACE: bool = false;

#[cfg(feature: 'log_level_debug')]
pub const LOG_LEVEL_DEBUG: bool = true;

#[cfg(feature: 'log_level_none')]
pub const LOG_LEVEL_TRACE: bool = false;

#[cfg(feature: 'log_level_none')]
pub const LOG_LEVEL_DEBUG: bool = false;

• in lib.cairo

pub mod logging;

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
raito	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 25, 2024 2:36pm

[maciejka]

How is it going @TropicalDog17? It seems like this one is close to be finished.

[TropicalDog17]

How is it going @TropicalDog17? It seems like this one is close to be finished.

Yeah @maciejka I think these feature-based constants cannot be imported from an external package, I tried some workaround but it's no luck, maybe the language hasn't supported that feature yet. It appears that for the logging feature to work correctly, the constant file needs to be placed within the specific package where we want to enable logging.

[maciejka]

Please check: https://github.com/keep-starknet-strange/raito/pull/224. I had to try it myself. Indeed there is a problem with conditional compilation in a multipackage project. Waiting for scarb developers response.

[maciejka]

Please check: #224. I had to try it myself. Indeed there is a problem with conditional compilation in a multipackage project. Waiting for scarb developers response.

[maciejka]

Please check: #224. I had to try it myself. Indeed there is a problem with conditional compilation in a multipackage project. Waiting for scarb developers response.

Which means we might need to wait until they implement it.

[TropicalDog17]

Please check: #224. I had to try it myself. Indeed there is a problem with conditional compilation in a multipackage project. Waiting for scarb developers response.

Which means we might need to wait until they implement it.

yeah I see, and very weird that the language server still recognize that feature.

[maciejka]

yeah I see, and very weird that the language server still recognize that feature.

true

[maciejka]

I am closing it for now. We will need to revisit this issue once feature support in Scarb is more mature. The work with my small fixes is parked in branch: feat/logging-macro

[maciejka]

@TropicalDog17 please contact me on tg: @aundumla