Licensing: credential based returns limits per type #4795
Conversation
…ted, removing hard coded values in the account license service
|
Warning Rate limit exceeded@techsmyth has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 15 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (4)
WalkthroughThis pull request introduces changes to the licensing and entitlement management system, affecting multiple files across the licensing and account domains. Key modifications include the addition of the Changes
Possibly related issues
Possibly related PRs
Suggested Reviewers
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
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🔭 Outside diff range comments (1)
src/platform/licensing/credential-based/license-policy/license.policy.service.ts (1)
Line range hint
25-33: Consider adding validation for granted entitlementsThe
createCredentialRulemethod should validate the granted entitlements before creating the rule, especially since it's now using a more complex type that includes limits.createCredentialRule( grantedEntitlements: LicensingGrantedEntitlement[], credentialType: LicensingCredentialBasedCredentialType, name: string ): ILicensingCredentialBasedPolicyCredentialRule { + if (!grantedEntitlements?.length) { + throw new Error('At least one granted entitlement is required'); + } + grantedEntitlements.forEach(entitlement => { + if (entitlement.limit < 0) { + throw new Error('Entitlement limit cannot be negative'); + } + }); return { grantedEntitlements: grantedEntitlements, credentialType, name, }; }
🧹 Nitpick comments (12)
src/domain/space/account/account.service.license.ts (7)
89-93: Wrap Declaration in a Block to Avoid Switch Scope Leakage
Static analysis flags that other switch clauses could erroneously access the declaration 'createSpaceEntitlement'. To resolve this, wrap the declaration in a block.Apply this fix:
case LicenseEntitlementType.ACCOUNT_SPACE_FREE: + { const createSpaceEntitlement = await this.licensingCredentialBasedService.getEntitlementIfGranted( LicenseEntitlementType.ACCOUNT_SPACE_FREE, accountAgent ); if (createSpaceEntitlement) { entitlement.limit = createSpaceEntitlement.limit; entitlement.enabled = true; } + } break;🧰 Tools
🪛 Biome (1.9.4)
[error] 89-93: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.The declaration is defined in this switch clause:
Unsafe fix: Wrap the declaration in a block.
(lint/correctness/noSwitchDeclarations)
100-104: Same Scope Leakage Concern
Wrap the declaration in its own block:case LicenseEntitlementType.ACCOUNT_SPACE_PLUS: + { const createSpacePLusEntitlement = await this.licensingCredentialBasedService.getEntitlementIfGranted( LicenseEntitlementType.ACCOUNT_SPACE_PLUS, accountAgent ); if (createSpacePLusEntitlement) { entitlement.limit = createSpacePLusEntitlement.limit; entitlement.enabled = true; } + } break;🧰 Tools
🪛 Biome (1.9.4)
[error] 100-104: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.The declaration is defined in this switch clause:
Unsafe fix: Wrap the declaration in a block.
(lint/correctness/noSwitchDeclarations)
111-115: Same Scope Leakage Concern
Again, use a block for the variable declaration:case LicenseEntitlementType.ACCOUNT_SPACE_PREMIUM: + { const createSpacePremiumEntitlement = await this.licensingCredentialBasedService.getEntitlementIfGranted( LicenseEntitlementType.ACCOUNT_SPACE_PREMIUM, accountAgent ); if (createSpacePremiumEntitlement) { entitlement.limit = createSpacePremiumEntitlement.limit; entitlement.enabled = true; } + } break;🧰 Tools
🪛 Biome (1.9.4)
[error] 111-115: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.The declaration is defined in this switch clause:
Unsafe fix: Wrap the declaration in a block.
(lint/correctness/noSwitchDeclarations)
122-126: Same Scope Leakage Concern
Wrap in a block:case LicenseEntitlementType.ACCOUNT_VIRTUAL_CONTRIBUTOR: + { const createVirtualContributorEntitlement = await this.licensingCredentialBasedService.getEntitlementIfGranted( LicenseEntitlementType.ACCOUNT_VIRTUAL_CONTRIBUTOR, accountAgent ); if (createVirtualContributorEntitlement) { entitlement.limit = createVirtualContributorEntitlement.limit; entitlement.enabled = true; } + } break;🧰 Tools
🪛 Biome (1.9.4)
[error] 122-126: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.The declaration is defined in this switch clause:
Unsafe fix: Wrap the declaration in a block.
(lint/correctness/noSwitchDeclarations)
133-137: Same Scope Leakage Concern
Add braces:case LicenseEntitlementType.ACCOUNT_INNOVATION_HUB: + { const createInnovationHubEntitlement = await this.licensingCredentialBasedService.getEntitlementIfGranted( LicenseEntitlementType.ACCOUNT_INNOVATION_HUB, accountAgent ); if (createInnovationHubEntitlement) { entitlement.limit = createInnovationHubEntitlement.limit; entitlement.enabled = true; } + } break;🧰 Tools
🪛 Biome (1.9.4)
[error] 133-137: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.The declaration is defined in this switch clause:
Unsafe fix: Wrap the declaration in a block.
(lint/correctness/noSwitchDeclarations)
144-148: Same Scope Leakage Concern
Wrap in braces as well:case LicenseEntitlementType.ACCOUNT_INNOVATION_PACK: + { const createInnovationPackEntitlement = await this.licensingCredentialBasedService.getEntitlementIfGranted( LicenseEntitlementType.ACCOUNT_INNOVATION_PACK, accountAgent ); if (createInnovationPackEntitlement) { entitlement.limit = createInnovationPackEntitlement.limit; entitlement.enabled = true; } + } break;🧰 Tools
🪛 Biome (1.9.4)
[error] 144-148: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.The declaration is defined in this switch clause:
Unsafe fix: Wrap the declaration in a block.
(lint/correctness/noSwitchDeclarations)
164-169: TODO: Implement External Subscription Entitlements
The code logs the entitlements but does not currently merge them into the existinglicense.entitlements. Consider adding logic to assign or merge these external subscription entitlements into your licensing model.Would you like me to open a GitHub issue or provide a snippet that merges these external entitlements?
src/platform/licensing/wingback-subscription/licensing.wingback.subscription.service.ts (1)
21-21: TODO: Return LicensingGrantedEntitlement[]
The method currently returns an array of arbitrary records. Consider implementing theLicensingGrantedEntitlementreturn structure to leverage type safety and consistent logic throughout your application.src/domain/space/account/account.module.ts (1)
Line range hint
33-51: Group related licensing modules togetherConsider grouping all licensing-related modules together in the imports array for better organization.
@Module({ imports: [ AccountHostModule, AgentModule, AuthorizationModule, AuthorizationPolicyModule, ContributorModule, StorageAggregatorModule, TemporaryStorageModule, PlatformAuthorizationPolicyModule, + // Licensing modules LicensingFrameworkModule, LicenseIssuerModule, LicensingCredentialBasedModule, LicensingWingbackSubscriptionModule, LicenseModule, + // Other modules SpaceModule, InnovationHubModule, InnovationPackModule, VirtualContributorModule, NameReporterModule, NamingModule, TypeOrmModule.forFeature([Account]), NotificationAdapterModule, ],src/migrations/1734087106799-licensePolicyLimits.ts (3)
34-34: Address TODO comment before mergingThe TODO comment indicates that
SPACE_LICENSE_ENTERPRISEshould be removed.Would you like me to help create a GitHub issue to track the removal of this enum value?
85-85: Fix typo in credential rule nameThere's a typo in the name: "Space Save As Templatet" should be "Space Save As Template"
- name: 'Space Save As Templatet', + name: 'Space Save As Template',
56-155: Consider extracting common entitlementsSeveral license types (PLUS, PREMIUM) share common entitlements. Consider extracting these into constants to improve maintainability.
Example refactor:
const COMMON_SPACE_ENTITLEMENTS = [ { type: LicenseEntitlementType.SPACE_FLAG_WHITEBOARD_MULTI_USER, limit: 1, }, { type: LicenseEntitlementType.SPACE_FLAG_SAVE_AS_TEMPLATE, limit: 1, }, ]; // Then in the rules: { credentialType: LicenseCredential.SPACE_LICENSE_PLUS, grantedEntitlements: [ { type: LicenseEntitlementType.SPACE_PLUS, limit: 1, }, ...COMMON_SPACE_ENTITLEMENTS, ], name: 'Space License Plus', },
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
src/domain/space/account/account.module.ts(2 hunks)src/domain/space/account/account.service.license.ts(3 hunks)src/migrations/1734087106799-licensePolicyLimits.ts(1 hunks)src/platform/licensing/credential-based/license-policy/license.policy.service.ts(2 hunks)src/platform/licensing/credential-based/licensing-credential-based-entitlements-engine/index.ts(1 hunks)src/platform/licensing/credential-based/licensing-credential-based-entitlements-engine/licensing.credential.based.policy.credential.rule.interface.ts(1 hunks)src/platform/licensing/credential-based/licensing-credential-based-entitlements-engine/licensing.credential.based.policy.credential.rule.ts(1 hunks)src/platform/licensing/credential-based/licensing-credential-based-entitlements-engine/licensing.credential.based.service.ts(4 hunks)src/platform/licensing/dto/licensing.dto.granted.entitlement.ts(1 hunks)src/platform/licensing/wingback-subscription/licensing.wingback.subscription.service.ts(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- src/platform/licensing/credential-based/licensing-credential-based-entitlements-engine/index.ts
🧰 Additional context used
📓 Path-based instructions (9)
src/platform/licensing/wingback-subscription/licensing.wingback.subscription.service.ts (1)
Pattern src/**/*.{ts,js}: Review the TypeScript/JavaScript code for NestJS best practices, dependency injection, module structure, and potential bugs.
Context Files (Do Not Review):
docs/Design.md- Design overview of the projectdocs/Pagination.md- Pagination design overviewdocs/Developing.md- Development setup overviewdocs/graphql-typeorm-usage.md- overview of GraphQL and TypeORM usage and how they are used together with NestJS in the projectdocs/database-definitions.md- guidelines for creating TypeORM entity defnitionssrc/core/error-handling/graphql.exception.filter.ts- GraphQL error handlingsrc/core/error-handling/http.exception.filter.ts- HTTP error handlingsrc/core/error-handling/rest.error.response.ts- REST error responsesrc/core/error-handling/unhandled.exception.filter.ts- Global exception handler
Guidelines:
- Our project uses global exception handlers (
UnhandledExceptionFilter), so avoid suggesting additionaltry/catchblocks unless handling specific cases. - Use NestJS latest documentation from
https://docs.nestjs.com/for reference on NestJS best practices. - Use TypeORM latest documentation from
https://typeorm.io/for reference on TypeORM best practices. - Refer to the design overview in the context files for better understanding.
src/domain/space/account/account.module.ts (1)
Pattern src/**/*.{ts,js}: Review the TypeScript/JavaScript code for NestJS best practices, dependency injection, module structure, and potential bugs.
Context Files (Do Not Review):
docs/Design.md- Design overview of the projectdocs/Pagination.md- Pagination design overviewdocs/Developing.md- Development setup overviewdocs/graphql-typeorm-usage.md- overview of GraphQL and TypeORM usage and how they are used together with NestJS in the projectdocs/database-definitions.md- guidelines for creating TypeORM entity defnitionssrc/core/error-handling/graphql.exception.filter.ts- GraphQL error handlingsrc/core/error-handling/http.exception.filter.ts- HTTP error handlingsrc/core/error-handling/rest.error.response.ts- REST error responsesrc/core/error-handling/unhandled.exception.filter.ts- Global exception handler
Guidelines:
- Our project uses global exception handlers (
UnhandledExceptionFilter), so avoid suggesting additionaltry/catchblocks unless handling specific cases. - Use NestJS latest documentation from
https://docs.nestjs.com/for reference on NestJS best practices. - Use TypeORM latest documentation from
https://typeorm.io/for reference on TypeORM best practices. - Refer to the design overview in the context files for better understanding.
src/platform/licensing/credential-based/license-policy/license.policy.service.ts (1)
Pattern src/**/*.{ts,js}: Review the TypeScript/JavaScript code for NestJS best practices, dependency injection, module structure, and potential bugs.
Context Files (Do Not Review):
docs/Design.md- Design overview of the projectdocs/Pagination.md- Pagination design overviewdocs/Developing.md- Development setup overviewdocs/graphql-typeorm-usage.md- overview of GraphQL and TypeORM usage and how they are used together with NestJS in the projectdocs/database-definitions.md- guidelines for creating TypeORM entity defnitionssrc/core/error-handling/graphql.exception.filter.ts- GraphQL error handlingsrc/core/error-handling/http.exception.filter.ts- HTTP error handlingsrc/core/error-handling/rest.error.response.ts- REST error responsesrc/core/error-handling/unhandled.exception.filter.ts- Global exception handler
Guidelines:
- Our project uses global exception handlers (
UnhandledExceptionFilter), so avoid suggesting additionaltry/catchblocks unless handling specific cases. - Use NestJS latest documentation from
https://docs.nestjs.com/for reference on NestJS best practices. - Use TypeORM latest documentation from
https://typeorm.io/for reference on TypeORM best practices. - Refer to the design overview in the context files for better understanding.
src/platform/licensing/dto/licensing.dto.granted.entitlement.ts (1)
Pattern src/**/*.{ts,js}: Review the TypeScript/JavaScript code for NestJS best practices, dependency injection, module structure, and potential bugs.
Context Files (Do Not Review):
docs/Design.md- Design overview of the projectdocs/Pagination.md- Pagination design overviewdocs/Developing.md- Development setup overviewdocs/graphql-typeorm-usage.md- overview of GraphQL and TypeORM usage and how they are used together with NestJS in the projectdocs/database-definitions.md- guidelines for creating TypeORM entity defnitionssrc/core/error-handling/graphql.exception.filter.ts- GraphQL error handlingsrc/core/error-handling/http.exception.filter.ts- HTTP error handlingsrc/core/error-handling/rest.error.response.ts- REST error responsesrc/core/error-handling/unhandled.exception.filter.ts- Global exception handler
Guidelines:
- Our project uses global exception handlers (
UnhandledExceptionFilter), so avoid suggesting additionaltry/catchblocks unless handling specific cases. - Use NestJS latest documentation from
https://docs.nestjs.com/for reference on NestJS best practices. - Use TypeORM latest documentation from
https://typeorm.io/for reference on TypeORM best practices. - Refer to the design overview in the context files for better understanding.
src/migrations/1734087106799-licensePolicyLimits.ts (1)
Pattern src/**/*.{ts,js}: Review the TypeScript/JavaScript code for NestJS best practices, dependency injection, module structure, and potential bugs.
Context Files (Do Not Review):
docs/Design.md- Design overview of the projectdocs/Pagination.md- Pagination design overviewdocs/Developing.md- Development setup overviewdocs/graphql-typeorm-usage.md- overview of GraphQL and TypeORM usage and how they are used together with NestJS in the projectdocs/database-definitions.md- guidelines for creating TypeORM entity defnitionssrc/core/error-handling/graphql.exception.filter.ts- GraphQL error handlingsrc/core/error-handling/http.exception.filter.ts- HTTP error handlingsrc/core/error-handling/rest.error.response.ts- REST error responsesrc/core/error-handling/unhandled.exception.filter.ts- Global exception handler
Guidelines:
- Our project uses global exception handlers (
UnhandledExceptionFilter), so avoid suggesting additionaltry/catchblocks unless handling specific cases. - Use NestJS latest documentation from
https://docs.nestjs.com/for reference on NestJS best practices. - Use TypeORM latest documentation from
https://typeorm.io/for reference on TypeORM best practices. - Refer to the design overview in the context files for better understanding.
src/platform/licensing/credential-based/licensing-credential-based-entitlements-engine/licensing.credential.based.policy.credential.rule.interface.ts (1)
Pattern src/**/*.{ts,js}: Review the TypeScript/JavaScript code for NestJS best practices, dependency injection, module structure, and potential bugs.
Context Files (Do Not Review):
docs/Design.md- Design overview of the projectdocs/Pagination.md- Pagination design overviewdocs/Developing.md- Development setup overviewdocs/graphql-typeorm-usage.md- overview of GraphQL and TypeORM usage and how they are used together with NestJS in the projectdocs/database-definitions.md- guidelines for creating TypeORM entity defnitionssrc/core/error-handling/graphql.exception.filter.ts- GraphQL error handlingsrc/core/error-handling/http.exception.filter.ts- HTTP error handlingsrc/core/error-handling/rest.error.response.ts- REST error responsesrc/core/error-handling/unhandled.exception.filter.ts- Global exception handler
Guidelines:
- Our project uses global exception handlers (
UnhandledExceptionFilter), so avoid suggesting additionaltry/catchblocks unless handling specific cases. - Use NestJS latest documentation from
https://docs.nestjs.com/for reference on NestJS best practices. - Use TypeORM latest documentation from
https://typeorm.io/for reference on TypeORM best practices. - Refer to the design overview in the context files for better understanding.
src/domain/space/account/account.service.license.ts (1)
Pattern src/**/*.{ts,js}: Review the TypeScript/JavaScript code for NestJS best practices, dependency injection, module structure, and potential bugs.
Context Files (Do Not Review):
docs/Design.md- Design overview of the projectdocs/Pagination.md- Pagination design overviewdocs/Developing.md- Development setup overviewdocs/graphql-typeorm-usage.md- overview of GraphQL and TypeORM usage and how they are used together with NestJS in the projectdocs/database-definitions.md- guidelines for creating TypeORM entity defnitionssrc/core/error-handling/graphql.exception.filter.ts- GraphQL error handlingsrc/core/error-handling/http.exception.filter.ts- HTTP error handlingsrc/core/error-handling/rest.error.response.ts- REST error responsesrc/core/error-handling/unhandled.exception.filter.ts- Global exception handler
Guidelines:
- Our project uses global exception handlers (
UnhandledExceptionFilter), so avoid suggesting additionaltry/catchblocks unless handling specific cases. - Use NestJS latest documentation from
https://docs.nestjs.com/for reference on NestJS best practices. - Use TypeORM latest documentation from
https://typeorm.io/for reference on TypeORM best practices. - Refer to the design overview in the context files for better understanding.
src/platform/licensing/credential-based/licensing-credential-based-entitlements-engine/licensing.credential.based.service.ts (1)
Pattern src/**/*.{ts,js}: Review the TypeScript/JavaScript code for NestJS best practices, dependency injection, module structure, and potential bugs.
Context Files (Do Not Review):
docs/Design.md- Design overview of the projectdocs/Pagination.md- Pagination design overviewdocs/Developing.md- Development setup overviewdocs/graphql-typeorm-usage.md- overview of GraphQL and TypeORM usage and how they are used together with NestJS in the projectdocs/database-definitions.md- guidelines for creating TypeORM entity defnitionssrc/core/error-handling/graphql.exception.filter.ts- GraphQL error handlingsrc/core/error-handling/http.exception.filter.ts- HTTP error handlingsrc/core/error-handling/rest.error.response.ts- REST error responsesrc/core/error-handling/unhandled.exception.filter.ts- Global exception handler
Guidelines:
- Our project uses global exception handlers (
UnhandledExceptionFilter), so avoid suggesting additionaltry/catchblocks unless handling specific cases. - Use NestJS latest documentation from
https://docs.nestjs.com/for reference on NestJS best practices. - Use TypeORM latest documentation from
https://typeorm.io/for reference on TypeORM best practices. - Refer to the design overview in the context files for better understanding.
src/platform/licensing/credential-based/licensing-credential-based-entitlements-engine/licensing.credential.based.policy.credential.rule.ts (1)
Pattern src/**/*.{ts,js}: Review the TypeScript/JavaScript code for NestJS best practices, dependency injection, module structure, and potential bugs.
Context Files (Do Not Review):
docs/Design.md- Design overview of the projectdocs/Pagination.md- Pagination design overviewdocs/Developing.md- Development setup overviewdocs/graphql-typeorm-usage.md- overview of GraphQL and TypeORM usage and how they are used together with NestJS in the projectdocs/database-definitions.md- guidelines for creating TypeORM entity defnitionssrc/core/error-handling/graphql.exception.filter.ts- GraphQL error handlingsrc/core/error-handling/http.exception.filter.ts- HTTP error handlingsrc/core/error-handling/rest.error.response.ts- REST error responsesrc/core/error-handling/unhandled.exception.filter.ts- Global exception handler
Guidelines:
- Our project uses global exception handlers (
UnhandledExceptionFilter), so avoid suggesting additionaltry/catchblocks unless handling specific cases. - Use NestJS latest documentation from
https://docs.nestjs.com/for reference on NestJS best practices. - Use TypeORM latest documentation from
https://typeorm.io/for reference on TypeORM best practices. - Refer to the design overview in the context files for better understanding.
🪛 Biome (1.9.4)
src/domain/space/account/account.service.license.ts
[error] 89-93: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.
The declaration is defined in this switch clause:
Unsafe fix: Wrap the declaration in a block.
(lint/correctness/noSwitchDeclarations)
[error] 100-104: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.
The declaration is defined in this switch clause:
Unsafe fix: Wrap the declaration in a block.
(lint/correctness/noSwitchDeclarations)
[error] 111-115: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.
The declaration is defined in this switch clause:
Unsafe fix: Wrap the declaration in a block.
(lint/correctness/noSwitchDeclarations)
[error] 122-126: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.
The declaration is defined in this switch clause:
Unsafe fix: Wrap the declaration in a block.
(lint/correctness/noSwitchDeclarations)
[error] 133-137: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.
The declaration is defined in this switch clause:
Unsafe fix: Wrap the declaration in a block.
(lint/correctness/noSwitchDeclarations)
[error] 144-148: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.
The declaration is defined in this switch clause:
Unsafe fix: Wrap the declaration in a block.
(lint/correctness/noSwitchDeclarations)
🔇 Additional comments (8)
src/domain/space/account/account.service.license.ts (1)
24-25: New Dependencies Injected Successfully
The injection of the new licensing services appears consistent with NestJS best practices. Ensure all dependencies are properly configured in the corresponding module (e.g., AccountModule).
src/platform/licensing/dto/licensing.dto.granted.entitlement.ts (1)
1-13: New GraphQL ObjectType Definition Looks Good
The type structure is clear, and both fields (type and limit) align well with the new licensing approach. Ensure that you handle any null or undefined values for limit in your resolvers or service methods.
src/platform/licensing/credential-based/licensing-credential-based-entitlements-engine/licensing.credential.based.policy.credential.rule.interface.ts (1)
3-11: Alignment with New Entitlement Type
Switching from an array of LicenseEntitlementType to LicensingGrantedEntitlement[] is consistent with the updated approach. This allows a more descriptive and flexible representation of entitlements.
src/platform/licensing/credential-based/licensing-credential-based-entitlements-engine/licensing.credential.based.policy.credential.rule.ts (1)
2-3: Verify all consumers of LicensingCredentialBasedPolicyCredentialRule are updated
The change from LicenseEntitlementType[] to LicensingGrantedEntitlement[] is a breaking change that requires updates in all consuming code.
Also applies to: 9-9, 13-13
✅ Verification successful
Let me check the implementation details of these files to verify if they have been properly updated.
All consumers have been properly updated to use LicensingGrantedEntitlement
The verification shows that all consuming files have been correctly updated to handle the type change:
license.policy.service.tsusesLicensingGrantedEntitlement[]in its method signaturelicensing.credential.based.service.tsproperly handles the new type by accessing bothtypeandlimitpropertieslicensing.credential.based.policy.credential.rule.interface.tsdeclares the field with the new type
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Find all files that might be affected by the type change
rg -l "LicensingCredentialBasedPolicyCredentialRule" | \
xargs rg -l "grantedEntitlements"
Length of output: 582
Script:
#!/bin/bash
# Check the usage of grantedEntitlements in the affected files
echo "=== license.policy.service.ts ==="
rg "grantedEntitlements" src/platform/licensing/credential-based/license-policy/license.policy.service.ts -B 2 -A 2
echo -e "\n=== licensing.credential.based.service.ts ==="
rg "grantedEntitlements" src/platform/licensing/credential-based/licensing-credential-based-entitlements-engine/licensing.credential.based.service.ts -B 2 -A 2
echo -e "\n=== licensing.credential.based.policy.credential.rule.interface.ts ==="
rg "grantedEntitlements" src/platform/licensing/credential-based/licensing-credential-based-entitlements-engine/licensing.credential.based.policy.credential.rule.interface.ts -B 2 -A 2
Length of output: 2367
src/domain/space/account/account.module.ts (1)
29-29: Verify LicensingWingbackSubscriptionModule dependencies
The addition of LicensingWingbackSubscriptionModule looks good, but we should verify its dependencies are properly configured.
Also applies to: 44-44
✅ Verification successful
Let me gather more information about the module's dependencies and configuration.
Dependencies for LicensingWingbackSubscriptionModule are properly configured
The module setup is correct with:
- Proper exports of LicensingWingbackSubscriptionService
- Correct service injection in AccountService.license
- No circular dependencies detected
- Required authorization modules imported
- Complete test coverage with spec files
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check for circular dependencies and proper module setup
rg -l "LicensingWingbackSubscriptionModule" | \
xargs rg "imports:|exports:|providers:"
Length of output: 923
Script:
#!/bin/bash
# Check the module's implementation and dependencies
ast-grep --pattern 'export class LicensingWingbackSubscriptionModule {
$$$
}'
# Check what services this module exports and their usage
rg -l "LicensingWingbackSubscriptionService" | \
xargs rg "LicensingWingbackSubscriptionService" -A 2
Length of output: 5871
src/migrations/1734087106799-licensePolicyLimits.ts (1)
19-28: LGTM! Well-structured type definitions
The type definitions are clear, well-organized, and follow TypeScript best practices.
src/platform/licensing/credential-based/licensing-credential-based-entitlements-engine/licensing.credential.based.service.ts (2)
14-16: LGTM! Follows NestJS best practices
The import structure and class definition follow NestJS best practices with proper dependency injection.
65-68: LGTM! Improved type safety and readability
The refactored entitlement check using find improves both type safety and code readability.
...l-based/licensing-credential-based-entitlements-engine/licensing.credential.based.service.ts
Show resolved
Hide resolved
… entitlements; clarify api + work to be done in wingback subscription licensing service
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
src/domain/space/account/account.service.license.ts (3)
24-25: Constructor injection updated to accommodate new licensing services.
Replacing the old license engine with the credential-based service and introducing the Wingback subscription service is a good approach to separate concerns. Ensure that downstream usage references are also updated so there are no lingering calls to the old service.
86-89: Sequentially checking entitlements is correct but could be optimized.
The loop awaiting each iteration is conceptually valid. For performance, ensure minimal overhead. If each call is independent, consider parallelizing to reduce runtime. However, be aware of rate limits from external services.
118-131: New private method checkAndAssignGrantedEntitlement.
The logic here is clear and properly updates the entitlement if it is granted. Consider logging additional details if the entitlement is denied for observability or debugging.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/domain/space/account/account.service.license.ts(2 hunks)src/platform/licensing/wingback-subscription/licensing.wingback.subscription.service.ts(2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
src/platform/licensing/wingback-subscription/licensing.wingback.subscription.service.ts (1)
Pattern src/**/*.{ts,js}: Review the TypeScript/JavaScript code for NestJS best practices, dependency injection, module structure, and potential bugs.
Context Files (Do Not Review):
docs/Design.md- Design overview of the projectdocs/Pagination.md- Pagination design overviewdocs/Developing.md- Development setup overviewdocs/graphql-typeorm-usage.md- overview of GraphQL and TypeORM usage and how they are used together with NestJS in the projectdocs/database-definitions.md- guidelines for creating TypeORM entity defnitionssrc/core/error-handling/graphql.exception.filter.ts- GraphQL error handlingsrc/core/error-handling/http.exception.filter.ts- HTTP error handlingsrc/core/error-handling/rest.error.response.ts- REST error responsesrc/core/error-handling/unhandled.exception.filter.ts- Global exception handler
Guidelines:
- Our project uses global exception handlers (
UnhandledExceptionFilter), so avoid suggesting additionaltry/catchblocks unless handling specific cases. - Use NestJS latest documentation from
https://docs.nestjs.com/for reference on NestJS best practices. - Use TypeORM latest documentation from
https://typeorm.io/for reference on TypeORM best practices. - Refer to the design overview in the context files for better understanding.
src/domain/space/account/account.service.license.ts (1)
Pattern src/**/*.{ts,js}: Review the TypeScript/JavaScript code for NestJS best practices, dependency injection, module structure, and potential bugs.
Context Files (Do Not Review):
docs/Design.md- Design overview of the projectdocs/Pagination.md- Pagination design overviewdocs/Developing.md- Development setup overviewdocs/graphql-typeorm-usage.md- overview of GraphQL and TypeORM usage and how they are used together with NestJS in the projectdocs/database-definitions.md- guidelines for creating TypeORM entity defnitionssrc/core/error-handling/graphql.exception.filter.ts- GraphQL error handlingsrc/core/error-handling/http.exception.filter.ts- HTTP error handlingsrc/core/error-handling/rest.error.response.ts- REST error responsesrc/core/error-handling/unhandled.exception.filter.ts- Global exception handler
Guidelines:
- Our project uses global exception handlers (
UnhandledExceptionFilter), so avoid suggesting additionaltry/catchblocks unless handling specific cases. - Use NestJS latest documentation from
https://docs.nestjs.com/for reference on NestJS best practices. - Use TypeORM latest documentation from
https://typeorm.io/for reference on TypeORM best practices. - Refer to the design overview in the context files for better understanding.
🔇 Additional comments (4)
src/platform/licensing/wingback-subscription/licensing.wingback.subscription.service.ts (2)
1-6: Ensure consistent NestJS logging usage and import organization.
The imports and logger injection follow recommended NestJS patterns; however, confirm that all imported modules (e.g. LoggerService) remain consistent with your overall logging strategy, particularly ensuring any existing log filtering configurations are respected.
10-14: Constructor injection looks good.
The constructor properly injects the WingbackManager and the logger, adhering to NestJS dependency injection conventions. No issues found here.
src/domain/space/account/account.service.license.ts (2)
15-16: Imports for new services and interfaces look correct.
The additions adequately reference the new LicensingWingbackSubscriptionService and the ILicenseEntitlement interface, aligning with the licensing domain.
92-112: Mixing Wingback entitlements with existing ones.
Overwriting local entitlements with Wingback data is straightforward, but be mindful of situations where Wingback might not have all entitlements listed. Confirm whether partial data from Wingback should override local data, or if you need a fallback to existing entitlements.
src/platform/licensing/wingback-subscription/licensing.wingback.subscription.service.ts
Show resolved
Hide resolved
This allows having the numerical limits specified in the license policy. Previously all limits associated with entitlements were actually booleans, not numbers.
A new type is added that can also be used to return granted entitlements from Wingback Subscription
Migration is added to update the credential based licensing policy
The actual resulting licensing credential based rule now looks like:
Previously grantedEntitlements was just an array of entitlement types, now there is a limit for each one.
Summary by CodeRabbit
New Features
LicensingWingbackSubscriptionModuleto enhance account management.LicensingWingbackSubscriptionService.LicensingGrantedEntitlementcreated for entitlement representation.Improvements
getEntitlementsmethod to return structured entitlement data.Bug Fixes
Chores