Improve lock timeout logging

[Fizzadar]

No description provided.

[coderabbitai]

📝 Walkthrough

Summary by CodeRabbit

• Improvements
  • Enhanced diagnostic logging for lock timeout scenarios by including specific lock identifiers in warning messages, improving troubleshooting capabilities for potential deadlock situations.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Walkthrough

Enhanced warning messages in worker lock handlers to include lock identifiers. WaitingLock._get_next_retry_interval now logs the lock name and key, while WaitingMultiLock._get_next_retry_interval logs the lock names. No functional changes or logic modifications.

Changes

Cohort / File(s)	Summary
Lock timeout warning message improvements synapse/handlers/worker_lock.py	Updated warning messages in WaitingLock._get_next_retry_interval and WaitingMultiLock._get_next_retry_interval to include lock identifiers for better diagnostic context. Messages now include lock name/key and collection of lock names respectively when reporting excessive timeout durations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.
Description check	❓ Inconclusive	No pull request description was provided by the author.	Consider adding a brief description explaining the logging improvements and their benefits for debugging lock timeout issues.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title check	✅ Passed	The pull request title 'Improve lock timeout logging' directly and clearly matches the changeset, which enhances lock timeout warning messages with additional context.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch nick-better-lock-timeout-logging

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

synapse/handlers/worker_lock.py (1)

358-366: Consider stabilizing lock_names ordering in MultiLock timeout log

The added lock_names context is useful. If lock_names is ever a set, its string representation (and thus the log line) may change order between runs, which can make log diffing/grepping harder. If that matters in your ops workflows, you could normalize:

sorted_lock_names = sorted(self.lock_names)
logger.warning(
    "MultiLock timeout is getting excessive: %s: %ss. There may be a deadlock.",
    sorted_lock_names,
    self._retry_interval,
)

Otherwise, the change is fine as-is.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between d362e2b and 20da4f1.

📒 Files selected for processing (1)

• synapse/handlers/worker_lock.py (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)

• GitHub Check: test-sytest
• GitHub Check: test-complement
• GitHub Check: test-trial
• GitHub Check: build-python
• GitHub Check: lint-types
• GitHub Check: test-sytest
• GitHub Check: test-complement
• GitHub Check: test-trial

🔇 Additional comments (1)

synapse/handlers/worker_lock.py (1)

276-285: Lock timeout logging now includes lock identifiers — looks good

Including lock_name and lock_key in the warning significantly improves debuggability around long waits / deadlocks, and the format string correctly matches the three arguments.