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

fix(ids-api): Fix validity dates where clause in scope check. #17600

Merged
merged 1 commit into from
Jan 23, 2025

Conversation

valurefugl
Copy link
Member

@valurefugl valurefugl commented Jan 22, 2025

What

Fix validity dates where clause in scope check.

Why

To align with the validity check used elsewhere.

Screenshots / Gifs

Attach Screenshots / Gifs to help reviewers understand the scope of the pull request

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

  • Refactor
    • Updated scope validation logic in the delegation service
    • Centralized custom scope validity determination using a new utility function
    • Simplified method for finding valid custom scopes

@valurefugl valurefugl requested review from a team as code owners January 22, 2025 09:11
Copy link
Contributor

coderabbitai bot commented Jan 22, 2025

Walkthrough

The pull request modifies the DelegationScopeService in the authentication API library by refactoring the method for finding valid custom scopes. The changes introduce two new imports and replace the existing logic for determining scope validity with a call to a utility function getScopeValidityWhereClause. This modification centralizes the scope validation logic, potentially improving code maintainability and readability by moving complex date-based filtering into a dedicated utility function.

Changes

File Change Summary
libs/auth-api-lib/src/lib/delegations/delegation-scope.service.ts - Added import for DelegationValidity from ./types/delegationValidity
- Added import for getScopeValidityWhereClause from ./utils/scopes
- Replaced manual scope validity logic with getScopeValidityWhereClause(DelegationValidity.NOW)

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • GunnlaugurG
  • magnearun
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

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

🧹 Nitpick comments (1)
libs/auth-api-lib/src/lib/delegations/delegation-scope.service.ts (1)

Line range hint 31-140: Architecture improvement: Centralized validity checks.

This refactoring improves the codebase by:

  1. Centralizing validity date checks into a reusable utility
  2. Maintaining consistency with other validity checks in the codebase
  3. Following the DRY principle
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 43f0fa9 and d13376c.

📒 Files selected for processing (1)
  • libs/auth-api-lib/src/lib/delegations/delegation-scope.service.ts (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
libs/auth-api-lib/src/lib/delegations/delegation-scope.service.ts (1)

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

  • Reusability of components and hooks across different NextJS apps.
  • TypeScript usage for defining props and exporting types.
  • Effective tree-shaking and bundling practices."
🔇 Additional comments (2)
libs/auth-api-lib/src/lib/delegations/delegation-scope.service.ts (2)

31-31: LGTM! Good refactoring to centralize validity checks.

The new imports support the centralization of scope validity logic into a dedicated utility function, improving code maintainability and consistency.

Also applies to: 33-33


140-140: Verify the behavior of getScopeValidityWhereClause.

The change aligns with the PR objective to fix validity dates in the where clause. However, let's verify that the new utility function maintains the same validity check behavior.

Run the following script to analyze the implementation of getScopeValidityWhereClause:

✅ Verification successful

The getScopeValidityWhereClause implementation is correct and properly handles validity dates

The utility function correctly implements date validity checks, including proper handling of current, future, and past delegations. For the NOW validity check used in the PR, it ensures delegations are active by verifying validFrom <= today AND (validTo >= today OR validTo IS NULL).

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the implementation of getScopeValidityWhereClause

# Find the implementation
ast-grep --pattern 'export function getScopeValidityWhereClause($_) {
  $$$
}'

# Find all other usages for consistency
rg -A 5 'getScopeValidityWhereClause'

Length of output: 4506


Script:

#!/bin/bash
# Get the complete implementation of getScopeValidityWhereClause and DelegationValidity
ast-grep --pattern 'export const getScopeValidityWhereClause = $_'

# Find DelegationValidity enum definition
ast-grep --pattern 'export enum DelegationValidity {
  $$$
}'

# Get the complete scopes.ts file for context
cat libs/auth-api-lib/src/lib/delegations/utils/scopes.ts

Length of output: 5706

Copy link

