Skip to content
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

Replaces sortString with sortBy #1055

Merged
merged 1 commit into from
Feb 3, 2025
Merged

Replaces sortString with sortBy #1055

Show file tree
Hide file tree
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
26 changes: 4 additions & 22 deletions src/main/java/edu/hawaii/its/api/controller/GroupingsRestController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,11 +119,11 @@ public ResponseEntity<String> allGroupings() {
public ResponseEntity<String> getGrouping(@RequestBody(required = true) List<String> groupPaths,
@RequestParam(required = true) Integer page,
@RequestParam(required = true) Integer size,
@RequestParam(required = true) String sortString,
@RequestParam(required = true) String sortBy,
@RequestParam(required = true) Boolean isAscending) {
logger.info("Entered REST getGrouping...");
String currentUid = policy.sanitize(userContextService.getCurrentUid());
Map<String, String> params = mapGroupingParameters(page, size, sortString, isAscending);
Map<String, String> params = mapGroupingParameters(page, size, sortBy, isAscending);
String baseUri = API_2_1_BASE + "/groupings/group";
String uri = buildUriWithParams(baseUri, params);
return httpRequestService.makeApiRequestWithBody(currentUid, uri, groupPaths, HttpMethod.POST);
Expand Down Expand Up @@ -537,24 +537,6 @@ public ResponseEntity<String> removeOwnerships(
return httpRequestService.makeApiRequest(currentUid, uri, HttpMethod.DELETE);
}

/**
* Fetch a page of the specified Grouping.
*/
@GetMapping(value = "/groupings/{path:.+}")
public ResponseEntity<String> getGrouping(@PathVariable String path,
@RequestParam(required = true) Integer page,
@RequestParam(required = true) Integer size,
@RequestParam(required = true) String sortString,
@RequestParam(required = true) Boolean isAscending) {
logger.info("Entered REST getGrouping...");
String currentUid = policy.sanitize(userContextService.getCurrentUid());
Map<String, String> params = mapGroupingParameters(page, size, sortString, isAscending);
String baseUri = String.format(API_2_1_BASE + "/groupings/%s", path);
String uri = buildUriWithParams(baseUri, params);

return httpRequestService.makeApiRequest(currentUid, uri, HttpMethod.GET);
}

/**
* Update the description of a grouping at path.
*/
Expand Down Expand Up @@ -670,12 +652,12 @@ public List<String> sanitizeList(List<String> data) {
return sanitizedList;
}

public Map<String, String> mapGroupingParameters(Integer page, Integer size, String sortString,
public Map<String, String> mapGroupingParameters(Integer page, Integer size, String sortBy,
Boolean isAscending) {
Map<String, String> params = new HashMap<>();
params.put("page", Integer.toString(page));
params.put("size", Integer.toString(size));
params.put("sortString", sortString);
params.put("sortBy", sortBy);
params.put("isAscending", Boolean.toString(isAscending));
return params;
}
Expand Down
6 changes: 3 additions & 3 deletions src/main/resources/static/javascript/mainApp/groupings.service.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,20 @@
* @param {String[]} groupPaths - The paths to the grouping.
* @param {Number} page - The number to fetch.
* @param {Number} size - The size data chunk to be fetched.
* @param {String} sortString - String to base sort off of.
* @param {String} sortBy - String to base sort off of.
* @param isAscending - On true the data returns in ascending order.
* @param onSuccess - Function to be called if HTTP request returns as a success.
* @param onError - Function to be called if HTTP request returns an error.
*/
getGrouping(groupPaths,
page,
size,
sortString,
sortBy,
isAscending,
onSuccess,
onError) {
let endpoint = BASE_URL + "groupings/group?";
let params = { page, size, sortString, isAscending };
let params = { page, size, sortBy, isAscending };
let query = this.encodeParameterizedQueryString(params);
endpoint = endpoint + query;
dataProvider.loadDataWithBodyRetry(endpoint, groupPaths, onSuccess, onError);
Expand Down
18 changes: 10 additions & 8 deletions src/test/java/edu/hawaii/its/api/controller/GroupingsRestControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -636,18 +636,20 @@ public void removeOwnershipsTest() throws Exception {
@Test
@WithMockUhUser
public void getGroupingTest() throws Exception {
String uri =
REST_CONTROLLER_BASE + "groupings/" + GROUPING + "?page=2&size=700&sortString=name&isAscending=true";
String uri = REST_CONTROLLER_BASE + "groupings/group?page=2&size=700&sortBy=name&isAscending=true";
List<String> groupPaths = List.of(GROUPING);

given(httpRequestService.makeApiRequest(eq(UID), anyString(), eq(HttpMethod.GET)))
given(httpRequestService.makeApiRequestWithBody(eq(UID), anyString(), eq(groupPaths), eq(HttpMethod.POST)))
.willReturn(new ResponseEntity(HttpStatus.OK));

assertNotNull(mockMvc.perform(get(uri).with(csrf()))
assertNotNull(mockMvc.perform(post(uri).with(csrf())
.contentType(MediaType.APPLICATION_JSON)
.content(JsonUtil.asJson(groupPaths)))
.andExpect(status().isOk())
.andReturn());

verify(httpRequestService, times(1))
.makeApiRequest(eq(UID), anyString(), eq(HttpMethod.GET));
.makeApiRequestWithBody(eq(UID), anyString(), eq(groupPaths), eq(HttpMethod.POST));
}

@Test
Expand Down Expand Up @@ -894,8 +896,8 @@ public void mapGroupingParametersTest() {
assertEquals("1", params.get("page"));
assertTrue(params.containsKey("size"));
assertEquals("2", params.get("size"));
assertTrue(params.containsKey("sortString"));
assertEquals("name", params.get("sortString"));
assertTrue(params.containsKey("sortBy"));
assertEquals("name", params.get("sortBy"));
assertTrue(params.containsKey("isAscending"));
assertEquals("true", params.get("isAscending"));
}
Expand All @@ -905,7 +907,7 @@ public void buildUriWithParamsTest() {
Map<String, String> params = groupingsRestController.mapGroupingParameters(1, 2, "name", true);
String uriTemplate = groupingsRestController.buildUriWithParams(API_2_1_BASE, params);
assertNotNull(uriTemplate);
String expectedResult = API_2_1_BASE + "?sortString=name&size=2&page=1&isAscending=true";
String expectedResult = API_2_1_BASE + "?size=2&sortBy=name&page=1&isAscending=true";
assertEquals(expectedResult, uriTemplate);
}

Expand Down
2 changes: 1 addition & 1 deletion src/test/javascript/grouping.controller.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ describe("GroupingController", () => {
groupingPath: "somePath",
currentPage: 1,
PAGE_SIZE: 1,
sortString: "name",
sortBy: "name",
isAscending: true
};
});
Expand Down
12 changes: 6 additions & 6 deletions src/test/javascript/groupings.service.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,25 +53,25 @@ describe("GroupingsService", () => {
describe("getGrouping", () => {
let page;
let size;
let sortString;
let sortBy;
let isAscending;

beforeEach(() => {
page = 0;
size = 1;
sortString = "name";
sortBy = "name";
isAscending = true;
});

it("should call dataProvider.loadDataWithBodyRetry", () => {
spyOn(dp, "loadDataWithBodyRetry");
gs.getGrouping(groupingPath, page, size, sortString, isAscending, onSuccess, onError);
gs.getGrouping(groupingPath, page, size, sortBy, isAscending, onSuccess, onError);
expect(dp.loadDataWithBodyRetry).toHaveBeenCalled();
});

it("should call encodeParameterizedQueryString()", () => {
spyOn(gs, "encodeParameterizedQueryString");
gs.getGrouping(groupingPath, page, size, sortString, isAscending, onSuccess, onError);
gs.getGrouping(groupingPath, page, size, sortBy, isAscending, onSuccess, onError);
expect(gs.encodeParameterizedQueryString).toHaveBeenCalled();
});
});
Expand Down Expand Up @@ -642,11 +642,11 @@ describe("GroupingsService", () => {
let params = {
"page": 1,
"size": 2,
"sortString": "name",
"sortBy": "name",
"isAscending": true
};
let result = gs.encodeParameterizedQueryString(params);
expect(result).toEqual("page=1&size=2&sortString=name&isAscending=true");
expect(result).toEqual("page=1&size=2&sortBy=name&isAscending=true");
});
});

Expand Down
Loading