fix(client): Make flush() call clear() and deprecate it #10242

me-no-dev · 2024-08-26T08:37:32Z

This is a compromise for issues caused by #9453

Example output:

/var/folders/74/n3f3k71s7lv_snk832kfgjfw0000gn/T/arduino_modified_sketch_265854/WiFiIPv6.ino: In function 'void wifiConnectedLoop()':
/var/folders/74/n3f3k71s7lv_snk832kfgjfw0000gn/T/arduino_modified_sketch_265854/WiFiIPv6.ino:53:20: warning: 'virtual void NetworkUDP::flush()' is deprecated: Use clear() instead. [-Wdeprecated-declarations]
   53 |     ntpClient.flush();
      |     ~~~~~~~~~~~~~~~^~
In file included from /Users/user/Documents/Arduino/hardware/espressif/esp32/libraries/Network/src/Network.h:14,
                 from /Users/user/Documents/Arduino/hardware/espressif/esp32/libraries/WiFi/src/WiFiGeneric.h:39,
                 from /Users/user/Documents/Arduino/hardware/espressif/esp32/libraries/WiFi/src/WiFiSTA.h:29,
                 from /Users/user/Documents/Arduino/hardware/espressif/esp32/libraries/WiFi/src/WiFi.h:33,
                 from /var/folders/74/n3f3k71s7lv_snk832kfgjfw0000gn/T/arduino_modified_sketch_265854/WiFiIPv6.ino:1:
/Users/user/Documents/Arduino/hardware/espressif/esp32/libraries/Network/src/NetworkUdp.h:68:8: note: declared here
   68 |   void flush();  // Print::flush tx
      |        ^~~~~

This is a compromise for issues caused by #9453

github-actions · 2024-08-26T08:38:09Z

	Messages
📖	🎉 Good Job! All checks are passing!

👋 Hello me-no-dev, we appreciate your contribution to this project!

Click to see more instructions ...

This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...

We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 9cb5dd5

github-actions · 2024-08-26T08:44:45Z

Test Results

56 files - 83 56 suites - 83 4m 53s ⏱️ - 1h 38m 16s
21 tests - 9 21 ✅ - 9 0 💤 ±0 0 ❌ ±0
135 runs - 168 135 ✅ - 168 0 💤 ±0 0 ❌ ±0

Results for commit 9cb5dd5. ± Comparison against base commit cd3d0bf.

This pull request removes 9 tests.

performance.coremark.test_coremark ‑ test_coremark
performance.fibonacci.test_fibonacci ‑ test_fibonacci
performance.psramspeed.test_psramspeed ‑ test_psramspeed
performance.ramspeed.test_ramspeed ‑ test_ramspeed
performance.superpi.test_superpi ‑ test_superpi
test_touch_errors
test_touch_interrtupt
test_touch_read
validation.periman.test_periman ‑ test_periman

♻️ This comment has been updated with latest results.

github-actions · 2024-08-26T08:54:19Z

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

Memory	FLASH [bytes]		FLASH [%]		RAM [bytes]		RAM [%]
Target	DEC	INC	DEC	INC	DEC	INC	DEC	INC
ESP32S3	0	⚠️ +88	0.00	⚠️ +0.01	0	0	0.00	0.00
ESP32S2	0	⚠️ +108	0.00	⚠️ +0.01	0	0	0.00	0.00
ESP32C3	0	⚠️ +74	0.00	⚠️ +0.01	0	0	0.00	0.00
ESP32C6	0	⚠️ +74	0.00	⚠️ +0.01	0	0	0.00	0.00
ESP32H2	0	⚠️ +38	0.00	⚠️ +0.01	0	0	0.00	0.00
ESP32	0	⚠️ +108	0.00	⚠️ +0.01	0	0	0.00	0.00

Click to expand the detailed deltas report [usage change in BYTES]

