Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(native-app): Add optional scopes #14863

Merged
merged 4 commits into from
May 22, 2024

Conversation

thoreyjona
Copy link
Contributor

@thoreyjona thoreyjona commented May 21, 2024

What

Allow some scopes of the app to be optional.

Why

If we add a scope and the auth token does not have that scope we force a logout of the app. When dealing with some scopes like for example the barcode scope that is only used for a functionality that is hidden behind a feature flag we don't want to force logout for everyone.

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features

    • Enhanced authentication logic to support optional scopes.
  • Bug Fixes

    • Improved scope validation to ensure required scopes are accurately checked, ignoring optional ones.

@thoreyjona thoreyjona requested a review from a team as a code owner May 21, 2024 10:27
Copy link
Contributor

coderabbitai bot commented May 21, 2024

Walkthrough

The changes in auth-store.ts introduce a new array called OPTIONAL_SCOPES to manage optional authentication scopes. The authentication logic is updated to filter out these optional scopes before verifying the required scopes, enhancing the flexibility and accuracy of scope validation during authentication.

Changes

File Path Change Summary
...native/app/src/stores/auth-store.ts Added OPTIONAL_SCOPES array and updated the scope validation logic to exclude optional scopes.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@datadog-island-is
Copy link

Datadog Report

All test runs a6ed271 🔗

8 Total Test Services: 0 Failed, 8 Passed
➡️ Test Sessions change in coverage: 17 no change

Test Services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
api 0 0 0 4 0 2.94s 1 no change Link
application-system-api 0 0 0 111 2 3m 2.94s 1 no change Link
application-template-api-modules 0 0 0 109 0 2m 44.75s 1 no change Link
application-templates-financial-aid 0 0 0 11 0 46.29s 1 no change Link
application-ui-shell 0 0 0 74 0 1m 22.29s 1 no change Link
financial-aid-backend 0 0 0 216 0 1m 0.14s 1 no change Link
financial-aid-shared 0 0 0 26 0 15.78s 1 no change Link
services-auth-personal-representative 0 0 0 59 0 1m 16.77s 1 no change Link

Copy link

codecov bot commented May 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.98%. Comparing base (4a27d65) to head (cd739ab).

Current head cd739ab differs from pull request most recent head 7c87931

Please upload reports for the commit 7c87931 to get more accurate results.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #14863      +/-   ##
==========================================
- Coverage   37.04%   36.98%   -0.07%     
==========================================
  Files        6331     6327       -4     
  Lines      129120   129006     -114     
  Branches    36852    36817      -35     
==========================================
- Hits        47835    47707     -128     
- Misses      81285    81299      +14     
Flag Coverage Δ
api 3.48% <ø> (ø)
application-system-api 41.97% <ø> (+0.01%) ⬆️
application-template-api-modules 24.38% <ø> (-0.01%) ⬇️
application-templates-financial-aid 12.10% <ø> (ø)
application-ui-shell 21.72% <ø> (ø)
financial-aid-backend 56.44% <ø> (ø)
services-auth-personal-representative 49.75% <ø> (+0.05%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 29 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4a27d65...7c87931. Read the comment docs.

@thoreyjona thoreyjona added the automerge Merge this PR as soon as all checks pass label May 21, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 6175885 and 8cbe952.
Files selected for processing (1)
  • apps/native/app/src/stores/auth-store.ts (2 hunks)
Additional Context Used
Path-based Instructions (1)
apps/native/app/src/stores/auth-store.ts (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
Additional comments not posted (2)
apps/native/app/src/stores/auth-store.ts (2)

22-23: Introduce OPTIONAL_SCOPES to manage scopes that do not require a forced logout.

This change aligns with the PR's objective to handle optional scopes effectively, ensuring that users are not logged out unnecessarily when such scopes are missing in the auth token.


205-208: Ensure that the authentication check filters out optional scopes correctly.

The modification to filter out OPTIONAL_SCOPES before checking the presence of required scopes is a robust solution to the problem of handling optional scopes. This change should prevent unnecessary logouts when a scope like @island.is/licenses:barcode is not present, which is crucial for maintaining a smooth user experience.

@kodiakhq kodiakhq bot merged commit 4d37ab4 into main May 22, 2024
23 checks passed
@kodiakhq kodiakhq bot deleted the feat/native-app-add-optional-scopes branch May 22, 2024 09:59
jonnigs pushed a commit that referenced this pull request May 22, 2024
* chore: add optional scopes to app

* fix: update comment

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
eirikurn added a commit that referenced this pull request May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants