chore(logs): support AR_IO_SDK_LOG_LEVEL #273
Conversation
This gives us better debug support when tracing down potential network process issues
|
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 eslint
error @permaweb/[email protected]: The engine "yarn" is incompatible with this module. Expected version "please-use-npm". Got "1.22.22" 📝 WalkthroughWalkthroughThe pull request introduces a new configuration mechanism for controlling the logging level of the AR.IO SDK across the application. This is achieved by adding an environment variable Changes
Sequence DiagramsequenceDiagram
participant Env as Environment
participant Config as config.ts
participant System as system.ts
participant SDK as AR.IO SDK
Env->>Config: Set AR_IO_SDK_LOG_LEVEL
Config->>System: Provide log level configuration
System->>SDK: Configure log level via ARIOLogger
The sequence diagram illustrates how the logging level configuration flows from the environment through the configuration and is ultimately set in the AR.IO SDK. Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
src/config.ts (1)
419-422: LGTM! Consider documenting valid log levels.The implementation follows the established pattern and uses a safe default value.
Consider adding a comment documenting the valid log level values that the AR.IO SDK supports, to help other developers configure logging appropriately.
src/system.ts (1)
101-101: Consider improving type safety for log level setting.The use of
as anytype assertion suggests that the log level values aren't properly typed.Consider defining an enum or union type for valid log levels to improve type safety:
type LogLevel = 'none' | 'error' | 'warn' | 'info' | 'debug' | 'trace'; ARIOLogger.default.setLogLevel(config.AR_IO_SDK_LOG_LEVEL as LogLevel);
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docker-compose.yaml(1 hunks)src/config.ts(1 hunks)src/system.ts(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: test (macos-latest)
- GitHub Check: test (ubuntu-latest)
🔇 Additional comments (2)
src/system.ts (1)
21-21: LGTM! Clean import with clear alias.The Logger import is properly aliased as ARIOLogger to avoid naming conflicts.
docker-compose.yaml (1)
82-82: LGTM! Environment variable properly configured.The AR_IO_SDK_LOG_LEVEL environment variable is correctly configured with a matching default value of 'none'.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #273 +/- ##
===========================================
+ Coverage 71.81% 71.82% +0.01%
===========================================
Files 37 37
Lines 9298 9303 +5
Branches 537 537
===========================================
+ Hits 6677 6682 +5
Misses 2617 2617
Partials 4 4 ☔ View full report in Codecov by Sentry. |
This gives us better debug support when tracing down potential network process issues