Target	ESP32S3		ESP32S2		ESP32C3		ESP32C6		ESP32H2		ESP32
Example	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM
Ethernet/examples/ETH_W5500_Arduino_SPI	⚠️ +36	0	⚠️ +60	0	⚠️ +32	0	⚠️ +32	0	⚠️ +32	0	⚠️ +72	0
Ethernet/examples/ETH_W5500_IDF_SPI	⚠️ +52	0	⚠️ +56	0	⚠️ +32	0	⚠️ +32	0	⚠️ +32	0	⚠️ +64	0
Ethernet/examples/ETH_WIFI_BRIDGE	⚠️ +28	0	⚠️ +28	0	0	0	0	0	-	-	⚠️ +28	0
NetworkClientSecure/examples/WiFiClientInsecure	⚠️ +44	0	⚠️ +64	0	⚠️ +34	0	⚠️ +34	0	-	-	⚠️ +68	0
NetworkClientSecure/examples/WiFiClientPSK	⚠️ +56	0	⚠️ +60	0	⚠️ +34	0	⚠️ +34	0	-	-	⚠️ +68	0
NetworkClientSecure/examples/WiFiClientSecure	⚠️ +44	0	⚠️ +60	0	⚠️ +34	0	⚠️ +34	0	-	-	⚠️ +68	0
NetworkClientSecure/examples/WiFiClientSecureEnterprise	⚠️ +56	0	⚠️ +60	0	⚠️ +38	0	⚠️ +38	0	-	-	⚠️ +68	0
NetworkClientSecure/examples/WiFiClientSecureProtocolUpgrade	⚠️ +56	0	⚠️ +64	0	⚠️ +38	0	⚠️ +36	0	-	-	⚠️ +72	0
NetworkClientSecure/examples/WiFiClientShowPeerCredentials	⚠️ +36	0	⚠️ +60	0	⚠️ +38	0	⚠️ +38	0	-	-	⚠️ +68	0
NetworkClientSecure/examples/WiFiClientTrustOnFirstUse	⚠️ +56	0	⚠️ +60	0	⚠️ +38	0	⚠️ +36	0	-	-	⚠️ +68	0
PPP/examples/PPP_Basic	⚠️ +52	0	⚠️ +60	0	⚠️ +38	0	⚠️ +38	0	⚠️ +38	0	⚠️ +64	0
PPP/examples/PPP_WIFI_BRIDGE	⚠️ +28	0	⚠️ +28	0	0	0	0	0	-	-	⚠️ +28	0
WebServer/examples/AdvancedWebServer	⚠️ +56	0	⚠️ +60	0	⚠️ +36	0	⚠️ +36	0	-	-	⚠️ +72	0
WebServer/examples/FSBrowser	⚠️ +56	0	⚠️ +60	0	⚠️ +38	0	⚠️ +38	0	-	-	⚠️ +68	0
WebServer/examples/Filters	⚠️ +56	0	⚠️ +64	0	⚠️ +36	0	⚠️ +36	0	-	-	⚠️ +68	0
WebServer/examples/HelloServer	⚠️ +56	0	⚠️ +64	0	⚠️ +38	0	⚠️ +38	0	-	-	⚠️ +72	0
WebServer/examples/HttpAdvancedAuth	⚠️ +88	0	⚠️ +104	0	⚠️ +74	0	⚠️ +74	0	-	-	⚠️ +108	0
WebServer/examples/HttpAuthCallback	⚠️ +88	0	⚠️ +100	0	⚠️ +72	0	⚠️ +72	0	-	-	⚠️ +100	0
WebServer/examples/HttpAuthCallbackInline	⚠️ +88	0	⚠️ +108	0	⚠️ +74	0	⚠️ +72	0	-	-	⚠️ +108	0
WebServer/examples/HttpBasicAuth	⚠️ +88	0	⚠️ +104	0	⚠️ +72	0	⚠️ +74	0	-	-	⚠️ +108	0
WebServer/examples/HttpBasicAuthSHA1	⚠️ +84	0	⚠️ +104	0	⚠️ +72	0	⚠️ +72	0	-	-	⚠️ +100	0
WebServer/examples/HttpBasicAuthSHA1orBearerToken	⚠️ +76	0	⚠️ +92	0	⚠️ +72	0	⚠️ +72	0	-	-	⚠️ +104	0
WebServer/examples/MultiHomedServers	⚠️ +56	0	⚠️ +60	0	⚠️ +36	0	⚠️ +36	0	-	-	⚠️ +68	0
WebServer/examples/PathArgServer	⚠️ +60	0	⚠️ +60	0	⚠️ +38	0	⚠️ +38	0	-	-	⚠️ +60	0
WebServer/examples/SDWebServer	⚠️ +56	0	⚠️ +60	0	⚠️ +38	0	⚠️ +38	0	-	-	⚠️ +68	0
WebServer/examples/SimpleAuthentification	⚠️ +56	0	⚠️ +64	0	⚠️ +36	0	⚠️ +36	0	-	-	⚠️ +72	0
WebServer/examples/UploadHugeFile	⚠️ +56	0	⚠️ +64	0	⚠️ +38	0	⚠️ +38	0	-	-	⚠️ +68	0
WebServer/examples/WebServer	⚠️ +56	0	⚠️ +60	0	⚠️ +38	0	⚠️ +38	0	-	-	⚠️ +68	0
WebServer/examples/WebUpdate	⚠️ +56	0	⚠️ +64	0	⚠️ +36	0	⚠️ +36	0	-	-	⚠️ +60	0
WiFi/examples/FTM/FTM_Initiator	⚠️ +28	0	⚠️ +28	0	0	0	0	0	-	-	⚠️ +28	0
WiFi/examples/FTM/FTM_Responder	⚠️ +28	0	⚠️ +28	0	0	0	0	0	-	-	⚠️ +28	0
WiFi/examples/SimpleWiFiServer	⚠️ +56	0	⚠️ +60	0	⚠️ +36	0	⚠️ +36	0	-	-	⚠️ +68	0
WiFi/examples/WPS	⚠️ +28	0	⚠️ +28	0	0	0	0	0	-	-	⚠️ +28	0
WiFi/examples/WiFiAccessPoint	⚠️ +56	0	⚠️ +60	0	⚠️ +36	0	⚠️ +36	0	-	-	⚠️ +68	0
WiFi/examples/WiFiBlueToothSwitch	⚠️ +28	0	-	-	0	0	0	0	-	-	⚠️ +28	0
WiFi/examples/WiFiClient	⚠️ +56	0	⚠️ +60	0	⚠️ +36	0	⚠️ +36	0	-	-	⚠️ +72	0
WiFi/examples/WiFiClientBasic	⚠️ +56	0	⚠️ +60	0	⚠️ +38	0	⚠️ +38	0	-	-	⚠️ +104	0
WiFi/examples/WiFiClientConnect	⚠️ +28	0	⚠️ +28	0	0	0	0	0	-	-	⚠️ +28	0
WiFi/examples/WiFiClientEnterprise	⚠️ +56	0	⚠️ +60	0	⚠️ +36	0	⚠️ +36	0	-	-	⚠️ +68	0
WiFi/examples/WiFiClientEvents	⚠️ +28	0	⚠️ +28	0	0	0	0	0	-	-	⚠️ +28	0
WiFi/examples/WiFiClientStaticIP	⚠️ +60	0	⚠️ +60	0	⚠️ +38	0	⚠️ +38	0	-	-	⚠️ +72	0
WiFi/examples/WiFiExtender	⚠️ +28	0	⚠️ +28	0	0	0	0	0	-	-	⚠️ +28	0
WiFi/examples/WiFiIPv6	⚠️ +32	0	⚠️ +32	0	⚠️ +2	0	⚠️ +2	0	-	-	⚠️ +32	0
WiFi/examples/WiFiMulti	⚠️ +28	0	⚠️ +28	0	0	0	0	0	-	-	⚠️ +28	0
WiFi/examples/WiFiMultiAdvanced	⚠️ +56	0	⚠️ +64	0	⚠️ +36	0	⚠️ +38	0	-	-	⚠️ +72	0
WiFi/examples/WiFiScan	⚠️ +28	0	⚠️ +28	0	0	0	0	0	-	-	⚠️ +28	0
WiFi/examples/WiFiScanAsync	⚠️ +28	0	⚠️ +28	0	0	0	0	0	-	-	⚠️ +28	0
WiFi/examples/WiFiScanDualAntenna	⚠️ +28	0	⚠️ +28	0	0	0	0	0	-	-	⚠️ +28	0
WiFi/examples/WiFiScanTime	⚠️ +28	0	⚠️ +28	0	0	0	0	0	-	-	⚠️ +28	0
WiFi/examples/WiFiSmartConfig	⚠️ +28	0	⚠️ +28	0	0	0	0	0	-	-	⚠️ +28	0
WiFi/examples/WiFiTelnetToSerial	⚠️ +56	0	⚠️ +64	0	⚠️ +38	0	⚠️ +40	0	-	-	⚠️ +68	0
WiFi/examples/WiFiUDPClient	⚠️ +64	0	⚠️ +64	0	⚠️ +36	0	⚠️ +38	0	-	-	⚠️ +72	0
Ethernet/examples/ETH_LAN8720	-	-	-	-	-	-	-	-	-	-	⚠️ +64	0
Ethernet/examples/ETH_TLK110	-	-	-	-	-	-	-	-	-	-	⚠️ +64	0