codecov bot commented Jan 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 35.57%. Comparing base (43f0fa9) to head (d13376c).
Report is 16 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #17600      +/-   ##
==========================================
- Coverage   35.57%   35.57%   -0.01%     
==========================================
  Files        7030     7030              
  Lines      150466   150467       +1     
  Branches    42959    42959              
==========================================
- Hits        53534    53533       -1     
- Misses      96932    96934       +2     
Flag Coverage Δ
air-discount-scheme-backend 48.15% <ø> (ø)
air-discount-scheme-web 0.00% <ø> (ø)
api 3.33% <ø> (ø)
api-catalogue-services 75.81% <ø> (ø)
api-domains-air-discount-scheme 37.90% <ø> (ø)
api-domains-assets 26.71% <ø> (ø)
api-domains-auth-admin 48.49% <ø> (ø)
api-domains-communications 39.49% <ø> (ø)
api-domains-criminal-record 47.81% <ø> (ø)
api-domains-driving-license 44.77% <ø> (ø)
api-domains-education 31.09% <ø> (ø)
api-domains-health-insurance 35.19% <ø> (ø)
api-domains-mortgage-certificate 34.96% <ø> (ø)
api-domains-payment-schedule 42.04% <ø> (ø)
application-api-files 61.80% <ø> (ø)
application-core 75.68% <ø> (ø)
application-system-api 38.68% <ø> (+<0.01%) ⬆️
application-template-api-modules 27.55% <ø> (ø)
application-templates-accident-notification 27.60% <ø> (ø)
application-templates-car-recycling 3.12% <ø> (ø)
application-templates-criminal-record 25.79% <ø> (ø)
application-templates-driving-license 18.15% <ø> (ø)
application-templates-estate 13.58% <ø> (ø)
application-templates-example-payment 24.66% <ø> (ø)
application-templates-general-petition 23.11% <ø> (ø)
application-templates-inheritance-report 6.59% <ø> (ø)
application-templates-marriage-conditions 14.80% <ø> (ø)
application-templates-mortgage-certificate 43.73% <ø> (ø)
application-templates-new-primary-school 21.02% <ø> (ø)
application-templates-parental-leave 29.92% <ø> (ø)
application-types 6.47% <ø> (ø)
application-ui-components 1.17% <ø> (ø)
application-ui-shell 22.01% <ø> (ø)
auth-admin-web 2.43% <ø> (ø)
auth-nest-tools 31.69% <ø> (ø)
auth-shared 75.00% <ø> (ø)
clients-charge-fjs-v2 28.88% <ø> (ø)
clients-driving-license 40.68% <ø> (ø)
clients-driving-license-book 43.75% <ø> (ø)
clients-financial-statements-inao 49.48% <ø> (ø)
clients-license-client 1.26% <ø> (ø)
clients-middlewares 72.82% <ø> (-0.57%) ⬇️
clients-regulations 42.75% <ø> (ø)
clients-rsk-company-registry 31.18% <ø> (ø)
clients-rsk-personal-tax-return 38.32% <ø> (ø)
clients-smartsolutions 12.77% <ø> (ø)
clients-syslumenn 49.18% <ø> (ø)
clients-zendesk 49.88% <ø> (ø)
cms 0.39% <ø> (ø)
cms-translations 38.82% <ø> (ø)
content-search-index-manager 95.65% <ø> (ø)
content-search-toolkit 8.16% <ø> (ø)
contentful-apps 4.56% <ø> (ø)
dokobit-signing 61.66% <ø> (ø)
email-service 59.68% <ø> (ø)
feature-flags 90.40% <ø> (ø)
file-storage 45.32% <ø> (ø)
financial-aid-backend 51.38% <ø> (ø)
financial-aid-shared 17.88% <ø> (ø)
icelandic-names-registry-backend 54.44% <ø> (ø)
infra-nest-server 48.06% <ø> (ø)
infra-tracing 69.94% <ø> (ø)
island-ui-core 30.32% <ø> (ø)
judicial-system-api 20.07% <ø> (ø)
judicial-system-audit-trail 68.53% <ø> (ø)
judicial-system-backend 55.81% <ø> (ø)
judicial-system-formatters 78.86% <ø> (ø)
judicial-system-message 66.29% <ø> (ø)
judicial-system-message-handler 47.89% <ø> (ø)
judicial-system-scheduler 71.24% <ø> (ø)
judicial-system-types 37.77% <ø> (ø)
judicial-system-web 27.97% <ø> (ø)
license-api 42.91% <ø> (+0.07%) ⬆️
localization 10.15% <ø> (ø)
logging 58.02% <ø> (ø)
message-queue 67.76% <ø> (ø)
nest-audit 65.78% <ø> (ø)
nest-aws 51.93% <ø> (ø)
nest-config 76.05% <ø> (ø)
nest-core 53.16% <ø> (ø)
nest-feature-flags 50.69% <ø> (ø)
nest-problem 45.64% <ø> (ø)
nest-sequelize 94.44% <ø> (ø)
nest-swagger 51.13% <ø> (ø)
nova-sms 60.96% <ø> (ø)
portals-admin-regulations-admin 1.80% <ø> (ø)
portals-core 19.60% <ø> (ø)
regulations 16.78% <ø> (ø)
residence-history 85.00% <ø> (ø)
services-auth-admin-api 52.49% <100.00%> (+0.01%) ⬆️
services-auth-delegation-api 58.49% <100.00%> (+0.09%) ⬆️
services-auth-ids-api 52.50% <100.00%> (-0.02%) ⬇️
services-auth-public-api 49.37% <100.00%> (+0.01%) ⬆️
services-sessions 65.28% <ø> (-0.05%) ⬇️
services-university-gateway 49.35% <ø> (-0.12%) ⬇️
services-user-notification 46.53% <ø> (ø)
services-user-profile 56.92% <ø> (ø)
shared-components 29.47% <ø> (ø)
shared-form-fields 33.36% <ø> (ø)
shared-mocking 58.64% <ø> (ø)
shared-pii 92.85% <ø> (ø)
shared-problem 87.50% <ø> (ø)
shared-utils 28.67% <ø> (ø)
skilavottord-ws 23.97% <ø> (ø)
web 2.39% <ø> (ø)

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

