Skip to content

WIP: Add endpoint to get context info from timegraph trees #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

WIP: Add endpoint to get context info from timegraph trees #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions ...ompass/incubator/internal/trace/server/jersey/rest/core/services/DataProviderService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -454,6 +454,28 @@ public Response getTimeGraphTree(
return getTree(expUUID, outputId, queryParameters);
}

@POST
@Path("/timeGraph/{outputId}/tree:context")
@Tag(name = TGR)
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@Operation(summary = "API to get the Time Graph tree:context", description = TREE_ENTRIES, responses = {
@ApiResponse(responseCode = "200", description = "Returns a list of Time Graph entries. " +
CONSISTENT_PARENT, content = @Content(schema = @Schema(implementation = TimeGraphTreeResponse.class))),
@ApiResponse(responseCode = "400", description = INVALID_PARAMETERS, content = @Content(schema = @Schema(implementation = String.class))),
@ApiResponse(responseCode = "404", description = PROVIDER_NOT_FOUND, content = @Content(schema = @Schema(implementation = String.class))),
@ApiResponse(responseCode = "405", description = NO_PROVIDER, content = @Content(schema = @Schema(implementation = String.class)))
})
public Response getTimeGraphTreeContext(
@Parameter(description = EXP_UUID) @PathParam("expUUID") UUID expUUID,
@Parameter(description = OUTPUT_ID) @PathParam("outputId") String outputId,
@RequestBody(description = "Query parameters to fetch the timegraph tree. " + TIMERANGE_TREE, content = {
@Content(examples = @ExampleObject("{\"parameters\":{" + TIMERANGE_EX_TREE +
"}}"), schema = @Schema(implementation = TreeQueryParameters.class))
}, required = true) QueryParameters queryParameters) {
return getTreeContext(expUUID, outputId, queryParameters);
}

/**
* Query the provider for the time graph states
*
Expand Down Expand Up @@ -1068,6 +1090,42 @@ private Response getTree(UUID expUUID, String outputId, QueryParameters queryPar
}
}

private Response getTreeContext(UUID expUUID, String outputId, QueryParameters queryParameters) {
Response errorResponse = validateParameters(outputId, queryParameters);
if (errorResponse != null) {
return errorResponse;
}
Map<String, Object> params = queryParameters.getParameters();
String errorMessage = QueryParametersUtil.validateTreeQueryParameters(params);
if (errorMessage != null) {
return Response.status(Status.BAD_REQUEST).entity(errorMessage).build();
}
try (FlowScopeLog scope = new FlowScopeLogBuilder(LOGGER, Level.FINE, "DataProviderService#getTree") //$NON-NLS-1$
.setCategory(outputId).build()) {
TmfExperiment experiment = ExperimentManagerService.getExperimentByUUID(expUUID);
if (experiment == null) {
return Response.status(Status.NOT_FOUND).entity(NO_SUCH_TRACE).build();
}

ITmfTreeDataProvider<? extends @NonNull ITmfTreeDataModel> provider = manager.getOrCreateDataProvider(experiment,
outputId, ITmfTreeDataProvider.class);

if (provider == null) {
// try and find the XML provider for the ID.
provider = getXmlProvider(experiment, outputId, EnumSet.allOf(OutputType.class));
}

if (provider == null) {
// The analysis cannot be run on this trace
return Response.status(Status.METHOD_NOT_ALLOWED).entity(NO_PROVIDER).build();
}

TmfModelResponse<Map<String, Object>> treeResponse = provider.fetchTreeContext(params, null);
Object model = treeResponse.getModel();
return Response.ok(treeResponse).build();
}
}

/**
* Query the provider for styles
*
Expand Down