Durante o processo de logout de uma instância, as chaves associadas a… #2191
Conversation
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
…o estado criptográfico não estavam sendo removidas corretamente do Redis. Dessa forma, quando uma nova conexão era estabelecida reutilizando o mesmo instanceName, o Baileys carregava chaves antigas e inválidas, incompatíveis com o novo conjunto de credenciais (creds) gerado na reconexão. Essa inconsistência gerava o seguinte sintoma prático: A instância autenticava com sucesso; Contudo, ao tentar enviar mensagens, entrava em estado de bloqueio, exibindo o status “aguardando mensagem” indefinidamente.
Contributor
Reviewer's GuideEnsures proper cleanup of authentication credentials on instance logout by adding removeCreds methods to all auth state handlers and invoking them during the logout flow to prevent stale keys from persisting. Sequence diagram for updated logout credential cleanup processsequenceDiagram
participant "BaileysStartupService"
participant "AuthStateProvider"
participant "useMultiFileAuthStateRedisDb"
participant "useMultiFileAuthStatePrisma"
participant "Redis/DB/Provider"
"BaileysStartupService"->>"AuthStateProvider": Call authStateProvider(instance.id)
"BaileysStartupService"->>"AuthStateProvider": Call removeCreds()
"AuthStateProvider"->>"Redis/DB/Provider": Remove session keys
"BaileysStartupService"->>"useMultiFileAuthStateRedisDb": Call useMultiFileAuthStateRedisDb(instance.id, cache)
"BaileysStartupService"->>"useMultiFileAuthStateRedisDb": Call removeCreds()
"useMultiFileAuthStateRedisDb"->>"Redis/DB/Provider": Delete Redis keys
"BaileysStartupService"->>"useMultiFileAuthStatePrisma": Call useMultiFileAuthStatePrisma(instance.id, cache)
"BaileysStartupService"->>"useMultiFileAuthStatePrisma": Call removeCreds()
"useMultiFileAuthStatePrisma"->>"Redis/DB/Provider": Delete DB/Redis keys
ER diagram for credential removal from Redis and DB on logouterDiagram
INSTANCE {
string id
string sessionId
}
REDIS {
string key
string value
}
DB {
string sessionId
string creds
}
INSTANCE ||--o{ REDIS : "removes keys on logout"
INSTANCE ||--o{ DB : "removes creds on logout"
Class diagram for updated auth state handlers with removeCreds methodclassDiagram
class AuthStateProvider {
+providerFiles: ProviderFiles
+authStateProvider(instance: string): AuthState
}
class AuthState {
+state: AuthenticationState
+saveCreds(): Promise<void>
+removeCreds(): Promise<void>
}
class useMultiFileAuthStatePrisma {
+state: AuthenticationState
+saveCreds(): Promise<void>
+removeCreds(): Promise<void>
}
class useMultiFileAuthStateRedisDb {
+state: AuthenticationState
+saveCreds(): Promise<void>
+removeCreds(): Promise<void>
}
AuthStateProvider --> AuthState
useMultiFileAuthStatePrisma --|> AuthState
useMultiFileAuthStateRedisDb --|> AuthState
File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- There’s significant duplication in the removeCreds implementation across Prisma, Redis, and file providers—consider extracting a shared helper to DRY up the code.
- Review the logger instantiations and naming (e.g. Redis file using the Prisma logger name) and standardize log levels for consistency.
- In BaileysStartupService, you could consolidate the three separate removeCreds calls into a unified loop or strategy to avoid repetitive authState loading.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- There’s significant duplication in the removeCreds implementation across Prisma, Redis, and file providers—consider extracting a shared helper to DRY up the code.
- Review the logger instantiations and naming (e.g. Redis file using the Prisma logger name) and standardize log levels for consistency.
- In BaileysStartupService, you could consolidate the three separate removeCreds calls into a unified loop or strategy to avoid repetitive authState loading.
## Individual Comments
### Comment 1
<location> `src/utils/use-multi-file-auth-state-provider-files.ts:93-99` </location>
<code_context>
return response;
};
+ const removeCreds = async () => {
+
+ const [response, error] = await this.providerFiles.removeSession(instance);
+ if (error) {
+ // this.logger.error(['removeData', error?.message, error?.stack]);
+ return;
+ }
+
</code_context>
<issue_to_address>
**suggestion (bug_risk):** removeCreds swallows errors silently; consider logging or surfacing them.
Errors from providerFiles.removeSession are currently ignored. If downstream consumers rely on error handling, log or propagate these errors.
```suggestion
const removeCreds = async () => {
const [response, error] = await this.providerFiles.removeSession(instance);
if (error) {
if (this.logger) {
this.logger.error(['removeCreds', error?.message, error?.stack]);
} else {
console.error('removeCreds error:', error);
}
throw error;
}
```
</issue_to_address>
### Comment 2
<location> `src/utils/use-multi-file-auth-state-provider-files.ts:152` </location>
<code_context>
}
}
+const logger = new Logger('useMultiFileAuthStatePrisma');
+
export default async function useMultiFileAuthStatePrisma(
</code_context>
<issue_to_address>
**suggestion:** Logger instance name may be misleading in this context.
Consider renaming the logger to match the provider file's purpose for improved traceability.
</issue_to_address>
### Comment 3
<location> `src/utils/use-multi-file-auth-state-redis-db.ts:41-48` </location>
<code_context>
+ async function removeCreds(): Promise<any> {
+ try {
+
+ logger.warn({ action: 'redis.delete', instanceName });
+
+ return await cache.delete(instanceName);
</code_context>
<issue_to_address>
**suggestion:** Consider using logger.info for successful deletion and logger.warn only for errors.
Use logger.info to indicate successful deletion, and reserve logger.warn or logger.error for error cases to improve log clarity.
```suggestion
try {
logger.info({ action: 'redis.delete', instanceName });
await cache.delete(instanceName);
} catch (err) {
logger.warn({ action: 'redis.delete.failed', instanceName, error: err });
return;
}
```
</issue_to_address>
### Comment 4
<location> `src/api/integrations/channel/whatsapp/whatsapp.baileys.service.ts:273-276` </location>
<code_context>
+ const cache = this.configService.get<CacheConf>('CACHE');
+ const provider = this.configService.get<ProviderSession>('PROVIDER');
+
+ if (provider?.ENABLED) {
+ const authState = await this.authStateProvider.authStateProvider(this.instance.id);
+
+ await authState.removeCreds()
+ }
+
</code_context>
<issue_to_address>
**suggestion:** Consider handling errors from removeCreds to avoid silent failures.
Currently, errors from removeCreds are ignored. Consider logging or handling these errors to improve reliability and traceability.
</issue_to_address>
### Comment 5
<location> `src/utils/use-multi-file-auth-state-prisma.ts:149-168` </location>
<code_context>
</code_context>
<issue_to_address>
**issue (code-quality):** Avoid function declarations, favouring function assignment expressions, inside blocks. ([`avoid-function-declarations-in-blocks`](https://docs.sourcery.ai/Reference/Rules-and-In-Line-Suggestions/TypeScript/Default-Rules/avoid-function-declarations-in-blocks))
<details><summary>Explanation</summary>Function declarations may be hoisted in Javascript, but the behaviour is inconsistent between browsers.
Hoisting is generally confusing and should be avoided. Rather than using function declarations inside blocks, you
should use function expressions, which create functions in-scope.
</details>
</issue_to_address>
### Comment 6
<location> `src/utils/use-multi-file-auth-state-redis-db.ts:40-49` </location>
<code_context>
</code_context>
<issue_to_address>
**issue (code-quality):** Avoid function declarations, favouring function assignment expressions, inside blocks. ([`avoid-function-declarations-in-blocks`](https://docs.sourcery.ai/Reference/Rules-and-In-Line-Suggestions/TypeScript/Default-Rules/avoid-function-declarations-in-blocks))
<details><summary>Explanation</summary>Function declarations may be hoisted in Javascript, but the behaviour is inconsistent between browsers.
Hoisting is generally confusing and should be avoided. Rather than using function declarations inside blocks, you
should use function expressions, which create functions in-scope.
</details>
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
93
to
99
| const removeCreds = async () => { | ||
|
|
||
| const [response, error] = await this.providerFiles.removeSession(instance); | ||
| if (error) { | ||
| // this.logger.error(['removeData', error?.message, error?.stack]); | ||
| return; | ||
| } |
Contributor
There was a problem hiding this comment.
suggestion (bug_risk): removeCreds swallows errors silently; consider logging or surfacing them.
Errors from providerFiles.removeSession are currently ignored. If downstream consumers rely on error handling, log or propagate these errors.
Suggested change
| const removeCreds = async () => { | |
| const [response, error] = await this.providerFiles.removeSession(instance); | |
| if (error) { | |
| // this.logger.error(['removeData', error?.message, error?.stack]); | |
| return; | |
| } | |
| const removeCreds = async () => { | |
| const [response, error] = await this.providerFiles.removeSession(instance); | |
| if (error) { | |
| if (this.logger) { | |
| this.logger.error(['removeCreds', error?.message, error?.stack]); | |
| } else { | |
| console.error('removeCreds error:', error); | |
| } | |
| throw error; | |
| } |
Comment on lines
41
to
48
| try { | ||
|
|
||
| logger.warn({ action: 'redis.delete', instanceName }); | ||
|
|
||
| return await cache.delete(instanceName); | ||
| } catch { | ||
| return; | ||
| } |
Contributor
There was a problem hiding this comment.
suggestion: Consider using logger.info for successful deletion and logger.warn only for errors.
Use logger.info to indicate successful deletion, and reserve logger.warn or logger.error for error cases to improve log clarity.
Suggested change
| try { | |
| logger.warn({ action: 'redis.delete', instanceName }); | |
| return await cache.delete(instanceName); | |
| } catch { | |
| return; | |
| } | |
| try { | |
| logger.info({ action: 'redis.delete', instanceName }); | |
| await cache.delete(instanceName); | |
| } catch (err) { | |
| logger.warn({ action: 'redis.delete.failed', instanceName, error: err }); | |
| return; | |
| } |
Comment on lines
149
to
168
| async function removeCreds(): Promise<any> { | ||
|
|
||
| const cacheConfig = configService.get<CacheConf>('CACHE'); | ||
|
|
||
| // Redis | ||
| try { | ||
| if (cacheConfig.REDIS.ENABLED) { | ||
| await cache.delete(sessionId); | ||
| logger.info({ action: 'redis.delete', sessionId }); | ||
|
|
||
| return | ||
| } | ||
| } catch (err) { | ||
| logger.warn({ action: 'redis.delete', sessionId, err }); | ||
| } | ||
|
|
||
| logger.info({ action: 'auth.key.delete', sessionId }); | ||
|
|
||
| await deleteAuthKey(sessionId); | ||
| } |
Contributor
There was a problem hiding this comment.
issue (code-quality): Avoid function declarations, favouring function assignment expressions, inside blocks. (avoid-function-declarations-in-blocks)
Explanation
Function declarations may be hoisted in Javascript, but the behaviour is inconsistent between browsers. Hoisting is generally confusing and should be avoided. Rather than using function declarations inside blocks, you should use function expressions, which create functions in-scope.
Comment on lines
40
to
49
| async function removeCreds(): Promise<any> { | ||
| try { | ||
|
|
||
| logger.warn({ action: 'redis.delete', instanceName }); | ||
|
|
||
| return await cache.delete(instanceName); | ||
| } catch { | ||
| return; | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
issue (code-quality): Avoid function declarations, favouring function assignment expressions, inside blocks. (avoid-function-declarations-in-blocks)
Explanation
Function declarations may be hoisted in Javascript, but the behaviour is inconsistent between browsers. Hoisting is generally confusing and should be avoided. Rather than using function declarations inside blocks, you should use function expressions, which create functions in-scope.![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| } else { | ||
| const { host, password, port, protocol: proto, username } = proxy | ||
| protocol = (proto || 'http').replace(':', '') | ||
| const { host, password, port, protocol: proto, username } = proxy; |
Check failure
Code scanning / CodeQL
Insecure randomness High
| } else { | ||
| const { host, password, port, protocol: proto, username } = proxy | ||
| protocol = (proto || 'http').replace(':', '') | ||
| const { host, password, port, protocol: proto, username } = proxy; |
Check failure
Code scanning / CodeQL
Insecure randomness High
| } else { | ||
| const { host, password, port, protocol: proto, username } = proxy | ||
| protocol = (proto || 'http').replace(':', '') | ||
| const { host, password, port, protocol: proto, username } = proxy; |
Check failure
Code scanning / CodeQL
Insecure randomness High
| } else { | ||
| const { host, password, port, protocol: proto, username } = proxy | ||
| protocol = (proto || 'http').replace(':', '') | ||
| const { host, password, port, protocol: proto, username } = proxy; |
Check failure
Code scanning / CodeQL
Insecure randomness High
| } else { | ||
| const { host, password, port, protocol: proto, username } = proxy | ||
| protocol = (proto || 'http').replace(':', '') | ||
| const { host, password, port, protocol: proto, username } = proxy; |
Check failure
Code scanning / CodeQL
Insecure randomness High
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
📋 Description
Durante o processo de logout de uma instância, as chaves associadas ao estado criptográfico não estavam sendo removidas corretamente do Redis.
Dessa forma, quando uma nova conexão era estabelecida reutilizando o mesmo instanceName, o Baileys carregava chaves antigas e inválidas, incompatíveis com o novo conjunto de credenciais (creds) gerado na reconexão.
Essa inconsistência gerava o seguinte sintoma prático:
A instância autenticava com sucesso;
Contudo, ao tentar enviar mensagens, entrava em estado de bloqueio, exibindo o status “aguardando mensagem” indefinidamente.
🔗 Related Issue
Closes #(issue_number)
🧪 Type of Change
🧪 Testing
📸 Screenshots (if applicable)
✅ Checklist
📝 Additional Notes
Summary by Sourcery
Ensure cryptographic keys are properly cleaned up on instance logout by adding and invoking removeCreds methods across auth state providers and logging deletion actions.
Bug Fixes:
Enhancements: