change /system/pathdesc API endpoint to accept JSON

fixes #3374

Author: Vladimir Kotal

apiary.apib

@@ -258,20 +258,19 @@ see https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html#parse-java
 ### updates path descriptions for web application [POST]
 
 This will refresh the path descriptions. The web application will store
-the descriptions in a file so it is not necessary to reload the path
-descriptions after each web application redeploy.
+the descriptions in a file under data root so it is not necessary to load the path
+descriptions manually after each web application redeploy.
 
-The input consists of strings separated by newline. Each string contains
-a path and its description.
+The paths are relative to source root, starting with /.
 
-The paths are relative to source root, starting with /. The path and its
-description is separated by a single tab character.
-
-+ Request (text/plain)
++ Request (application/json)
   + Body
 
-            /foo    bar
-            /foo/foo    bar bar
+            [
+                {"path": "/foo", "description": "foo foo"},
+                {"path": "/bar", "description": "bar"}
+            ]
+
 
 + Response 204
 

opengrok-indexer/src/main/java/org/opengrok/indexer/web/EftarFile.java

@@ -23,15 +23,11 @@
 package org.opengrok.indexer.web;
 
 import java.io.BufferedOutputStream;
-import java.io.BufferedReader;
 import java.io.DataOutputStream;
-import java.io.File;
-import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
-import java.io.FileReader;
 import java.io.IOException;
-import java.io.StringReader;
 import java.util.Map;
+import java.util.Set;
 import java.util.StringTokenizer;
 import java.util.TreeMap;
 
