-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
MessageProcessingHandler.java
171 lines (154 loc) · 5.38 KB
/
MessageProcessingHandler.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/*
* Copyright (c) 2002-2018 "Neo4j,"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.bolt.v1.messaging;
import java.io.IOException;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;
import org.neo4j.bolt.runtime.BoltConnection;
import org.neo4j.bolt.v1.packstream.PackOutputClosedException;
import org.neo4j.bolt.v1.runtime.BoltResponseHandler;
import org.neo4j.bolt.v1.runtime.Neo4jError;
import org.neo4j.bolt.v1.runtime.spi.BoltResult;
import org.neo4j.kernel.api.exceptions.Status;
import org.neo4j.logging.Log;
import org.neo4j.values.AnyValue;
import org.neo4j.values.virtual.MapValue;
import org.neo4j.values.virtual.MapValueBuilder;
class MessageProcessingHandler implements BoltResponseHandler
{
// Errors that are expected when the client disconnects mid-operation
private static final Set<Status> CLIENT_MID_OP_DISCONNECT_ERRORS = new HashSet<>( Arrays.asList(
Status.Transaction.Terminated, Status.Transaction.LockClientStopped ) );
protected final MapValueBuilder metadata = new MapValueBuilder( );
protected final Log log;
protected final BoltConnection connection;
protected final BoltResponseMessageHandler<IOException> handler;
private Neo4jError error;
private boolean ignored;
MessageProcessingHandler( BoltResponseMessageHandler<IOException> handler, BoltConnection connection,
Log logger )
{
this.handler = handler;
this.connection = connection;
this.log = logger;
}
@Override
public void onStart()
{
}
@Override
public void onRecords( BoltResult result, boolean pull ) throws Exception
{
}
@Override
public void onMetadata( String key, AnyValue value )
{
metadata.add( key, value );
}
@Override
public void markIgnored()
{
this.ignored = true;
}
@Override
public void markFailed( Neo4jError error )
{
this.error = error;
}
@Override
public void onFinish()
{
try
{
if ( ignored )
{
handler.onIgnored();
}
else if ( error != null )
{
publishError( handler, error );
}
else
{
handler.onSuccess( getMetadata() );
}
}
catch ( Throwable e )
{
connection.stop();
log.error( "Failed to write response to driver", e );
}
finally
{
clearState();
}
}
MapValue getMetadata()
{
return metadata.build();
}
private void clearState()
{
error = null;
ignored = false;
metadata.clear();
}
private void publishError( BoltResponseMessageHandler<IOException> out, Neo4jError error )
{
try
{
if ( error.isFatal() )
{
out.onFatal( error.status(), error.message() );
}
else
{
out.onFailure( error.status(), error.message() );
}
}
catch ( PackOutputClosedException e )
{
// Can't write error to the client, because the connection is closed.
// Very likely our error is related to the connection being closed.
// If the error is that the transaction was terminated, then the error is a side-effect of
// us cleaning up stuff that was running when the client disconnected. Log a warning without
// stack trace to highlight clients are disconnecting while stuff is running:
if ( CLIENT_MID_OP_DISCONNECT_ERRORS.contains( error.status() ) )
{
log.warn( "Client %s disconnected while query was running. Session has been cleaned up. " +
"This can be caused by temporary network problems, but if you see this often, " +
"ensure your applications are properly waiting for operations to complete before exiting.",
e.clientAddress() );
return;
}
// If the error isn't that the tx was terminated, log it to the console for debugging. It's likely
// there are other "ok" errors that we can whitelist into the conditional above over time.
log.warn( "Unable to send error back to the client. " + e.getMessage(), error.cause() );
}
catch ( Throwable t )
{
// some unexpected error happened while writing exception back to the client
// log it together with the original error being suppressed
t.addSuppressed( error.cause() );
log.error( "Unable to send error back to the client", t );
}
}
}