aws-amplify / amplify-swift

A declarative library for application development using cloud services.
Apache License 2.0
456 stars 198 forks source link

chore: Marking Storage's key-based API as deprecated in the Category implementation. #3863

Closed ruisebas closed 2 months ago

ruisebas commented 2 months ago

Issue \

Description

When we introduced the new path: StoragePath parameters for the Storage APIs, we deprecated the old ones using key: String. However, we only did so in the category protocol and not in the category implementation itself, which results in the warning not being propagated to the users because Amplify.Storage is not typed to the protocol, but rather to the actual implementation.

So in order to discourage the usage of these APIs and raise awareness of the new ones, I'm adding the deprecation annotations to the category as well.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 68.43%. Comparing base (806a75c) to head (90c315c). Report is 4 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #3863 +/- ## ========================================== - Coverage 68.50% 68.43% -0.08% ========================================== Files 1082 1082 Lines 37699 37699 ========================================== - Hits 25827 25799 -28 - Misses 11872 11900 +28 ``` | [Flag](https://app.codecov.io/gh/aws-amplify/amplify-swift/pull/3863/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aws-amplify) | Coverage Δ | | |---|---|---| | [API_plugin_unit_test](https://app.codecov.io/gh/aws-amplify/amplify-swift/pull/3863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aws-amplify) | `69.32% <ø> (ø)` | | | [AWSPluginsCore](https://app.codecov.io/gh/aws-amplify/amplify-swift/pull/3863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aws-amplify) | `68.53% <ø> (ø)` | | | [Amplify](https://app.codecov.io/gh/aws-amplify/amplify-swift/pull/3863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aws-amplify) | `47.59% <ø> (+0.03%)` | :arrow_up: | | [Analytics_plugin_unit_test](https://app.codecov.io/gh/aws-amplify/amplify-swift/pull/3863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aws-amplify) | `84.52% <ø> (ø)` | | | [Auth_plugin_unit_test](https://app.codecov.io/gh/aws-amplify/amplify-swift/pull/3863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aws-amplify) | `79.32% <ø> (-0.07%)` | :arrow_down: | | [DataStore_plugin_unit_test](https://app.codecov.io/gh/aws-amplify/amplify-swift/pull/3863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aws-amplify) | `81.47% <ø> (-0.34%)` | :arrow_down: | | [Geo_plugin_unit_test](https://app.codecov.io/gh/aws-amplify/amplify-swift/pull/3863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aws-amplify) | `72.00% <ø> (ø)` | | | [Logging_plugin_unit_test](https://app.codecov.io/gh/aws-amplify/amplify-swift/pull/3863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aws-amplify) | `62.95% <ø> (ø)` | | | [Predictions_plugin_unit_test](https://app.codecov.io/gh/aws-amplify/amplify-swift/pull/3863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aws-amplify) | `36.86% <ø> (ø)` | | | [PushNotifications_plugin_unit_test](https://app.codecov.io/gh/aws-amplify/amplify-swift/pull/3863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aws-amplify) | `86.21% <ø> (ø)` | | | [Storage_plugin_unit_test](https://app.codecov.io/gh/aws-amplify/amplify-swift/pull/3863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aws-amplify) | `76.81% <ø> (ø)` | | | [unit_tests](https://app.codecov.io/gh/aws-amplify/amplify-swift/pull/3863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aws-amplify) | `68.43% <ø> (-0.08%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aws-amplify#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.