ctubbsii commented on code in PR #5398: URL: https://github.com/apache/accumulo/pull/5398#discussion_r1990492134
########## core/src/main/java/org/apache/accumulo/core/rpc/AccumuloProtocolFactory.java: ########## @@ -0,0 +1,156 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.accumulo.core.rpc; + +import org.apache.accumulo.core.trace.TraceUtil; +import org.apache.thrift.TException; +import org.apache.thrift.protocol.TCompactProtocol; +import org.apache.thrift.protocol.TMessage; +import org.apache.thrift.protocol.TProtocol; +import org.apache.thrift.transport.TTransport; + +import io.opentelemetry.api.trace.Span; +import io.opentelemetry.context.Scope; + +public class AccumuloProtocolFactory extends TCompactProtocol.Factory { + + private static final long serialVersionUID = 1L; + + private final boolean isClient; + + public static class AccumuloProtocol extends TCompactProtocol { + + private static final int MAGIC_NUMBER = 0x41434355; // "ACCU" in ASCII + private static final byte PROTOCOL_VERSION = 1; + + private final boolean isClient; + + private Span span = null; + private Scope scope = null; + + public AccumuloProtocol(TTransport transport, boolean isClient) { + super(transport); + this.isClient = isClient; + } + + @Override + public void writeMessageBegin(TMessage message) throws TException { + if (this.isClient) { + span = TraceUtil.startClientRpcSpan(this.getClass(), message.name); + scope = span.makeCurrent(); + + try { + this.writeHeader(); + } catch (TException e) { + if (scope != null) { + scope.close(); + } + if (span != null) { + span.end(); + } + throw e; + } + } + + super.writeMessageBegin(message); + } + + /** + * Writes the Accumulo protocol header containing version and identification info + */ + private void writeHeader() throws TException { + super.writeI32(MAGIC_NUMBER); + super.writeByte(PROTOCOL_VERSION); + } + + @Override + public TMessage readMessageBegin() throws TException { + if (!this.isClient) { + this.validateHeader(); + } + + return super.readMessageBegin(); + } + + /** + * Checks if the given version is compatible with the current protocol version + */ + private boolean isCompatibleVersion(byte version) { + return version == PROTOCOL_VERSION; + } + + /** + * Reads and validates the Accumulo protocol header + * + * @throws TException if the header is invalid or incompatible + */ + private void validateHeader() throws TException { + final int magic = super.readI32(); + if (magic != MAGIC_NUMBER) { + throw new TException("Invalid Accumulo protocol: magic number mismatch. Expected: 0x" + + Integer.toHexString(MAGIC_NUMBER) + ", got: 0x" + Integer.toHexString(magic)); + } + + final byte version = super.readByte(); + if (!isCompatibleVersion(version)) { + throw new TException("Incompatible protocol version. Client version: " + version + + ", Server version: " + PROTOCOL_VERSION); + } + } + + @Override + public void writeMessageEnd() throws TException { + super.writeMessageEnd(); + + if (this.isClient && scope != null) { + scope.close(); + span.end(); + } Review Comment: I don't think we care if it's a client. If a scope was opened, we'd want to close it. ########## core/src/main/java/org/apache/accumulo/core/rpc/AccumuloProtocolFactory.java: ########## @@ -0,0 +1,156 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.accumulo.core.rpc; + +import org.apache.accumulo.core.trace.TraceUtil; +import org.apache.thrift.TException; +import org.apache.thrift.protocol.TCompactProtocol; +import org.apache.thrift.protocol.TMessage; +import org.apache.thrift.protocol.TProtocol; +import org.apache.thrift.transport.TTransport; + +import io.opentelemetry.api.trace.Span; +import io.opentelemetry.context.Scope; + +public class AccumuloProtocolFactory extends TCompactProtocol.Factory { + + private static final long serialVersionUID = 1L; + + private final boolean isClient; + + public static class AccumuloProtocol extends TCompactProtocol { + + private static final int MAGIC_NUMBER = 0x41434355; // "ACCU" in ASCII + private static final byte PROTOCOL_VERSION = 1; + + private final boolean isClient; + + private Span span = null; + private Scope scope = null; + + public AccumuloProtocol(TTransport transport, boolean isClient) { + super(transport); + this.isClient = isClient; + } + + @Override + public void writeMessageBegin(TMessage message) throws TException { + if (this.isClient) { Review Comment: The code this replaces used the same protocol for both clients and servers. I'm not 100% sure when writeMessageBegin gets called, but I think it's probably fine to do it on every message, and not discriminate based on client and server. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
