Skip to content

fix: fresh session first poll #236

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 3 commits into from
Feb 1, 2025
Merged

Conversation

williamsjokvist
Copy link
Owner

@williamsjokvist williamsjokvist commented Feb 1, 2025

Summary by CodeRabbit

  • New Features
    • The default GUI appearance now uses the "tekken" theme for a refreshed look.
    • Session handling has been streamlined, with new match notifications added following session updates.
  • Bug Fixes
    • Enhanced error handling during match update processing improves overall tracking reliability.

Copy link
Contributor

coderabbitai bot commented Feb 1, 2025

Warning

Rate limit exceeded

@williamsjokvist has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 24 minutes and 57 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 76ccc33 and b806fc7.

📒 Files selected for processing (2)
  • pkg/tracker/sf6/track.go (1 hunks)
  • pkg/tracker/t8/track.go (1 hunks)

Walkthrough

This pull request updates control flow and error handling in key tracking components. In the StartTracking method, a session is created first, followed by user retrieval and assignment of user details, with an event emission for a "match" added afterward. The SF6Tracker's Poll method now checks for a nil battle log in addition to errors, invoking a cancellation function if necessary. Additionally, the default theme in GUI configuration has been updated from "default" to "tekken".

Changes

File(s) Change Summary
cmd/tracking.go, pkg/tracker/sf6/track.go Updated control flow and error handling: In tracking.go, session creation now precedes user retrieval with a subsequent match event emission; in track.go, added a nil check for battle log and proper cancellation on error.
pkg/model/config.go Changed the default Theme in GUIConfig from "default" to "tekken".

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant TH as TrackingHandler
    participant DB as SQLDB
    participant GT as GameTracker
    participant EV as EventEmitter

    C->>TH: StartTracking(userCode, restore=false)
    TH->>DB: CreateSession(userCode)
    DB-->>TH: Session created
    TH->>GT: GetUser(userCode)
    GT-->>TH: User details (LP, MR, DisplayName)
    TH->>DB: Update session with user info
    TH->>EV: Emit "match" event
    TH-->>C: Return session
Loading
sequenceDiagram
    participant T as SF6Tracker
    participant BL as BattleLog Service
    participant C as Cancel Handler

    T->>BL: GetBattleLog()
    alt Battle log is nil or error occurs
        T->>C: Invoke cancel function
    else Valid battle log
        T->>T: Process match & update stats
    end
Loading

Possibly related PRs

Poem

Hop, hop, hop, I code with delight,
Creating sessions that take flight.
User details join in after a swift start,
With a match event beating like a heart.
I’m a rabbit in code, leaping bugs out of sight —
Celebrating clean changes in the pale moonlight!


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e296994 and 76ccc33.

📒 Files selected for processing (3)
  • cmd/tracking.go (1 hunks)
  • pkg/model/config.go (1 hunks)
  • pkg/tracker/sf6/track.go (1 hunks)
🧰 Additional context used
🪛 GitHub Check: go-lint
pkg/tracker/sf6/track.go

[failure] 40-40:
SA5011(related information): this check suggests that the pointer can be nil (staticcheck)

🪛 GitHub Actions: Lint go code
pkg/tracker/sf6/track.go

[error] 43-43: SA5011: possible nil pointer dereference (staticcheck)

🔇 Additional comments (5)
pkg/model/config.go (1)

9-9: Verify if this change belongs in this PR.

The change to the default theme from "default" to "tekken" seems unrelated to fixing the first poll in a fresh session. Consider moving this change to a separate PR to maintain focused changes.

cmd/tracking.go (4)

78-82: LGTM! Improved session creation flow.

Creating the session first, then fetching user details is a cleaner approach.


88-98: LGTM! Proper error handling and user details assignment.

The code properly handles errors when fetching and saving user details, and correctly assigns the user's LP, MR, and DisplayName to the session.


99-105: LGTM! Added initial match state emission.

Emitting the initial match state helps update the UI immediately with the user's current stats.


78-106: Verify potential race condition in session initialization.

There's a potential race condition where the Poll method could be called before the session fields (LP, MR, UserName) are populated, as the ticker and polling goroutine are started immediately after session creation.

Consider moving the ticker and polling initialization after the session fields are populated:

 session.UserName = user.DisplayName

 ch.eventEmitter("match", model.Match{
     UserName:  session.UserName,
     LP:        session.LP,
     MR:        session.MR,
     SessionId: session.Id,
     UserId:    session.UserId,
 })

+// Initialize polling after session is fully populated
 ticker := time.NewTicker(30 * time.Second)
 ch.forcePollChan = make(chan struct{})

@williamsjokvist williamsjokvist merged commit fc8db1f into master Feb 1, 2025
2 checks passed
@williamsjokvist williamsjokvist deleted the fix/fresh-match-first-poll branch February 1, 2025 14:47
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