Fix/express version #197
Fix/express version #197
Conversation
WalkthroughThis pull request introduces updates to the documentation for the Java and NodeJS SDKs. The Java SDK documentation has been modified to reflect a change in dependency versioning, allowing for any version greater than or equal to Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 8
🧹 Outside diff range and nitpick comments (2)
src/content/docs/developer-tools/sdks/backend/nodejs-sdk.mdx (1)
19-19: Improve clarity and accuracy of the new Node.js version requirementThe addition of the Node.js version requirement for use with the Express SDK is valuable information. However, we can improve its clarity and accuracy:
- The phrase "in conjunction with" could be simplified.
- "ExpressJS" should be spelled as "Express.js" for consistency with official naming.
- The sentence structure can be improved for better readability.
Consider revising the line as follows:
-- Node version 18.x.x or newer. If used in conjunction with the ExpressJS sdk [Express SDK](https://github.com/kinde-oss/kinde-node-express), then Node 20.x.x or new is required. ++ Node version 18.x.x or newer. When used with the [Express.js SDK](https://github.com/kinde-oss/kinde-node-express), Node 20.x.x or newer is required.This revision maintains the essential information while improving clarity and accuracy.
🧰 Tools
🪛 LanguageTool
[style] ~19-~19: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...- Node version 18.x.x or newer. If used in conjunction with the ExpressJS sdk [Express SDK](https:/...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
[uncategorized] ~19-~19: The official spelling of this programming framework is “Express.js”.
Context: ... newer. If used in conjunction with the ExpressJS sdk [Express SDK](https://github.com/ki...(NODE_JS)
src/content/docs/developer-tools/sdks/backend/java-sdk.mdx (1)
Line range hint
62-716: Overall recommendation for dependency version managementThroughout the document, there's a consistent pattern of updating version numbers to allow for newer versions. While this can ensure access to the latest features and bug fixes, it also introduces potential risks:
- Maven dependencies now use
[2.0.1,), which allows any version from 2.0.1 onwards.- Gradle dependencies now use
+, which always fetches the latest version.These changes could lead to unexpected breaking changes and inconsistent behavior across different environments. To maintain stability while still allowing for updates, consider the following approach for all dependencies:
For Maven:
Use a version range that allows minor and patch updates but excludes major version changes, e.g.,[2.0.1,3.0.0).For Gradle:
Use a fixed version or a range that allows only patch updates, e.g.,2.0.1or2.0.+.Implementing these changes consistently across all dependencies will provide a better balance between staying up-to-date and maintaining stability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- src/content/docs/developer-tools/sdks/backend/java-sdk.mdx (7 hunks)
- src/content/docs/developer-tools/sdks/backend/nodejs-sdk.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/developer-tools/sdks/backend/nodejs-sdk.mdx
[style] ~19-~19: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...- Node version 18.x.x or newer. If used in conjunction with the ExpressJS sdk [Express SDK](https:/...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
[uncategorized] ~19-~19: The official spelling of this programming framework is “Express.js”.
Context: ... newer. If used in conjunction with the ExpressJS sdk [Express SDK](https://github.com/ki...(NODE_JS)
🔇 Additional comments (1)
src/content/docs/developer-tools/sdks/backend/nodejs-sdk.mdx (1)
Line range hint
1-1000: Documentation appears comprehensive and well-structuredWhile only one line was changed in this update, it's worth noting that the overall documentation for the NodeJS SDK is comprehensive and well-structured. It covers installation, configuration, integration, and various SDK features in detail, which is valuable for developers using the Kinde NodeJS SDK.
🧰 Tools
🪛 LanguageTool
[style] ~19-~19: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...- Node version 18.x.x or newer. If used in conjunction with the ExpressJS sdk [Express SDK](https:/...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
[uncategorized] ~19-~19: The official spelling of this programming framework is “Express.js”.
Context: ... newer. If used in conjunction with the ExpressJS sdk [Express SDK](https://github.com/ki...(NODE_JS)
| @@ -638,15 +638,15 @@ To use configure Spring Boot to use Kinde for authentication, include the follow | |||
| <dependency> | |||
| <groupId>com.kinde.spring</groupId> | |||
| <artifactId>kinde-springboot-starter</artifactId> | |||
| <version>2.0.0</version> | |||
| <version>[2.0.1,)</version> | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider using a more restrictive version range for kinde-springboot-starter
Consistent with the previous Maven dependencies, the version range [2.0.1,) allows for any version from 2.0.1 onwards, including potential major version updates. To ensure compatibility and avoid unexpected breaking changes, consider using a more restrictive range.
- <version>[2.0.1,)</version>
+ <version>[2.0.1,3.0.0)</version>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <version>[2.0.1,)</version> | |
| <version>[2.0.1,3.0.0)</version> |
| @@ -59,7 +59,7 @@ Kinde’s SDK is available through [Maven](https://search.maven.org/). To insta | |||
| <dependency> | |||
| <groupId>com.kinde</groupId> | |||
| <artifactId>java-sdk</artifactId> | |||
| <version>2.0.0</version> | |||
| <version>[2.0.1,)</version> | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider using a more restrictive version range
The current version range [2.0.1,) allows for any version from 2.0.1 onwards, including potential major version updates. This could lead to unexpected breaking changes in the future. Consider using a more restrictive range to ensure compatibility, such as [2.0.1,3.0.0) which would allow all 2.x versions but exclude 3.0.0 and above.
- <version>[2.0.1,)</version>
+ <version>[2.0.1,3.0.0)</version>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <version>[2.0.1,)</version> | |
| <version>[2.0.1,3.0.0)</version> |
| @@ -533,7 +533,7 @@ In order to use this SDK include following POM dependency. | |||
| <dependency> | |||
| <groupId>com.kinde</groupId> | |||
| <artifactId>kinde-j2ee</artifactId> | |||
| <version>2.0.0</version> | |||
| <version>[2.0.1,)</version> | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider using a more restrictive version range for kinde-j2ee
Similar to the previous Maven dependency, the version range [2.0.1,) allows for any version from 2.0.1 onwards, including potential major version updates. To ensure compatibility and avoid unexpected breaking changes, consider using a more restrictive range.
- <version>[2.0.1,)</version>
+ <version>[2.0.1,3.0.0)</version>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <version>[2.0.1,)</version> | |
| <version>[2.0.1,3.0.0)</version> |
| @@ -704,7 +704,7 @@ To use this SDK, include the following dependency in your `pom.xml`: | |||
| <dependency> | |||
| <groupId>com.kinde</groupId> | |||
| <artifactId>kinde-management</artifactId> | |||
| <version>2.0.0</version> | |||
| <version>[2.0.1,).0</version> | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix version range syntax and consider using a more restrictive range
There's a typo in the version range syntax. The .0 at the end should be removed. Additionally, as with previous Maven dependencies, consider using a more restrictive range to avoid potential breaking changes.
- <version>[2.0.1,).0</version>
+ <version>[2.0.1,3.0.0)</version>This change removes the typo and restricts the range to versions 2.0.1 up to, but not including, 3.0.0.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <version>[2.0.1,).0</version> | |
| <version>[2.0.1,3.0.0)</version> |
| @@ -713,7 +713,7 @@ To use this SDK, include the following dependency in your `pom.xml`: | |||
| For Gradle, add the following dependency to your build file: | |||
|
|
|||
| ```groovy | |||
| implementation('com.kinde:kinde-management:2.0.0') | |||
| implementation('com.kinde:kinde-management:+') | |||
There was a problem hiding this comment.
Avoid using the latest version syntax (+) for kinde-management in production
Consistent with the previous Gradle dependencies, using + for the version can lead to unpredictable builds and potential breaking changes. For production use, it's recommended to specify a fixed version or a more controlled range.
Consider using a specific version or a range with an upper bound:
-implementation('com.kinde:kinde-management:+')
+implementation('com.kinde:kinde-management:2.0.1')Or if you want to allow patch updates:
-implementation('com.kinde:kinde-management:+')
+implementation('com.kinde:kinde-management:2.0.+')📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| implementation('com.kinde:kinde-management:+') | |
| implementation('com.kinde:kinde-management:2.0.1') |
| </dependency> | ||
| ``` | ||
| #### Gradle | ||
|
|
||
| To use the SDK with a Gradle build process, use the following dependency. | ||
|
|
||
| ```groovy | ||
| configuration('com.kinde.spring:kinde-springboot-starter:2.0.0') | ||
| configuration('com.kinde.spring:kinde-springboot-starter:+') |
There was a problem hiding this comment.
Avoid using the latest version syntax (+) for kinde-springboot-starter in production
Consistent with the previous Gradle dependencies, using + for the version can lead to unpredictable builds and potential breaking changes. For production use, it's recommended to specify a fixed version or a more controlled range.
Consider using a specific version or a range with an upper bound:
- configuration('com.kinde.spring:kinde-springboot-starter:+')
+ configuration('com.kinde.spring:kinde-springboot-starter:2.0.1')Or if you want to allow patch updates:
- configuration('com.kinde.spring:kinde-springboot-starter:+')
+ configuration('com.kinde.spring:kinde-springboot-starter:2.0.+')📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| configuration('com.kinde.spring:kinde-springboot-starter:+') | |
| configuration('com.kinde.spring:kinde-springboot-starter:2.0.1') |
| @@ -542,7 +542,7 @@ In order to use this SDK include following POM dependency. | |||
| In order to use the SDK with a Gradle build process please use the following dependency. | |||
|
|
|||
| ```groovy | |||
| configuration('com.kinde:kinde-j2ee:2.0.0') | |||
| configuration('com.kinde:kinde-j2ee:+') | |||
There was a problem hiding this comment.
Avoid using the latest version syntax (+) for kinde-j2ee in production
As with the previous Gradle dependency, using + for the version can lead to unpredictable builds and potential breaking changes. For production use, it's recommended to specify a fixed version or a more controlled range.
Consider using a specific version or a range with an upper bound:
- configuration('com.kinde:kinde-j2ee:+')
+ configuration('com.kinde:kinde-j2ee:2.0.1')Or if you want to allow patch updates:
- configuration('com.kinde:kinde-j2ee:+')
+ configuration('com.kinde:kinde-j2ee:2.0.+')📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| configuration('com.kinde:kinde-j2ee:+') | |
| configuration('com.kinde:kinde-j2ee:2.0.1') |
| @@ -74,7 +74,7 @@ repositories { | |||
| } | |||
|
|
|||
| dependencies { | |||
| implementation "com.kinde:java-sdk:2.0.0” | |||
| implementation "com.kinde:java-sdk:+” | |||
There was a problem hiding this comment.
Avoid using the latest version syntax (+) in production
Using + for the version in Gradle dependencies can lead to unpredictable builds and potential breaking changes. For production use, it's recommended to specify a fixed version or a more controlled range.
Consider using a specific version or a range with an upper bound:
- implementation "com.kinde:java-sdk:+"
+ implementation "com.kinde:java-sdk:2.0.1"Or if you want to allow patch updates:
- implementation "com.kinde:java-sdk:+"
+ implementation "com.kinde:java-sdk:2.0.+"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| implementation "com.kinde:java-sdk:+” | |
| implementation "com.kinde:java-sdk:2.0.1" |
There was a problem hiding this comment.
Hey @brettchaldecott,
It looks like there is Java SDK changes here. Are you able to create a PR just for Express changes as I am not across Java so I can't review that.
| @@ -16,7 +16,7 @@ You can view the [NodeJS docs](https://github.com/kinde-oss/kinde-nodejs-sdk) a | |||
|
|
|||
| ## Requirements | |||
|
|
|||
| - Node version 18.x.x or newer. | |||
| - Node version 18.x.x or newer. If used in conjunction with the ExpressJS sdk [Express SDK](https://github.com/kinde-oss/kinde-node-express), then Node 20.x.x or new is required. | |||
There was a problem hiding this comment.
@brettchaldecott - shouldnt there be changes to the Express SDK doc, not the NodeJS SDK doc?
Description (required)
Added requirements for use of express in conjunction with node.
Related issues & labels (optional)
Summary by CodeRabbit
New Features
Bug Fixes