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

PR#7 Fix - Added Support for Auth URL Params + Test Fixes #8

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

malik19995
Copy link

Contributions from Serhii Holovashchuk

#7

Explain your changes

Fixed config.yaml -- Added reference for auth_url_params.dart

Fixed failing tests on flutter test in generated kinde-flutter-sdk:

  • Added test value test_org_name to test createOrganization
  • Added test value to test_user_id to test updateUser

Checklist

Contributions from Serhii Holovashchuk

kinde-oss#7

Fixed config.yaml

Fixed failing tests on `flutter test` - Added test values.
Used the similar pattern for the test values.
Copy link

coderabbitai bot commented Jul 28, 2024

Walkthrough

This update enhances the kinde_sdk library by introducing a new AuthUrlParams class, which encapsulates parameters for authentication URL handling. It also refines the login and register methods to accept additional contextual information, improving the overall API. Furthermore, the changes extend to unit tests, ensuring thorough coverage of the updated functionalities and promoting better maintainability.

Changes

File Change Summary
.gitignore Added kinde-flutter-sdk/ to ignore this directory in version control.
my_custom_templates/lib/kinde_sdk.dart Added export for auth_url_params.dart to expand the library's public API.
my_custom_templates/lib/src/auth_url_params.dart Introduced AuthUrlParams class for encapsulating authentication URL parameters and added toMap method.
my_custom_templates/lib/src/kinde_flutter_sdk.dart Enhanced login and register methods with new loginHint and authUrlParams parameters.
my_custom_templates/test/organizations_api_test.dart Modified createOrganization method to use a builder pattern for setting properties.
my_custom_templates/test/users_api_test.dart Updated updateUser method call to include an id parameter.

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.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

CodeRabbit Configuration 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.

@malik19995 malik19995 changed the title Pr/7 fix - Added Support for Auth URL Params + Test Fixes Pr-7 fix - Added Support for Auth URL Params + Test Fixes Jul 28, 2024
@malik19995 malik19995 changed the title Pr-7 fix - Added Support for Auth URL Params + Test Fixes PR#7 Fix - Added Support for Auth URL Params + Test Fixes Jul 28, 2024
Copy link

@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: 1

Outside diff range, codebase verification and nitpick comments (4)
my_custom_templates/lib/src/auth_url_params.dart (2)

2-3: Use consistent naming conventions for private fields.

Consider using a consistent naming convention for private fields, such as prefixing with an underscore.

-  static const _lang = 'lang';
-  static const _connectionId = 'connection_id';
+  static const String _lang = 'lang';
+  static const String _connectionId = 'connection_id';

5-9: Add documentation for class fields.

While there are comments, consider using Dart's documentation comments (///) for consistency and better integration with documentation tools.

/// Language to display for login page
String? lang;

/// Connection id string corresponding to social sign in
String? connectionId;
my_custom_templates/lib/src/kinde_flutter_sdk.dart (2)

195-212: Update test cases to match the new register function signature.

The register function has been updated to include loginHint and authUrlParams parameters. However, the test cases in my_custom_templates/test/kinde_flutter_sdk_test.dart do not include these new parameters. Please update the test cases to match the new function signature and ensure the new parameters are tested properly.

  • my_custom_templates/test/kinde_flutter_sdk_test.dart:
    • Update the register function calls to include loginHint and authUrlParams.
Analysis chain

LGTM! But verify the function usage in the codebase.

The code changes are approved.

However, ensure that all function calls to register match the new signature.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `register` match the new signature.

# Test: Search for the function usage. Expect: Only occurrences of the new signature.
rg --type dart -A 5 $'register'

Length of output: 1689


161-172: Function calls to login do not match the new signature.

The following instances of login calls do not include the new parameters loginHint and authUrlParams:

  • my_custom_templates/test/kinde_flutter_sdk_test.dart: await KindeFlutterSDK.instance.login();

Please update these calls to match the new function signature.

Analysis chain

LGTM! But verify the function usage in the codebase.

The code changes are approved.

However, ensure that all function calls to login match the new signature.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `login` match the new signature.

# Test: Search for the function usage. Expect: Only occurrences of the new signature.
rg --type dart -A 5 $'login'

Length of output: 12910

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 96cf3e0 and 6ab54d6.

Files ignored due to path filters (2)
  • config.yaml is excluded by !**/*.yaml
  • my_custom_templates/openapitools.json is excluded by !**/*.json
Files selected for processing (6)
  • .gitignore (1 hunks)
  • my_custom_templates/lib/kinde_sdk.dart (1 hunks)
  • my_custom_templates/lib/src/auth_url_params.dart (1 hunks)
  • my_custom_templates/lib/src/kinde_flutter_sdk.dart (6 hunks)
  • my_custom_templates/test/organizations_api_test.dart (1 hunks)
  • my_custom_templates/test/users_api_test.dart (1 hunks)
Files skipped from review due to trivial changes (2)
  • .gitignore
  • my_custom_templates/lib/kinde_sdk.dart
Additional comments not posted (6)
my_custom_templates/lib/src/auth_url_params.dart (1)

11-14: Constructor looks good.

The constructor correctly initializes the fields.

my_custom_templates/test/users_api_test.dart (1)

64-65: Test updateUser looks good.

The addition of the id parameter ensures the test aligns with the updated method signature.

my_custom_templates/test/organizations_api_test.dart (1)

34-36: Test createOrganization looks good.

The addition of the name parameter ensures the test has a defined context and expected behavior.

my_custom_templates/lib/src/kinde_flutter_sdk.dart (3)

Line range hint 177-191:
LGTM! The changes are approved.

The code changes are straightforward and correctly integrated.


Line range hint 266-277:
LGTM! The changes are approved.

The code changes are straightforward and correctly integrated.


Line range hint 292-303:
LGTM! The changes are approved.

The code changes are straightforward and correctly integrated.

my_custom_templates/lib/src/auth_url_params.dart Outdated Show resolved Hide resolved
Updated toMap method
Copy link

@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 UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6ab54d6 and 09ffa4b.

Files selected for processing (1)
  • my_custom_templates/lib/src/auth_url_params.dart (1 hunks)
Files skipped from review due to trivial changes (1)
  • my_custom_templates/lib/src/auth_url_params.dart

@malik19995
Copy link
Author

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.

1 participant