@alteriom/painlessmesh 2.0.1 → 2.0.3

package/CHANGELOG.md

@@ -7,6 +7,151 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.3] - 2026-09-11
+
+`sendToInternet()` fixes from one user's WhatsApp integration (#450, #452,
+#453), and one the hardware rig found while validating them. **Upgrade if a
+node of yours is a bridge or relays to the Internet**: on 2.0.2 a bridge's own
+sends were refused for 30 s after boot, a service that answered a refusal with
+HTTP 201 was reported as delivered, a destination that does not resolve
+stalled an ESP32 gateway on every attempt, and a bridge that rebooted as a
+regular node swallowed every request its peers still sent it. Every fix was
+reproduced first -- against the new HTTP test point, which CI now runs, or
+over real TCP on the desktop -- and is covered by a row on the hardware farm.
+
+### Fixed
+
+- **A bridge's own `sendToInternet()` was refused for the first 30 s after
+  `initAsBridge()`** (#450). The Internet health check is armed one line after
+  `stationManual()` re-issues `WiFi.begin()`, so its first probe ran while the
+  station was still associating and failed, and the next was a full interval
+  away. Every send from the bridge in that window fell through to the mesh
+  path and was refused with "No active mesh connections" -- #445 again, with
+  a 30 s hole instead of forever. `sendToInternet()` and the retry path now
+  spend one on-demand probe per interval when the flag says no, and the
+  station's got-IP event re-probes at once on a bridge or shared gateway.
+- **A gateway reported a refusal as delivered, and every failure as a bare
+  number** (#450, #452). The gateway decided on the HTTP status alone and
+  discarded the response body. CallMeBot's WhatsApp API answers "Too many
+  requests" with HTTP 201 and HTTP 203, the same page under both, so a refused
+  message sent through a gateway on 2.0.2 could be reported as delivered; and
+  it answers HTTP 208 to messages it never delivers, which 2.0.2 reported as
+  "Ambiguous response" with nothing to say why. The gateway now reads the
+  start of the body (bounded to 512 bytes and 250 ms). Only 200, 201, 202 and
+  204 count as delivered, and not when the body says the service refused the
+  request; every other 2xx is a failure. Every failure reaches the origin
+  node's callback with a one-line, tag-free excerpt of the body -- for example
+  `HTTP 201: service refused the request: Oops! Too many requests...` or
+  `HTTP 208: not a delivery the gateway can confirm: ...` -- and is logged at
+  ERROR level, so a sketch on the default log levels sees what the service
+  said.
+- **A destination whose name does not resolve stalled an ESP32 gateway on
+  every attempt** (#453). A failed lookup surfaced as `connection refused`
+  after the resolver's own patience, which this library cannot bound on ESP32,
+  and every attempt -- the origin node's retries and, since the bridge fix
+  above, the bridge's own sends -- paid it again, until relayed requests timed
+  out on their origin nodes. An ESP32 gateway now resolves the host once,
+  reports `DNS lookup failed for <host>`, and refuses that host for 60 s
+  without another lookup. ESP8266 is unchanged: its core bounds the lookup by
+  the HTTP timeout. The gateway blocking budget is unchanged.
+- **A bridge that rebooted as a regular node swallowed every Internet request
+  routed to it.** Found on the hardware rig while validating this release. A
+  bridge that reboots, crashes, loses power or is reflashed announces nothing
+  -- only a bridge stepping down in-process sends `leaving` -- so its peers
+  kept it in their bridge list for the 60 s they trust a status, and could
+  prefer it over a live bridge on RSSI. A regular node had no handler for
+  gateway requests and dropped them without a reply; each sender waited out
+  its 30 s request timeout and reported "Request timed out". Every node now
+  answers a gateway request it cannot serve with
+  `Node <id> is not an Internet gateway`; the sender forgets that node as a
+  gateway and sends again at once through the next one, without spending a
+  retry. When it knows no other gateway, the request rides the ordinary retry
+  backoff -- on the rig the live bridge was advertised half a second later --
+  and fails with `No Internet gateway available: ...` only when none appears.
+- **Mismatched log format arguments in `routePackage()`** (CodeQL
+  `cpp/wrong-type-format-argument`). A message that failed to parse was logged
+  with its `size_t` lengths through `%d`/`%u` -- the wrong width on 64-bit
+  hosts -- and with its `DeserializationError` object passed through `%u`,
+  undefined behaviour on every platform, in the ArduinoJson 7 path every
+  current build compiles as well as the legacy one CodeQL flagged.
+
+### Changed
+
+- **The mock HTTP server is now the gateway test point.** It keeps a delivery
+  ledger (`GET /requests/{tag}`) and emulates CallMeBot's status quirks
+  (`GET /callmebot/whatsapp.php`, profile chosen by `apikey`). The desktop CI
+  job starts it and `PAINLESSMESH_TESTPOINT` points the suite at it, so the
+  library's delivery verdict is checked against what the service actually did,
+  not against a table of status codes. The Alteriom farm's gateway probe serves
+  the same routes.
+- **`Mesh::sendGatewayAck()` is public and portable.** It moved from the ESP
+  gateway code into `painlessmesh::Mesh`, because every node now needs it to
+  answer a request it cannot serve.
+- **`Log()` is format-checked in the desktop build.** The test build marks it
+  printf-like, so CI's `-Wall -Werror` rejects an argument that does not match
+  its specifier. Device builds are unchanged: on ESP-IDF 5 `uint32_t` is
+  `unsigned long`, and every `%u` of a node id would warn there.
+- **`sendToInternet` example.** The startup WhatsApp retries every 30 s until
+  a gateway with Internet is known instead of firing once before a regular
+  node has joined, and the cloud endpoint moved to a `CLOUD_URL` define whose
+  placeholder is skipped with a message rather than reported as
+  `connection refused`.
+
+## [2.0.2] - 2026-09-08
+
+Two gateway defects that reached users on 2.0.1, both in code the desktop test
+suite cannot compile, and both now asserted on real hardware. **Upgrade if a
+node of yours is a bridge**: on 2.0.1 a bridge could not use its own uplink at
+all, and any request that failed below HTTP was reported to the origin node as
+`HTTP 65535`.
+
+### Fixed
+
+- **A bridge could not reach the Internet through its own uplink** (#445).
+  `sendToInternet()` serves a request locally only when `hasLocalInternet()` is
+  true. That flag is set by the Internet health checker, and `initAsBridge()`
+  never started it — only `initAsSharedGateway()` did — so on a bridge it was
+  false for the life of the node. Every request the bridge itself made fell
+  through to the mesh-routing path and failed with *"No active mesh
+  connections"* whenever no peer had joined yet, which is exactly what a
+  single-node sketch does at start-up. `initAsBridge()` now starts the checker,
+  without touching a `setInternetCheckTarget()` the sketch made before `init()`.
+
+- **A request that never reached a server was reported as `HTTP 65535`** (#446).
+  `HTTPClient` returns an `int`: positive is an HTTP status, negative is one of
+  its own transport errors (`-1` refused, `-11` read timeout). The gateway
+  stored that in a `uint16_t`, so `-1` wrapped to 65535 — a value that passes
+  `httpCode > 0`. Three things followed: the origin node was told "HTTP 65535",
+  the `errorToString()` branch was unreachable, and `handleGatewayAck()` filed a
+  retryable network failure as a permanent HTTP status. A transport failure now
+  arrives as `httpStatus 0` with the real reason in the error string, which is
+  what the origin node already treats as retryable.
+
+- **A lone gateway consumed its retries without issuing a single request.**
+  `retryInternetRequest()` knew only the remote path: it required an active mesh
+  connection and then routed to a discovered bridge, so a gateway serving its
+  own request satisfied neither check and reported *"Max retries exceeded"* in
+  place of the transport error that actually happened — the same dishonest
+  failure as #446, one layer up. A retry whose gateway is this node now goes
+  back to the local handler.
+
+### Changed
+
+- The HTTP result classification moved into `gateway::classifyHttpResult()`, so
+  the desktop test suite exercises the same function `wifi.hpp` calls. The
+  previous test duplicated the classification — and duplicated the `uint16_t`
+  with it, which is why it mirrored #446 instead of catching it.
+
+### Validated
+
+Both fixes are asserted on the ESP32 farm, not only in desktop tests: a bridge
+must report Internet on its own uplink, must relay its own request through it,
+must do so with **no mesh peer at all**, and must return `httpStatus 0` with a
+real reason for a refused port, an unresolvable host and a destination that
+answers past the timeout. Those rows did not exist when 2.0.1 shipped — the
+gateway suite passed on the run that carried both bugs.
+
+
 ## [2.0.1] - 2026-09-07
 
 A packaging and documentation release. **No library behaviour changed**: the

package/CONTRIBUTING.md

@@ -55,6 +55,21 @@ and OTA behaviour is validated on the Alteriom hardware-in-the-loop farm; a
 maintainer runs it on a pull request by adding the `run-hil` label, and the
 release gate is three consecutive clean runs of the whole suite.
 
+### The HTTP test point
+
+`test/mock-http-server/server.py` is the controlled Internet destination for
+`sendToInternet()` tests at every level. It answers the way real services do,
+including the ways they get it wrong (its CallMeBot emulation returns refusals
+as HTTP 201 and 203, as the real API does), and it keeps a delivery ledger:
+`GET /requests/{tag}` says whether the service actually accepted a request.
+The desktop CI job starts one and exports `PAINLESSMESH_TESTPOINT`, and
+`catch_issue450_testpoint_semantics` makes real HTTP requests to it and
+requires the library's verdict to match the ledger. The farm's gateway probe
+serves the same routes with the same record shape, so a hardware row and a
+desktop scenario are measured against one source of truth. When a gateway bug
+comes in, add the service behaviour that exposed it to the server first, then
+the test that fails against it.
+
 ### Adding tests for new features
 
 1. **Unit tests**: add to `test/catch/` for new components.

package/README.md

@@ -596,9 +596,13 @@ These are the message types used by applications built on painlessMesh:
 - **Event Coordination** - Synchronized displays, distributed processing
 - **Bridge Networks** - Connect mesh to WiFi/Internet/MQTT - [📖 Bridge Guide](BRIDGE_TO_INTERNET.md)
 
-## Latest Release: v2.0.1 (September 7, 2026)
+## Latest Release: v2.0.3 (September 11, 2026)
 
-**A packaging fix over 2.0.0 — no library behaviour changed.** 2.0.0's installation instructions named a PlatformIO package that has no 2.0.0 (`alteriom/…` stops at 1.10.0; releases go out under `sparck75`), and its GitHub release carries no library archive because the upload was refused by an immutable release. Both are fixed; upgrading from 2.0.0 is optional.
+**`sendToInternet()` fixes — upgrade if any node of yours is a bridge or relays to the Internet.** On 2.0.2 a bridge's own sends were refused with "No active mesh connections" for the first 30 s after `initAsBridge()`, because the health check's first probe ran while the station was still associating. The gateway also decided delivery on the HTTP status alone: CallMeBot answers a refusal with HTTP 201, so a message it refused could be reported as sent, and every failure reached the origin node as a bare number. The gateway now reads the start of the response body, counts only 200/201/202/204 without a refusing body as delivered, and hands every failure to your callback with the service's own words. A destination whose name does not resolve no longer stalls an ESP32 gateway on every attempt: it is refused for 60 s after one failed lookup. And a bridge that reboots, crashes or is reflashed as a regular node no longer swallows the requests its peers still send it for a minute: it answers that it is not a gateway, and the sender moves to the next one at once.
+
+**2.0.2 — two gateway fixes.** On 2.0.1 a bridge could not reach the Internet through its own uplink at all (`initAsBridge()` never started the health checker that `sendToInternet()`'s local path depends on, so a bridge with no peer yet failed with "No active mesh connections"), and any request that failed *below* HTTP — refused, unresolvable, timed out — was reported to the origin node as `HTTP 65535`, a truncated `-1`, which also stopped it from being retried. Both are now asserted on the hardware rig, including a bridge with no mesh peer at all.
+
+**2.0.1 — a packaging fix over 2.0.0, no library behaviour changed.** 2.0.0's installation instructions named a PlatformIO package that has no 2.0.0 (`alteriom/…` stops at 1.10.0; releases go out under `sparck75`), and its GitHub release carried no library archive because the upload was refused by an immutable release.
 
 **2.0.0 — delivery confirmation, a unified send path, and a mesh that holds together on real hardware**
 

package/RELEASE_GUIDE.md

@@ -38,13 +38,23 @@ These files must always contain the same semantic version:
 - `library.properties`
 - `library.json`
 - `package.json`
+- `package-lock.json` (the root `version` and `packages[""].version`)
+- `src/AlteriomPainlessMesh.h` (the version string and the MAJOR/MINOR/PATCH
+  defines a sketch compiles against)
+- `doxygen/Doxyfile` (`PROJECT_NUMBER`, the number on every generated API page)
 
-Use the repository script to change them together:
+Use the repository script to change them together; it updates all six and then
+verifies they agree:
 
 ```bash
 ./scripts/bump-version.sh patch
+./scripts/bump-version.sh patch 2.0.3 --yes   # no prompt, for CI or an agent
 ```
 
+`jq` is used when it is installed and awk otherwise, and both paths change only
+the package's own version — never a dependency range. `test/ci/test_bump_version.sh`
+holds that, and the Code Quality job runs it.
+
 You may use `minor`, `major`, or an explicit version when the release plan
 requires it. Version 2.0 patch releases must remain wire-compatible with the
 2.0 protocol.
@@ -82,12 +92,24 @@ The pull request must also pass all required GitHub checks, including:
 - formatting and documentation checks
 - CodeQL
 - simulator scenarios
-- ESP32, ESP32-C3, and ESP32-S3 hardware-in-the-loop coverage when the change
+- hardware-in-the-loop coverage on the six-family board bank when the change
   touches radio, routing, gateway, OTA, or platform-specific behavior
 
-For a hardware defect, attach the HIL run identifier and report link to the
-pull request. A unit test alone is not sufficient evidence for a radio or
-multi-device timing fix.
+### How the hardware result arrives
+
+The Alteriom ESP32 farm is a separate, private repository, so nothing in this
+one triggers it — a public workflow can hold no credential for it. The farm
+watches instead: it picks up `main` and open non-fork pull requests that touch
+`src/`, `examples/`, `test/` or the library metadata, runs the simulator gate
+and then the physical suite, and posts the verdict back as a **`farm/hil`
+commit status** with a link to the run. Expect it within roughly half an hour
+of a push; nothing is required of the author.
+
+For a hardware defect, link that run in the pull request. A unit test alone is
+not sufficient evidence for a radio or multi-device timing fix — and a desktop
+test that re-implements the logic it is checking is not evidence at all
+(`catch_http_status_codes.cpp` copied the `uint16_t` that caused #446 and so
+mirrored the bug instead of catching it).
 
 ## Review gate
 

package/examples/sendToInternet/README.md

@@ -187,10 +187,10 @@ The callback provides `httpStatus` to indicate the result:
 
 **FAILURE (success = false):**
 - `203 Non-Authoritative Information` - **Cached/proxied response, NOT actual delivery**
-- `4xx` - Client error (bad request, unauthorized, not found, etc.)
-- `5xx` - Server error (service unavailable, gateway timeout, etc.)
 
-⚠️ **Important:** HTTP 203 is treated as **FAILURE** because it indicates the response came from a cache or proxy, not from the actual WhatsApp API server. If you see `HTTP Status: 203`, the message was **NOT delivered**.
+⚠️ **The status alone does not say whether WhatsApp got the message.** CallMeBot answers a refusal (for example "Too many requests") with HTTP 201 or HTTP 203, the same error page under both. The gateway therefore reads the start of the response body: a 2xx whose body says the service refused the request is reported as a failure, with the service's own words in the callback's `error` string, and HTTP 203 stays a failure because a proxy, not the WhatsApp API, may have answered. If your callback prints `HTTP 201: service refused the request: Oops! Too many requests...`, that is CallMeBot talking, and the message was **NOT delivered**. Likewise `HTTP 208: not a delivery the gateway can confirm: ...`: CallMeBot answers 208 to messages that never arrive (issues #450 and #452), so only 200, 201, 202 and 204 with a clean body are reported as sent, and the rest of the line is whatever the service said.
+
+Also replace `CLOUD_URL` at the top of the sketch: the placeholder `api.example.com` does not resolve, and until you change it the sketch skips the cloud send and says so instead of reporting `connection refused` every minute.
 
 ## Files
 

package/examples/sendToInternet/sendToInternet.ino

@@ -74,6 +74,19 @@
 #define WHATSAPP_PHONE  "+1234567890"    // Your phone number with country code
 #define WHATSAPP_APIKEY "your_api_key"   // Your Callmebot API key
 
+// ============================================
+// Cloud API Configuration
+// ============================================
+// The endpoint the periodic sensor readings are POSTed to. Replace it with
+// your own; the placeholder below does not resolve, so until you do the
+// sketch skips the cloud send and says so rather than reporting
+// "connection refused" every minute (issue #450).
+// Example endpoints:
+// - ThingsBoard: "https://demo.thingsboard.io/api/v1/YOUR_TOKEN/telemetry"
+// - AWS IoT:     "https://YOUR_ENDPOINT.iot.us-east-1.amazonaws.com/topics/sensors"
+// - Custom API:  "https://api.yourserver.com/sensors/data"
+#define CLOUD_URL       "https://api.example.com/sensors"
+
 // ============================================
 // Sensor Simulation Configuration
 // ============================================
@@ -115,6 +128,15 @@ String urlEncode(const String& str);
 // Task to periodically send sensor data (simulated)
 Task taskSendSensorData(60000, TASK_FOREVER, &sendSensorDataToCloud);
 
+// The startup WhatsApp used to be a single 30 s one-shot. A regular node that
+// took longer than that to find the mesh -- following a bridge to another
+// channel takes about a minute -- fired it with no gateway in sight and never
+// tried again (issue #450). It now retries until a gateway with Internet is
+// known, then disables itself.
+void sendStartupAlert();
+Task taskStartupAlert(30000, TASK_FOREVER, &sendStartupAlert);
+String startupMsg;
+
 // ============================================
 // URL Encoding Helper
 // ============================================
@@ -184,13 +206,12 @@ void sendAlertToWhatsApp(String message) {
   
   // Use sendToInternet() to route the request through a gateway
   // The callback will be invoked when we get a response (or timeout)
-  // 
-  // SUCCESS CODES: Only specific HTTP codes indicate genuine delivery:
-  // - 200 OK: Standard success (most common for WhatsApp API)
-  // - 201 Created, 202 Accepted, 204 No Content
-  // 
-  // FAILURE: HTTP 203 (Non-Authoritative) is treated as FAILURE because
-  // it indicates a cached/proxied response, not actual delivery to WhatsApp.
+  //
+  // The gateway reads the response body, not only the status: CallMeBot
+  // answers a refusal ("Too many requests") with HTTP 201 or 203, so a 2xx
+  // alone proves nothing. A refusal arrives here as success=false with the
+  // service's own words in `error`; HTTP 203 stays a failure because a proxy,
+  // not WhatsApp, may have answered.
   uint32_t msgId = mesh.sendToInternet(
     url,
     "",  // No payload needed for GET request - params are in URL
@@ -249,14 +270,13 @@ void sendSensorDataToCloud() {
     return;
   }
   
-  // Send to cloud API (replace with your actual endpoint)
-  // Example endpoints:
-  // - ThingsBoard: "https://demo.thingsboard.io/api/v1/YOUR_TOKEN/telemetry"
-  // - AWS IoT: "https://YOUR_ENDPOINT.iot.us-east-1.amazonaws.com/topics/sensors"
-  // - Custom API: "https://api.yourserver.com/sensors/data"
-  
-  String cloudUrl = "https://api.example.com/sensors";  // Replace with your endpoint
-  
+  // Send to the cloud API configured at the top of the sketch
+  String cloudUrl = CLOUD_URL;
+  if (cloudUrl.indexOf("example.com") >= 0) {
+    Serial.println("   (CLOUD_URL is still the placeholder; set your endpoint to send readings)");
+    return;
+  }
+
   uint32_t msgId = mesh.sendToInternet(
     cloudUrl,
     payload,
@@ -276,6 +296,21 @@ void sendSensorDataToCloud() {
 // Mesh Callbacks
 // ============================================
 
+/**
+ * Send the startup notification once a gateway with Internet is known.
+ *
+ * Runs every 30 s from taskStartupAlert until it has handed the message to
+ * sendToInternet(), then disables itself.
+ */
+void sendStartupAlert() {
+  if (!mesh.hasInternetConnection()) {
+    Serial.println("(startup WhatsApp waiting for a gateway with Internet; retrying in 30 s)");
+    return;
+  }
+  sendAlertToWhatsApp(startupMsg);
+  taskStartupAlert.disable();
+}
+
 void receivedCallback(uint32_t from, String& msg) {
   Serial.printf("📨 Received from %u: %s\n", from, msg.c_str());
 }
@@ -347,14 +382,14 @@ void setup() {
   Serial.printf("Is Bridge: %s\n", mesh.isBridge() ? "YES" : "NO");
   Serial.println("================================================\n");
   
-  // Send a startup notification via WhatsApp (demonstrates sendToInternet)
-  String startupMsg = "🚀 Node " + String(mesh.getNodeId()) + " started!";
-  
-  // Delay to allow mesh to connect first
-  Serial.println("Will attempt to send startup WhatsApp in 30 seconds...\n");
-  mesh.addTask([startupMsg]() {
-    sendAlertToWhatsApp(startupMsg);
-  }, 30000);  // 30 second delay
+  // Send a startup notification via WhatsApp (demonstrates sendToInternet).
+  // First attempt in 30 s, then every 30 s until a gateway with Internet is
+  // known: a bridge can use its own uplink at once, a regular node has to
+  // find the mesh first.
+  startupMsg = "🚀 Node " + String(mesh.getNodeId()) + " started!";
+  Serial.println("Will send the startup WhatsApp as soon as a gateway with Internet is known (first try in 30 s)...\n");
+  userScheduler.addTask(taskStartupAlert);
+  taskStartupAlert.enableDelayed();
 }
 
 // ============================================

package/library.json

@@ -6,7 +6,7 @@
     "type": "git",
     "url": "https://github.com/Alteriom/painlessMesh"
   },
-  "version": "2.0.1",
+  "version": "2.0.3",
   "frameworks": [
     "arduino"
   ],

package/library.properties

@@ -1,5 +1,5 @@
 name=Alteriom PainlessMesh
-version=2.0.1
+version=2.0.3
 author=Coopdis,Scotty Franzyshen,Edwin van Leeuwen,Germán Martín,Maximilian Schwarz,Doanh Doanh,Alteriom
 maintainer=Alteriom
 sentence=A painless way to setup a mesh with ESP8266 and ESP32 devices with Alteriom extensions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alteriom/painlessmesh",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "painlessMesh is a user-friendly library for creating mesh networks with ESP8266 and ESP32 devices. This Alteriom fork includes additional packages for sensor data (SensorPackage), device commands (CommandPackage), and status monitoring (StatusPackage). It handles routing and network management automatically, so you can focus on your application. The library uses JSON-based messaging and syncs time across all nodes, making it ideal for coordinated behaviour like synchronized light displays or sensor networks reporting to a central node.",
   "keywords": [
     "arduino",

package/src/AlteriomPainlessMesh.h

@@ -29,10 +29,10 @@
 /**
  * @brief AlteriomPainlessMesh library version information
  */
-#define ALTERIOM_PAINLESS_MESH_VERSION "2.0.1"
+#define ALTERIOM_PAINLESS_MESH_VERSION "2.0.3"
 #define ALTERIOM_PAINLESS_MESH_VERSION_MAJOR 2
 #define ALTERIOM_PAINLESS_MESH_VERSION_MINOR 0
-#define ALTERIOM_PAINLESS_MESH_VERSION_PATCH 1
+#define ALTERIOM_PAINLESS_MESH_VERSION_PATCH 3
 
 /**
  * @brief Library description and usage information