Enhance pixel color detection in SensorsBlocks.js with improved error handling and additional utility methods#4545

Merged

walterbender merged 11 commits intosugarlabs:masterfrom

Ashrafmuhmed:RefactoringSensorsBlocks

Mar 22, 2025

Contributor

Ashrafmuhmed commented Mar 16, 2025

Description

This PR refactors the GetColorPixelBlock class in js/blocks/SensorsBlocks.js to improve its readability, robustness, and maintainability. These changes enhance the block’s color detection functionality and lay a foundation for future extensions.

Changes Made

Modularized Logic: Split the arg method into helper functions (getTurtleSafely, getPixelData, detectColor, getBackgroundColor, getFallbackColor) for better readability and testability.
Added Error Handling: Introduced a try-catch block to handle failures (e.g., missing turtle or canvas context), with a fallback to a default gray color (searchColors(128, 128, 128)).
Preserved Functionality: Kept the original behavior (color detection via canvas pixel data) while ensuring the turtle’s visibility is safely toggled.
Updated Documentation: Enhanced JSDoc comments to clarify return values, exceptions, and method purposes.

Ashrafmuhmed and others added 6 commits

February 21, 2025 18:02


          fix localization strings for motion-y and get-protein in Arabic

c533fac


          Merge branch 'sugarlabs:master' into master

ebccc9f


          Merge branch 'sugarlabs:master' into master

a9162db


          Refactor text cleaning and translation retrieval in utils.js


          Fix comment formatting in getTranslationWithCase function

52ec3a5


          Enhance pixel color detection in SensorsBlocks.js with improved error…

bfcfdf1

… handling and additional utility methods

Contributor

github-actions bot commented Mar 16, 2025

✅ All Jest tests passed! This PR is ready to merge.


          fix Eslint warnings

ed4585c

Contributor

github-actions bot commented Mar 16, 2025

✅ All Jest tests passed! This PR is ready to merge.

Member

walterbender commented Mar 22, 2025

I think these changes are good but a couple of questions.
(1) It seems like the getTurtleSafely method is more general than just for this code block. Maybe it should be a function in turtles.js that can be reused elsewhere?
(2) We have a test suite for Sensors. Can you modify the tests to include your new methods?


          Fix merge conflict

289472c

Contributor

github-actions bot commented Mar 22, 2025

✅ All Jest tests passed! This PR is ready to merge.


          Merge branch 'master' into RefactoringSensorsBlocks

3bc889b

Contributor

github-actions bot commented Mar 22, 2025

✅ All Jest tests passed! This PR is ready to merge.


          Add tests for the new methods in SensorsBlocks.js

b165ced

Contributor

github-actions bot commented Mar 22, 2025

✅ All Jest tests passed! This PR is ready to merge.


          fix eslint warning

f1ebe56

Contributor

github-actions bot commented Mar 22, 2025

✅ All Jest tests passed! This PR is ready to merge.

Contributor Author

Ashrafmuhmed commented Mar 22, 2025

@walterbender
(1) - I have enhanced getTurtle() to handle missing turtles.
(2) - I have added tests for the new methods in SensorsBlocks.js and all the tests pass!
Let me know if there’s anything else you’d like me to adjust!

walterbender merged commit 893603a into sugarlabs:master

5 checks passed

sa-fw-an pushed a commit to sa-fw-an/musicblocks that referenced this pull request


          Enhance pixel color detection in SensorsBlocks.js with improved error…

4ff97f9

… handling and additional utility methods (sugarlabs#4545)

* fix localization strings for motion-y and get-protein in Arabic

* Refactor text cleaning and translation retrieval in utils.js

* Fix comment formatting in getTranslationWithCase function

* Enhance pixel color detection in SensorsBlocks.js with improved error handling and additional utility methods

* fix Eslint warnings

* Add tests for the new methods in SensorsBlocks.js

* fix eslint warning

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet