Merge pull request #4115 from alkem-io/wingback

* wip * moved dir to adapters * poc wingback create customer * poc wingback create customer * getEntitlements * comment added * renamed the two ways for assigning entitlements * fix compilation: * renaming; code setup * simplify usage of wingback api setup * added flag to be able to disable wingback * fix build * fix build * fix build * Fixed imports * Update src/services/external/wingback/wingback.manager.ts Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Auto stash before merge of "wingback" and "origin/wingback" * Update src/platform/licensing/wingback-subscription/licensing.wingback.subscription.service.spec.ts Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * fixed comments / test issue --------- Co-authored-by: Neil Smyth <[email protected]> Co-authored-by: Neil Smyth <[email protected]> Co-authored-by: Valentin Yanakiev <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
alkem-io · Dec 11, 2024 · 15c1951 · 15c1951
2 parents ae6d6db + dd79b2f
commit 15c1951
Show file tree

Hide file tree

Showing 80 changed files with 640 additions and 202 deletions.
diff --git a/alkemio.yml b/alkemio.yml
@@ -85,6 +85,12 @@ search:
   # The dash at the end is MANDATORY
   index_pattern: ${ELASTIC_SEARCH_INDEX_PATTERN}:alkemio-data-
 
+licensing:
+  wingback:
+    enabled: ${LICENSING_WINGBACK_ENABLED}:false
+    key: ${LICENSING_WINGBACK_API_KEY}
+    endpoint: ${LICENSING_WINGBACK_API_ENDPOINT}
+
 ## identity ##
 
 # Defines all authentication and authorization configuration.

diff --git a/src/app.module.ts b/src/app.module.ts
@@ -61,7 +61,6 @@ import {
   UnhandledExceptionFilter,
 } from '@core/error-handling';
 import { MeModule } from '@services/api/me';
-import { ExcalidrawServerModule } from '@services/external/excalidraw-backend';
 import { ChatGuidanceModule } from '@services/api/chat-guidance/chat.guidance.module';
 import { LookupModule } from '@services/api/lookup';
 import { AuthResetSubscriberModule } from '@services/auth-reset/subscriber/auth-reset.subscriber.module';
@@ -87,6 +86,8 @@ import { Cipher, EncryptionModule } from '@hedger/nestjs-encryption';
 import { AdminUsersModule } from '@platform/admin/users/admin.users.module';
 import { InAppNotificationReaderModule } from '@domain/in-app-notification-reader/in.app.notification.reader.module';
 import { InAppNotificationReceiverModule } from '@domain/in-app-notification-receiver';
+import { LicensingWingbackSubscriptionModule } from '@platform/licensing/wingback-subscription/licensing.wingback.subscription.module';
+import { WingbackManagerModule } from '@services/external/wingback/wingback.manager.module';
 
 @Module({
   imports: [
@@ -267,6 +268,8 @@ import { InAppNotificationReceiverModule } from '@domain/in-app-notification-rec
     AdminCommunicationModule,
     AdminSearchIngestModule,
     AdminLicensingModule,
+    LicensingWingbackSubscriptionModule,
+    WingbackManagerModule,
     AgentModule,
     MessageModule,
     MessageReactionModule,

diff --git a/src/common/enums/credential.type.ts b/src/common/enums/credential.type.ts
@@ -1,13 +1,15 @@
 import { registerEnumType } from '@nestjs/graphql';
-import { LicenseCredential } from './license.credential';
+import { LicensingCredentialBasedCredentialType } from './licensing.credential.based.credential.type';
 import { AuthorizationCredential } from './authorization.credential';
 
 export const CredentialType = {
-  ...LicenseCredential,
+  ...LicensingCredentialBasedCredentialType,
   ...AuthorizationCredential,
 };
 
-export type CredentialType = LicenseCredential | AuthorizationCredential;
+export type CredentialType =
+  | LicensingCredentialBasedCredentialType
+  | AuthorizationCredential;
 
 registerEnumType(CredentialType, {
   name: 'CredentialType',

diff --git a/src/common/enums/license.credential.ts → ...nsing.credential.based.credential.type.ts b/src/common/enums/license.credential.ts → ...nsing.credential.based.credential.type.ts
@@ -1,7 +1,7 @@
 import { registerEnumType } from '@nestjs/graphql';
 
 // Credentials to be added later:
-export enum LicenseCredential {
+export enum LicensingCredentialBasedCredentialType {
   SPACE_LICENSE_FREE = 'space-license-free',
   SPACE_LICENSE_PLUS = 'space-license-plus',
   SPACE_LICENSE_PREMIUM = 'space-license-premium',
@@ -12,6 +12,6 @@ export enum LicenseCredential {
   ACCOUNT_LICENSE_PLUS = 'account-license-plus',
 }
 
-registerEnumType(LicenseCredential, {
-  name: 'LicenseCredential',
+registerEnumType(LicensingCredentialBasedCredentialType, {
+  name: 'LicensingCredentialBasedCredentialType',
 });
diff --git a/src/common/enums/license.plan.type.ts → ...s/licensing.credential.based.plan.type.ts b/src/common/enums/license.plan.type.ts → ...s/licensing.credential.based.plan.type.ts
@@ -1,12 +1,12 @@
 import { registerEnumType } from '@nestjs/graphql';
 
-export enum LicensePlanType {
+export enum LicensingCredentialBasedPlanType {
   ACCOUNT_FEATURE_FLAG = 'account-feature-flag',
   ACCOUNT_PLAN = 'account-plan',
   SPACE_PLAN = 'space-plan',
   SPACE_FEATURE_FLAG = 'space-feature-flag',
 }
 
-registerEnumType(LicensePlanType, {
-  name: 'LicensePlanType',
+registerEnumType(LicensingCredentialBasedPlanType, {
+  name: 'LicensingCredentialBasedPlanType',
 });
diff --git a/src/common/enums/licensing.wingback.subscription.feature.name.ts b/src/common/enums/licensing.wingback.subscription.feature.name.ts
@@ -0,0 +1,11 @@
+import { registerEnumType } from '@nestjs/graphql';
+
+export enum LicensingWingbackSubscriptionFeatureName {
+  ACCOUNT_SPACE_FREE = 'account-space-free',
+  ACCOUNT_SPACE_PLUS = 'account-space-plus',
+  ACCOUNT_SPACE_PREMIUM = 'account-space-premium',
+}
+
+registerEnumType(LicensingWingbackSubscriptionFeatureName, {
+  name: 'LicensingWingbackSubscriptionFeatureName',
+});
diff --git a/src/core/bootstrap/bootstrap.module.ts b/src/core/bootstrap/bootstrap.module.ts
@@ -20,9 +20,9 @@ import { TemplatesSetModule } from '@domain/template/templates-set/templates.set
 import { TemplatesManagerModule } from '@domain/template/templates-manager/templates.manager.module';
 import { TemplateDefaultModule } from '@domain/template/template-default/template.default.module';
 import { LicenseModule } from '@domain/common/license/license.module';
-import { LicensePlanModule } from '@platform/license-plan/license.plan.module';
-import { LicensingFrameworkModule } from '@platform/licensing-framework/licensing.framework.module';
 import { AiPersonaServiceModule } from '@services/ai-server/ai-persona-service/ai.persona.service.module';
+import { LicensingFrameworkModule } from '@platform/licensing/credential-based/licensing-framework/licensing.framework.module';
+import { LicensePlanModule } from '@platform/licensing/credential-based/license-plan/license.plan.module';
 
 @Module({
   imports: [

diff --git a/src/core/bootstrap/bootstrap.service.ts b/src/core/bootstrap/bootstrap.service.ts
@@ -57,8 +57,8 @@ import { bootstrapSpaceTutorialsCalloutGroups } from './platform-template-defini
 import { bootstrapSpaceTutorialsCallouts } from './platform-template-definitions/space-tutorials/bootstrap.space.tutorials.callouts';
 import { LicenseService } from '@domain/common/license/license.service';
 import { AccountLicenseService } from '@domain/space/account/account.service.license';
-import { LicensePlanService } from '@platform/license-plan/license.plan.service';
-import { LicensingFrameworkService } from '@platform/licensing-framework/licensing.framework.service';
+import { LicensePlanService } from '@platform/licensing/credential-based/license-plan/license.plan.service';
+import { LicensingFrameworkService } from '@platform/licensing/credential-based/licensing-framework/licensing.framework.service';
 import { AiPersonaServiceService } from '@services/ai-server/ai-persona-service/ai.persona.service.service';
 import { AiPersonaEngine } from '@common/enums/ai.persona.engine';
 import { AiPersonaBodyOfKnowledgeType } from '@common/enums/ai.persona.body.of.knowledge.type';

diff --git a/src/core/license-engine/index.ts b/src/core/license-engine/index.ts
diff --git a/src/core/license-engine/license.engine.module.ts b/src/core/license-engine/license.engine.module.ts
diff --git a/src/core/license-engine/license.policy.rule.credential.interface.ts b/src/core/license-engine/license.policy.rule.credential.interface.ts
diff --git a/src/core/license-engine/license.policy.rule.credential.ts b/src/core/license-engine/license.policy.rule.credential.ts
diff --git a/src/domain/in-app-notification-reader/dto/in.app.notification.community.new.member.ts b/src/domain/in-app-notification-reader/dto/in.app.notification.community.new.member.ts
@@ -2,12 +2,10 @@ import { ObjectType } from '@nestjs/graphql';
 import {
   InAppNotificationCommunityNewMemberPayload,
   NotificationEventType,
-  InAppNotificationCategory,
 } from '@alkemio/notifications-lib';
 import { IContributor } from '@domain/community/contributor/contributor.interface';
 import { CommunityContributorType } from '@common/enums/community.contributor.type';
 import { ISpace } from '@domain/space/space/space.interface';
-import { InAppNotificationState } from '@domain/in-app-notification/in.app.notification.state';
 import { InAppNotification } from '../in.app.notification.interface';
 import { InAppNotificationBase } from '@domain/in-app-notification-reader/dto/in.app.notification.base';
 

diff --git a/src/domain/in-app-notification-reader/dto/in.app.notification.user.mentioned.ts b/src/domain/in-app-notification-reader/dto/in.app.notification.user.mentioned.ts
@@ -2,12 +2,9 @@ import { ObjectType } from '@nestjs/graphql';
 import {
   InAppNotificationContributorMentionedPayload,
   NotificationEventType,
-  InAppNotificationCategory,
 } from '@alkemio/notifications-lib';
 import { CommunityContributorType } from '@common/enums/community.contributor.type';
-import { IContributor } from '@domain/community/contributor/contributor.interface';
 import { InAppNotification } from '../in.app.notification.interface';
-import { InAppNotificationState } from '@domain/in-app-notification/in.app.notification.state';
 import { InAppNotificationBase } from '@domain/in-app-notification-reader/dto/in.app.notification.base';
 
 @ObjectType('InAppNotificationUserMentioned', {

diff --git a/src/domain/space/account.host/account.host.module.ts b/src/domain/space/account.host/account.host.module.ts
@@ -1,12 +1,12 @@
 import { Module } from '@nestjs/common';
 import { AccountHostService } from './account.host.service';
 import { AgentModule } from '@domain/agent/agent/agent.module';
-import { LicenseIssuerModule } from '@platform/license-issuer/license.issuer.module';
+import { LicenseIssuerModule } from '@platform/licensing/credential-based/license-credential-issuer/license.issuer.module';
 import { StorageAggregatorModule } from '@domain/storage/storage-aggregator/storage.aggregator.module';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { Account } from '../account/account.entity';
 import { LicenseModule } from '@domain/common/license/license.module';
-import { LicensingFrameworkModule } from '@platform/licensing-framework/licensing.framework.module';
+import { LicensingFrameworkModule } from '@platform/licensing/credential-based/licensing-framework/licensing.framework.module';
 
 @Module({
   imports: [

diff --git a/src/domain/space/account.host/account.host.service.ts b/src/domain/space/account.host/account.host.service.ts
@@ -12,8 +12,8 @@ import { ICredentialDefinition } from '@domain/agent/credential/credential.defin
 import { User } from '@domain/community/user/user.entity';
 import { Organization } from '@domain/community/organization';
 import { AgentService } from '@domain/agent/agent/agent.service';
-import { ILicensePlan } from '@platform/license-plan/license.plan.interface';
-import { LicenseIssuerService } from '@platform/license-issuer/license.issuer.service';
+import { ILicensePlan } from '@platform/licensing/credential-based/license-plan/license.plan.interface';
+import { LicenseIssuerService } from '@platform/licensing/credential-based/license-credential-issuer/license.issuer.service';
 import { Account } from '../account/account.entity';
 import { AuthorizationPolicy } from '@domain/common/authorization-policy/authorization.policy.entity';
 import { StorageAggregatorService } from '@domain/storage/storage-aggregator/storage.aggregator.service';
@@ -28,7 +28,7 @@ import { LicenseService } from '@domain/common/license/license.service';
 import { LicenseType } from '@common/enums/license.type';
 import { LicenseEntitlementType } from '@common/enums/license.entitlement.type';
 import { LicenseEntitlementDataType } from '@common/enums/license.entitlement.data.type';
-import { LicensingFrameworkService } from '@platform/licensing-framework/licensing.framework.service';
+import { LicensingFrameworkService } from '@platform/licensing/credential-based/licensing-framework/licensing.framework.service';
 
 @Injectable()
 export class AccountHostService {

diff --git a/src/domain/space/account/account.license.subscription.interface.ts b/src/domain/space/account/account.license.subscription.interface.ts
@@ -1,12 +1,12 @@
-import { LicenseCredential } from '@common/enums/license.credential';
+import { LicensingCredentialBasedCredentialType } from '@common/enums/licensing.credential.based.credential.type';
 import { Field, ObjectType } from '@nestjs/graphql';
 
 @ObjectType('AccountSubscription')
 export abstract class IAccountSubscription {
-  @Field(() => LicenseCredential, {
+  @Field(() => LicensingCredentialBasedCredentialType, {
     description: 'The name of the Subscription.',
   })
-  name!: LicenseCredential;
+  name!: LicensingCredentialBasedCredentialType;
 
   @Field(() => Date, {
     nullable: true,

diff --git a/src/domain/space/account/account.module.ts b/src/domain/space/account/account.module.ts
@@ -14,9 +14,9 @@ import { NameReporterModule } from '@services/external/elasticsearch/name-report
 import { AccountResolverQueries } from './account.resolver.queries';
 import { ContributorModule } from '@domain/community/contributor/contributor.module';
 import { VirtualContributorModule } from '@domain/community/virtual-contributor/virtual.contributor.module';
-import { LicenseIssuerModule } from '@platform/license-issuer/license.issuer.module';
+import { LicenseIssuerModule } from '@platform/licensing/credential-based/license-credential-issuer/license.issuer.module';
 import { AccountHostModule } from '../account.host/account.host.module';
-import { LicenseEngineModule } from '@core/license-engine/license.engine.module';
+import { LicensingCredentialBasedModule } from '@platform/licensing/credential-based/licensing-credential-based-entitlements-engine/licensing.credential.based.module';
 import { StorageAggregatorModule } from '@domain/storage/storage-aggregator/storage.aggregator.module';
 import { NotificationAdapterModule } from '@services/adapters/notification-adapter/notification.adapter.module';
 import { InnovationHubModule } from '@domain/innovation-hub/innovation.hub.module';
@@ -25,7 +25,7 @@ import { NamingModule } from '@services/infrastructure/naming/naming.module';
 import { TemporaryStorageModule } from '@services/infrastructure/temporary-storage/temporary.storage.module';
 import { LicenseModule } from '@domain/common/license/license.module';
 import { AccountLicenseService } from './account.service.license';
-import { LicensingFrameworkModule } from '@platform/licensing-framework/licensing.framework.module';
+import { LicensingFrameworkModule } from '@platform/licensing/credential-based/licensing-framework/licensing.framework.module';
 
 @Module({
   imports: [
@@ -39,7 +39,7 @@ import { LicensingFrameworkModule } from '@platform/licensing-framework/licensin
     PlatformAuthorizationPolicyModule,
     LicensingFrameworkModule,
     LicenseIssuerModule,
-    LicenseEngineModule,
+    LicensingCredentialBasedModule,
     LicenseModule,
     SpaceModule,
     InnovationHubModule,

diff --git a/src/domain/space/account/account.service.license.ts b/src/domain/space/account/account.service.license.ts
@@ -8,7 +8,7 @@ import {
 import { IAgent } from '@domain/agent/agent/agent.interface';
 import { LicenseService } from '@domain/common/license/license.service';
 import { ILicense } from '@domain/common/license/license.interface';
-import { LicenseEngineService } from '@core/license-engine/license.engine.service';
+import { LicensingCredentialBasedService } from '@platform/licensing/credential-based/licensing-credential-based-entitlements-engine/licensing.credential.based.service';
 import { LicenseEntitlementType } from '@common/enums/license.entitlement.type';
 import { IAccount } from './account.interface';
 import { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';
@@ -19,7 +19,7 @@ export class AccountLicenseService {
   constructor(
     private licenseService: LicenseService,
     private accountService: AccountService,
-    private licenseEngineService: LicenseEngineService,
+    private licenseEngineService: LicensingCredentialBasedService,
     private spaceLicenseService: SpaceLicenseService,
     @Inject(WINSTON_MODULE_NEST_PROVIDER) private readonly logger: LoggerService
   ) {}

diff --git a/src/domain/space/account/account.service.ts b/src/domain/space/account/account.service.ts
@@ -35,7 +35,7 @@ import { AuthorizationPolicyService } from '@domain/common/authorization-policy/
 import { AccountHostService } from '../account.host/account.host.service';
 import { IAgent } from '@domain/agent/agent/agent.interface';
 import { IAccountSubscription } from './account.license.subscription.interface';
-import { LicenseCredential } from '@common/enums/license.credential';
+import { LicensingCredentialBasedCredentialType } from '@common/enums/licensing.credential.based.credential.type';
 import { LicenseService } from '@domain/common/license/license.service';
 
 @Injectable()
@@ -367,12 +367,12 @@ export class AccountService {
     const subscriptions: IAccountSubscription[] = [];
     for (const credential of account.agent.credentials) {
       if (
-        Object.values(LicenseCredential).includes(
-          credential.type as LicenseCredential
+        Object.values(LicensingCredentialBasedCredentialType).includes(
+          credential.type as LicensingCredentialBasedCredentialType
         )
       ) {
         subscriptions.push({
-          name: credential.type as LicenseCredential,
+          name: credential.type as LicensingCredentialBasedCredentialType,
           expires: credential.expires,
         });
       }

diff --git a/src/domain/space/space/space.license.subscription.interface.ts b/src/domain/space/space/space.license.subscription.interface.ts
@@ -1,12 +1,12 @@
-import { LicenseCredential } from '@common/enums/license.credential';
+import { LicensingCredentialBasedCredentialType } from '@common/enums/licensing.credential.based.credential.type';
 import { Field, ObjectType } from '@nestjs/graphql';
 
 @ObjectType('SpaceSubscription')
 export abstract class ISpaceSubscription {
-  @Field(() => LicenseCredential, {
+  @Field(() => LicensingCredentialBasedCredentialType, {
     description: 'The name of the Subscription.',
   })
-  name!: LicenseCredential;
+  name!: LicensingCredentialBasedCredentialType;
 
   @Field(() => Date, {
     nullable: true,

diff --git a/src/domain/space/space/space.module.ts b/src/domain/space/space/space.module.ts
@@ -23,13 +23,13 @@ import { PlatformAuthorizationPolicyModule } from '@platform/authorization/platf
 import { NamingModule } from '@services/infrastructure/naming/naming.module';
 import { SpaceSettingsModule } from '../space.settings/space.settings.module';
 import { AccountHostModule } from '../account.host/account.host.module';
-import { LicenseEngineModule } from '@core/license-engine/license.engine.module';
-import { LicenseIssuerModule } from '@platform/license-issuer/license.issuer.module';
+import { LicensingCredentialBasedModule } from '@platform/licensing/credential-based/licensing-credential-based-entitlements-engine/licensing.credential.based.module';
+import { LicenseIssuerModule } from '@platform/licensing/credential-based/license-credential-issuer/license.issuer.module';
 import { InputCreatorModule } from '@services/api/input-creator/input.creator.module';
 import { RoleSetModule } from '@domain/access/role-set/role.set.module';
 import { TemplatesManagerModule } from '@domain/template/templates-manager/templates.manager.module';
 import { SpaceDefaultsModule } from '../space.defaults/space.defaults.module';
-import { LicensingFrameworkModule } from '@platform/licensing-framework/licensing.framework.module';
+import { LicensingFrameworkModule } from '@platform/licensing/credential-based/licensing-framework/licensing.framework.module';
 import { LicenseModule } from '@domain/common/license/license.module';
 import { SpaceLicenseService } from './space.service.license';
 
@@ -44,7 +44,7 @@ import { SpaceLicenseService } from './space.service.license';
     ProfileModule,
     LicensingFrameworkModule,
     LicenseIssuerModule,
-    LicenseEngineModule,
+    LicensingCredentialBasedModule,
     NamingModule,
     PlatformAuthorizationPolicyModule,
     TemplatesManagerModule,

diff --git a/src/domain/space/space/space.service.license.ts b/src/domain/space/space/space.service.license.ts
@@ -7,7 +7,7 @@ import {
 import { IAgent } from '@domain/agent/agent/agent.interface';
 import { LicenseService } from '@domain/common/license/license.service';
 import { ILicense } from '@domain/common/license/license.interface';
-import { LicenseEngineService } from '@core/license-engine/license.engine.service';
+import { LicensingCredentialBasedService } from '@platform/licensing/credential-based/licensing-credential-based-entitlements-engine/licensing.credential.based.service';
 import { LicenseEntitlementType } from '@common/enums/license.entitlement.type';
 import { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';
 import { SpaceService } from './space.service';
@@ -19,7 +19,7 @@ export class SpaceLicenseService {
   constructor(
     private licenseService: LicenseService,
     private spaceService: SpaceService,
-    private licenseEngineService: LicenseEngineService,
+    private licenseEngineService: LicensingCredentialBasedService,
     private roleSetLicenseService: RoleSetLicenseService,
     private collaborationLicenseService: CollaborationLicenseService,
     @Inject(WINSTON_MODULE_NEST_PROVIDER) private readonly logger: LoggerService