Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

[shared_preferences] Fix possible clash of string with double entry #3895

Merged
merged 13 commits into from Aug 20, 2021
Merged

[shared_preferences] Fix possible clash of string with double entry #3895

merged 13 commits into from Aug 20, 2021

Conversation

Cobinja
Copy link
Contributor

@Cobinja Cobinja commented May 15, 2021 •
edited

This prevents clashing of a string entry with a double entry.
This was already checked for string lists and big integers, yet doubles remained previously unchecked although being stored as strings as well.

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the Flutter Style Guide and the C++, Objective-C, Java style guides. (Note that unlike the flutter/flutter repo, the flutter/plugins repo does use dart format. See plugin_tool format)
  • I signed the CLA.
  • The title of the PR starts with the name of the plugin surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy.
  • I updated CHANGELOG.md to add a description of the change.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test exempt.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@google-cla google-cla bot added the cla: yes label May 15, 2021
@stuartmorgan
Copy link
Contributor

No new tests written because tests currently use InMemorySharedPreferencesStore

Limitations in existing testing isn't a reason to not add new tests. Is there a reason this is not easily testable? It seems like a unit test calling the method handler and validating that result.error is called should be straightforward. Failing that, it seems like an integration test covering this scenario would also be straightforward.

@Cobinja
Copy link
Contributor Author

Cobinja commented May 18, 2021

Is testing of the Android side already available? If so, can you point me to how that's done?
If it's not already available, I think it should be added by someone who knows the testing environment.

@stuartmorgan
Copy link
Contributor

It looks like Android unit tests aren't set up for this plugin yet. Integration tests should be fine for this though.

See https://github.com/flutter/flutter/wiki/Plugin-Tests for pointers to where the test files are and how to run them.

@Cobinja
[shared_preferences] Fix possible clash of string with double entry
532964e 
This prevents overwriting a double entry with a string on Android
@Cobinja
Added test for string clashes
8b244a2 
This adds integration tests for string clashes, but limits them to Android
@Cobinja
Added documentation for string clashes on Android
eef5119
@Cobinja
Fix formatting
90a2604
@Cobinja
Copy link
Contributor Author

Cobinja commented May 20, 2021

Integration test for string clashes are added and succeed

@Cobinja
Copy link
Contributor Author

Cobinja commented May 30, 2021

Resolved a merge conflict that was caused by a different PR/push adding an issue tracker to pubspec.yaml

@stuartmorgan stuartmorgan self-requested a review August 1, 2021 12:02
stuartmorgan
stuartmorgan suggested changes Aug 10, 2021
View reviewed changes
packages/shared_preferences/shared_preferences/CHANGELOG.md Outdated
@@ -1,6 +1,7 @@
## NEXT
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be updated to bump the version.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in the new commit.

packages/shared_preferences/shared_preferences/lib/shared_preferences.dart Outdated
@@ -128,6 +128,15 @@ class SharedPreferences {
_setValue('Double', key, value);

/// Saves a string [value] to persistent storage in the background.
///
/// Note: Due to limitations in Android's SharedPreferences,
/// values cannot start with either one of the following:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: s/either one/any of/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in the new commit.

.../shared_preferences/shared_preferences/example/integration_test/shared_preferences_test.dart Show resolved Hide resolved
packages/shared_preferences/shared_preferences/lib/shared_preferences.dart Outdated Show resolved Hide resolved
stuartmorgan
stuartmorgan suggested changes Aug 13, 2021
View reviewed changes
Copy link
Contributor

@stuartmorgan stuartmorgan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, but unfortunately you'll need to merge in the latest master again so that the CI checks will run, due to an infra issue that required updates to in-repo configuration to resolve.

stuartmorgan
stuartmorgan approved these changes Aug 20, 2021
View reviewed changes
Copy link
Contributor

@stuartmorgan stuartmorgan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@stuartmorgan stuartmorgan added the waiting for tree to go green (Use "autosubmit") This PR is approved and tested, but waiting for the tree to be green to land. label Aug 20, 2021
@fluttergithubbot fluttergithubbot merged commit 5ea96e5 into flutter:master Aug 20, 2021
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Aug 20, 2021
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Aug 20, 2021
@engine-flutter-autoroll
5ea96e5 [shared_preferences] Fix possible clash of string with double…
5d53c65 
… entry (flutter/plugins#3895)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Aug 20, 2021
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Aug 20, 2021
@engine-flutter-autoroll
5ea96e5 [shared_preferences] Fix possible clash of string with double…
3d99d58 
… entry (flutter/plugins#3895)
fotiDim pushed a commit to fotiDim/plugins that referenced this pull request Sep 13, 2021
@Cobinja @fotiDim
[shared_preferences] Fix possible clash of string with double entry (f…
3784697 
…lutter#3895)
amantoux pushed a commit to amantoux/plugins that referenced this pull request Sep 27, 2021
@Cobinja @amantoux
[shared_preferences] Fix possible clash of string with double entry (f…
710f488 
…lutter#3895)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@stuartmorgan stuartmorgan stuartmorgan approved these changes

Assignees
No one assigned
Labels
cla: yes p: shared_preferences platform-android waiting for tree to go green (Use "autosubmit") This PR is approved and tested, but waiting for the tree to be green to land.
Projects
None yet
Milestone
No milestone
3 participants
@Cobinja @stuartmorgan @fluttergithubbot