docs(socket): refresh configuration and connecting guides#34
Open
kaikybrofc wants to merge 1 commit into
Open
Conversation
📝 WalkthroughWalkthroughThis pull request rewrites two Baileys socket documentation pages to prioritize production-ready guidance. The configuration page now leads with minimum required options and essential config areas with deployment-oriented examples. The connecting page provides structured lifecycle management, covering QR handling, restart detection, reconnect strategy, and complete working skeletons with backoff logic. ChangesSocket Configuration and Connection Guidance
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/socket/connecting.md`:
- Around line 180-183: The reconnect loop in this example never stops; add a
max-attempt guard (e.g., const MAX_RECONNECT_ATTEMPTS) and check
reconnectAttempts against it before scheduling the retry so the code stops once
the cap is reached; update the logic around reconnectAttempts, delay calculation
and the setTimeout(() => void startSocket(), delay) call to bail out (and
optionally log) when reconnectAttempts >= MAX_RECONNECT_ATTEMPTS to match the
checklist.
- Around line 136-140: The snippet may call sock.requestPairingCode multiple
times because the condition (connection === 'connecting' || qr) can be true on
repeated connection.update events; add a one-shot guard (e.g., a boolean flag
pairingCodeRequested or a Set keyed by session/user) and check it before calling
sock.requestPairingCode so the logic around connection, qr, phoneNumber and code
only runs once per login attempt and set the flag immediately after initiating
the request; also reset the flag on final success/failure (when connection
becomes 'open' or 'close') so subsequent login attempts can request a new code.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 5d4e1d64-3de4-4eb7-8504-a077ab414a70
📒 Files selected for processing (2)
docs/socket/configuration.mddocs/socket/connecting.md
Comment on lines
+136
to
140
| if (connection === 'connecting' || qr) { | ||
| const phoneNumber = '12345678901' | ||
| const code = await sock.requestPairingCode(phoneNumber) | ||
| // send the pairing code somewhere | ||
| console.log('pairing code:', code) | ||
| } |
There was a problem hiding this comment.
Guard pairing-code requests to run once per login attempt.
Line 136 condition can be true across multiple connection.update events, which may request multiple pairing codes unnecessarily. Add a one-shot guard.
Suggested doc snippet adjustment
+let pairingCodeRequested = false
+
sock.ev.on('connection.update', async (update) => {
const { connection, qr } = update
- if (connection === 'connecting' || qr) {
+ if (!pairingCodeRequested && (connection === 'connecting' || qr)) {
+ pairingCodeRequested = true
const phoneNumber = '12345678901'
const code = await sock.requestPairingCode(phoneNumber)
console.log('pairing code:', code)
}
})🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/socket/connecting.md` around lines 136 - 140, The snippet may call
sock.requestPairingCode multiple times because the condition (connection ===
'connecting' || qr) can be true on repeated connection.update events; add a
one-shot guard (e.g., a boolean flag pairingCodeRequested or a Set keyed by
session/user) and check it before calling sock.requestPairingCode so the logic
around connection, qr, phoneNumber and code only runs once per login attempt and
set the flag immediately after initiating the request; also reset the flag on
final success/failure (when connection becomes 'open' or 'close') so subsequent
login attempts can request a new code.
Comment on lines
+180
to
+183
| reconnectAttempts += 1 | ||
| const delay = Math.min(1000 * 2 ** reconnectAttempts, 30_000) | ||
| setTimeout(() => void startSocket(), delay) | ||
| } |
There was a problem hiding this comment.
Add an explicit reconnect attempt cap to match the checklist and avoid endless loops.
The skeleton currently backs off but never stops retrying, while Line 198 requires attempt limits. Include a max-attempt guard in the example.
Suggested doc snippet adjustment
let reconnectAttempts = 0
+const MAX_RECONNECT_ATTEMPTS = 10
@@
if (connection === 'close') {
@@
reconnectAttempts += 1
+ if (reconnectAttempts > MAX_RECONNECT_ATTEMPTS) {
+ console.log('max reconnect attempts reached; stopping reconnect loop')
+ return
+ }
const delay = Math.min(1000 * 2 ** reconnectAttempts, 30_000)
setTimeout(() => void startSocket(), delay)
}Also applies to: 198-198
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/socket/connecting.md` around lines 180 - 183, The reconnect loop in this
example never stops; add a max-attempt guard (e.g., const
MAX_RECONNECT_ATTEMPTS) and check reconnectAttempts against it before scheduling
the retry so the code stops once the cap is reached; update the logic around
reconnectAttempts, delay calculation and the setTimeout(() => void
startSocket(), delay) call to bail out (and optionally log) when
reconnectAttempts >= MAX_RECONNECT_ATTEMPTS to match the checklist.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
3 issues found across 2 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/socket/configuration.md">
<violation number="1" location="docs/socket/configuration.md:163">
P2: Version-caching example uses in-memory-only cache while documentation claims it 'avoid[s] querying each boot'</violation>
</file>
<file name="docs/socket/connecting.md">
<violation number="1" location="docs/socket/connecting.md:136">
P2: Pairing code example missing guard against repeated `requestPairingCode` calls</violation>
<violation number="2" location="docs/socket/connecting.md:180">
P2: The reconnect loop increments `reconnectAttempts` and applies backoff but never caps the retries. This contradicts the checklist item at the end of the page ("retry strategy uses backoff and attempt limits"). Add a max-attempt guard to prevent an endless reconnect loop in the example users will copy.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
Re-trigger cubic
|
|
||
| const log = pino({ level: process.env.LOG_LEVEL || 'info' }) | ||
|
|
||
| let cachedVersion: { version: typeof DEFAULT_CONNECTION_CONFIG.version; ts: number } | null = null |
There was a problem hiding this comment.
P2: Version-caching example uses in-memory-only cache while documentation claims it 'avoid[s] querying each boot'
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/socket/configuration.md, line 163:
<comment>Version-caching example uses in-memory-only cache while documentation claims it 'avoid[s] querying each boot'</comment>
<file context>
@@ -4,75 +4,210 @@ sidebar_position: 1
+
+const log = pino({ level: process.env.LOG_LEVEL || 'info' })
+
+let cachedVersion: { version: typeof DEFAULT_CONNECTION_CONFIG.version; ts: number } | null = null
+const VERSION_TTL_MS = 24 * 60 * 60 * 1000
+
</file context>
| return | ||
| } | ||
|
|
||
| reconnectAttempts += 1 |
There was a problem hiding this comment.
P2: The reconnect loop increments reconnectAttempts and applies backoff but never caps the retries. This contradicts the checklist item at the end of the page ("retry strategy uses backoff and attempt limits"). Add a max-attempt guard to prevent an endless reconnect loop in the example users will copy.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/socket/connecting.md, line 180:
<comment>The reconnect loop increments `reconnectAttempts` and applies backoff but never caps the retries. This contradicts the checklist item at the end of the page ("retry strategy uses backoff and attempt limits"). Add a max-attempt guard to prevent an endless reconnect loop in the example users will copy.</comment>
<file context>
@@ -4,79 +4,195 @@ sidebar_position: 2
+ return
+ }
+
+ reconnectAttempts += 1
+ const delay = Math.min(1000 * 2 ** reconnectAttempts, 30_000)
+ setTimeout(() => void startSocket(), delay)
</file context>
Suggested change
| reconnectAttempts += 1 | |
| reconnectAttempts += 1 | |
| if (reconnectAttempts > 10) { | |
| console.log('max reconnect attempts reached; stopping') | |
| return | |
| } |
| if (connection == "connecting" || !!qr) { // your choice | ||
| const { connection, qr } = update | ||
|
|
||
| if (connection === 'connecting' || qr) { |
There was a problem hiding this comment.
P2: Pairing code example missing guard against repeated requestPairingCode calls
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/socket/connecting.md, line 136:
<comment>Pairing code example missing guard against repeated `requestPairingCode` calls</comment>
<file context>
@@ -4,79 +4,195 @@ sidebar_position: 2
- if (connection == "connecting" || !!qr) { // your choice
+ const { connection, qr } = update
+
+ if (connection === 'connecting' || qr) {
+ const phoneNumber = '12345678901'
const code = await sock.requestPairingCode(phoneNumber)
</file context>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
What changed
Scope
Summary by cubic
Refresh socket configuration and connecting guides with production-focused patterns for stable
baileysdeployments. Clarifies required options, reconnection handling, and pairing flows; docs-only change.auth,logger,getMessage) with concise examples andpinotips.creds.update; showsgetMessageretrieval from storage.DisconnectReason, stop onloggedOut, restart onrestartRequired, use backoff.browserprofiles and E.164 phone format (no+) forrequestPairingCode.Written for commit e283999. Summary will update on new commits. Review in cubic
Summary by CodeRabbit