feat(open-api): get authorized apps

CHANGES.md

@@ -47,6 +47,7 @@ Apollo 1.9.0
 * [add More... link for known users](https://github.com/ctripcorp/apollo/pull/3757)
 * [update OIDC documentation](https://github.com/ctripcorp/apollo/pull/3766)
 * [feature: add Spring Boot 2.4 config data loader support](https://github.com/ctripcorp/apollo/pull/3754)
+* [feat(open-api): get authorized apps](https://github.com/ctripcorp/apollo/pull/3647)
 ------------------
 All issues and pull requests are [here](https://github.com/ctripcorp/apollo/milestone/6?closed=1)
 

apollo-openapi/src/main/java/com/ctrip/framework/apollo/openapi/client/ApolloOpenApiClient.java

@@ -87,6 +87,15 @@ public List<OpenAppDTO> getAllApps() {
     return appService.getAppsInfo(null);
   }
 
+  /**
+   * Get applications which can be operated by current open api client.
+   *
+   * @return app's information
+   */
+  public List<OpenAppDTO> getAuthorizedApps() {
+    return this.appService.getAuthorizedApps();
+  }
+
   /**
    * Get App information by app ids
    */

apollo-openapi/src/main/java/com/ctrip/framework/apollo/openapi/client/service/AppOpenApiService.java

@@ -63,4 +63,13 @@ public List<OpenAppDTO> getAppsInfo(List<String> appIds) {
       throw new RuntimeException(String.format("Load app information for appIds: %s failed", appIds), ex);
     }
   }
+
+  public List<OpenAppDTO> getAuthorizedApps() {
+    String path = "apps/authorized";
+    try(CloseableHttpResponse response = this.get(path)) {
+      return gson.fromJson(EntityUtils.toString(response.getEntity()), OPEN_APP_DTO_LIST_TYPE);
+    } catch (Throwable ex) {
+      throw new RuntimeException("Load authorized apps failed", ex);
+    }
+  }
 }

apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/service/ConsumerService.java

@@ -28,6 +28,7 @@
 import com.ctrip.framework.apollo.portal.component.config.PortalConfig;
 import com.ctrip.framework.apollo.portal.entity.bo.UserInfo;
 import com.ctrip.framework.apollo.portal.entity.po.Role;
+import com.ctrip.framework.apollo.portal.repository.RoleRepository;
 import com.ctrip.framework.apollo.portal.service.RolePermissionService;
 import com.ctrip.framework.apollo.portal.spi.UserInfoHolder;
 import com.ctrip.framework.apollo.portal.spi.UserService;
@@ -37,6 +38,9 @@
 import com.google.common.base.Preconditions;
 import com.google.common.base.Strings;
 import com.google.common.hash.Hashing;
+import java.util.HashSet;
+import java.util.Set;
+import java.util.stream.Collectors;
 import org.apache.commons.lang.time.FastDateFormat;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
@@ -62,6 +66,7 @@ public class ConsumerService {
   private final PortalConfig portalConfig;
   private final RolePermissionService rolePermissionService;
   private final UserService userService;
+  private final RoleRepository roleRepository;
 
   public ConsumerService(
       final UserInfoHolder userInfoHolder,
@@ -71,7 +76,8 @@ public ConsumerService(
       final ConsumerRoleRepository consumerRoleRepository,
       final PortalConfig portalConfig,
       final RolePermissionService rolePermissionService,
-      final UserService userService) {
+      final UserService userService,
+      final RoleRepository roleRepository) {
     this.userInfoHolder = userInfoHolder;
     this.consumerTokenRepository = consumerTokenRepository;
     this.consumerRepository = consumerRepository;
@@ -80,6 +86,7 @@ public ConsumerService(
     this.portalConfig = portalConfig;
     this.rolePermissionService = rolePermissionService;
     this.userService = userService;
+    this.roleRepository = roleRepository;
   }
 
 
@@ -257,4 +264,33 @@ ConsumerRole createConsumerRole(Long consumerId, Long roleId, String operator) {
     return consumerRole;
   }
 
+  public Set<String> findAppIdsAuthorizedByConsumerId(long consumerId) {
+    List<ConsumerRole> consumerRoles = this.findConsumerRolesByConsumerId(consumerId);
+    List<Long> roleIds = consumerRoles.stream().map(ConsumerRole::getRoleId)
+        .collect(Collectors.toList());
+
+    Set<String> appIds = this.findAppIdsByRoleIds(roleIds);
+    return appIds;
+  }
+
+  private List<ConsumerRole> findConsumerRolesByConsumerId(long consumerId) {
+    List<ConsumerRole> consumerRoles = this.consumerRoleRepository.findByConsumerId(consumerId);
+    return consumerRoles;
+  }
+
+  private Set<String> findAppIdsByRoleIds(List<Long> roleIds) {
+    Iterable<Role> roleIterable = this.roleRepository.findAllById(roleIds);
+
+    Set<String> appIds = new HashSet<>();
+
+    roleIterable.forEach(role -> {
+      if (!role.isDeleted()) {
+        String roleName = role.getRoleName();
+        String appId = RoleUtils.extractAppIdFromRoleName(roleName);
+        appIds.add(appId);
+      }
+    });
+
+    return appIds;
+  }
 }

apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/v1/controller/AppController.java

@@ -19,6 +19,9 @@
 import com.ctrip.framework.apollo.common.dto.ClusterDTO;
 import com.ctrip.framework.apollo.common.entity.App;
 import com.ctrip.framework.apollo.common.utils.BeanUtils;
+import com.ctrip.framework.apollo.openapi.entity.ConsumerRole;
+import com.ctrip.framework.apollo.openapi.service.ConsumerService;
+import com.ctrip.framework.apollo.openapi.util.ConsumerAuthUtil;
 import com.ctrip.framework.apollo.portal.environment.Env;
 import com.ctrip.framework.apollo.openapi.dto.OpenAppDTO;
 import com.ctrip.framework.apollo.openapi.dto.OpenEnvClusterDTO;
@@ -27,6 +30,8 @@
 import com.ctrip.framework.apollo.portal.service.AppService;
 import com.ctrip.framework.apollo.portal.service.ClusterService;
 import com.google.common.collect.Sets;
+import java.util.Set;
+import javax.servlet.http.HttpServletRequest;
 import org.springframework.util.StringUtils;
 import org.springframework.web.bind.annotation.*;
 
@@ -41,13 +46,19 @@ public class AppController {
   private final PortalSettings portalSettings;
   private final ClusterService clusterService;
   private final AppService appService;
+  private final ConsumerAuthUtil consumerAuthUtil;
+  private final ConsumerService consumerService;
 
   public AppController(final PortalSettings portalSettings,
-                       final ClusterService clusterService,
-                       final AppService appService) {
+      final ClusterService clusterService,
+      final AppService appService,
+      final ConsumerAuthUtil consumerAuthUtil,
+      final ConsumerService consumerService) {
     this.portalSettings = portalSettings;
     this.clusterService = clusterService;
     this.appService = appService;
+    this.consumerAuthUtil = consumerAuthUtil;
+    this.consumerService = consumerService;
   }
 
   @GetMapping(value = "/apps/{appId}/envclusters")
@@ -80,4 +91,19 @@ public List<OpenAppDTO> findApps(@RequestParam(value = "appIds", required = fals
     }
     return OpenApiBeanUtils.transformFromApps(apps);
   }
+
+  /**
+   * @return which apps can be operated by open api
+   */
+  @GetMapping("/apps/authorized")
+  public List<OpenAppDTO> findAppsAuthorized(HttpServletRequest request) {
+    long consumerId = this.consumerAuthUtil.retrieveConsumerId(request);
+
+    Set<String> appIds = this.consumerService.findAppIdsAuthorizedByConsumerId(consumerId);
+
+    List<App> apps = this.appService.findByAppIds(appIds);
+    List<OpenAppDTO> openAppDTOS = OpenApiBeanUtils.transformFromApps(apps);
+    return openAppDTOS;
+  }
+
 }

apollo-portal/src/test/java/com/ctrip/framework/apollo/openapi/service/ConsumerServiceIntegrationTest.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2021 Apollo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package com.ctrip.framework.apollo.openapi.service;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+
+import com.ctrip.framework.apollo.portal.AbstractIntegrationTest;
+import com.google.common.collect.Sets;
+import java.util.Set;
+import org.junit.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.test.context.jdbc.Sql;
+
+/**
+ * @author wxq
+ */
+public class ConsumerServiceIntegrationTest extends AbstractIntegrationTest {
+
+  @Autowired
+  private ConsumerService consumerService;
+
+  @Test
+  @Sql(scripts = "/sql/openapi/ConsumerServiceIntegrationTest.testFindAppIdsAuthorizedByConsumerId.sql", executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD)
+  @Sql(scripts = "/sql/cleanup.sql", executionPhase = Sql.ExecutionPhase.AFTER_TEST_METHOD)
+  public void testFindAppIdsAuthorizedByConsumerId() {
+    Set<String> appIds = this.consumerService.findAppIdsAuthorizedByConsumerId(1000L);
+    assertEquals(Sets.newHashSet("consumer-test-app-id-0", "consumer-test-app-id-1"), appIds);
+    assertFalse(appIds.contains("consumer-test-app-id-2"));
+  }
+}

apollo-portal/src/test/java/com/ctrip/framework/apollo/openapi/v1/controller/AppControllerIntegrationTest.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright 2021 Apollo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package com.ctrip.framework.apollo.openapi.v1.controller;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import com.ctrip.framework.apollo.openapi.dto.OpenAppDTO;
+import com.ctrip.framework.apollo.portal.AbstractIntegrationTest;
+import java.util.HashSet;
+import java.util.Set;
+import org.junit.Test;
+import org.springframework.http.HttpEntity;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpMethod;
+import org.springframework.http.ResponseEntity;
+import org.springframework.test.context.jdbc.Sql;
+
+/**
+ * Integration test for {@link AppController}.
+ *
+ * @author wxq
+ */
+public class AppControllerIntegrationTest extends AbstractIntegrationTest {
+
+  @Test
+  @Sql(scripts = "/sql/openapi/ConsumerServiceIntegrationTest.testFindAppIdsAuthorizedByConsumerId.sql", executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD)
+  @Sql(scripts = "/sql/cleanup.sql", executionPhase = Sql.ExecutionPhase.AFTER_TEST_METHOD)
+  public void testFindAppsAuthorized() {
+    final String token = "3c16bf5b1f44b465179253442460e8c0ad845289";
+    HttpHeaders httpHeaders = new HttpHeaders();
+    httpHeaders.set(HttpHeaders.AUTHORIZATION, token);
+
+    ResponseEntity<OpenAppDTO[]> responseEntity =
+        restTemplate.exchange(this.url("/openapi/v1/apps/authorized"), HttpMethod.GET,
+            new HttpEntity<>(httpHeaders), OpenAppDTO[].class);
+
+    OpenAppDTO[] openAppDTOS = responseEntity.getBody();
+    assertEquals(2, openAppDTOS.length);
+
+    Set<String> appIds = new HashSet<>();
+    for (OpenAppDTO openAppDTO : openAppDTOS) {
+      appIds.add(openAppDTO.getAppId());
+    }
+
+    assertTrue(appIds.contains("consumer-test-app-id-0"));
+    assertTrue(appIds.contains("consumer-test-app-id-1"));
+  }
+}