feat: improve Spring Boot auto-configuration for Kinde SDK #194
Conversation
- Add KindeSdkClientAutoConfig for automatic bean configuration - Update KindeSdkClient with enhanced Spring integration - Configure AutoConfiguration.imports for Spring Boot 2.7+ compatibility - Enable automatic discovery and registration of Kinde beans - Simplify Spring Boot application setup and configuration - Provide seamless integration with Spring Boot's dependency injection
WalkthroughAdds a Spring Boot auto-configuration class Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant App as Spring ApplicationContext
participant AutoConfig as KindeSdkClientAutoConfig
participant Conditions as ConditionalOnKindeClientProperties
participant Registry as BeanRegistry
participant Client as KindeSdkClient
App->>AutoConfig: Load auto-configurations (from imports)
AutoConfig->>Conditions: Evaluate Kinde OAuth2 properties
Conditions-->>AutoConfig: true / false
alt properties present
AutoConfig->>Registry: Check existing KindeSdkClient bean
Registry-->>AutoConfig: missing / present
alt bean missing
AutoConfig->>Registry: Register KindeSdkClient bean definition
Registry->>Client: Instantiate KindeSdkClient
Registry-->>App: Bean available
else bean present
AutoConfig-->>App: Skip registration
end
else properties absent
AutoConfig-->>App: Skip registration
end
note right of AutoConfig: Listed before KindeOAuth2AutoConfig in imports (ordering)
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related issues
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
kinde-springboot/kinde-springboot-core/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.importsis excluded by none and included by none
📒 Files selected for processing (2)
kinde-springboot/kinde-springboot-core/src/main/java/com/kinde/spring/KindeSdkClientAutoConfig.java(1 hunks)kinde-springboot/kinde-springboot-core/src/main/java/com/kinde/spring/sdk/KindeSdkClient.java(0 hunks)
💤 Files with no reviewable changes (1)
- kinde-springboot/kinde-springboot-core/src/main/java/com/kinde/spring/sdk/KindeSdkClient.java
🧰 Additional context used
📓 Path-based instructions (1)
**/*
⚙️ CodeRabbit configuration file
**/*: Please focus on:
- Code quality and best practices
- Security considerations
- Performance implications
- Test coverage and quality
- API design and consistency
- Error handling and edge cases
For Java code specifically:
- Check for proper exception handling
- Verify async method implementations
- Review builder pattern usage
- Validate test coverage
- Check for memory leaks in async operations
Ignore:
- Generated code files
- Build artifacts
- Configuration files
- Documentation formatting
Files:
kinde-springboot/kinde-springboot-core/src/main/java/com/kinde/spring/KindeSdkClientAutoConfig.java
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
🔇 Additional comments (2)
kinde-springboot/kinde-springboot-core/src/main/java/com/kinde/spring/KindeSdkClientAutoConfig.java (2)
20-24: No changes needed for KindeSdkClient bean injection. The no-arg@Beanmethod is sufficient, as Spring will autowire theKindeOAuth2Propertiesfield on the returned instance.
15-17: No action needed on custom conditional annotation. The@ConditionalOnKindeClientPropertiesis correctly defined as an alias for@ConditionalOnProperty(name="spring.security.oauth2.client.registration.kinde.client-id")and complements (rather than duplicates)@EnableConfigurationProperties.
...pringboot/kinde-springboot-core/src/main/java/com/kinde/spring/KindeSdkClientAutoConfig.java
Show resolved
Hide resolved
- Add CustomerProblemFixVerificationTest to validate Spring Boot integration fixes - Ensure auto-configuration works correctly for customer use cases - Verify proper bean registration and dependency injection - Test edge cases and configuration scenarios - Provide regression testing for reported customer issues
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/CustomerProblemFixVerificationTest.java (1)
39-39: Use class references instead of hard-coded strings.The tests use string literals for class names (e.g.,
"com.kinde.spring.KindeSdkClientAutoConfig"). This approach is brittle because if the classes are renamed or moved to a different package, the compiler won't catch the issue and tests will silently fail.Replace string literals with class references:
- assertThat(lines).contains("com.kinde.spring.KindeSdkClientAutoConfig"); + assertThat(lines).contains(KindeSdkClientAutoConfig.class.getName());- int kindeSdkClientAutoConfigIndex = lines.indexOf("com.kinde.spring.KindeSdkClientAutoConfig"); - int kindeOAuth2AutoConfigIndex = lines.indexOf("com.kinde.spring.KindeOAuth2AutoConfig"); + int kindeSdkClientAutoConfigIndex = lines.indexOf(KindeSdkClientAutoConfig.class.getName()); + int kindeOAuth2AutoConfigIndex = lines.indexOf(KindeOAuth2AutoConfig.class.getName());This provides compile-time safety and makes refactoring easier.
Also applies to: 50-51, 71-71, 90-90, 108-108
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/CustomerProblemFixVerificationTest.java(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*
⚙️ CodeRabbit configuration file
**/*: Please focus on:
- Code quality and best practices
- Security considerations
- Performance implications
- Test coverage and quality
- API design and consistency
- Error handling and edge cases
For Java code specifically:
- Check for proper exception handling
- Verify async method implementations
- Review builder pattern usage
- Validate test coverage
- Check for memory leaks in async operations
Ignore:
- Generated code files
- Build artifacts
- Configuration files
- Documentation formatting
Files:
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/CustomerProblemFixVerificationTest.java
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
🔇 Additional comments (2)
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/CustomerProblemFixVerificationTest.java (2)
1-26: LGTM!The class documentation clearly explains the customer problem and how the fix addresses it. The imports are appropriate for the testing approach.
42-57: Valuable ordering verification, but apply resource handling fix.This test provides unique value by verifying that
KindeSdkClientAutoConfigloads beforeKindeOAuth2AutoConfig, which is critical for dependency resolution. The logic correctly checks both presence (viaindexOf > -1) and ordering.Ensure you apply the resource handling fix from the earlier comment (using
getInputStream()instead ofgetFile().toPath()) to prevent JAR deployment failures.
...kinde-springboot-core/src/test/java/com/kinde/spring/CustomerProblemFixVerificationTest.java
Outdated
Show resolved
Hide resolved
...kinde-springboot-core/src/test/java/com/kinde/spring/CustomerProblemFixVerificationTest.java
Outdated
Show resolved
Hide resolved
- Add KindeSdkClientAutoConfigTest with complete test coverage - Test bean creation with required and optional properties - Verify conditional bean creation based on configuration presence - Test custom bean override functionality - Validate environment variable configuration support - Test auto-configuration disable/enable functionality - Include tests for Management API and multiple scopes configuration - Provide comprehensive validation of Spring Boot integration
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigTest.java (2)
22-32: Consider consolidating duplicate test logic.Four test methods (
testKindeSdkClientAutoConfigIsRegisteredInImportsFile,testAutoConfigurationImportsFileExists,testCustomerProblemIsResolved,testNoManualConfigurationRequired) all verify that the imports file containsKindeSdkClientAutoConfig. While the comments describe different concerns, the actual assertions are identical.Consider:
- Merging tests 1, 7, and 8 into a single comprehensive test method
- Keeping test 3 separate if the existence/non-empty checks provide distinct value
- Alternatively, extract a reusable helper method
assertAutoConfigurationIsRegistered()if you prefer keeping separate test methods for documentation purposesThis reduces duplication and improves maintainability.
Also applies to: 50-61, 131-151, 153-166
108-110: Optional: Use type comparison instead of simple name.Consider comparing the actual return type instead of the simple name for more robust type checking:
-if (method.getReturnType().getSimpleName().equals("KindeSdkClient")) { +if (method.getReturnType().equals(com.kinde.spring.sdk.KindeSdkClient.class)) {This avoids potential false positives if unrelated classes share the same simple name, though this is unlikely in practice.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigTest.java(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*
⚙️ CodeRabbit configuration file
**/*: Please focus on:
- Code quality and best practices
- Security considerations
- Performance implications
- Test coverage and quality
- API design and consistency
- Error handling and edge cases
For Java code specifically:
- Check for proper exception handling
- Verify async method implementations
- Review builder pattern usage
- Validate test coverage
- Check for memory leaks in async operations
Ignore:
- Generated code files
- Build artifacts
- Configuration files
- Documentation formatting
Files:
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigTest.java
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
🔇 Additional comments (1)
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigTest.java (1)
1-20: Well-structured test suite for auto-configuration.The test structure is solid:
- Clear documentation explaining test coverage
- Good use of reflection to verify Spring Boot auto-configuration mechanics
- Appropriate use of AssertJ for assertions
- Comprehensive coverage of class existence, annotations, and bean methods
Also applies to: 63-96
...gboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigTest.java
Outdated
Show resolved
Hide resolved
- Enhance CustomerProblemFixVerificationTest with additional test scenarios - Improve test coverage for Spring Boot auto-configuration edge cases - Add validation for customer-reported integration issues - Strengthen regression testing for Spring Boot compatibility - Update test assertions and mock configurations for better reliability
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/CustomerProblemFixVerificationTest.java (2)
51-55: Add resource existence check for consistency.The first test (line 34) explicitly verifies
resource.exists()before reading, but this test doesn't. While the IOException will still surface if the resource is missing, adding the existence check provides consistency and clearer failure messaging.Apply this diff to add the existence check:
ClassPathResource resource = new ClassPathResource("META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports"); + assertThat(resource.exists()).isTrue(); + List<String> lines; try (var reader = new java.io.BufferedReader(new java.io.InputStreamReader(resource.getInputStream()))) {
33-38: Consider extracting resource reading logic if tests expand.The resource-reading pattern (lines 33-38 and 51-55) is duplicated. For just two tests, this is acceptable and keeps each test self-contained. However, if additional tests are added that verify the imports file, consider extracting this into a helper method.
Example helper method (only if tests expand):
private List<String> readAutoConfigurationImports() throws IOException { ClassPathResource resource = new ClassPathResource( "META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports"); assertThat(resource.exists()).isTrue(); try (var reader = new java.io.BufferedReader( new java.io.InputStreamReader(resource.getInputStream()))) { return reader.lines().collect(java.util.stream.Collectors.toList()); } }Also applies to: 51-55
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/CustomerProblemFixVerificationTest.java(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*
⚙️ CodeRabbit configuration file
**/*: Please focus on:
- Code quality and best practices
- Security considerations
- Performance implications
- Test coverage and quality
- API design and consistency
- Error handling and edge cases
For Java code specifically:
- Check for proper exception handling
- Verify async method implementations
- Review builder pattern usage
- Validate test coverage
- Check for memory leaks in async operations
Ignore:
- Generated code files
- Build artifacts
- Configuration files
- Documentation formatting
Files:
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/CustomerProblemFixVerificationTest.java
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
- Update KindeSdkClientAutoConfigTest with improved test scenarios - Strengthen validation logic for Spring Boot auto-configuration - Add more robust assertions for bean creation and dependency injection - Improve test isolation and mock configuration handling - Enhance error handling and edge case testing for auto-configuration
...kinde-springboot-core/src/test/java/com/kinde/spring/CustomerProblemFixVerificationTest.java
Outdated
Show resolved
Hide resolved
...gboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigTest.java
Outdated
Show resolved
Hide resolved
…ecott/kinde-java-sdk into fix/spring-auto-configuration
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigurationRegistrationTest.java(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*
⚙️ CodeRabbit configuration file
**/*: Please focus on:
- Code quality and best practices
- Security considerations
- Performance implications
- Test coverage and quality
- API design and consistency
- Error handling and edge cases
For Java code specifically:
- Check for proper exception handling
- Verify async method implementations
- Review builder pattern usage
- Validate test coverage
- Check for memory leaks in async operations
Ignore:
- Generated code files
- Build artifacts
- Configuration files
- Documentation formatting
Files:
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigurationRegistrationTest.java
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
🔇 Additional comments (1)
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigurationRegistrationTest.java (1)
1-20: LGTM! Well-documented test class setup.The imports are appropriate, and the class javadoc clearly documents the test objectives. The test class name follows standard naming conventions.
...oot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigurationRegistrationTest.java
Outdated
Show resolved
Hide resolved
...oot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigurationRegistrationTest.java
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigTest.java (1)
25-76: Consider extracting file reading logic to reduce duplication.Multiple tests read the auto-configuration imports file using identical code patterns. This creates maintenance overhead if the reading logic needs to change.
Consider extracting a helper method:
private List<String> readAutoConfigurationImports() throws IOException { ClassPathResource resource = new ClassPathResource( "META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports"); try (var inputStream = resource.getInputStream(); var reader = new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8))) { return reader.lines().collect(Collectors.toList()); } }Then simplify each test:
-ClassPathResource resource = new ClassPathResource("META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports"); -assertThat(resource.exists()).isTrue(); - -List<String> lines; -try (var inputStream = resource.getInputStream(); - var reader = new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8))) { - lines = reader.lines().collect(Collectors.toList()); -} +List<String> lines = readAutoConfigurationImports();This maintains test independence while improving maintainability.
Also applies to: 146-189
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigTest.java(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*
⚙️ CodeRabbit configuration file
**/*: Please focus on:
- Code quality and best practices
- Security considerations
- Performance implications
- Test coverage and quality
- API design and consistency
- Error handling and edge cases
For Java code specifically:
- Check for proper exception handling
- Verify async method implementations
- Review builder pattern usage
- Validate test coverage
- Check for memory leaks in async operations
Ignore:
- Generated code files
- Build artifacts
- Configuration files
- Documentation formatting
Files:
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigTest.java
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
🔇 Additional comments (2)
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigTest.java (2)
6-8: Imports are correct and necessary.The past comment suggested removing
java.ioimports, but these are standard Java I/O classes required for the InputStream reading pattern used throughout the tests. The imports are properly organized and all are in use.
78-144: Excellent reflection-based validation.The tests effectively use reflection to verify class existence, required annotations, and bean method characteristics. The exception handling is appropriate, and the assertions comprehensively validate the auto-configuration setup.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigTest.java (4)
41-48: Consider consolidating redundant registration checks.Four test methods (
testKindeSdkClientAutoConfigIsRegisteredInImportsFile,testAutoConfigurationImportsFileExists,testCustomerProblemIsResolved,testNoManualConfigurationRequired) all verify thatKindeSdkClientAutoConfigappears in the imports file. While the narrative/documentation value is clear, consider consolidating into fewer tests with descriptive names or combining assertions.Also applies to: 65-73, 143-162, 164-176
117-120: ImportMethodinstead of using fully qualified name.The code uses
java.lang.reflect.Methodwith its fully qualified name. Based on the past review feedback about removingjava.*prefixes, consider adding an import statement for cleaner code.Apply this diff:
+import java.lang.reflect.Method;Then update the usage:
- java.lang.reflect.Method[] methods = autoConfigClass.getDeclaredMethods(); + Method[] methods = autoConfigClass.getDeclaredMethods(); boolean hasKindeSdkClientMethod = false; - for (java.lang.reflect.Method method : methods) { + for (Method method : methods) {
121-122: Use fully qualified name for return type matching.Matching by simple name (
getSimpleName().equals("KindeSdkClient")) could produce false positives if another class with the same simple name exists in a different package.Apply this diff to match by fully qualified name:
- if (method.getReturnType().getSimpleName().equals("KindeSdkClient")) { + if (method.getReturnType().getName().equals("com.kinde.spring.KindeSdkClient")) {Or, if the KindeSdkClient class is available at compile time, use a class reference:
- if (method.getReturnType().getSimpleName().equals("KindeSdkClient")) { + if (method.getReturnType().equals(com.kinde.spring.KindeSdkClient.class)) {
23-23: Consider adding negative test cases for conditional behavior.The test suite covers registration and structure verification well but lacks tests for conditional auto-configuration scenarios:
- Verify
@ConditionalOnMissingBeanprevents duplicate bean registration when aKindeSdkClientbean already exists- Verify
@ConditionalOnKindeClientPropertiesprevents auto-configuration when Kinde properties are absent- Test that auto-configuration doesn't trigger in unexpected scenarios
These tests would strengthen confidence in the auto-configuration's conditional logic.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigTest.java(1 hunks)kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigurationRegistrationTest.java(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigurationRegistrationTest.java
🧰 Additional context used
📓 Path-based instructions (1)
**/*
⚙️ CodeRabbit configuration file
**/*: Please focus on:
- Code quality and best practices
- Security considerations
- Performance implications
- Test coverage and quality
- API design and consistency
- Error handling and edge cases
For Java code specifically:
- Check for proper exception handling
- Verify async method implementations
- Review builder pattern usage
- Validate test coverage
- Check for memory leaks in async operations
Ignore:
- Generated code files
- Build artifacts
- Configuration files
- Documentation formatting
Files:
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigTest.java
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
🔇 Additional comments (2)
kinde-springboot/kinde-springboot-core/src/test/java/com/kinde/spring/KindeSdkClientAutoConfigTest.java (2)
31-39: LGTM! JAR compatibility issue resolved.The helper method correctly uses
InputStreamwith try-with-resources, ensuring tests work both in IDE and packaged JAR environments. This properly addresses the critical issue raised in the previous review.
50-63: LGTM! Ordering verification is sound.The test correctly verifies that
KindeSdkClientAutoConfigis registered beforeKindeOAuth2AutoConfig, ensuring proper bean initialization order.
3 participants
Explain your changes
Checklist
🛟 If you need help, consider asking for advice over in the Kinde community.
Summary by CodeRabbit
New Features
Tests