JAndrassy · 2024-08-26T09:34:40Z

but there are multiplatform libraries which invoke flush() for TX and they will get the deprecation warning too and may unintentionally discard RX data. flush is virtual so even if invoked on a base class pointer it would discard RX data.

Jason2866 · 2024-08-26T10:06:35Z

@JAndrassy Ten times better than your code breaking change!! Still there is the possibility to revert the unneeded PR completely.

JAndrassy · 2024-08-26T10:09:59Z

@Jason2866 loosing RX data is not good.

me-no-dev · 2024-08-26T10:12:53Z

but there are multiplatform libraries which invoke flush() for TX and they will get the deprecation warning too

if those libs worked on ESP32, then they would expect to really clear(), so getting the deprecation warning is OK.

JAndrassy · 2024-08-26T10:19:46Z

@me-no-dev multiplatform libraries which don't care about the specific platform and just are at risk not working correctly on the esp32 platform. for example some library which prints to a provided Print pointer

TD-er · 2024-08-26T10:21:59Z

but there are multiplatform libraries which invoke flush() for TX and they will get the deprecation warning too and may unintentionally discard RX data. flush is virtual so even if invoked on a base class pointer it would discard RX data.

This deprecated warning is only shown when calling this virtual function if it is an instance of these 2 classes right?

