convert project add API to asynchronous

fixes #3878

Author: vladak

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

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2020, Chris Fraire <[email protected]>.
  */
 package org.opengrok.web.api.v1.controller;
@@ -85,10 +85,22 @@ public class ProjectsController {
 
     @POST
     @Consumes(MediaType.TEXT_PLAIN)
-    public Response addProject(String projectName) {
+    public Response addProject(@Context HttpServletRequest request, String projectNameParam) {
         // Avoid classification as a taint bug.
-        projectName = Laundromat.launderInput(projectName);
+        final String projectName = Laundromat.launderInput(projectNameParam);
+
+        LOGGER.log(Level.INFO, "adding project {0}", projectName);
 
+        return ApiTaskManager.getInstance().submitApiTask(PROJECTS_PATH,
+                new ApiTask(request.getRequestURI(),
+                        () -> {
+                            addProjectWorkHorse(projectName);
+                            return null;
+                        },
+                        Response.Status.CREATED));
+    }
+
+    private void addProjectWorkHorse(String projectName) {
         File srcRoot = env.getSourceRootFile();
         File projDir = new File(srcRoot, projectName);
 
@@ -138,8 +150,6 @@ public Response addProject(String projectName) {
                 map.put(project, repos);
             }
         }
-
-        return Response.status(Response.Status.CREATED).build();
     }
 
     private List<RepositoryInfo> getRepositoriesInDir(final File projDir) {

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

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2022, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2019, 2020, Chris Fraire <[email protected]>.
  */
 package org.opengrok.web.api.v1.controller;
@@ -155,10 +155,11 @@ void testAddInherit() {
         assertTrue(proj.isHandleRenamedFiles());
     }
 
-    private void addProject(final String project) {
-        target("projects")
+    private Response addProject(final String project) {
+        Response response = target("projects")
                 .request()
                 .post(Entity.text(project));
+        return waitForTask(response);
     }
 
     /**
@@ -319,8 +320,7 @@ void testDelete() throws Exception {
         Indexer.getInstance().doIndexerExecution(true, null, null);
 
         for (String proj : projectsToDelete) {
-            Response response = delete(proj);
-            waitForTask(response);
+            deleteProject(proj);
         }
 
         assertEquals(1, env.getProjects().size());
@@ -349,11 +349,12 @@ void testDelete() throws Exception {
         assertEquals(0, group.getProjects().size());
     }
 
-    private Response delete(final String project) {
-        return target("projects")
+    private Response deleteProject(final String project) {
+        Response response = target("projects")
                 .path(project)
                 .request()
                 .delete();
+        return waitForTask(response);
     }
 
     @Test

tools/src/main/python/opengrok_tools/projadm.py

@@ -18,7 +18,7 @@
 # CDDL HEADER END
 
 #
-# Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2018, 2022, Oracle and/or its affiliates. All rights reserved.
 #
 
 """
@@ -164,18 +164,16 @@ def config_refresh(doit, logger, basedir, uri, configmerge, jar_file,
                     install_config(doit, logger, fmerged.name, main_config)
 
 
-def project_add(doit, logger, project, uri, headers=None, timeout=None):
+def project_add(doit, logger, project, uri, headers=None, timeout=None, api_timeout=None):
     """
-    Adds a project to configuration. Works in multiple steps:
-
-      1. add the project to configuration
-      2. refresh on disk configuration
+    Adds a project to configuration.
     """
 
     logger.info("Adding project {}".format(project))
 
     if doit:
-        if add_project(logger, project, uri, headers=headers, timeout=timeout):
+        if add_project(logger, project, uri, headers=headers, timeout=timeout,
+                       api_timeout=api_timeout):
             repos = get_repos(logger, project, uri,
                               headers=headers, timeout=timeout)
             if repos:
@@ -356,7 +354,8 @@ def main():
                     project_add(doit=doit, logger=logger,
                                 project=proj,
                                 uri=uri, headers=headers,
-                                timeout=args.api_timeout)
+                                timeout=args.api_timeout,
+                                api_timeout=args.async_api_timeout)
 
                 config_refresh(doit=doit, logger=logger,
                                basedir=args.base,

tools/src/main/python/opengrok_tools/utils/opengrok.py

@@ -174,10 +174,13 @@ def list_indexed_projects(logger, uri, headers=None, timeout=None):
     return res.json()
 
 
-def add_project(logger, project, uri, headers=None, timeout=None):
+def add_project(logger, project, uri, headers=None, timeout=None, api_timeout=None):
     try:
-        do_api_call('POST', get_uri(uri, 'api', 'v1', 'projects'),
-                    data=project, headers=headers, timeout=timeout)
+        r = do_api_call('POST', get_uri(uri, 'api', 'v1', 'projects'),
+                        data=project, headers=headers, timeout=timeout, api_timeout=api_timeout)
+        if r is None or r.status_code != 201:
+            logger.error(f"could not add project '{project}' in web application")
+            return False
     except Exception as exception:
         logger.error("could not add project '{}' to web application: {}".
                      format(project, exception))