fix(Core): Fix plugin configuration validation #543
Merged
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
Previous validation logic threw an error if it encountered a configuration stanza with no corresponding plugin registered for that key. However, the current CLI emits some plugin keys in unexpected situations, breaking this validation. Remediation would require a customer to edit the config file, which is possibly dangerous, and definitely inconvenient. This change: - Replaces the throwing error with a logged warning when the config encounters an unmatched plugin key - Changes the `Plugin.configure` signature to accept an optional `Any?` argument, instead of a non-optional. This will let plugins decide if they need to throw or not. - Fixes a data race in hub test code - Fix AWSCognitoAuthPlugin and AWSS3StoragePlugin to throw a PluginError instead of a category-specific error if they encounter an error during configuration fixes #540
lawmicha
approved these changes
Jun 15, 2020
...ins/API/AWSAPICategoryPluginTests/Configuration/AWSAPICategoryPluginConfigurationTests.swift
Outdated
Show resolved
Hide resolved
Comment on lines
+14
to
+16
| // Note this test requires the ability to write a new database in the Documents directcory, so it must be embedded | ||
| // in a host app | ||
| func testDoesNotThrowOnMissingConfig() throws { |
There was a problem hiding this comment.
unrelated to this PR, leaving a note for @DongQuanRui this looks like the right place to put tests for the configuring DataStore when schema version changes
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.
Previous validation logic threw an error if it encountered a configuration
stanza with no corresponding plugin registered for that key. However, the
current CLI emits some plugin keys in unexpected situations, breaking this
validation. Remediation would require a customer to edit the config file, which
is possibly dangerous, and definitely inconvenient.
This change:
an unmatched plugin key
Plugin.configuresignature to accept an optionalAny?argument, instead of a non-optional. This will let plugins decide if they
need to throw or not.
instead of a category-specific error if they encounter an error during
configuration
Issue #, if available:
#540
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.