StanfordSpezi / SpeziAccount

The Spezi Account module to enable login and signup functionality
https://swiftpackageindex.com/StanfordSpezi/SpeziAccount/documentation/
MIT License
5 stars 5 forks source link

Infrastructure changes to allow for seamless Single-Sign-On implementations. #28

Closed Supereg closed 1 year ago

Supereg commented 1 year ago

Infrastructure changes to allow for seamless Single-Sign-On implementations.

:recycle: Current situation & Problem

While IdentityProvider are currently supported by SpeziAccount, there are some issues when trying to accommodate more extended use cases or certain limitations when combining different functionality.

Below is a list of certain pain points including general improvements this PR makes:

:gear: Release Notes

Added several infrastructure enhancements that allow for an improved user experience and compatibility when using identity providers.

Breaking Changes

:books: Documentation

Documentation was updated respectively.

:white_check_mark: Testing

Test cases were added for new functionality or fixed functionality.

:pencil: Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

codecov[bot] commented 1 year ago

Codecov Report

Merging #28 (63d2d83) into main (1eca293) will increase coverage by 0.85%. The diff coverage is 82.19%.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28/graphs/tree.svg?width=650&height=150&src=pr&token=AudNwGU7tR&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi)](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) ```diff @@ Coverage Diff @@ ## main #28 +/- ## ========================================== + Coverage 75.17% 76.01% +0.85% ========================================== Files 115 122 +7 Lines 4014 4418 +404 ========================================== + Hits 3017 3358 +341 - Misses 997 1060 +63 ``` | [Files](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) | Coverage Δ | | |---|---|---| | [Sources/SpeziAccount/AccountOverview.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aUFjY291bnQvQWNjb3VudE92ZXJ2aWV3LnN3aWZ0) | `56.37% <ø> (ø)` | | | [...s/SpeziAccount/AccountService/AccountService.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aUFjY291bnQvQWNjb3VudFNlcnZpY2UvQWNjb3VudFNlcnZpY2Uuc3dpZnQ=) | `80.00% <ø> (ø)` | | | [...untService/Configuration/RequiredAccountKeys.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aUFjY291bnQvQWNjb3VudFNlcnZpY2UvQ29uZmlndXJhdGlvbi9SZXF1aXJlZEFjY291bnRLZXlzLnN3aWZ0) | `75.00% <ø> (-25.00%)` | :arrow_down: | | [...ntService/Configuration/SupportedAccountKeys.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aUFjY291bnQvQWNjb3VudFNlcnZpY2UvQ29uZmlndXJhdGlvbi9TdXBwb3J0ZWRBY2NvdW50S2V5cy5zd2lmdA==) | `96.67% <ø> (ø)` | | | [...ccount/AccountService/Wrapper/StandardBacked.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aUFjY291bnQvQWNjb3VudFNlcnZpY2UvV3JhcHBlci9TdGFuZGFyZEJhY2tlZC5zd2lmdA==) | `72.73% <100.00%> (+0.64%)` | :arrow_up: | | [...s/SpeziAccount/AccountValue/AccountKey+Views.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aUFjY291bnQvQWNjb3VudFZhbHVlL0FjY291bnRLZXkrVmlld3Muc3dpZnQ=) | `100.00% <100.00%> (+4.17%)` | :arrow_up: | | [Sources/SpeziAccount/AccountValue/AccountKey.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aUFjY291bnQvQWNjb3VudFZhbHVlL0FjY291bnRLZXkuc3dpZnQ=) | `60.00% <100.00%> (+5.46%)` | :arrow_up: | | [...eziAccount/AccountValue/AccountKeyCollection.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aUFjY291bnQvQWNjb3VudFZhbHVlL0FjY291bnRLZXlDb2xsZWN0aW9uLnN3aWZ0) | `81.82% <100.00%> (+1.82%)` | :arrow_up: | | [.../SpeziAccount/AccountValue/Keys/IsNewUserKey.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aUFjY291bnQvQWNjb3VudFZhbHVlL0tleXMvSXNOZXdVc2VyS2V5LnN3aWZ0) | `100.00% <100.00%> (ø)` | | | [.../SpeziAccount/Environment/AccountRequiredKey.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aUFjY291bnQvRW52aXJvbm1lbnQvQWNjb3VudFJlcXVpcmVkS2V5LnN3aWZ0) | `100.00% <100.00%> (ø)` | | | ... and [31 more](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) | | ... and [2 files with indirect coverage changes](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Last update [1eca293...63d2d83](https://app.codecov.io/gh/StanfordSpezi/SpeziAccount/pull/28?src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi).