fix: send mail to opted in users for trial instance in MembershipService

https://gravitee.atlassian.net/browse/APIM-4276
gravitee-io · Mar 27, 2024 · 008b59f · 008b59f
1 parent b4c480a
commit 008b59f
Show file tree

Hide file tree

Showing 12 changed files with 90 additions and 6 deletions.
diff --git a/...st-api-service/src/main/java/io/gravitee/rest/api/service/impl/MembershipServiceImpl.java b/...st-api-service/src/main/java/io/gravitee/rest/api/service/impl/MembershipServiceImpl.java
@@ -52,6 +52,8 @@
 import io.gravitee.rest.api.model.common.Pageable;
 import io.gravitee.rest.api.model.common.PageableImpl;
 import io.gravitee.rest.api.model.pagedresult.Metadata;
+import io.gravitee.rest.api.model.parameters.Key;
+import io.gravitee.rest.api.model.parameters.ParameterReferenceType;
 import io.gravitee.rest.api.model.permissions.RoleScope;
 import io.gravitee.rest.api.model.permissions.SystemRole;
 import io.gravitee.rest.api.model.providers.User;
@@ -64,6 +66,7 @@
 import io.gravitee.rest.api.service.GroupService;
 import io.gravitee.rest.api.service.IdentityService;
 import io.gravitee.rest.api.service.MembershipService;
+import io.gravitee.rest.api.service.ParameterService;
 import io.gravitee.rest.api.service.RoleService;
 import io.gravitee.rest.api.service.UserService;
 import io.gravitee.rest.api.service.builder.EmailNotificationBuilder;
@@ -137,6 +140,7 @@ public class MembershipServiceImpl extends AbstractService implements Membership
     private final EventManager eventManager;
 
     private final PrimaryOwnerService primaryOwnerService;
+    private ParameterService parameterService;
 
     public MembershipServiceImpl(
         @Autowired @Lazy IdentityService identityService,
@@ -153,7 +157,8 @@ public MembershipServiceImpl(
         @Autowired @Lazy ApiGroupService apiGroupService,
         @Autowired @Lazy ApiRepository apiRepository,
         @Autowired @Lazy GroupService groupService,
-        @Autowired AuditService auditService
+        @Autowired AuditService auditService,
+        @Autowired ParameterService parameterService
     ) {
         this.identityService = identityService;
         this.userService = userService;
@@ -170,6 +175,7 @@ public MembershipServiceImpl(
         this.apiRepository = apiRepository;
         this.groupService = groupService;
         this.auditService = auditService;
+        this.parameterService = parameterService;
     }
 
     @Override
@@ -319,7 +325,14 @@ private MemberEntity _addRoleToMemberOnReference(
                             reference.getId()
                         );
                         if (emailNotification != null) {
-                            emailService.sendAsyncEmailNotification(executionContext, emailNotification);
+                            final boolean isTrialInstance = parameterService.findAsBoolean(
+                                executionContext,
+                                Key.TRIAL_INSTANCE,
+                                ParameterReferenceType.SYSTEM
+                            );
+                            if (!isTrialInstance || userEntity.optedIn()) {
+                                emailService.sendAsyncEmailNotification(executionContext, emailNotification);
+                            }
                         }
                     }
 

diff --git a/...a/io/gravitee/rest/api/service/impl/MembershipService_AddRoleToMemberOnReferenceTest.java b/...a/io/gravitee/rest/api/service/impl/MembershipService_AddRoleToMemberOnReferenceTest.java
@@ -31,11 +31,14 @@
 import io.gravitee.rest.api.model.MembershipReferenceType;
 import io.gravitee.rest.api.model.RoleEntity;
 import io.gravitee.rest.api.model.UserEntity;
+import io.gravitee.rest.api.model.parameters.Key;
+import io.gravitee.rest.api.model.parameters.ParameterReferenceType;
 import io.gravitee.rest.api.model.permissions.RoleScope;
 import io.gravitee.rest.api.service.AuditService;
 import io.gravitee.rest.api.service.EmailService;
 import io.gravitee.rest.api.service.GroupService;
 import io.gravitee.rest.api.service.MembershipService;
+import io.gravitee.rest.api.service.ParameterService;
 import io.gravitee.rest.api.service.RoleService;
 import io.gravitee.rest.api.service.UserService;
 import io.gravitee.rest.api.service.common.GraviteeContext;
@@ -81,6 +84,9 @@ public class MembershipService_AddRoleToMemberOnReferenceTest {
     @Mock
     private AuditService auditService;
 
+    @Mock
+    private ParameterService parameterService;
+
     @BeforeEach
     public void setUp() throws Exception {
         membershipService =
@@ -99,7 +105,8 @@ public void setUp() throws Exception {
                 null,
                 null,
                 groupService,
-                auditService
+                auditService,
+                parameterService
             );
     }
 
@@ -186,6 +193,7 @@ public void shouldAddPrimaryOwnerApiGroupMembership() throws Exception {
         )
             .thenReturn(Set.of(newMembership), Collections.emptySet());
         when(membershipRepository.create(any())).thenReturn(newMembership);
+        when(parameterService.findAsBoolean(any(), eq(Key.TRIAL_INSTANCE), eq(ParameterReferenceType.SYSTEM))).thenReturn(false);
 
         membershipService.addRoleToMemberOnReference(
             GraviteeContext.getExecutionContext(),
@@ -207,6 +215,59 @@ public void shouldAddPrimaryOwnerApiGroupMembership() throws Exception {
         verify(emailService, times(1)).sendAsyncEmailNotification(eq(GraviteeContext.getExecutionContext()), any());
     }
 
+    @Test
+    public void shouldAddPrimaryOwnerApiGroupMembershipAndNotSendEmailForNonOptedInUserInTrialInstance() throws Exception {
+        RoleEntity role = mock(RoleEntity.class);
+        when(role.getScope()).thenReturn(RoleScope.API);
+        when(role.getName()).thenReturn("PRIMARY_OWNER");
+        when(role.getId()).thenReturn("API_PRIMARY_OWNER");
+        when(roleService.findByScopeAndName(RoleScope.API, "PRIMARY_OWNER", GraviteeContext.getCurrentOrganization()))
+            .thenReturn(Optional.of(role));
+
+        UserEntity userEntity = new UserEntity();
+        userEntity.setId("my name");
+        userEntity.setEmail("me@mail.com");
+        when(userService.findById(GraviteeContext.getExecutionContext(), userEntity.getId())).thenReturn(userEntity);
+
+        Membership newMembership = new Membership();
+        newMembership.setReferenceType(io.gravitee.repository.management.model.MembershipReferenceType.API);
+        newMembership.setRoleId("API_PRIMARY_OWNER");
+        newMembership.setReferenceId(API_ID);
+        newMembership.setMemberId(GROUP_ID);
+        newMembership.setMemberType(io.gravitee.repository.management.model.MembershipMemberType.GROUP);
+        when(groupService.findById(GraviteeContext.getExecutionContext(), GROUP_ID)).thenReturn(mock(GroupEntity.class));
+        when(
+            membershipRepository.findByMemberIdAndMemberTypeAndReferenceTypeAndReferenceId(
+                userEntity.getId(),
+                io.gravitee.repository.management.model.MembershipMemberType.USER,
+                io.gravitee.repository.management.model.MembershipReferenceType.GROUP,
+                GROUP_ID
+            )
+        )
+            .thenReturn(Set.of(newMembership), Collections.emptySet());
+        when(membershipRepository.create(any())).thenReturn(newMembership);
+        when(parameterService.findAsBoolean(any(), eq(Key.TRIAL_INSTANCE), eq(ParameterReferenceType.SYSTEM))).thenReturn(true);
+
+        membershipService.addRoleToMemberOnReference(
+            GraviteeContext.getExecutionContext(),
+            new MembershipService.MembershipReference(MembershipReferenceType.GROUP, GROUP_ID),
+            new MembershipService.MembershipMember("my name", null, MembershipMemberType.USER),
+            new MembershipService.MembershipRole(RoleScope.API, "PRIMARY_OWNER")
+        );
+
+        verify(userService, times(1)).findById(GraviteeContext.getExecutionContext(), userEntity.getId());
+        verify(membershipRepository, times(2))
+            .findByMemberIdAndMemberTypeAndReferenceTypeAndReferenceId(
+                userEntity.getId(),
+                io.gravitee.repository.management.model.MembershipMemberType.USER,
+                io.gravitee.repository.management.model.MembershipReferenceType.GROUP,
+                GROUP_ID
+            );
+        verify(membershipRepository, times(1)).create(any());
+        verify(membershipRepository, never()).update(any());
+        verify(emailService, times(0)).sendAsyncEmailNotification(eq(GraviteeContext.getExecutionContext()), any());
+    }
+
     @Test
     public void shouldDisallowAddUnknownRoleOnApi() throws Exception {
         when(roleService.findByScopeAndName(any(), any(), any())).thenReturn(Optional.empty());

diff --git a/...va/io/gravitee/rest/api/service/impl/MembershipService_CreateNewMembershipForApiTest.java b/...va/io/gravitee/rest/api/service/impl/MembershipService_CreateNewMembershipForApiTest.java
@@ -107,7 +107,8 @@ public void setUp() throws Exception {
                 null,
                 apiRepository,
                 null,
-                auditService
+                auditService,
+                null
             );
 
         mockRole();

diff --git a/...e/src/test/java/io/gravitee/rest/api/service/impl/MembershipService_DeleteMemberTest.java b/...e/src/test/java/io/gravitee/rest/api/service/impl/MembershipService_DeleteMemberTest.java
@@ -81,6 +81,7 @@ public void setUp() throws Exception {
                 null,
                 null,
                 null,
+                null,
                 null
             );
         when(roleService.findByScopeAndName(RoleScope.API, PRIMARY_OWNER.name(), ORG_ID))

diff --git a/...ice/src/test/java/io/gravitee/rest/api/service/impl/MembershipService_EditMemberTest.java b/...ice/src/test/java/io/gravitee/rest/api/service/impl/MembershipService_EditMemberTest.java
@@ -78,6 +78,7 @@ public void setUp() throws Exception {
                 null,
                 null,
                 null,
+                null,
                 null
             );
     }

diff --git a/...test/java/io/gravitee/rest/api/service/impl/MembershipService_FindUserMembershipTest.java b/...test/java/io/gravitee/rest/api/service/impl/MembershipService_FindUserMembershipTest.java
@@ -101,6 +101,7 @@ public void setUp() throws Exception {
                 null,
                 mockApiRepository,
                 mockGroupService,
+                null,
                 null
             );
     }

diff --git a/...st/java/io/gravitee/rest/api/service/impl/MembershipService_GetMemberPermissionsTest.java b/...st/java/io/gravitee/rest/api/service/impl/MembershipService_GetMemberPermissionsTest.java
@@ -98,6 +98,7 @@ public void setUp() throws Exception {
                 null,
                 apiRepository,
                 null,
+                null,
                 null
             );
     }

diff --git a/...ice/src/test/java/io/gravitee/rest/api/service/impl/MembershipService_GetMembersTest.java b/...ice/src/test/java/io/gravitee/rest/api/service/impl/MembershipService_GetMembersTest.java
@@ -81,6 +81,7 @@ public void setUp() throws Exception {
                 null,
                 null,
                 null,
+                null,
                 null
             );
     }

diff --git a/...src/test/java/io/gravitee/rest/api/service/impl/MembershipService_GetMembershipsTest.java b/...src/test/java/io/gravitee/rest/api/service/impl/MembershipService_GetMembershipsTest.java
@@ -68,6 +68,7 @@ public void setUp() throws Exception {
                 null,
                 null,
                 null,
+                null,
                 null
             );
     }

diff --git a/.../src/test/java/io/gravitee/rest/api/service/impl/MembershipService_GetUserMemberTest.java b/.../src/test/java/io/gravitee/rest/api/service/impl/MembershipService_GetUserMemberTest.java
@@ -72,6 +72,7 @@ public void setUp() throws Exception {
                 null,
                 apiRepository,
                 null,
+                null,
                 null
             );
     }

diff --git a/.../test/java/io/gravitee/rest/api/service/impl/MembershipService_TransferOwnershipTest.java b/.../test/java/io/gravitee/rest/api/service/impl/MembershipService_TransferOwnershipTest.java
@@ -114,7 +114,8 @@ public void setUp() throws TechnicalException {
                 apiGroupService,
                 apiRepository,
                 null,
-                auditService
+                auditService,
+                null
             );
         newPrimaryOwnerRole.setId(USER_ROLE_ID);
         newPrimaryOwnerRole.setName(USER_ROLE_NAME);

diff --git a/.../java/io/gravitee/rest/api/service/impl/MembershipService_UpdateMembershipForApiTest.java b/.../java/io/gravitee/rest/api/service/impl/MembershipService_UpdateMembershipForApiTest.java
@@ -101,7 +101,8 @@ public void setUp() throws Exception {
                 null,
                 apiRepository,
                 null,
-                auditService
+                auditService,
+                null
             );
         mockApi();
     }