perf: Enhance Windows package info plugin with error handling and improved documentation #3144
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…documentation - Added error handling in the `getAll` method to catch and report exceptions. - Improved documentation comments for `PackageInfoPlusWindowsPlugin` and its methods. - Included additional comments to explain the workaround for UNC path issues on Windows. - Ensured consistent formatting and naming conventions throughout the code. - Enhanced the `_GetOrNull` extension to provide a safer way to access list elements. These updates improve the robustness and maintainability of the Windows-specific implementation of the `package_info_plus` plugin.
miquelbeltran
requested changes
Aug 5, 2024
| return Future.value(data); | ||
| } catch (e) { | ||
| // Handle exceptions, e.g., logging or rethrowing | ||
| return Future.error('Failed to retrieve package info: $e'); |
There was a problem hiding this comment.
I am not sure if I see the point of catching an exception and then returning a Future.error. This is the same as just throwing the exception up, except in this case the exception info is lost and instead is wrapped in a String.
| Future<PackageInfoData> getAll({String? baseUrl}) { | ||
| String resolvedExecutable = Platform.resolvedExecutable; | ||
|
|
||
| /// Workaround for https://github.com/dart-lang/sdk/issues/52309 |
There was a problem hiding this comment.
Why did you remove this ticket reference?
|
Agree with what is said above. It seems like some PR for the sake of PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
getAllmethod to catch and report exceptions.PackageInfoPlusWindowsPluginand its methods._GetOrNullextension to provide a safer way to access list elements.These updates improve the robustness and maintainability of the Windows-specific implementation of the
package_info_plusplugin.Related Issues
CHANGELOG.mdnor the plugin version inpubspec.yamlfiles.flutter analyze) does not report any problems on my PR.Breaking Change
Does your PR require plugin users to manually update their apps to accommodate your change?
!in the title as explained in Conventional Commits).