-
Notifications
You must be signed in to change notification settings - Fork 21
refactor: reduce duplicate code in loggers, validation, and session handling #2790
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,27 +11,24 @@ import ( | |
|
|
||
| // Close Pattern for Logger Types | ||
| // | ||
| // All logger types in this package should implement their Close() method using this pattern: | ||
| // All logger types in this package implement their Close() method using the withLock | ||
| // helper to ensure consistent mutex handling: | ||
| // | ||
| // func (l *Logger) Close() error { | ||
| // l.mu.Lock() | ||
| // defer l.mu.Unlock() | ||
| // | ||
| // // Optional: Perform cleanup before closing (e.g., write footer) | ||
| // // if l.logFile != nil { | ||
| // // if err := writeCleanup(); err != nil { | ||
| // // return closeLogFile(l.logFile, &l.mu, "loggerName") | ||
| // // } | ||
| // // } | ||
| // | ||
| // return closeLogFile(l.logFile, &l.mu, "loggerName") | ||
| // return l.withLock(func() error { | ||
| // // Optional: Perform cleanup before closing (e.g., write footer) | ||
| // return closeLogFile(l.logFile, &l.mu, "loggerName") | ||
| // }) | ||
| // } | ||
| // | ||
| // The withLock helper (defined on each logger type) acquires the mutex, executes the | ||
| // callback, then releases the mutex — ensuring the lock is always released via defer. | ||
| // | ||
| // Why this pattern? | ||
| // | ||
| // 1. Mutex protection: Acquire lock at method entry to ensure thread-safe cleanup | ||
| // 2. Deferred unlock: Use defer to release lock even if errors occur | ||
| // 3. Optional cleanup: Logger-specific cleanup (like MarkdownLogger's footer) goes before closeLogFile | ||
| // 1. Consistent locking: withLock enforces acquire-on-enter / release-on-exit | ||
| // 2. Deferred unlock: Implemented inside withLock using defer, so it's never forgotten | ||
| // 3. Optional cleanup: Logger-specific cleanup (like MarkdownLogger's footer) goes inside the callback | ||
| // 4. Shared helper: Always delegate to closeLogFile() for consistent sync and close behavior | ||
| // 5. Error handling: Return errors from closeLogFile to indicate serious issues | ||
| // | ||
|
|
@@ -40,38 +37,28 @@ import ( | |
| // Simple Close() with no cleanup (FileLogger, JSONLLogger): | ||
| // | ||
| // func (fl *FileLogger) Close() error { | ||
| // fl.mu.Lock() | ||
| // defer fl.mu.Unlock() | ||
| // return closeLogFile(fl.logFile, &fl.mu, "file") | ||
| // return fl.withLock(func() error { | ||
| // return closeLogFile(fl.logFile, &fl.mu, "file") | ||
| // }) | ||
| // } | ||
| // | ||
| // Close() with custom cleanup (MarkdownLogger): | ||
| // | ||
| // func (ml *MarkdownLogger) Close() error { | ||
| // ml.mu.Lock() | ||
| // defer ml.mu.Unlock() | ||
| // | ||
| // if ml.logFile != nil { | ||
| // // Write closing details tag before closing | ||
| // footer := "\n</details>\n" | ||
| // if _, err := ml.logFile.WriteString(footer); err != nil { | ||
| // // Even if footer write fails, try to close the file properly | ||
| // return ml.withLock(func() error { | ||
| // if ml.logFile != nil { | ||
| // footer := "\n</details>\n" | ||
| // if _, err := ml.logFile.WriteString(footer); err != nil { | ||
| // return closeLogFile(ml.logFile, &ml.mu, "markdown") | ||
| // } | ||
| // return closeLogFile(ml.logFile, &ml.mu, "markdown") | ||
| // } | ||
| // | ||
| // // Footer written successfully, now close | ||
| // return closeLogFile(ml.logFile, &ml.mu, "markdown") | ||
| // } | ||
| // return nil | ||
| // return nil | ||
| // }) | ||
| // } | ||
| // | ||
| // This pattern is intentionally duplicated across logger types rather than abstracted: | ||
| // - It's a standard Go idiom for wrapper methods | ||
| // - The duplication is minimal (5-14 lines per type) | ||
| // - Each logger can customize cleanup as needed | ||
| // - The shared closeLogFile() helper eliminates complex logic duplication | ||
| // | ||
| // When adding a new logger type, follow this pattern to ensure consistent behavior. | ||
| // When adding a new logger type, add a withLock helper and follow this pattern to ensure | ||
| // consistent, safe Close() behavior. | ||
|
|
||
| // Initialization Pattern for Logger Types | ||
| // | ||
|
|
@@ -81,23 +68,21 @@ import ( | |
| // | ||
| // Standard Initialization Pattern: | ||
| // | ||
| // All logger types use the initLogger() generic helper function for initialization: | ||
| // All logger types use the initLogger() generic helper function for initialization. | ||
| // The setup and error-handler callbacks are defined as named package-level functions | ||
| // (e.g., setupFileLogger, handleFileLoggerError) to aid readability and testability: | ||
|
Comment on lines
+71
to
+73
|
||
| // | ||
| // func Init*Logger(logDir, fileName string) error { | ||
| // logger, err := initLogger( | ||
| // logDir, fileName, fileFlags, | ||
| // setupFunc, // Configure logger after file is opened | ||
| // errorHandler, // Handle initialization failures | ||
| // ) | ||
| // logger, err := initLogger(logDir, fileName, fileFlags, setup*Logger, handle*LoggerError) | ||
| // initGlobal*Logger(logger) | ||
| // return err | ||
| // } | ||
| // | ||
| // The initLogger() helper: | ||
| // 1. Attempts to create the log directory (if needed) | ||
| // 2. Opens the log file with specified flags (os.O_APPEND, os.O_TRUNC, etc.) | ||
| // 3. Calls setupFunc to configure the logger instance | ||
| // 4. On error, calls errorHandler to implement fallback behavior | ||
| // 3. Calls setup*Logger to configure the logger instance | ||
| // 4. On error, calls handle*LoggerError to implement fallback behavior | ||
| // 5. Returns the initialized logger and any error | ||
| // | ||
| // Fallback Behavior Strategies: | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The doc comment claims all logger types use a per-type
withLockhelper for Close(), but several logger types (e.g., ServerFileLogger, ToolsLogger's no-op Close) don’t follow this pattern. Please reword to either scope it to the specific loggers that implementwithLock(File/Markdown/JSONL/Tools) or adjust the guidance to cover exceptions accurately.