Would it be better to suggest to check if change to clear() is needed then?
Or are you referring to making flush() call clear() ?

@me-no-dev multiplatform libraries which don't care about the specific platform and just are at risk not working correctly on the esp32 plaform

The alternative is what we're dealing with now, that existing ESP32 code is no longer working.
So I do think we all realize now what a terrible mess this has become.

me-no-dev · 2024-08-26T10:22:23Z

@JAndrassy you need to be able to accept some compromise. Breaking ESP specific libs is also not a good thing. This is such compromise that will allow libs to move to clear and in the future have your way.

fix(client): Make flush() call clear() and deprecate it

9cb5dd5

This is a compromise for issues caused by #9453

me-no-dev mentioned this pull request Aug 26, 2024

WiFiClient - rename flush() to clear() #9453

Merged

VojtechBartoska added the Area: WiFi Issue related to WiFi label Aug 26, 2024

VojtechBartoska added this to the 3.0.5 milestone Aug 26, 2024

VojtechBartoska added the Status: Review needed Issue or PR is awaiting review label Aug 26, 2024

me-no-dev added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Aug 27, 2024

me-no-dev merged commit 7633653 into master Aug 28, 2024
97 checks passed

me-no-dev deleted the re_flush_to_clear branch August 28, 2024 06:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(client): Make flush() call clear() and deprecate it #10242

fix(client): Make flush() call clear() and deprecate it #10242

me-no-dev commented Aug 26, 2024 •

edited

Loading

github-actions bot commented Aug 26, 2024 •

edited

Loading

github-actions bot commented Aug 26, 2024 •

edited

Loading

github-actions bot commented Aug 26, 2024

JAndrassy commented Aug 26, 2024 •

edited

Loading

Jason2866 commented Aug 26, 2024 •

edited

Loading

JAndrassy commented Aug 26, 2024

me-no-dev commented Aug 26, 2024

JAndrassy commented Aug 26, 2024 •

edited

Loading

TD-er commented Aug 26, 2024 •

edited

Loading

me-no-dev commented Aug 26, 2024

fix(client): Make flush() call clear() and deprecate it #10242

fix(client): Make flush() call clear() and deprecate it #10242

Conversation

me-no-dev commented Aug 26, 2024 • edited Loading

github-actions bot commented Aug 26, 2024 • edited Loading

github-actions bot commented Aug 26, 2024 • edited Loading

Test Results

github-actions bot commented Aug 26, 2024

Memory usage test (comparing PR against master branch)

JAndrassy commented Aug 26, 2024 • edited Loading

Jason2866 commented Aug 26, 2024 • edited Loading

JAndrassy commented Aug 26, 2024

me-no-dev commented Aug 26, 2024

JAndrassy commented Aug 26, 2024 • edited Loading

TD-er commented Aug 26, 2024 • edited Loading

me-no-dev commented Aug 26, 2024

me-no-dev commented Aug 26, 2024 •

edited

Loading

github-actions bot commented Aug 26, 2024 •

edited

Loading

github-actions bot commented Aug 26, 2024 •

edited

Loading

JAndrassy commented Aug 26, 2024 •

edited

Loading

Jason2866 commented Aug 26, 2024 •

edited

Loading

JAndrassy commented Aug 26, 2024 •

edited

Loading

TD-er commented Aug 26, 2024 •

edited

Loading