Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(wifi_scan): Fix some edge cases where WiFi Scan may fail #11188

Merged
merged 1 commit into from
Mar 27, 2025

Conversation

me-no-dev
Copy link
Member

Rework of #11075

This pull request focuses on memory management improvements and code simplification in the WiFiScan.cpp file. The most important changes include replacing delete[] with free(), using calloc() instead of new, and simplifying the scan completion check.

Memory management improvements:

  • Replaced delete[] with free() and set the pointer to NULL in the _scanDone and scanDelete methods to prevent potential memory leaks. [1] [2]
  • Replaced new with calloc() for allocating memory for WiFiScanClass::_scanResult to ensure the allocated memory is zero-initialized.

Code simplification:

  • Simplified the scan completion check in the scanComplete method by removing unnecessary conditions and comments.

Other changes:

  • Removed unnecessary increment of _scanStarted to prevent 0 from millis overflow.

Closes: #11075

Copy link
Contributor

Messages
📖 🎉 Good Job! All checks are passing!

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


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for 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 7553880

@me-no-dev me-no-dev added the Status: Pending Merge Pull Request is ready to be merged label Mar 27, 2025
Copy link
Contributor

github-actions bot commented Mar 27, 2025

Test Results

 76 files   76 suites   12m 42s ⏱️
 38 tests  38 ✅ 0 💤 0 ❌
241 runs  241 ✅ 0 💤 0 ❌

Results for commit 7553880.

♻️ This comment has been updated with latest results.

Copy link
Contributor

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.

MemoryFLASH [bytes]FLASH [%]RAM [bytes]RAM [%]
TargetDECINCDECINCDECINCDECINC
ESP32P40⚠️ +2700.00⚠️ +0.040⚠️ +160.00⚠️ +0.06
ESP32S30⚠️ +1760.00⚠️ +0.02000.000.00
ESP32S20⚠️ +1800.00⚠️ +0.02000.000.00
ESP32C30⚠️ +2700.00⚠️ +0.030⚠️ +160.00⚠️ +0.05
ESP32C60⚠️ +2700.00⚠️ +0.030⚠️ +160.00⚠️ +0.04
ESP320⚠️ +1600.00⚠️ +0.02000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32P4ESP32S3ESP32S2ESP32C3ESP32C6ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
libraries/WiFi/examples/FTM/FTM_Initiator⚠️ +2660⚠️ +1600⚠️ +1680⚠️ +2640⚠️ +2620⚠️ +1440
libraries/WiFi/examples/FTM/FTM_Responder⚠️ +262⚠️ +16⚠️ +1640⚠️ +1520⚠️ +264⚠️ +16⚠️ +2660⚠️ +1480
libraries/WiFi/examples/SimpleWiFiServer⚠️ +260⚠️ +16⚠️ +1640⚠️ +1480⚠️ +2620⚠️ +2620⚠️ +1480
libraries/WiFi/examples/WiFiAccessPoint⚠️ +262⚠️ +16⚠️ +1600⚠️ +1520⚠️ +2620⚠️ +2620⚠️ +1520
libraries/WiFi/examples/WiFiClient⚠️ +2620⚠️ +1240⚠️ +1520⚠️ +2600⚠️ +2600⚠️ +1400
libraries/WiFi/examples/WiFiClientBasic⚠️ +2700⚠️ +1640⚠️ +1520⚠️ +268⚠️ +16⚠️ +270⚠️ +16⚠️ +1400
libraries/WiFi/examples/WiFiClientConnect⚠️ +260⚠️ +16⚠️ +1560⚠️ +1520⚠️ +264⚠️ +16⚠️ +2640⚠️ +1440
libraries/WiFi/examples/WiFiClientEvents⚠️ +262⚠️ +16⚠️ +1280⚠️ +1480⚠️ +264⚠️ +16⚠️ +2640⚠️ +1480
libraries/WiFi/examples/WiFiClientStaticIP⚠️ +262⚠️ +16⚠️ +1600⚠️ +1560⚠️ +2620⚠️ +2640⚠️ +1440
libraries/WiFi/examples/WiFiExtender⚠️ +262⚠️ +16⚠️ +1320⚠️ +1560⚠️ +262⚠️ +16⚠️ +2640⚠️ +1440
libraries/WiFi/examples/WiFiIPv6⚠️ +2620⚠️ +1560⚠️ +1560⚠️ +2640⚠️ +2640⚠️ +1440
libraries/WiFi/examples/WiFiMulti⚠️ +2700⚠️ +1720⚠️ +1760⚠️ +270⚠️ +16⚠️ +270⚠️ +16⚠️ +1600
libraries/WiFi/examples/WiFiMultiAdvanced⚠️ +2700⚠️ +1760⚠️ +1720⚠️ +270⚠️ +16⚠️ +270⚠️ +16⚠️ +1560
libraries/WiFi/examples/WiFiScan⚠️ +266⚠️ +16⚠️ +1640⚠️ +1760⚠️ +268⚠️ +16⚠️ +2660⚠️ +1480
libraries/WiFi/examples/WiFiScanAsync⚠️ +254⚠️ +16⚠️ +1640⚠️ +1760⚠️ +254⚠️ +16⚠️ +2540⚠️ +1400
libraries/WiFi/examples/WiFiScanDualAntenna⚠️ +266⚠️ +16⚠️ +1560⚠️ +1720⚠️ +266⚠️ +16⚠️ +2660⚠️ +1480
libraries/WiFi/examples/WiFiScanTime⚠️ +268⚠️ +16⚠️ +1760⚠️ +1800⚠️ +268⚠️ +16⚠️ +2680⚠️ +1480
libraries/WiFi/examples/WiFiTelnetToSerial⚠️ +2700⚠️ +1680⚠️ +1600⚠️ +270⚠️ +16⚠️ +270⚠️ +16⚠️ +1600
libraries/WiFi/examples/WiFiUDPClient⚠️ +2620⚠️ +1600⚠️ +1560⚠️ +2640⚠️ +2640⚠️ +1560
libraries/WiFi/examples/WPS--⚠️ +1560⚠️ +1200⚠️ +264⚠️ +16⚠️ +2640⚠️ +1480
libraries/WiFi/examples/WiFiBlueToothSwitch--⚠️ +1720--⚠️ +262⚠️ +16⚠️ +262⚠️ +16⚠️ +1480
libraries/WiFi/examples/WiFiClientEnterprise--⚠️ +1640⚠️ +1560⚠️ +262⚠️ +16⚠️ +2620⚠️ +1320
libraries/WiFi/examples/WiFiSmartConfig--⚠️ +1680⚠️ +1480⚠️ +2620⚠️ +2620⚠️ +1120

@me-no-dev me-no-dev merged commit 1725893 into master Mar 27, 2025
62 of 71 checks passed
@me-no-dev me-no-dev deleted the bugfix/wifi_scan branch March 27, 2025 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Pending Merge Pull Request is ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant