indexation directory elements (#114)

Signed-off-by: Ghazwa REHILI <[email protected]>

Author: ghazwarhili

pom.xml

@@ -42,6 +42,7 @@
 
     <properties>
         <powsybl-ws-dependencies.version>2.7.0</powsybl-ws-dependencies.version>
+        <testcontainers.version>1.18.3</testcontainers.version>
         <liquibase-hibernate-package>org.gridsuite.directory.server</liquibase-hibernate-package>
         <to-string-verifier-version>1.4.8</to-string-verifier-version>
         <native-buildtools.version>0.10.0</native-buildtools.version>
@@ -172,6 +173,12 @@
                 <version>${to-string-verifier-version}</version>
                 <scope>test</scope>
             </dependency>
+            <dependency>
+                <groupId>org.testcontainers</groupId>
+                <artifactId>elasticsearch</artifactId>
+                <version>${testcontainers.version}</version>
+                <scope>test</scope>
+            </dependency>
         </dependencies>
     </dependencyManagement>
 
@@ -208,6 +215,12 @@
             <artifactId>spring-boot-starter-data-jpa</artifactId>
         </dependency>
 
+        <!-- elasticsearch -->
+        <dependency>
+            <groupId>org.springframework.data</groupId>
+            <artifactId>spring-data-elasticsearch</artifactId>
+        </dependency>
+
         <!-- Runtime dependencies -->
         <dependency>
             <groupId>com.powsybl</groupId>
@@ -260,6 +273,11 @@
             <artifactId>h2</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.testcontainers</groupId>
+            <artifactId>elasticsearch</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>com.powsybl</groupId>
             <artifactId>powsybl-config-test</artifactId>

src/main/java/org/gridsuite/directory/server/DirectoryController.java

@@ -13,6 +13,7 @@
 import io.swagger.v3.oas.annotations.tags.Tag;
 import org.gridsuite.directory.server.dto.ElementAttributes;
 import org.gridsuite.directory.server.dto.RootDirectoryAttributes;
+import org.gridsuite.directory.server.services.DirectoryRepositoryService;
 import org.springframework.data.util.Pair;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
@@ -33,8 +34,11 @@ public class DirectoryController {
 
     private final DirectoryService service;
 
-    public DirectoryController(DirectoryService service) {
+    private final DirectoryRepositoryService repositoryService;
+
+    public DirectoryController(DirectoryService service, DirectoryRepositoryService repositoryService) {
         this.service = service;
+        this.repositoryService = repositoryService;
     }
 
     @PostMapping(value = "/root-directories", consumes = MediaType.APPLICATION_JSON_VALUE)
@@ -247,7 +251,15 @@ public ResponseEntity<Void> notify(@PathVariable("elementUuid") UUID elementUuid
     public ResponseEntity<Void> elementExists(@PathVariable("directoryUuid") UUID directoryUuid,
                                                     @PathVariable("elementName") String elementName,
                                                     @PathVariable("type") String type) {
-        HttpStatus status = service.elementExists(directoryUuid, elementName, type) ? HttpStatus.OK : HttpStatus.NO_CONTENT;
+        HttpStatus status = repositoryService.isElementExists(directoryUuid, elementName, type) ? HttpStatus.OK : HttpStatus.NO_CONTENT;
         return ResponseEntity.status(status).contentType(MediaType.APPLICATION_JSON).build();
     }
+
+    @PostMapping(value = "/elements/reindex-all")
+    @Operation(summary = "reindex the element")
+    @ApiResponse(responseCode = "200", description = "Elements reindexed")
+    public ResponseEntity<Void> reindexAllElements() {
+        service.reindexAllElements();
+        return ResponseEntity.ok().build();
+    }
 }

src/main/java/org/gridsuite/directory/server/DirectoryService.java

@@ -0,0 +1,59 @@
+/*
+  Copyright (c) 2024, RTE (http://www.rte-france.com)
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package org.gridsuite.directory.server.dto.elasticsearch;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.*;
+import lombok.experimental.SuperBuilder;
+import org.springframework.data.annotation.Id;
+import org.springframework.data.annotation.TypeAlias;
+import org.springframework.data.elasticsearch.annotations.*;
+
+import java.time.LocalDateTime;
+import java.util.UUID;
+
+/**
+ * @author Ghazwa Rehili <ghazwa.rehili at rte-france.com>
+ */
+@SuperBuilder
+@NoArgsConstructor
+@Setter
+@Getter
+@ToString
+@EqualsAndHashCode
+@Schema(description = "Directory element infos")
+@Document(indexName = "#{@environment.getProperty('powsybl-ws.elasticsearch.index.prefix')}directory-elements")
+@Setting(settingPath = "elasticsearch_settings.json")
+@TypeAlias(value = "DirectoryElementInfos")
+public class DirectoryElementInfos {
+    @Id
+    private UUID id;
+
+    @MultiField(
+            mainField = @Field(name = "name", type = FieldType.Text),
+            otherFields = {
+                @InnerField(suffix = "fullascii", type = FieldType.Keyword, normalizer = "fullascii"),
+                @InnerField(suffix = "raw", type = FieldType.Keyword)
+            }
+            )
+    private String name;
+
+    private UUID parentId;
+
+    private String type;
+
+    private String owner;
+
+    @Field(type = FieldType.Long)
+    private long subdirectoriesCount;
+
+    @Field(type = FieldType.Date, format = DateFormat.date_hour_minute_second_millis)
+    LocalDateTime lastModificationDate;
+
+    @Field(type = FieldType.Boolean)
+    private Boolean isPrivate;
+}

src/main/java/org/gridsuite/directory/server/dto/elasticsearch/DirectoryElementInfos.java

@@ -0,0 +1,18 @@
+/*
+  Copyright (c) 2024, RTE (http://www.rte-france.com)
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package org.gridsuite.directory.server.elasticsearch;
+
+import org.gridsuite.directory.server.dto.elasticsearch.DirectoryElementInfos;
+import org.springframework.data.elasticsearch.repository.ElasticsearchRepository;
+
+import java.util.UUID;
+
+/**
+ * @author Ghazwa Rehili <ghazwa.rehili at rte-france.com>
+ */
+public interface DirectoryElementInfosRepository extends ElasticsearchRepository<DirectoryElementInfos, UUID> {
+}

src/main/java/org/gridsuite/directory/server/elasticsearch/DirectoryElementInfosRepository.java

@@ -0,0 +1,57 @@
+/*
+  Copyright (c) 2024, RTE (http://www.rte-france.com)
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package org.gridsuite.directory.server.elasticsearch;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.elasticsearch.client.ClientConfiguration;
+import org.springframework.data.elasticsearch.client.elc.ElasticsearchConfiguration;
+import org.springframework.data.elasticsearch.repository.config.EnableElasticsearchRepositories;
+
+import javax.annotation.Nonnull;
+import java.util.Optional;
+
+/**
+ * @author Ghazwa Rehili <ghazwa.rehili at rte-france.com>
+ */
+@Configuration
+@EnableElasticsearchRepositories
+public class ESConfig extends ElasticsearchConfiguration {
+
+    @Value("#{'${spring.data.elasticsearch.embedded:false}' ? 'localhost' : '${spring.data.elasticsearch.host}'}")
+    private String esHost;
+
+    @Value("#{'${spring.data.elasticsearch.embedded:false}' ? '${spring.data.elasticsearch.embedded.port:}' : '${spring.data.elasticsearch.port}'}")
+    private int esPort;
+
+    @Value("${spring.data.elasticsearch.client.timeout:60}")
+    int timeout;
+
+    @Value("${spring.data.elasticsearch.username:#{null}}")
+    private Optional<String> username;
+
+    @Value("${spring.data.elasticsearch.password:#{null}}")
+    private Optional<String> password;
+
+    //It should work without having to specify the bean name but it doesn't. To investigate.
+    @Bean(name = "elasticsearchClientConfiguration")
+    @Override
+    @SuppressWarnings("squid:S2095")
+    @Nonnull
+    public ClientConfiguration clientConfiguration() {
+        var clientConfiguration = ClientConfiguration.builder()
+                .connectedTo(esHost + ":" + esPort)
+                .withConnectTimeout(timeout * 1000L).withSocketTimeout(timeout * 1000L);
+
+        if (username.isPresent() && password.isPresent()) {
+            clientConfiguration.withBasicAuth(username.get(), password.get());
+        }
+
+        return clientConfiguration.build();
+    }
+}

src/main/java/org/gridsuite/directory/server/elasticsearch/ESConfig.java

@@ -11,6 +11,8 @@
 import org.gridsuite.directory.server.dto.ElementAttributes;
 
 import jakarta.persistence.*;
+import org.gridsuite.directory.server.dto.elasticsearch.DirectoryElementInfos;
+
 import java.time.LocalDateTime;
 import java.util.Objects;
 import java.util.UUID;
@@ -102,4 +104,16 @@ public DirectoryElementEntity stashElement(boolean stashed, LocalDateTime stashD
         this.stashed = stashed;
         return this;
     }
+
+    public DirectoryElementInfos toDirectoryElementInfos() {
+        return DirectoryElementInfos.builder()
+                .id(getId())
+                .name(getName())
+                .owner(getOwner())
+                .parentId(getParentId() == null ? getId() : getParentId())
+                .type(getType())
+                .isPrivate(getIsPrivate())
+                .lastModificationDate(getLastModificationDate())
+                .build();
+    }
 }

src/main/java/org/gridsuite/directory/server/repository/DirectoryElementEntity.java

@@ -23,6 +23,8 @@
 @Repository
 public interface DirectoryElementRepository extends JpaRepository<DirectoryElementEntity, UUID> {
 
+    List<DirectoryElementEntity> findAllByStashed(boolean stashed);
+
     List<DirectoryElementEntity> findAllByParentIdAndStashed(UUID parentId, boolean stashed);
 
     List<DirectoryElementEntity> findAllByIdInAndStashed(List<UUID> uuids, boolean stashed);
@@ -50,10 +52,6 @@ public interface DirectoryElementRepository extends JpaRepository<DirectoryEleme
 
     boolean existsByIdAndOwnerOrIsPrivateAndId(UUID id, String owner, boolean isPrivate, UUID id2);
 
-    default boolean canRead(UUID id, String userId) {
-        return existsByIdAndOwnerOrIsPrivateAndId(id, userId, false, id);
-    }
-
     interface SubDirectoryCount {
         UUID getId();