Merge pull request #2 from mcanoy/last-update-refresh

refresh engagements. last update

Author: mcanoy

src/main/java/com/redhat/labs/lodestar/resource/EngagementResource.java

@@ -46,6 +46,8 @@
 import com.redhat.labs.lodestar.service.ConfigService;
 import com.redhat.labs.lodestar.service.EngagementService;
 import com.redhat.labs.lodestar.util.JWTUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 @RequestScoped
 @Path("/engagements")
@@ -54,6 +56,7 @@
 @SecurityScheme(securitySchemeName = "jwt", type = SecuritySchemeType.HTTP, scheme = "bearer", bearerFormat = "JWT")
 @Tag(name = "Engagements", description = "Base engagement apis")
 public class EngagementResource {
+    private static final Logger LOGGER = LoggerFactory.getLogger(EngagementResource.class);
 
     private static final String ACCEPT_VERSION_1 = "v1";
 
@@ -92,7 +95,6 @@ public Response getAll(@Context UriInfo uriInfo, @BeanParam ListFilterOptions fi
         // create one page with many results for v1
         setDefaultPagingFilterOptions(filterOptions);
 
-        // TODO not implement yet - kinda important
         return engagementService.getEngagementsPaged(filterOptions);
     }
 
@@ -139,6 +141,7 @@ public Response findCustomers(@Context UriInfo uriInfo,
      */
 
     //TODO remove this access
+    @Deprecated
     @GET
     @SecurityRequirement(name = "jwt")
     @Path("/customers/{customerName}/projects/{projectName}")
@@ -149,13 +152,15 @@ public Response findCustomers(@Context UriInfo uriInfo,
     public Response get(@PathParam("customerName") String customerName, @PathParam("projectName") String projectName,
             @BeanParam FilterOptions filterOptions) {
 
+        LOGGER.warn("Deprecated get method used /customers/{}/projects/{}", customerName, projectName);
+
         Engagement engagement = engagementService.getByCustomerAndProjectName(customerName, projectName);
 
         boolean writer = jwtUtils.isAllowedToWriteEngagement(jwt, configService.getPermission(engagement.getType()));
         engagement.setWriteable(writer);
 
         return Response.ok(engagement).header(LAST_UPDATE_HEADER, engagement.getLastUpdate())
-                .header(ACCESS_CONTROL_EXPOSE_HEADER, LAST_UPDATE_HEADER).build();
+                .header(ACCESS_CONTROL_EXPOSE_HEADER, LAST_UPDATE_HEADER).header("deprecated", "use get by uuid").build();
 
     }
 
@@ -187,6 +192,7 @@ public Response get(@PathParam("id") String uuid, @BeanParam FilterOptions filte
      * GET - Queries
      */
 
+    // Not sure if this one is being used currently
     @GET
     @Path("/state/{state}")
     @SecurityRequirement(name = "jwt")
@@ -253,8 +259,6 @@ public Response getUserSummary(@QueryParam("search") String search) {
      * HEAD
      */
 
-
-    //TODO ensure last update is valid here
     @HEAD
     @SecurityRequirement(name = "jwt")
     @Path("/{id}")
@@ -263,7 +267,7 @@ public Response getUserSummary(@QueryParam("search") String search) {
             @APIResponse(responseCode = "200", description = "Engagement resource found and metadata returned in headers") })
     @Operation(summary = "Returns metadata regarding the engagement resource for the given customer and project names.")
     public Response head(@PathParam("id") String uuid) {
-        return activityService.getActivityHead(uuid);
+        return engagementService.getEngagementHead(uuid);
     }
 
     @HEAD
@@ -330,6 +334,8 @@ public Response post(@Valid Engagement engagement, @Context UriInfo uriInfo) {
     @Operation(deprecated = true, summary = "Updates the engagement resource in the database.")
     public Response put(@PathParam("customerName") String customerName, @PathParam("projectName") String projectName,
             @Valid Engagement engagement) {
+
+        LOGGER.warn("Deprecated put method used /customers/{}/projects/{}", customerName, projectName);
 
         boolean writer = jwtUtils.isAllowedToWriteEngagement(jwt, configService.getPermission(engagement.getType()));
         if(!writer) {
@@ -354,6 +360,7 @@ public Response put(@PathParam("customerName") String customerName, @PathParam("
     @Operation(summary = "Updates the engagement resource in the database.")
     public Response put(@PathParam("id") String uuid, @Valid Engagement engagement) {
 
+
         boolean writer = jwtUtils.isAllowedToWriteEngagement(jwt, configService.getPermission(engagement.getType()));
         if(!writer) {
             return forbiddenResponse(engagement.getType());
@@ -367,7 +374,7 @@ public Response put(@PathParam("id") String uuid, @Valid Engagement engagement)
 
     }
 
-    //TODO this method should be /launch/{uuid} with no body
+    //TODO this method should be /launch/{uuid} with no body. fix after v2 rollout
     @PUT
     @Path("/launch")
     @SecurityRequirement(name = "jwt")
@@ -429,17 +436,9 @@ private void setDefaultPagingFilterOptions(ListFilterOptions options) {
 
         boolean isV1 = null == options.getApiVersion() || ACCEPT_VERSION_1.equals(options.getApiVersion());
 
-        options.setPage(getPage(options.getPage()));
-        options.setPerPage(getPerPage(options.getPerPage(), isV1));
-
-    }
-
-    private Integer getPage(Optional<Integer> page) {
-        return page.orElse(1);
-    }
+        options.setPage(options.getPage().orElse(1));
+        options.setPerPage(options.getPerPage().orElse(isV1 ? 500 : 20));
 
-    private Integer getPerPage(Optional<Integer> perPage, boolean isV1) {
-        return perPage.orElse(isV1 ? 500 : 20);
     }
 
 }

src/main/java/com/redhat/labs/lodestar/resource/RefreshResource.java

@@ -17,6 +17,7 @@
 import javax.ws.rs.*;
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
+import java.util.Set;
 
 @RequestScoped
 @Path("/engagements/refresh")
@@ -38,10 +39,10 @@ public class RefreshResource {
             @APIResponse(responseCode = "400", description = "No refresh data set selected. Options are engagements, artifacts, participants and activity. You can mix and match"),
             @APIResponse(responseCode = "404", description = "UUID provided, but no engagement found in database."),
             @APIResponse(responseCode = "202", description = "The request was accepted and will be processed.") })
-    @Operation(summary = "Refreshes database with data in git, purging first if the query paramater set to true.")
+    @Operation(summary = "Refreshes database with data in git. If uuids are set then only those will be refreshed (engagements only support for that). Engagement Service first")
     public Response refresh(
             @Parameter(description = "When set deletes engagements first.") @QueryParam("purgeFirst") Boolean purgeFirst,
-            @Parameter(description = "Refresh engagement with uuid") @QueryParam("uuid") String uuid,
+            @Parameter(description = "Refresh engagement with uuid") @QueryParam("uuid") Set<String> uuids,
             @Parameter(description = "Refresh engagement with project id") @QueryParam("projectId") String projectId,
             @Parameter(description = "Refresh artifacts") @QueryParam("artifacts") boolean refreshArtifacts,
             @Parameter(description = "Refresh participants") @QueryParam("participants") boolean refreshParticipants,
@@ -51,6 +52,12 @@ public Response refresh(
 
         boolean didPickSomething = false;
 
+        if (refreshEngagements) {  //Engagements done first since all others are predicated on this content.
+            //Engagements will be synchronous
+            engagementService.refresh(uuids);
+            didPickSomething = true;
+        }
+
         if (refreshActivity) {
             eventBus.publish(EventType.RELOAD_ACTIVITY_EVENT_ADDRESS, EventType.RELOAD_ACTIVITY_EVENT_ADDRESS);
             didPickSomething = true;
@@ -72,12 +79,6 @@ public Response refresh(
             didPickSomething = true;
         }
 
-        if (refreshEngagements) {
-            //TODO
-            //engagementService.syncGitToDatabase(Boolean.TRUE.equals(purgeFirst), uuid, projectId);
-            didPickSomething = true;
-        }
-
         if (didPickSomething) {
             return Response.accepted().build();
         }

src/main/java/com/redhat/labs/lodestar/rest/client/EngagementApiClient.java

@@ -54,11 +54,17 @@ public interface EngagementApiClient {
     @PUT
     Response updateEngagement(Engagement engagement);
 
+    @PUT
+    @Path("{uuid}/lastUpdate")
+    Response registerUpdate(@PathParam("uuid") String uuid);
+
     @PUT
     @Path("{uuid}/launch")
     Response launch(@PathParam("uuid") String uuid, @QueryParam("author") String author, @QueryParam("authorEmail") String authorEmail);
 
-    @PUT Response refresh();
+    @PUT
+    @Path("refresh")
+    Response refresh(@QueryParam("uuids") Set<String> uuids);
 
     @GET
     @Path("suggest")

src/main/java/com/redhat/labs/lodestar/service/EngagementService.java

@@ -97,15 +97,12 @@ public Engagement getEngagement(String uuid) {
         engagement.setCategories(categories);
         engagement.setCommits(activity);
 
-        if(!engagement.getCommits().isEmpty()) {
-            engagement.setLastUpdate(activity.get(0).getCommitDate());
-        }
-
         EngagementState state = engagement.getEngagementCurrentState(Instant.now());
         if(state.equals(EngagementState.ACTIVE) || state.equals(EngagementState.TERMINATING)) {
             engagement.setStatus(getStatus(uuid));
         }
 
+        LOGGER.trace("got uuid {} with last update {}", uuid, engagement.getLastUpdate());
         return engagement;
     }
 
@@ -150,22 +147,24 @@ public Engagement create(Engagement engagement) {
      * @return
      */
     public Engagement update(Engagement engagement) {
+        boolean somethingChanged = false;
 
         String author = engagement.getLastUpdateByName();
         String authorEmail = engagement.getLastUpdateByEmail();
         String engagementUuid = engagement.getUuid();
 
-        // Validate activity is sync'd to prevent overwrites
-        // This is legacy behavior. We should support last update per service
-        validateLastUpdateIsLatest(engagementUuid, engagement.getLastUpdate());
-
         //Will return a 404 with a message saying the uuid is not valid
         Engagement current = engagementApiClient.getEngagement(engagement.getUuid());
 
+        // Validate activity is sync'd to prevent overwrites
+        // This is legacy behavior. We should support last update per service
+        validateLastUpdateIsLatest(engagement.getLastUpdate(), current.getLastUpdate(), engagementUuid);
+
         Diff diff = javers.compare(current, engagement);
         if(diff.hasChanges()) {
             LOGGER.debug("Engagement changes {}", diff);
             engagementApiClient.updateEngagement(engagement);
+            //somethingChanged not needed as it will occur during engagement update
         }
 
         nullToEmpty(engagement);
@@ -176,13 +175,15 @@ public Engagement update(Engagement engagement) {
             LOGGER.debug("Hosting Environment changes {}", diff);
             hostingEnvironmentService.updateAndReload(engagementUuid, engagement.getHostingEnvironments(),
                     Author.builder().email(authorEmail).name(author).build());
+            somethingChanged = true;
         }
 
         List<Artifact> artifacts = artifactService.getArtifacts(engagement.getUuid());
         diff = javers.compareCollections(artifacts, engagement.getArtifacts(), Artifact.class);
         if(diff.hasChanges()) {
             LOGGER.debug("Artifacts has changes {}", diff);
             artifactService.update(engagement, author, authorEmail);
+            somethingChanged = true;
         }
 
         List<EngagementUser> participants = participantService.getParticipantsForEngagement(engagement.getUuid());
@@ -192,7 +193,7 @@ public Engagement update(Engagement engagement) {
             participants = participantService.updateParticipantsAndReload(engagementUuid, author, authorEmail,
                     engagement.getEngagementUsers());
             LOGGER.debug("Updated {}", participants);
-
+            somethingChanged = true;
         }
 
         List<Category> categories = categoryApiClient.getCategories(engagement.getUuid());
@@ -202,23 +203,26 @@ public Engagement update(Engagement engagement) {
             Set<String> catString = new TreeSet<>();
             engagement.getCategories().forEach(c -> catString.add(c.getName()));
             categoryApiClient.updateCategories(engagementUuid, author, authorEmail, catString);
+            somethingChanged = true;
         }
 
         //TODO update cache
+        if(somethingChanged) {
+            engagementApiClient.registerUpdate(engagementUuid);
+        }
         return getEngagement(engagementUuid);
     }
 
     /**
      * Will throw a 409 error if invalid
-     * @param engagementUuid the engagement
-     * @param requesterLastUpdate incoming last known update
      */
-    private void validateLastUpdateIsLatest(String engagementUuid, String requesterLastUpdate) {
-        Instant lastUpdateFromRequester = Instant.parse(requesterLastUpdate);
-        Instant lastUpdateFromSystem = activityService.getLatestActivity(engagementUuid);
+    private void validateLastUpdateIsLatest(String requestValue, String persistedValue, String engagementUuid) {
+        Instant lastUpdateFromRequester = Instant.parse(requestValue);
+        Instant lastUpdateFromSystem = Instant.parse(persistedValue);
 
-        if(lastUpdateFromSystem.compareTo(lastUpdateFromRequester) != 0) {
-            LOGGER.info("Last update is out of sync with the activity. Caller needs refresh for {}", engagementUuid);
+        if(!lastUpdateFromSystem.equals(lastUpdateFromRequester)) {
+            LOGGER.info("Last update is out of sync with the engagement db. Caller needs refresh for {} ui ({}) db ({})",
+                    engagementUuid, requestValue, persistedValue);
             throw new WebApplicationException(409);
         }
     }
@@ -412,7 +416,11 @@ public Response getUseCases(ListFilterOptions filterOptions) {
     public Engagement launch(String uuid, String author, String authorEmail) {
 
         engagementApiClient.launch(uuid, author, authorEmail);
-        return getEngagement(uuid); //TODO This method should happen via UUID not full engagement
+        return getEngagement(uuid);
+    }
+
+    public void refresh(Set<String> uuids) {
+        engagementApiClient.refresh(uuids);
     }
 
 }

src/main/resources/application.properties

@@ -49,15 +49,15 @@ quarkus.cache.caffeine.rbac-cache.expire-after-write=600S
 # Quarkus build properties
 quarkus.package.type=uber-jar
 
-lodestar.git.api/mp-rest/url=${LODESTAR_GITLAB_API_URL:http://lodestar-git-api:8080}
-lodestar.status.api/mp-rest/url=${LODESTAR_STATUS_API_URL:http://lodestar-status:8080}
-lodestar.config.api/mp-rest/url=${LODESTAR_CONFIG_API_URL:http://lodestar-config:8080}
-lodestar.activity.api/mp-rest/url=${LODESTAR_ACTIVITY_API_URL:http://lodestar-activity:8080}
-lodestar.artifacts.api/mp-rest/url=${LODESTAR_ARTIFACTS_API_URL:http://lodestar-artifacts:8080}
-lodestar.participants.api/mp-rest/url=${LODESTAR_PARTICIPANTS_API_URL:http://lodestar-participants:8080}
-lodestar.engagement.status.api/mp-rest/url=${LODESTAR_ENGAGEMENT_STATUS_API_URL:http://lodestar-engagement-status:8080}
-lodestar.engagements.api/mp-rest/url=${LODESTAR_ENGAGEMENTS_API_URL:http://lodestar-engagements:8080}
-lodestar.hosting.api/mp-rest/url=${LODESTAR_HOSTING_ENV_API_URL:http://lodestar-hosting:8080}
+lodestar.git.api/mp-rest/url=${GITLAB_API_URL:http://lodestar-git-api:8080}
+lodestar.status.api/mp-rest/url=${STATUS_API_URL:http://lodestar-status:8080}
+lodestar.config.api/mp-rest/url=${CONFIG_API_URL:http://lodestar-config:8080}
+lodestar.activity.api/mp-rest/url=${ACTIVITY_API_URL:http://lodestar-activity:8080}
+lodestar.artifacts.api/mp-rest/url=${ARTIFACTS_API_URL:http://lodestar-artifacts:8080}
+lodestar.participants.api/mp-rest/url=${PARTICIPANTS_API_URL:http://lodestar-participants:8080}
+lodestar.engagement.status.api/mp-rest/url=${ENGAGEMENT_STATUS_API_URL:http://lodestar-engagement-status:8080}
+lodestar.engagements.api/mp-rest/url=${ENGAGEMENT_API_URL:http://lodestar-engagements:8080}
+lodestar.hosting.api/mp-rest/url=${HOSTING_ENV_API_URL:http://lodestar-hosting:8080}
 
 webhook.token=${WEBHOOK_TOKEN:t}
 cleanup.token=${CLEANUP_TOKEN:OFF}

src/test/java/com/redhat/labs/lodestar/resource/ConfigResourceTest.java

@@ -6,6 +6,7 @@
 import javax.ws.rs.core.Response;
 
 import com.redhat.labs.lodestar.rest.client.ConfigApiClient;
+import io.quarkus.test.common.http.TestHTTPEndpoint;
 import io.quarkus.test.junit.mockito.InjectMock;
 import org.eclipse.microprofile.rest.client.inject.RestClient;
 import org.junit.jupiter.api.Tag;
@@ -17,6 +18,7 @@
 import io.quarkus.test.junit.QuarkusTest;
 
 @QuarkusTest
+@TestHTTPEndpoint(ConfigResource.class)
 @Tag("nested")
 class ConfigResourceTest {
 
@@ -33,7 +35,7 @@ void testGetConfigTokenHasWrongRole()  {
             .when()
                 .auth()
                     .oauth2(token)
-                .get("/config")
+                .get()
             .then()
                 .statusCode(403);
 
@@ -52,7 +54,7 @@ void testGetConfigWithoutType() {
             .when()
                 .auth()
                     .oauth2(token)
-                .get("/config")
+                .get()
             .then()
                 .statusCode(200)
                 .body(is(body))
@@ -75,11 +77,18 @@ void testGetConfigWithType() {
             .when()
                 .auth()
                     .oauth2(token)
-                .get("/config")
+                .get()
             .then()
                 .statusCode(200)
                 .body(is(body));
 
     }
 
+    @Test
+    void testVoidCache() {
+        String token = TokenUtils.generateTokenString("/JwtClaimsReader.json");
+
+        given().when().auth().oauth2(token).put("/rbac/cache").then().statusCode(200);
+    }
+
 }