@@ -52,6 +48,7 @@ public class EftarFile {
 
     public static final int RECORD_LENGTH = 14;
     private long offset;
+    private Node root;
 
     class Node {
 
@@ -142,46 +139,28 @@ private void traverse(Node n) {
             traverse(childnode);
         }
     }
-    private Node root;
-
-    public void readInput(File inputFile) throws IOException {
-        try (BufferedReader r = new BufferedReader(new FileReader(inputFile))) {
-            readInput(r);
-        }
-    }
-
-    public void readInput(String input) throws IOException {
-        try (BufferedReader r = new BufferedReader(new StringReader(input))) {
-            readInput(r);
-        }
-    }
 
     /**
      * Reads the input into interim representation. Can be called multiple times.
-     * @param r reader
+     * @param descriptions set of PathDescription
      * @throws IOException
      */
-    private void readInput(BufferedReader r) throws IOException {
+    private void readInput(Set<PathDescription> descriptions) throws IOException {
         if (root == null) {
             root = new Node(1, null);
         }
-        String line;
-        while ((line = r.readLine()) != null) {
-            int tab = line.indexOf('\t');
-            if (tab > 0) {
-                String path = line.substring(0, tab);
-                String desc = line.substring(tab + 1);
-                StringTokenizer toks = new StringTokenizer(path, "\\/");
-                Node n = root;
-                while (toks.hasMoreTokens()) {
-                    n = n.put(myHash(toks.nextToken()), null);
-                }
-                n.tag = desc;
+
+        for (PathDescription desc : descriptions) {
+            StringTokenizer toks = new StringTokenizer(desc.getPath(), "\\/");
+            Node n = root;
+            while (toks.hasMoreTokens()) {
+                n = n.put(myHash(toks.nextToken()), null);
             }
+            n.tag = desc.getDescription();
         }
     }
 
-    public void write(String outPath) throws FileNotFoundException, IOException {
+    public void write(String outPath) throws IOException {
         offset = RECORD_LENGTH;
         traverse(root);
         try (DataOutputStream out = new DataOutputStream(
@@ -195,13 +174,8 @@ public void write(String outPath) throws FileNotFoundException, IOException {
         }
     }
 
-    public void create(File inputFile, String outputPath) throws IOException {
-        readInput(inputFile);
-        write(outputPath);
-    }
-
-    public void create(String input, String outputPath) throws IOException, FileNotFoundException {
-        readInput(input);
+    public void create(Set<PathDescription> descriptions, String outputPath) throws IOException {
+        readInput(descriptions);
         write(outputPath);
     }
 }

opengrok-indexer/src/main/java/org/opengrok/indexer/web/PathDescription.java

@@ -0,0 +1,52 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License (the "License").
+ * You may not use this file except in compliance with the License.
+ *
+ * See LICENSE.txt included in this distribution for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at LICENSE.txt.
+ * If applicable, add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your own identifying
+ * information: Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ */
+
+/*
+ * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
+ */
+package org.opengrok.indexer.web;
+
+public class PathDescription {
+    private String path;
+    private String description;
+
+    PathDescription() { // needed for deserialization
+    }
+
+    public PathDescription(String path, String description) {
+        this.path = path;
+        this.description = description;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public void setDescription(String description) {
+        this.description = description;
+    }
+
+    public String getPath() {
+        return path;
+    }
+
+    public void setPath(String path) {
+        this.path = path;
+    }
+}

opengrok-indexer/src/test/java/org/opengrok/indexer/web/EftarFileTest.java

@@ -23,9 +23,9 @@
 package org.opengrok.indexer.web;
 
 import java.io.File;
-import java.io.FileWriter;
 import java.io.IOException;
-import java.io.PrintWriter;
+import java.util.HashSet;
+import java.util.Set;
 
 import org.junit.After;
 import org.junit.AfterClass;
@@ -40,7 +40,6 @@
  */
 public class EftarFileTest {
 
-    private static File tsv;
     private static File eftar;
 
     public EftarFileTest() {
@@ -50,35 +49,26 @@ public EftarFileTest() {
 
     @BeforeClass
     public static void setUpClass() throws Exception {
-        tsv = File.createTempFile("paths", ".tsv");
+
         eftar = File.createTempFile("paths", ".eftar");
+        int len = 100;
+        Set<PathDescription> descriptions = new HashSet<>();
 
-        try (PrintWriter out = new PrintWriter(new FileWriter(tsv))) {
-            StringBuilder sb = new StringBuilder();
-            for (int ii = 0; ii < 100; ii++) {
-                sb.append(PATH_STRING);
-                sb.append(ii);
-                out.print(sb.toString());
-                out.print("\tDescription ");
-                out.println(ii);
-            }
-            out.flush();
+        StringBuilder sb = new StringBuilder();
+        for (int ii = 0; ii < len; ii++) {
+            sb.append(PATH_STRING);
+            sb.append(ii);
+            descriptions.add(new PathDescription(sb.toString(), "Description " + ii));
         }
 
-        // Create eftar files.
-        String inputFile = tsv.getAbsolutePath();
         String outputFile = eftar.getAbsolutePath();
 
         EftarFile ef = new EftarFile();
-        ef.create(new File(inputFile), outputFile);
+        ef.create(descriptions, outputFile);
     }
 
     @AfterClass
     public static void tearDownClass() throws Exception {
-        if (tsv != null) {
-            tsv.delete();
-        }
-
         if (eftar != null) {
             eftar.delete();
         }
@@ -113,7 +103,7 @@ private void searchEftarFile(EftarFileReader er) throws IOException {
             match.setLength(offset);
             match.append(ii);
 
-            assertEquals(match.toString(), er.get(sb.toString()));
+            assertEquals("description for path " + sb.toString(), match.toString(), er.get(sb.toString()));
         }
         er.close();
     }

opengrok-web/src/main/java/org/opengrok/web/api/v1/controller/SystemController.java

@@ -24,23 +24,31 @@
 
 import org.opengrok.indexer.configuration.RuntimeEnvironment;
 import org.opengrok.indexer.web.EftarFile;
+import org.opengrok.indexer.logger.LoggerFactory;
+import org.opengrok.indexer.web.PathDescription;
 import org.opengrok.web.api.v1.suggester.provider.service.SuggesterService;
 
 import javax.inject.Inject;
+import javax.validation.Valid;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.POST;
 import javax.ws.rs.PUT;
 import javax.ws.rs.Path;
 import javax.ws.rs.core.MediaType;
 import java.io.IOException;
 import java.util.Collections;
+import java.util.Set;
 import java.util.concurrent.CompletableFuture;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 @Path("/system")
 public class SystemController {
 
     private final RuntimeEnvironment env = RuntimeEnvironment.getInstance();
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(SystemController.class);
+
     @Inject
     private SuggesterService suggester;
 
@@ -60,9 +68,10 @@ public void reloadIncludes() {
 
     @POST
     @Path("/pathdesc")
-    @Consumes(MediaType.TEXT_PLAIN)
-    public void loadPathDescriptions(final String input) throws IOException {
+    @Consumes(MediaType.APPLICATION_JSON)
+    public void loadPathDescriptions(@Valid final PathDescription[] descriptions) throws IOException {
         EftarFile ef = new EftarFile();
-        ef.create(input, env.getDtagsEftarPath().toString());
+        ef.create(Set.of(descriptions), env.getDtagsEftarPath().toString());
+        LOGGER.log(Level.INFO, "reloaded path descriptions with {0} entries", descriptions.length);
     }
 }

opengrok-web/src/test/java/org/opengrok/web/api/v1/controller/SystemControllerTest.java

@@ -27,6 +27,7 @@
 import org.opengrok.indexer.configuration.RuntimeEnvironment;
 import org.opengrok.indexer.util.IOUtils;
 import org.opengrok.indexer.web.EftarFileReader;
+import org.opengrok.indexer.web.PathDescription;
 import org.opengrok.web.api.v1.RestApp;
 
 import javax.ws.rs.client.Entity;
@@ -106,31 +107,23 @@ public void testDtagsEftarReload() throws IOException {
 
         // Create path descriptions string.
         StringBuilder sb = new StringBuilder();
-        String[][] descriptions = {
-                {"/path1", "foo foo"},
-                {"/path2", "bar bar"}
+        PathDescription[] descriptions = {
+                new PathDescription("/path1", "foo foo"),
+                new PathDescription("/path2", "bar bar")
         };
 
-        for (String[] description : descriptions) {
-            sb.append(description[0]);
-            sb.append("\t");
-            sb.append(description[1]);
-            sb.append("\n");
-        }
-        String input = sb.toString();
-
         // Reload the contents via API call.
         Response r = target("system")
                 .path("pathdesc")
-                .request().post(Entity.text(input));
+                .request().post(Entity.json(descriptions));
         assertEquals(Response.Status.NO_CONTENT.getStatusCode(), r.getStatus());
 
         // Check
         Path eftarPath = env.getDtagsEftarPath();
         assertTrue(eftarPath.toFile().exists());
         try (EftarFileReader er = new EftarFileReader(eftarPath.toString())) {
-            for (String[] description : descriptions) {
-                assertEquals(description[1], er.get(description[0]));
+            for (PathDescription description : descriptions) {
+                assertEquals(description.getDescription(), er.get(description.getPath()));
             }
         }