Files with missing lines Coverage Δ
...ib/src/lib/delegations/delegation-scope.service.ts 91.59% <100.00%> (+0.07%) ⬆️

... and 1 file 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 43f0fa9...d13376c. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Jan 22, 2025

Datadog Report

All test runs 89f35b8 🔗

10 Total Test Services: 0 Failed, 10 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.03%), 2 increased, 197 no change

Test Services
This report shows up to 10 services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
air-discount-scheme-backend 0 0 0 63 0 47.79s N/A Link
air-discount-scheme-web 0 0 0 2 0 6.14s N/A Link
api 0 0 0 4 0 2.29s 1 no change Link
api-catalogue-services 0 0 0 23 0 7.99s 1 no change Link
api-domains-air-discount-scheme 0 0 0 6 0 16.89s 1 no change Link
api-domains-assets 0 0 0 3 0 10.22s 1 no change Link
api-domains-auth-admin 0 0 0 18 0 9.33s 1 no change Link
api-domains-communications 0 0 0 5 0 32.28s 1 no change Link
api-domains-criminal-record 0 0 0 5 0 8s 1 no change Link
api-domains-driving-license 0 0 0 23 0 30.47s N/A Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • services-university-gateway - jest 45.21% (-0.03%) - Details

@valurefugl valurefugl added this pull request to the merge queue Jan 23, 2025
Merged via the queue into main with commit 583f2b6 Jan 23, 2025
277 checks passed
@valurefugl valurefugl deleted the ids-api/fix-scope-check branch January 23, 2025 10:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants