Skip to content

debug: add logging for .agents files in SettingSync list#1

Open
LLQWQ wants to merge 1 commit into
Go1c:masterfrom
LLQWQ:fix/setting-sync-debug-log
Open

debug: add logging for .agents files in SettingSync list#1
LLQWQ wants to merge 1 commit into
Go1c:masterfrom
LLQWQ:fix/setting-sync-debug-log

Conversation

@LLQWQ

@LLQWQ LLQWQ commented Apr 27, 2026

Copy link
Copy Markdown

Problem

When syncing with CLI, .agents files are not being sent to the client even though they exist in the server database.

Debug Addition

Added debug logging to check if .agents files are present in the SettingSync list returned by SettingService.Sync().

This will help diagnose why .agents files are not being synchronized to CLI clients.

Related

Related to CLI PR: Go1c/FastNodeSync-CLI#17

@sourcery-ai

sourcery-ai Bot commented Apr 27, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds targeted debug logging in the WebSocket settings sync handler to detect and count .agents files in the SettingSync list, aiding investigation of missing .agents sync to CLI clients.

Sequence diagram for debug logging of .agents files in SettingSync

sequenceDiagram
    participant WebsocketClient
    participant SettingWSHandler
    participant SettingService
    participant Logger

    WebsocketClient->>SettingWSHandler: SettingSync(websocketClient, websocketMessage)
    SettingWSHandler->>SettingService: Sync()
    SettingService-->>SettingWSHandler: list

    loop iterate_list
        SettingWSHandler->>SettingWSHandler: check s.Path prefix .agents/
        alt path_starts_with_agents
            SettingWSHandler->>SettingWSHandler: increment agentsCount
        end
    end

    alt agentsCount_greater_than_zero
        SettingWSHandler->>Logger: Debug(traceID, uid, agentsCount, totalList)
    end

    SettingWSHandler-->>WebsocketClient: continue existing SettingSync logic
Loading

Class diagram for SettingWSHandler debug logging update

classDiagram
    class SettingWSHandler {
        +App App
        +SettingSync(c WebsocketClient, msg WebsocketMessage) error
    }

    class App {
        +Logger() Logger
    }

    class Logger {
        +Debug(message string, fieldTraceID string, fieldUID int64, agentsCount int, totalList int)
    }

    class SettingSyncItem {
        +Path string
    }

    SettingWSHandler --> App : uses
    App --> Logger : returns
    SettingWSHandler --> SettingSyncItem : iterates_over_list
Loading

File-Level Changes

Change Details Files
Add debug logging to detect presence and count of .agents files during SettingSync.
  • Iterate over SettingSync result list and count entries whose path starts with .agents/.
  • Conditionally emit a debug log only when at least one .agents file is present.
  • Include trace ID, user ID, .agents file count, and total list size as structured zap log fields.
internal/routers/websocket_router/ws_setting.go

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • Since the goal is to debug why .agents files might be missing, consider logging the agentsCount even when it is zero so you can distinguish between "no .agents in DB" and "present but not synced" scenarios during analysis.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Since the goal is to debug why `.agents` files might be missing, consider logging the `agentsCount` even when it is zero so you can distinguish between "no .agents in DB" and "present but not synced" scenarios during analysis.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant