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

Jump to bottom

Throw ProtocolException when QueryType is unknown #1193

Merged
merged 1 commit into from
Mar 29, 2022
Merged

Throw ProtocolException when QueryType is unknown #1193

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: 21 additions & 5 deletions driver/src/main/java/org/neo4j/driver/internal/handlers/LegacyPullAllResponseHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import org.neo4j.driver.Query;
import org.neo4j.driver.Record;
import org.neo4j.driver.Value;
import org.neo4j.driver.exceptions.Neo4jException;
import org.neo4j.driver.internal.InternalRecord;
import org.neo4j.driver.internal.messaging.request.PullAllMessage;
import org.neo4j.driver.internal.spi.Connection;
Expand Down Expand Up @@ -92,12 +93,27 @@ public boolean canManageAutoRead()
public synchronized void onSuccess( Map<String,Value> metadata )
{
finished = true;
summary = extractResultSummary( metadata );
Neo4jException exception = null;
try
{
summary = extractResultSummary( metadata );
}
catch ( Neo4jException e )
{
exception = e;
}

completionListener.afterSuccess( metadata );
if ( exception == null )
{
completionListener.afterSuccess( metadata );

completeRecordFuture( null );
completeFailureFuture( null );
completeRecordFuture( null );
completeFailureFuture( null );
}
else
{
onFailure( exception );
}
}

@Override
Expand Down Expand Up @@ -335,7 +351,7 @@ private boolean completeFailureFuture( Throwable error )
private ResultSummary extractResultSummary( Map<String,Value> metadata )
{
long resultAvailableAfter = runResponseHandler.resultAvailableAfter();
return metadataExtractor.extractSummary(query, connection, resultAvailableAfter, metadata );
return metadataExtractor.extractSummary( query, connection, resultAvailableAfter, metadata );
}

private void enableAutoRead()
Expand Down
16 changes: 13 additions & 3 deletions driver/src/main/java/org/neo4j/driver/internal/handlers/pulln/BasicPullResponseHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.neo4j.driver.Query;
import org.neo4j.driver.Record;
import org.neo4j.driver.Value;
import org.neo4j.driver.exceptions.Neo4jException;
import org.neo4j.driver.internal.InternalRecord;
import org.neo4j.driver.internal.handlers.PullResponseCompletionListener;
import org.neo4j.driver.internal.handlers.RunResponseHandler;
Expand Down Expand Up @@ -112,9 +113,18 @@ protected void completeWithFailure( Throwable error )
protected void completeWithSuccess( Map<String,Value> metadata )
{
completionListener.afterSuccess( metadata );
ResultSummary summary = extractResultSummary( metadata );

complete( summary, null );
ResultSummary summary;
Neo4jException exception = null;
try
{
summary = extractResultSummary( metadata );
}
catch ( Neo4jException e )
{
summary = extractResultSummary( emptyMap() );
exception = e;
}
complete( summary, exception );
}

protected void successHasMore()
Expand Down
15 changes: 10 additions & 5 deletions driver/src/main/java/org/neo4j/driver/internal/util/MetadataExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,12 @@
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.function.Function;

import org.neo4j.driver.Bookmark;
import org.neo4j.driver.Query;
import org.neo4j.driver.Value;
import org.neo4j.driver.exceptions.ProtocolException;
import org.neo4j.driver.exceptions.UntrustedServerException;
import org.neo4j.driver.internal.InternalBookmark;
import org.neo4j.driver.internal.spi.Connection;
Expand All @@ -49,6 +51,9 @@
public class MetadataExtractor
{
public static final int ABSENT_QUERY_ID = -1;
private static final String UNEXPECTED_TYPE_MSG_FMT = "Unexpected query type '%s', consider updating the driver";
private static final Function<String,ProtocolException> UNEXPECTED_TYPE_EXCEPTION_SUPPLIER =
( type ) -> new ProtocolException( String.format( UNEXPECTED_TYPE_MSG_FMT, type ) );
private final String resultAvailableAfterMetadataKey;
private final String resultConsumedAfterMetadataKey;

Expand Down Expand Up @@ -98,14 +103,14 @@ public long extractResultAvailableAfter( Map<String,Value> metadata )
return -1;
}

public ResultSummary extractSummary(Query query, Connection connection, long resultAvailableAfter, Map<String,Value> metadata )
public ResultSummary extractSummary( Query query, Connection connection, long resultAvailableAfter, Map<String,Value> metadata )
{
ServerInfo serverInfo =
new InternalServerInfo( connection.serverAgent(), connection.serverAddress(), connection.protocol().version() );
DatabaseInfo dbInfo = extractDatabaseInfo( metadata );
return new InternalResultSummary(query, serverInfo, dbInfo, extractQueryType( metadata ), extractCounters( metadata ), extractPlan( metadata ),
extractProfiledPlan( metadata ), extractNotifications( metadata ), resultAvailableAfter,
extractResultConsumedAfter( metadata, resultConsumedAfterMetadataKey ) );
return new InternalResultSummary( query, serverInfo, dbInfo, extractQueryType( metadata ), extractCounters( metadata ), extractPlan( metadata ),
extractProfiledPlan( metadata ), extractNotifications( metadata ), resultAvailableAfter,
extractResultConsumedAfter( metadata, resultConsumedAfterMetadataKey ) );
}

public static DatabaseInfo extractDatabaseInfo( Map<String,Value> metadata )
Expand Down Expand Up @@ -151,7 +156,7 @@ private static QueryType extractQueryType( Map<String,Value> metadata )
Value typeValue = metadata.get( "type" );
if ( typeValue != null )
{
return QueryType.fromCode( typeValue.asString() );
return QueryType.fromCode( typeValue.asString(), UNEXPECTED_TYPE_EXCEPTION_SUPPLIER );
}
return null;
}
Expand Down
24 changes: 22 additions & 2 deletions driver/src/main/java/org/neo4j/driver/summary/QueryType.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,14 @@
*/
package org.neo4j.driver.summary;

import java.util.function.Function;

import org.neo4j.driver.exceptions.ClientException;
import org.neo4j.driver.exceptions.Neo4jException;

/**
* The type of query executed.
*
* @since 1.0
*/
public enum QueryType
Expand All @@ -31,7 +35,16 @@ public enum QueryType
WRITE_ONLY,
SCHEMA_WRITE;

public static QueryType fromCode(String type )
private static final String UNEXPECTED_TYPE_MSG_FMT = "Unknown query type: `%s`.";
private static final Function<String,ClientException> UNEXPECTED_TYPE_EXCEPTION_SUPPLIER =
( type ) -> new ClientException( String.format( UNEXPECTED_TYPE_MSG_FMT, type ) );

public static QueryType fromCode( String type )
{
return fromCode( type, UNEXPECTED_TYPE_EXCEPTION_SUPPLIER );
}

public static QueryType fromCode( String type, Function<String,? extends Neo4jException> exceptionFunction )
{
switch ( type )
{
Expand All @@ -44,7 +57,14 @@ public static QueryType fromCode(String type )
case "s":
return QueryType.SCHEMA_WRITE;
default:
throw new ClientException( "Unknown query type: `" + type + "`." );
if ( exceptionFunction != null )
{
throw exceptionFunction.apply( type );
}
else
{
return null;
}
}
}
}
1 change: 0 additions & 1 deletion testkit-backend/src/main/java/neo4j/org/testkit/backend/messages/requests/StartTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ public class StartTest implements TestkitRequest

static
{
COMMON_SKIP_PATTERN_TO_REASON.put( "^.*\\.test_invalid_query_type$", "Does not report type exception" );
COMMON_SKIP_PATTERN_TO_REASON.put( "^.*\\.test_no_notifications$", "An empty list is returned when there are no notifications" );
COMMON_SKIP_PATTERN_TO_REASON.put( "^.*\\.test_no_notification_info$", "An empty list is returned when there are no notifications" );
COMMON_SKIP_PATTERN_TO_REASON.put( "^.*\\.test_notifications_without_position$", "Null value is provided when position is absent" );
Expand Down