add support for Buttons and Lists (CTA limited) by rodrigo-gmengue · Pull Request #119 · clairton/unoapi-cloud

rodrigo-gmengue · 2025-11-17T15:01:02Z

This application adds support for buttons via Whaileys.
There's the UNOAPI_NATIVE_FLOW_BUTTONS environment variable for those interested in testing buttons with functionality (CTA) (currently only functional on Android) or by default, quick reply (compatible with web/Android/iOS).

Summary by CodeRabbit

New Features
- Enhanced interactive message handling with support for native WhatsApp flow buttons and media headers.
Bug Fixes
- Improved credential persistence by awaiting completion and ensuring immediate save on initial validation.
Chores
- Bumped version to 2.5.19.
- Updated baileys dependency to 6.3.10.

coderabbitai · 2025-11-17T15:03:37Z

Walkthrough

This change introduces environment variable-driven mode configuration across npm scripts, improves credential persistence through await enforcement and return value propagation, enhances interactive message handling with native WhatsApp flow support and fallback options, and adds dependency injection for contact handling in the web module.

Changes

Cohort / File(s)	Summary
Configuration & Gitignore `.gitignore`, `package.json`	Adds `.vscode/` to ignored paths. Bumps version to 2.5.19 and updates baileys to 6.3.10. Prefixes all npm scripts with `UNOAPI_MODE` environment variable (simple, web, waker, standalone, worker, bulker, broker, bridge, cloud) for mode-specific initialization.
Environment & Defaults `src/cloud.ts`, `src/defaults.ts`	Sets `UNOAPI_CLOUD=true` at startup. Adds `UNOAPI_NATIVE_FLOW_BUTTONS` boolean constant, defaulting to false unless env var is explicitly set to 'false' (inverted logic).
Credential Persistence Services `src/services/auth_state.ts`, `src/services/session_redis.ts`, `src/services/socket.ts`	Makes `saveCreds()` await `writeData()` completion. Updates `writeData()` in session_redis to return `setAuth()` result. Adds immediate `saveCreds()` invocation in `firstSaveCreds()` when phone numbers match.
Interactive Message Transformation `src/services/transformer.ts`	Enhances `toBaileysMessageContent()` with new interactive header/media handling path. Adds branching logic for sections vs. buttons-based payloads. Conditionally uses native WhatsApp interactive messages or fallback classic buttonsMessage based on `UNOAPI_NATIVE_FLOW_BUTTONS` flag with try/catch protected filename/mimetype detection.
Application Bootstrap & DI `src/web.ts`	Imports contact implementations (ContactBaileys, ContactDummy), routing middleware, and listener classes. Adds mode-based branching to select concrete or dummy contact handler. Extends App constructor signature with `injectRouteDummy` and `contactType!` parameters.

Sequence Diagram(s)

sequenceDiagram
    participant App as Application<br/>(via npm script)
    participant Env as Environment<br/>Variables
    participant Web as web.ts<br/>Bootstrap
    participant Contact as Contact<br/>Handler
    participant Transformer as transformer.ts<br/>(Message Flow)
    participant Baileys as Baileys

    App->>Env: UNOAPI_MODE=web
    Env-->>Web: Set MODE & detect cloud
    Web->>Contact: Load ContactBaileys<br/>or ContactDummy
    Contact-->>Web: contactType selected
    
    Note over Web,Contact: App initialized with DI
    
    Transformer->>Env: Check UNOAPI_NATIVE_FLOW_BUTTONS
    alt Native Flow Enabled
        Transformer->>Transformer: Build interactive message<br/>with buttons array
        Transformer->>Baileys: Send native interactive
    else Native Flow Disabled (default)
        Transformer->>Transformer: Build classic<br/>buttonsMessage
        Transformer->>Baileys: Send legacy format
    end

sequenceDiagram
    participant Socket as socket.ts
    participant Auth as auth_state.ts
    participant Redis as session_redis.ts
    participant Storage as Persistent<br/>Storage

    Socket->>Socket: firstSaveCreds() triggered
    alt Phone number matches config
        Socket->>Auth: saveCreds()
        Auth->>Redis: writeData()
        Redis->>Storage: setAuth(...)
        Storage-->>Redis: result
        Redis-->>Auth: return result
        Auth->>Auth: await completion
        Auth-->>Socket: ✓ Creds persisted
    else Number mismatch
        Socket-->>Socket: Skip persistence
    end

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

