Merge pull request #219 from MeasureAuthoringTool/MAT-10219

MAT-10219 namespace registery endpoint

Author: sb-prateekkeerthi

src/main/java/gov/cms/madie/cqllibraryservice/controllers/CqlLibraryController.java

@@ -51,6 +51,7 @@ public class CqlLibraryController {
   private final CqlDifferentiatorService cqlDifferentiatorService;
   private final CqlLibraryLockService cqlLibraryLockService;
   private final AppConfigService appConfigService;
+  private final NamespaceService namespaceService;
 
   @PutMapping("/searches")
   public ResponseEntity<Page<LibraryListDTO>> fetchLibrariesByCriteria(
@@ -77,6 +78,11 @@ public ResponseEntity<List<String>> getAllOwners(
     return ResponseEntity.status(HttpStatus.OK).body(results);
   }
 
+  @GetMapping("/namespaces")
+  public ResponseEntity<List<NamespaceDTO>> getAllNamespaces() {
+    return ResponseEntity.ok(namespaceService.getAllNamespaces());
+  }
+
   @GetMapping("/{id}")
   public ResponseEntity<CqlLibrary> getCqlLibrary(
       @PathVariable("id") String id, Principal principal) {

src/main/java/gov/cms/madie/cqllibraryservice/dto/NamespaceDTO.java

@@ -0,0 +1,16 @@
+package gov.cms.madie.cqllibraryservice.dto;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class NamespaceDTO {
+
+  private String namespaceCanonical;
+  private String namespacePrefix;
+}

src/main/java/gov/cms/madie/cqllibraryservice/repositories/ExternalLibraryRepository.java

@@ -1,8 +1,11 @@
 package gov.cms.madie.cqllibraryservice.repositories;
 
+import gov.cms.madie.cqllibraryservice.dto.NamespaceDTO;
 import gov.cms.madie.cqllibraryservice.models.ExternalLibrary;
+import org.springframework.data.mongodb.repository.Aggregation;
 import org.springframework.data.mongodb.repository.MongoRepository;
 
+import java.util.List;
 import java.util.Optional;
 
 public interface ExternalLibraryRepository extends MongoRepository<ExternalLibrary, String> {
@@ -12,4 +15,20 @@ Optional<ExternalLibrary> findByPackageCanonicalAndLibraryName(
 
   boolean existsByPackageCanonicalAndLibraryNameAndVersion(
       String canonical, String libraryName, String version);
+
+  /**
+   * Returns every distinct {@code (packageCanonical, namespacePrefix)} pair present in the External
+   * Libraries collection, sorted by canonical.
+   */
+  @Aggregation(
+      pipeline = {
+        "{'$match': {'packageCanonical': {'$nin': [null, '']},"
+            + " 'namespacePrefix': {'$nin': [null, '']}}}",
+        "{'$group': {'_id': {'canonical': '$packageCanonical', 'prefix': '$namespacePrefix'}}}",
+        "{'$project': {'_id': 0,"
+            + " 'namespaceCanonical': '$_id.canonical',"
+            + " 'namespacePrefix': '$_id.prefix'}}",
+        "{'$sort': {'namespaceCanonical': 1}}"
+      })
+  List<NamespaceDTO> findDistinctNamespaces();
 }

src/main/java/gov/cms/madie/cqllibraryservice/services/NamespaceService.java

@@ -0,0 +1,23 @@
+package gov.cms.madie.cqllibraryservice.services;
+
+import gov.cms.madie.cqllibraryservice.dto.NamespaceDTO;
+import gov.cms.madie.cqllibraryservice.repositories.ExternalLibraryRepository;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Service;
+
+import java.util.List;
+
+@Slf4j
+@Service
+@RequiredArgsConstructor
+public class NamespaceService {
+
+  private final ExternalLibraryRepository externalLibraryRepository;
+
+  public List<NamespaceDTO> getAllNamespaces() {
+    List<NamespaceDTO> namespaces = externalLibraryRepository.findDistinctNamespaces();
+    log.info("Found [{}] known namespaces", namespaces.size());
+    return namespaces;
+  }
+}

src/test/java/gov/cms/madie/cqllibraryservice/controllers/CqlLibraryControllerMvcTest.java

@@ -86,6 +86,7 @@ public class CqlLibraryControllerMvcTest {
   @MockitoBean ActionLogService actionLogService;
   @MockitoBean private UserServiceClient userServiceClient;
   @MockitoBean private CqlLibraryLockService cqlLibraryLockService;
+  @MockitoBean private NamespaceService namespaceService;
 
   @Captor private ArgumentCaptor<CqlLibrary> cqlLibraryArgumentCaptor;
 
@@ -525,6 +526,30 @@ public void testCreateCqlLibraryReturnsCreatedForUsQualityCoreWhenFlagEnabled()
         .andExpect(jsonPath("$.createdBy").value(TEST_USER_ID));
   }
 
+  @Test
+  public void testGetAllNamespacesReturnsKnownNamespaces() throws Exception {
+    when(namespaceService.getAllNamespaces())
+        .thenReturn(
+            List.of(
+                NamespaceDTO.builder()
+                    .namespaceCanonical("http://hl7.org/fhir/us/qicore")
+                    .namespacePrefix("hl7.fhir.us.qicore")
+                    .build(),
+                NamespaceDTO.builder()
+                    .namespaceCanonical("http://hl7.org/fhir/uv/cqm")
+                    .namespacePrefix("hl7.fhir.uv.cqm")
+                    .build()));
+    mockMvc
+        .perform(get("/cql-libraries/namespaces").with(user(TEST_USER_ID)).with(csrf()))
+        .andExpect(status().isOk())
+        .andExpect(jsonPath("$.length()").value(2))
+        .andExpect(jsonPath("$[0].namespaceCanonical").value("http://hl7.org/fhir/us/qicore"))
+        .andExpect(jsonPath("$[0].namespacePrefix").value("hl7.fhir.us.qicore"))
+        .andExpect(jsonPath("$[1].namespaceCanonical").value("http://hl7.org/fhir/uv/cqm"))
+        .andExpect(jsonPath("$[1].namespacePrefix").value("hl7.fhir.uv.cqm"));
+    verify(namespaceService, times(1)).getAllNamespaces();
+  }
+
   @Test
   public void testGetCqlLibraryReturns404() throws Exception {
     doThrow(new ResourceNotFoundException("CQL Library", "Library1_ID"))

src/test/java/gov/cms/madie/cqllibraryservice/controllers/CqlLibraryControllerTest.java

@@ -15,6 +15,7 @@
 import gov.cms.madie.cqllibraryservice.dto.LibraryListDTO;
 import gov.cms.madie.cqllibraryservice.dto.LibrarySearchCriteria;
 import gov.cms.madie.cqllibraryservice.dto.MadieFeatureFlag;
+import gov.cms.madie.cqllibraryservice.dto.NamespaceDTO;
 import gov.cms.madie.cqllibraryservice.exceptions.BadRequestObjectException;
 import gov.cms.madie.cqllibraryservice.exceptions.InvalidIdException;
 import gov.cms.madie.cqllibraryservice.exceptions.PermissionDeniedException;
@@ -57,6 +58,8 @@ class CqlLibraryControllerTest {
 
   @Mock private AppConfigService appConfigService;
 
+  @Mock private NamespaceService namespaceService;
+
   @Mock Principal principal;
 
   @InjectMocks CqlLibraryController cqlLibraryController;
@@ -404,6 +407,22 @@ public void testGetAllOwners() {
     assertEquals(mockedResponse, result.getBody());
   }
 
+  @Test
+  public void testGetAllNamespaces() {
+    List<NamespaceDTO> mockedResponse =
+        List.of(
+            NamespaceDTO.builder()
+                .namespaceCanonical("http://hl7.org/fhir/us/qicore")
+                .namespacePrefix("hl7.fhir.us.qicore")
+                .build());
+    when(namespaceService.getAllNamespaces()).thenReturn(mockedResponse);
+
+    ResponseEntity<List<NamespaceDTO>> response = cqlLibraryController.getAllNamespaces();
+
+    assertEquals(HttpStatus.OK, response.getStatusCode());
+    assertEquals(mockedResponse, response.getBody());
+  }
+
   @Test
   public void testGetCqlLibraryThrowsExceptionForNotFound() {
     Principal principal = mock(Principal.class);

src/test/java/gov/cms/madie/cqllibraryservice/services/NamespaceServiceTest.java

@@ -0,0 +1,59 @@
+package gov.cms.madie.cqllibraryservice.services;
+
+import gov.cms.madie.cqllibraryservice.dto.NamespaceDTO;
+import gov.cms.madie.cqllibraryservice.repositories.ExternalLibraryRepository;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+
+import java.util.List;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.equalTo;
+import static org.hamcrest.Matchers.is;
+import static org.mockito.Mockito.when;
+
+@ExtendWith(MockitoExtension.class)
+class NamespaceServiceTest {
+
+  @Mock private ExternalLibraryRepository externalLibraryRepository;
+
+  @InjectMocks private NamespaceService namespaceService;
+
+  @Test
+  void testGetAllNamespacesReturnsAllKnownNamespaces() {
+    NamespaceDTO qiCore =
+        NamespaceDTO.builder()
+            .namespaceCanonical("http://hl7.org/fhir/us/qicore")
+            .namespacePrefix("hl7.fhir.us.qicore")
+            .build();
+    NamespaceDTO cqfmScoring =
+        NamespaceDTO.builder()
+            .namespaceCanonical("http://hl7.org/fhir/uv/cqm")
+            .namespacePrefix("hl7.fhir.uv.cqm")
+            .build();
+    when(externalLibraryRepository.findDistinctNamespaces())
+        .thenReturn(List.of(qiCore, cqfmScoring));
+
+    List<NamespaceDTO> namespaces = namespaceService.getAllNamespaces();
+
+    assertThat(namespaces.size(), is(equalTo(2)));
+    assertThat(
+        namespaces.get(0).getNamespaceCanonical(), is(equalTo("http://hl7.org/fhir/us/qicore")));
+    assertThat(namespaces.get(0).getNamespacePrefix(), is(equalTo("hl7.fhir.us.qicore")));
+    assertThat(
+        namespaces.get(1).getNamespaceCanonical(), is(equalTo("http://hl7.org/fhir/uv/cqm")));
+    assertThat(namespaces.get(1).getNamespacePrefix(), is(equalTo("hl7.fhir.uv.cqm")));
+  }
+
+  @Test
+  void testGetAllNamespacesReturnsEmptyListWhenNoExternalLibrariesExist() {
+    when(externalLibraryRepository.findDistinctNamespaces()).thenReturn(List.of());
+
+    List<NamespaceDTO> namespaces = namespaceService.getAllNamespaces();
+
+    assertThat(namespaces.isEmpty(), is(true));
+  }
+}