Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(changelog): complete the unreleased entries for the latest fixes

Yudhi Armyndharis4a292e205ae2
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e40a4078f..89ae66c4b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -45,7 +45,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Acknowledge, when the dashboard opens a chat on Baileys, up to the 100 newest loaded incoming messages it has not acknowledged yet, where it acknowledged only the newest.
- Add `builtInSet` to the `database`, `redis` and `storage` sections of `GET /api/infra/config`, true when the saved configuration states the built-in mode; a host pinned by the environment now decides `builtIn`.
- List `message.receipt` among the webhook events of the Webhooks page and say in the description of `*` that it does not deliver `message.receipt`.
-- List a pinned `DATABASE_HOST`, `REDIS_HOST` or `S3_ENDPOINT` in `envPinned` of `GET /api/infra/status` and report the storage `endpoint` there in S3 mode; the Infrastructure page names a pinned host under Use Built-in.
+- List in `envPinned` of `GET /api/infra/status` any of the 29 settings a save of the Infrastructure page writes that the environment pins, where 0.25.0 listed eight, and report the storage `endpoint` there in S3 mode; the page names each pinned setting beside its field and its restart warning follows the pinned value.
+- Add `running` to the `database`, `redis` and `storage` sections of `GET /api/infra/status`, true while a bundled container OpenWA created runs and this instance's built-in flag is set, whether or not the service uses it, and false for one Docker Compose created; it is absent while Docker is unreachable.
- Accept a `database` or `storage` section without `type` on `PUT /api/infra/config`, keeping the stored type.
- Serve every page after the first of `GET /api/sessions/{sessionId}/chats` and `GET /api/sessions/{sessionId}/contacts` from the list the engine returned within the last 5 s, so walking a large account costs one engine read instead of one per page.
- Name the Go SDK status font constants after the WhatsApp protocol (`StatusFontSystemText`, `StatusFontFBScript`, `StatusFontMorningBreezeRegular`, `StatusFontCalistogaRegular`, `StatusFontExo2ExtraBold`, `StatusFontCourierPrimeBold`), from Go SDK 0.7.0; the old names, which did not match the font each id selects, stay as deprecated aliases.
@@ -90,9 +91,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Show hours for a session active within the last day on the Sessions page, as the Dashboard does.
- List a whatsapp-web.js contact held under both its LID and its phone once in the contacts and blocked lists, and give it the phone as `number` in the contacts list and by id, where the first copy carried the LID digits.
- Clear both entries when unblocking a whatsapp-web.js contact blocked under its phone number and its LID; it stayed in the blocked list after a successful unblock.
-- Show a localized edited indicator in Chats for observed message edits, including after a reload; stored messages now carry `metadata.edited: true` once the gateway has observed an edit, a `message.received` or `message.sent` of a message edited before it was stored carries `edited: true`, and earlier messages are not marked (#1905). Thanks @yederlv.
+- Show a localized edited indicator in Chats, including after a reload, for a message whose text an observed edit changed, also when a later edit restored it: its stored row carries `metadata.edited: true` and a `message.received` or `message.sent` announced after the edit carries `edited: true`, while an edit that repeats the text sets neither, a deleted message keeps its placeholder and existing messages are not marked retroactively (#1905). Thanks @yederlv.
+- Announce a message WhatsApp delivers already deleted with an empty `body` in `message.received` and `message.sent`, instead of the text of an edit made while it was being processed.
- Answer 409 to a start of a session whose delete is still running; it started an engine that stayed registered for the deleted session.
- Claim a session for the whole of its delete, so another node can no longer start or adopt it meanwhile; the delete answers 503 and removes nothing when the claim cannot be written.
+- Keep a session create, a session delete and a plugin instance delete on SQLite out of another request's open transaction, whose rollback could undo a write already answered as done and bring a deleted session back after a `204`; each waits up to 10 s for that transaction to end.
+- Stop two session creates or plugin instance deletes at the same moment on SQLite from leaving every later data import refused with `409` until a restart.
+- Save a webhook or automation rule without a transaction, so on SQLite one that fails because its session was just deleted no longer undoes the writes other requests made meanwhile.
+- Stop a session delete that fails or is refused from leaving the session stopped when nobody stopped it.
+- Remove the auth directories a deleted session's name keyed before 0.23.5 on PostgreSQL too; a failed id lookup left the old WhatsApp login on the volume.
- List a Baileys contact blocked under both its LID and its phone once in the blocked list, as whatsapp-web.js does.
- Hold a queued ingress delivery and a reconciler replay for a plugin still restoring after startup without spending a retry attempt, instead of dead-lettering it; held deliveries wake together, which keeps their order apart from the limits docs/25 states.
- Answer 400 for a `GET /api/search` `dateFrom` or `dateTo` outside the safe integer range and publish that range in the schema; on PostgreSQL a value past about 9.2e21 answered 500.
@@ -102,15 +109,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Count in `GET /api/infra/storage/files/count` only the keys the export carries, leaving out S3 folder placeholders and unsafe keys.
- Fall back to the 5000 ms default for a negative `SIMULATE_TYPING_MAX_MS`, which cut the typing pause to about 1 ms.
- Never fail a log call on metadata that holds a circular reference, a BigInt or a throwing getter, and redact secret-named keys at any depth instead of the first five levels, including on an object with its own `toJSON`.
-- Bound the copy of log metadata: below the fifth level at most 1000 more objects and arrays are written and an array or object that does not fit what is left of that budget is written as `[Truncated]`; an array of more than 1,000,000 entries is `[Truncated]` at any level.
-- Bound one copy of log metadata to 2,000,000 entries (object keys and array lengths) and 2^26 characters (string values, key names and BigInt text), a shared value counted at every use, and write what does not fit as `[Truncated]`; a few references to one large value expanded into a copy or a line of unbounded size.
-- Write an Error in log metadata as its name, message and stack, a Date as its ISO text, a Map or Set as an array of its entries and a Buffer or typed array as its type and length; they were written as `{}` or one field per byte.
+- Bound the copy of log metadata: below the fifth level at most 1000 more objects and arrays are written and an array or object that does not fit what is left of that budget is written as `[Truncated]`; an array, Map or Set of more than 1,000,000 entries is `[Truncated]` at any level.
+- Bound one copy of log metadata to 2,000,000 entries (object keys and array lengths, three to a Map's pair) and 2^26 characters (string values, key names and BigInt text, a digit counted sixteen times), a shared value counted at every use, and write what does not fit as `[Truncated]`; a few references to one large value expanded into a copy or a line of unbounded size.
+- Write an Error in log metadata as its name, message and stack, a Date as its ISO text, a boxed string, number or boolean as its value, a Map or Set as an array of its entries and a Buffer or typed array as its type and length; they were written as `{}` or one field per byte or character.
- Redact credentials at any depth in the Baileys wire log (`BAILEYS_LOG_LEVEL`) and copy nested errors before they are written.
- Leave functions out of log lines; a function with its own `toJSON` used to be written.
- Write a plugin log call whose meta is a string, array, boxed string, typed array, Map, Date, Error or class instance as one `meta` field instead of one field per character or index.
-- Replace the log metadata of a sandboxed plugin that exceeds 8192 values and characters by the size marker without building its text first, so a large or heavily shared object no longer blocks the host.
+- Measure the log metadata of a sandboxed plugin as the logger writes it, a credential value as `[REDACTED]` included, and replace one that exceeds 8192 values and characters by the size marker without building its text first, so it can no longer pass the cap and a large or heavily shared object no longer blocks the host.
- Relay a non-string log message of a sandboxed plugin as `[non-string log message]`.
- Stop `ctx.logger.error` called without an error from writing the trace `undefined`.
+- Stop an in-process plugin's `ctx.logger` call from throwing on a message, error or meta it cannot read, such as a Symbol, a revoked Proxy or a throwing `toString`; the line is written with `[Unprintable]` or `[Unreadable]` in its place.
- Apply a delete for everyone, an edit or a reaction that reaches a whatsapp-web.js message on SQLite while its contact or media is still being fetched, instead of hooking, storing and announcing the message with its deleted or unedited content.
- Store a Baileys reaction to a message that is still downloading its media with the message on SQLite, as on PostgreSQL, and announce it and an edit of the same window once the gateway has the message.
- Keep Baileys chat pin, mute and archive state from reverting, or coming back for a deleted or unlinked chat, or reading as defaults for a lid-addressed contact, when a restore, a session start or a chat-list read overlaps a change; a change written under a contact's lid while its state is merged onto the phone number, or in the same millisecond as the phone entry, is no longer lost.
@@ -120,8 +128,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Describe the 400 of `POST /api/sessions/{id}/messages/react` and `/delete` as `Session not active or invalid request` in the OpenAPI schema; a missing message answers 404.
- Keep the Infrastructure page from reverting a database, Redis, queue or storage switch that was saved and awaits a restart, and from deleting the stored credentials of the backend it switched away from, on the next save.
- Seed the Use Built-in toggles of the Infrastructure page from the saved configuration, add a pending-restart note per card and warn in the restart dialog for a switch between a bundled and an external service or to another S3 bucket or endpoint; settings typed beside a switch awaiting a restart were discarded on save.
-- Stop a save of the Infrastructure page from writing an untouched database type, storage type or Redis switch that the environment pins over the stored choice, and the bundled credentials over stored external ones while the environment pins the host to the bundled container.
-- Start a built-in container at boot only for a datastore in use whose host the environment does not pin elsewhere, and stop the built-in Redis when the Infrastructure page switches Redis off and neither the queue nor the cache uses it; a leftover flag started a container nothing used.
+- Stop a save of the Infrastructure page from writing an untouched database type, storage type or Redis switch that the environment pins over the stored choice.
+- Treat a host that reaches a bundled container by its container name, another letter case or a trailing dot as that container in `GET /api/infra/status` and on the Infrastructure page, whose Use Built-in toggles, notes and switch warnings follow it.
+- Keep the stored database password, user, database name and schema and the S3 keys, bucket and region when the Infrastructure page saves a database or storage whose saved or pinned host already reaches the bundled container, under any of those spellings, instead of resetting them to the bundled defaults.
+- Start a built-in container at boot only for a datastore in use whose host the environment does not pin elsewhere; a restart from the Infrastructure page, whose dialog names each container it stops, stops the built-in Redis when Redis is switched off and neither the queue nor the cache uses it, and a container the dashboard created whose host the environment now pins to another server. A leftover flag started a container nothing used.
- Allow saving the Infrastructure page with the PostgreSQL pool size field emptied, which sent null and answered 400.
- Allow saving a plugin config whose secret field declares a pattern, which the stored mask failed.
- Stop the Webhooks and Templates pages from sending operator-only reads with a viewer key.
@@ -130,8 +140,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Keep a dashboard chat reader on their message when several images above it decode at once, when images decode above it while older messages load, and when they open another chat and come back while those messages load or after they arrived.
- Scroll a message sent while its chat or an older page is still loading into view, keep a reader at the bottom of the chat when an image decodes as their sent message is confirmed, and open a chat at its own saved position when an image of the previous chat was still decoding.
- Keep keyboard focus on the Copy button after a copy where the Clipboard API is missing (plain HTTP), on the API keys, webhooks, templates, plugins and Infrastructure pages.
-- Fix the dashboard layout on phones, short and half-screen windows: the Dashboard sessions table, Sessions cards, login screen, API key names, install dialog header, webhook filter rows and popover, Infrastructure, Plugins and Templates columns, page headers, Infrastructure card titles and the Chats search scope in longer languages, the Plugins rail, the Templates session select, the closed navigation drawer's edge, the language menu, icons at larger text sizes and the page height under a phone browser toolbar.
-- Make the dashboard usable by keyboard and under right-to-left languages: Infrastructure choices and toggles reachable with visible focus, a focus ring on global search results and every focus ring at 3:1 or better in the light theme, the toast close icon and select arrow shown, one main landmark per page, raised text contrast in both themes (error text, muted text, status badges, pills and danger buttons, text on the brand green and amber fills, the read tick on the dark outgoing bubble), reduced motion honoured, and mirrored layout and icons under Arabic and Hebrew.
+- Fix the dashboard layout on phones, short and half-screen windows: the Dashboard sessions table, Sessions cards, login screen, API key names, install dialog header, webhook filter rows and popover, Infrastructure, Plugins and Templates columns, page headers, Infrastructure card titles and the Chats search scope in longer languages, the Plugins rail and its config dialog's tab strip, the Templates session select, the closed navigation drawer's edge, the language menu, icons at larger text sizes and the page height under a phone browser toolbar.
+- Make the dashboard usable by keyboard and under right-to-left languages: Infrastructure choices and toggles reachable with visible focus, a focus ring on global search results, visible keyboard focus on form fields, filter builder fields and native checkboxes, every focus ring at 3:1 or better in the light theme, the toast close icon and select arrow shown, one main landmark per page, raised text contrast in both themes (error text, muted text, status badges, pills and danger buttons, text on the brand green and amber fills, the read tick on the dark outgoing bubble), reduced motion honoured, and mirrored layout and icons under Arabic and Hebrew.
- Stop the Message Tester multi-group send when the session is not running or the gateway cannot be reached, instead of recording one failure per remaining group.
- Read phone numbers typed in native digits in the Message Tester, bulk list, webhook filter, pairing field, the chat, channel and status searches, the status recipient search and the chat access list of an API key.
- Keep the database, Redis and S3 secret fields of the Infrastructure page from being filled by a browser's password manager with the saved dashboard key.
@@ -147,7 +157,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Read a Baileys inbound poll sent under the `pollCreationMessageV4` or `pollCreationMessageV5` content key as a poll with its question and options instead of an empty unknown message.
- Stop whatsapp-web.js from announcing `message.edited` and overwriting the stored caption when WhatsApp Web only replaces a media thumbnail or a location preview.
- Retry a whatsapp-web.js profile picture asked for by phone id under the contact's LID when the phone form answers nothing or fails, for a contact WhatsApp keys by LID.
-- Stop a session that cannot see a contact's number from erasing the number another session stored for that contact's lid, so a key restricted to that number keeps the chat.
+- Stop a session that cannot see a contact's number from erasing the number another session stored for that contact's lid, so a key restricted to that number keeps the chat; the number is cleared by the session that stored it, or by any session once that one is deleted, logged out or unlinked.
+- Write a lid's phone, or the clearing of a number its contact hid, to the lid table again on a later report when the write failed, at most once a minute per lid, instead of only after a restart, so a chat-restricted key stops matching a hidden number (#1058).
+- Answer a `@lid` chat for a chat-restricted API key by the lid table in both the single-chat check and the chat lists, which could disagree after another node changed the number, and admit neither number while this node's write of a new one has not reached the table.
- Wait for the message writes still in flight for the sessions a data import removes, so no message row is left for a removed session; an import that does not commit fails the unfinished bulk batches of those sessions.
- Name each font in the dashboard status composer (System, System text, Script, Bold, Morning Breeze, Calistoga, Exo 2, Courier Prime) instead of its number, offer only ids 0 to 7 on whatsapp-web.js, which posts 8 to 10 in the default font, and draw a received status with font 1 in the system face instead of a serif one.
- Throw `OpenWATimeoutException` from the PHP SDK on a host without ext-curl when the gateway stays silent past `timeout`, instead of a Guzzle exception, from PHP SDK 0.7.0.
@@ -169,14 +181,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `GET /info` through the bundled Docker socket proxy is refused; a client of your own that reads it needs `INFO: 1` on the proxy.
- Changing `QUEUE_PREFIX` on a live deployment leaves the jobs queued under the old prefix unprocessed.
- The first boot on PostgreSQL converts the legacy message types in one statement inside the boot transaction, about 1 minute per million legacy rows while the port stays closed; raise `startupProbe.failureThreshold` or run the migrations first (docs/14, section 14.5).
-- A session delete removes its messages, webhook outbox rows and delivery failures in batches (about 150 ms each and at most 2000 rows on SQLite, 500 rows on PostgreSQL) before the final transaction, so it is no longer atomic: a failure part-way leaves the session with fewer rows until the delete is repeated, and on SQLite it takes 3 to 4.5 times as long as the single statement of 0.25.0, which froze the process meanwhile; give a client or proxy a timeout that covers a large session.
+- A session delete removes its messages, webhook outbox rows and delivery failures in batches (about 150 ms each and at most 2000 rows on SQLite, 500 rows on PostgreSQL) before the final transaction, so it is no longer atomic: a failure part-way leaves the session stopped with fewer rows until the delete is repeated. A large session takes longer than the single statement of 0.25.0: 3 to 4.5 times as long on SQLite, which 0.25.0 froze meanwhile, and 13 to 50 times on PostgreSQL (17 to 67 s for a million messages on a loaded test host); give a client or proxy a timeout that covers a large session.
+- During a rolling upgrade, a node still on 0.25.0 does not read the `deleting` record a session delete keeps in `sessions.desiredState` while it runs, after it fails part-way or after its node dies, which newer nodes treat as a stop until an explicit `POST /start`: such a node can adopt that session, and a `POST /start` it serves leaves the record in place.
+- On SQLite, `POST /api/sessions`, `DELETE /api/sessions/{sessionId}` and `DELETE /api/integration/plugins/{pluginId}/instances/{instanceId}` wait for another open database transaction and answer `503` when it stays open for 10 s: the create stores nothing, the instance delete deletes nothing and the session delete leaves the session stopped, possibly with fewer rows; retry them.
- A storage export or file count now answers 409 on a symbolic link inside the local storage directory (replace it with the real directory or a bind mount), on a directory the app cannot read and on one nested 20 levels deep.
- Request validation is stricter: a JSON boolean or object in a string field, an object for a list or an array for an object, a body nested over 100 levels and a `muteUntil` above 9007199254740991 answer `400` where they were accepted or answered `500`; a client that posts a number for a string field is unaffected.
- ⚠️ **Breaking (SDK types only, no gateway change).** From SDK 0.7.0, the JavaScript, Python and Go SDKs type the response fields the gateway always sends as required and no longer allow the `null` it never sends, the Go response fields marked required no longer leave a zero value out when marshaled, `ParticipantsResult` no longer extends `SuccessResult` in the JavaScript and Python SDKs, and the key validation `role` is typed `admin`, `operator` or `viewer` in both; code that builds these objects by hand or tests those fields for `null` needs updating.
- From SDK 0.7.0, the PHP SDK throws from the constructor for an empty list as a `defaultHeaders` value, which 0.6.0 accepted; use `''` for an empty header value.
-- `restore.sh` stops before it copies anything, naming the key, when a path from the archive's own `.env.generated` leads out of the data directory; set that key in the environment or `./.env` to restore there. The default paths and a leftover `./uploads` restore as before.
+- `restore.sh` stops before it copies anything, naming the key, when a path from the archive's own `.env.generated` leads out of the data directory, passes through a link that does not resolve, or lies inside or around another directory the restore refills; set that key in the environment or `./.env` to restore there. The default paths and a leftover `./uploads` restore as before.
- The amd64 image moves from Chrome for Testing 153 to 156, so an amd64 rollback to 0.25.0 or earlier crosses a browser major and deletes the stored whatsapp-web.js logins unless `sessions/` is restored from a backup taken before the first start on the new image (see `docs/11-operational-runbooks.md`); Baileys sessions are unaffected.
-- A `POSTGRES_BUILTIN`, `REDIS_BUILTIN` or `MINIO_BUILTIN` flag starts its container at boot only while the datastore is in use (PostgreSQL selected; Redis, the queue or the cache on; S3 storage) and its host is not pinned to another server; a container nothing used is no longer started.
+- A `POSTGRES_BUILTIN`, `REDIS_BUILTIN` or `MINIO_BUILTIN` flag starts its container at boot only while the datastore is in use (PostgreSQL selected; Redis, the queue or the cache on; S3 storage) and its host is not pinned to another server; a container nothing used is no longer started, and a restart from the Infrastructure page stops one the dashboard created whose host is pinned elsewhere.
+- `envPinned` of `GET /api/infra/status` can list any of the 29 settings a save of the Infrastructure page writes, where 0.25.0 listed eight; a client that reads it must expect the database, Redis and S3 keys and the built-in flags too.
- The dashboard status composer offers only fonts 0 to 7 on whatsapp-web.js, which posts 8 to 10 in the default font; the API still accepts every font id.
### Security