src/services/transformer.ts: Most complex change with multiple branching paths (native vs. classic flow), new media handling logic, and nested conditional structures—requires detailed understanding of interactive message formats and baileys compatibility.
src/web.ts: Dependency injection changes and constructor signature expansion need validation of parameter ordering and impact on app initialization flow.
package.json: Repetitive but systematic; verify all UNOAPI_MODE values are correctly mapped to their respective entry points.
Credential persistence chain (auth_state.ts, session_redis.ts, socket.ts): Validate that await/return value propagation doesn't introduce race conditions or unexpected behavior in credential save workflows.

Possibly related PRs

Pairing code #97: Modifies overlapping files (src/defaults.ts and src/services/socket.ts) with related configuration and socket connection initialization logic.

Poem

🐰 Whiskers twitching with delight ✨
Environment modes hop through the night,
Native buttons bloom, or fade to grey,
Credentials saved—no more delay,
The web boots up with DI's might! 🚀

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'add support for Buttons and Lists (CTA limited)' accurately reflects the main changes in the PR, which include implementing button and list message support with CTA functionality limitations.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

Tip

📝 Customizable high-level summaries are now available!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  - Provide custom instructions to shape the summary (bullet lists, tables, contributor stats, etc.).
  - Use `high_level_summary_in_walkthrough` to move the summary from the description to the walkthrough section.

  Example:

  > "Create a concise high-level summary as a bullet-point list. Then include a Markdown table showing lines added and removed by each contributing author."

  Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

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

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

coderabbitai

Actionable comments posted: 2

🧹 Nitpick comments (2)

src/web.ts (2)
62-68: Consider validating UNOAPI_MODE to prevent silent fallback.

The current logic defaults to ContactDummy for any non-'cloud' value of UNOAPI_MODE. If an invalid or misspelled mode is provided, the application will silently use the dummy implementation rather than failing fast.

Consider adding validation:
 let contactType: Contact
-if (process.env.UNOAPI_MODE == 'cloud') {
+const validModes = ['cloud', 'web', 'simple', 'standalone', 'worker', 'bulker', 'broker', 'bridge', 'waker']
+if (!validModes.includes(process.env.UNOAPI_MODE || '')) {
+  throw new Error(`Invalid UNOAPI_MODE: ${process.env.UNOAPI_MODE}. Must be one of: ${validModes.join(', ')}`)
+}
+if (process.env.UNOAPI_MODE === 'cloud') {
   let listener: Listener = new ListenerBaileys(outgoing, broadcast, getConfigRedis)
   contactType = new ContactBaileys(listener, getConfigRedis, getClientBaileys, onNewLogin)
 } else {
   contactType = new ContactDummy()
 }
64-64: Review listener variable scope.

The listener variable is block-scoped and only used for the ContactBaileys constructor. Consider whether it should be declared in a wider scope for potential future use, or if this scoping is intentional.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fd89fa9 and f68e543.

⛔ Files ignored due to path filters (1)

yarn.lock is excluded by !**/yarn.lock, !**/*.lock

📒 Files selected for processing (9)

.gitignore (1 hunks)
package.json (3 hunks)
src/cloud.ts (1 hunks)
src/defaults.ts (1 hunks)
src/services/auth_state.ts (1 hunks)
src/services/session_redis.ts (1 hunks)
src/services/socket.ts (1 hunks)
src/services/transformer.ts (2 hunks)
src/web.ts (2 hunks)

🧰 Additional context used

🧬 Code graph analysis (4)

src/services/auth_state.ts (2)

src/services/session.ts (1)

writeData (1-3)

src/services/session_file.ts (2)

key (49-59)

phone (6-92)

src/services/session_redis.ts (1)

src/services/redis.ts (1)

setAuth (348-352)

src/web.ts (6)

src/services/client.ts (1)

Contact (10-14)

src/services/listener.ts (1)

Listener (3-5)

src/services/contact_baileys.ts (1)

ContactBaileys (8-53)

src/services/client_baileys.ts (2)

getClientBaileys (49-85)

logout (408-412)

src/services/contact_dummy.ts (1)

ContactDummy (3-7)

src/app.ts (1)

App (21-101)

src/services/transformer.ts (1)

src/defaults.ts (1)

UNOAPI_NATIVE_FLOW_BUTTONS (30-31)

🪛 Biome (2.1.2)

src/services/transformer.ts

[error] 233-233: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.