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

Improve error handling for malformed query cursors #3066

Merged
merged 4 commits into from
Oct 10, 2024
Merged

Improve error handling for malformed query cursors #3066

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c9b61e7
Add reproducer for malformed cursor handling
Swiddis Oct 10, 2024
ec239d2
Handle malformed query cursors
Swiddis Oct 10, 2024
30ce0e8
Move malformed cursor test to correct file
Swiddis Oct 10, 2024
01e2f1e
Apply spotless
Swiddis Oct 10, 2024
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
11 changes: 11 additions & 0 deletions integ-test/src/test/java/org/opensearch/sql/legacy/CursorIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,17 @@ public void noPaginationWithNonJDBCFormat() throws IOException {
assertThat(rows.length, equalTo(1000));
}

@Test
public void testMalformedCursorGracefullyHandled() throws IOException {
ResponseException result = assertThrows(
"Expected query with malformed cursor to raise error, but didn't",
ResponseException.class,
() -> executeCursorQuery("d:a11b4db33f")
);
assertTrue(result.getMessage().contains("Malformed cursor"));
assertEquals(result.getResponse().getStatusLine().getStatusCode(), 400);
}

public void verifyWithAndWithoutPaginationResponse(
String sqlQuery, String cursorQuery, int fetch_size, boolean shouldFallBackToV1)
throws IOException {
Expand Down
11 changes: 10 additions & 1 deletion legacy/src/main/java/org/opensearch/sql/legacy/executor/cursor/CursorResultExecutor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import org.opensearch.action.search.SearchResponse;
import org.opensearch.client.Client;
import org.opensearch.common.unit.TimeValue;
import org.opensearch.core.rest.RestStatus;
import org.opensearch.rest.BytesRestResponse;
import org.opensearch.rest.RestChannel;
import org.opensearch.search.SearchHit;
Expand All @@ -36,6 +37,7 @@
import org.opensearch.sql.legacy.pit.PointInTimeHandler;
import org.opensearch.sql.legacy.pit.PointInTimeHandlerImpl;
import org.opensearch.sql.legacy.rewriter.matchtoterm.VerificationException;
import org.opensearch.sql.opensearch.response.error.ErrorMessageFactory;

public class CursorResultExecutor implements CursorRestExecutor {

Expand All @@ -58,7 +60,14 @@ public void execute(Client client, Map<String, String> params, RestChannel chann
} catch (IllegalArgumentException | JSONException e) {
Metrics.getInstance().getNumericalMetric(MetricName.FAILED_REQ_COUNT_CUS).increment();
LOG.error("Error parsing the cursor", e);
channel.sendResponse(new BytesRestResponse(channel, e));
channel.sendResponse(new BytesRestResponse(
RestStatus.BAD_REQUEST,
"application/json; charset=UTF-8",
ErrorMessageFactory.createErrorMessage(
new IllegalArgumentException("Malformed cursor: unable to extract cursor information"),
RestStatus.BAD_REQUEST.getStatus()
).toString()
));
} catch (OpenSearchException e) {
int status = (e.status().getStatus());
if (status > 399 && status < 500) {
Expand Down
Loading