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.

Sign up for GitHub

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

Jump to bottom

feat: add parameter guards #116

Merged
merged 2 commits into from
Dec 10, 2024
Merged

feat: add parameter guards #116

merged 2 commits into from
Dec 10, 2024

Conversation

ctran88
Copy link
Contributor

@ctran88 ctran88 commented Dec 9, 2024 •
edited
Loading

What's New?

  • Adds parameter guards for all Auth and User operations to simplify input checks that can be done before making a network request
  • Guards for the deprecated create magic link method are not added because it relies on default values from our API to execute without exception, so adding exceptions here would be a breaking change

Screenshots (if appropriate):

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have manually tested my code thoroughly
  • I have added/updated inline documentation for public facing interfaces if relevant
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing integration and unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Additional context

@ctran88 ctran88 force-pushed the PSG-5516-parameter-guards branch from d7273c1 to 7845a9a Compare December 9, 2024 21:29
@ctran88 ctran88 marked this pull request as ready for review December 9, 2024 21:30
@ctran88 ctran88 requested a review from a team December 9, 2024 21:44
vanessa-passage
vanessa-passage reviewed Dec 9, 2024
View reviewed changes
lib/passageidentity/user_api.rb
@@ -199,6 +199,8 @@ def create_v2(args: {})
end

def update_v2(user_id:, options: {})
raise ArgumentError, 'user_id is required.' unless user_id && !user_id.empty?
Copy link
Contributor

Choose a reason for hiding this comment

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

We probably want options not to be empty too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oh yeah good point. added in 3f6fb30

@ctran88 ctran88 force-pushed the PSG-5516-parameter-guards branch from 7845a9a to 3f6fb30 Compare December 9, 2024 23:08
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@ctran88 ctran88 merged commit ce5c590 into main Dec 10, 2024
6 checks passed
@ctran88 ctran88 deleted the PSG-5516-parameter-guards branch December 10, 2024 15:52
This was referenced Dec 10, 2024
Merged
Closed
Merged
Merged
Merged
Merged
Closed
Merged
Merged
Merged
Merged
Merged
Closed
Merged
@ctran88 ctran88 mentioned this pull request Dec 20, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vanessa-passage vanessa-passage vanessa-passage approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ctran88 @vanessa-passage