shibd commented on code in PR #953: URL: https://github.com/apache/pulsar-client-go/pull/953#discussion_r1112724648
########## pulsar/transactionCoordinatorClient.go: ########## @@ -0,0 +1,222 @@ +// 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 +// +// http://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 pulsar + +import ( + "context" + "strconv" + "sync/atomic" + "time" + + "github.com/apache/pulsar-client-go/pulsar/internal" + pb "github.com/apache/pulsar-client-go/pulsar/internal/pulsar_proto" + "github.com/apache/pulsar-client-go/pulsar/log" + "google.golang.org/protobuf/proto" +) + +type transactionCoordinatorClient struct { + client *client + cons []internal.Connection + epoch uint64 + semaphore internal.Semaphore + blockIfReachMaxPendingOps bool + //The number of transactionImpl coordinators + tcNum uint64 + log log.Logger +} + +// TransactionCoordinatorAssign is the transaction_impl coordinator topic which is used to look up the broker +// where the TC located. +const TransactionCoordinatorAssign = "persistent://pulsar/system/transaction_coordinator_assign" + +/* +* +Init a transactionImpl coordinator client and acquire connections with all transactionImpl coordinators. +*/ +func newTransactionCoordinatorClientImpl(client *client) *transactionCoordinatorClient { + tc := &transactionCoordinatorClient{ + client: client, + blockIfReachMaxPendingOps: true, + semaphore: internal.NewSemaphore(1000), + } + tc.log = client.log.SubLogger(log.Fields{}) + return tc +} + +func (tc *transactionCoordinatorClient) start() error { + r, err := tc.client.lookupService.GetPartitionedTopicMetadata(TransactionCoordinatorAssign) + if err != nil { + return err + } + tc.tcNum = uint64(r.Partitions) + tc.cons = make([]internal.Connection, tc.tcNum) + + //Get connections with all transaction_impl coordinators which is synchronized + for i := uint64(0); i < tc.tcNum; i++ { + err := tc.grabConn(i) + if err != nil { + return err + } + } + return nil +} + +func (tc *transactionCoordinatorClient) grabConn(partition uint64) error { + lr, err := tc.client.lookupService.Lookup(getTCAssignTopicName(partition)) + if err != nil { + tc.log.WithError(err).Warn("Failed to lookup the transaction_impl " + + "coordinator assign topic [" + strconv.FormatUint(partition, 10) + "]") + return err + } + + requestID := tc.client.rpcClient.NewRequestID() + cmdTCConnect := pb.CommandTcClientConnectRequest{ + RequestId: proto.Uint64(requestID), + TcId: proto.Uint64(partition), + } + + res, err := tc.client.rpcClient.Request(lr.LogicalAddr, lr.PhysicalAddr, requestID, + pb.BaseCommand_TC_CLIENT_CONNECT_REQUEST, &cmdTCConnect) + + if err != nil { + tc.log.WithError(err).Error("Failed to connect transaction_impl coordinator " + + strconv.FormatUint(partition, 10)) + return err + } + tc.cons[partition] = res.Cnx + return nil +} + +func (tc *transactionCoordinatorClient) close() { + for _, con := range tc.cons { + con.Close() + } +} + +/* +* +New a transactionImpl which can be used to guarantee exactly-once semantics. +*/ +func (tc *transactionCoordinatorClient) newTransaction(timeout time.Duration) (TxnID, error) { Review Comment: This method will be changed to return `transaction` object in the future, right? ########## Makefile: ########## @@ -18,7 +18,7 @@ # IMAGE_NAME = pulsar-client-go-test:latest -PULSAR_VERSION ?= 2.8.3 +PULSAR_VERSION ?= 2.10.3 Review Comment: Maybe we need to keep using `latest` version. ########## pulsar/transaction_test.go: ########## @@ -0,0 +1,100 @@ +// 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 +// +// http://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 pulsar + +import ( + pb "github.com/apache/pulsar-client-go/pulsar/internal/pulsar_proto" + "github.com/stretchr/testify/assert" + + "testing" + "time" +) + +func TestTCClient(t *testing.T) { + //1. Prepare: create PulsarClient and init transaction coordinator client. + topic := "my-topic" Review Comment: ```suggestion topic := newTopicName() ``` ########## pulsar/transaction_test.go: ########## @@ -0,0 +1,100 @@ +// 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 +// +// http://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 pulsar + +import ( + pb "github.com/apache/pulsar-client-go/pulsar/internal/pulsar_proto" + "github.com/stretchr/testify/assert" + + "testing" + "time" +) + +func TestTCClient(t *testing.T) { + //1. Prepare: create PulsarClient and init transaction coordinator client. + topic := "my-topic" + sub := "my-sub" + tc, client := createTcClient(t) + //2. Prepare: create Topic and Subscription. + consumer, err := client.Subscribe(ConsumerOptions{ + Topic: topic, + SubscriptionName: sub, + }) + assert.NoError(t, err) + //3. Test newTransaction, addSubscriptionToTxn, addPublishPartitionToTxn + //Create a transaction1 and add subscription and publish topic to the transaction. + id1, err := tc.newTransaction(3 * time.Minute) + assert.NoError(t, err) + err = tc.addSubscriptionToTxn(id1, topic, sub) + assert.NoError(t, err) + err = tc.addPublishPartitionToTxn(id1, []string{topic}) + assert.NoError(t, err) + //4. Verify the transaction1 stats + stats, err := transactionStats(id1) + assert.NoError(t, err) + assert.Equal(t, "OPEN", stats["status"]) + producedPartitions := stats["producedPartitions"].(map[string]interface{}) + ackedPartitions := stats["ackedPartitions"].(map[string]interface{}) + _, ok := producedPartitions[topic] + assert.True(t, ok) + temp, ok := ackedPartitions[topic] + assert.True(t, ok) + subscriptions := temp.(map[string]interface{}) + _, ok = subscriptions[sub] + assert.True(t, ok) + //5. Test End transaction + //Create transaction2 and Commit the transaction. + id2, err := tc.newTransaction(3 * time.Minute) + assert.NoError(t, err) + //6. Verify the transaction2 stats + stats2, err := transactionStats(id2) + assert.NoError(t, err) + assert.Equal(t, "OPEN", stats2["status"]) + err = tc.endTxn(id2, pb.TxnAction_COMMIT) + assert.NoError(t, err) + stats2, err = transactionStats(id2) + //The transaction will be removed from txnMeta. Therefore, it is expected that stats2 is zero + if err == nil { + assert.Equal(t, "COMMITTED", stats2["status"]) + } else { + assert.Equal(t, err.Error(), "http error status code: 404") + } + defer consumer.Close() + defer tc.close() + defer client.Close() +} + +/* +Create a transaction coordinator client to send request +*/ +func createTcClient(t *testing.T) (*transactionCoordinatorClient, *client) { + c, err := NewClient(ClientOptions{ + URL: webServiceURLTLS, Review Comment: Does Transaction have to have TLS enabled? ########## pulsar/transactionCoordinatorClient.go: ########## @@ -0,0 +1,222 @@ +// 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 +// +// http://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 pulsar + +import ( + "context" + "strconv" + "sync/atomic" + "time" + + "github.com/apache/pulsar-client-go/pulsar/internal" + pb "github.com/apache/pulsar-client-go/pulsar/internal/pulsar_proto" + "github.com/apache/pulsar-client-go/pulsar/log" + "google.golang.org/protobuf/proto" +) + +type transactionCoordinatorClient struct { + client *client + cons []internal.Connection + epoch uint64 + semaphore internal.Semaphore + blockIfReachMaxPendingOps bool + //The number of transactionImpl coordinators + tcNum uint64 + log log.Logger +} + +// TransactionCoordinatorAssign is the transaction_impl coordinator topic which is used to look up the broker +// where the TC located. +const TransactionCoordinatorAssign = "persistent://pulsar/system/transaction_coordinator_assign" + +/* +* +Init a transactionImpl coordinator client and acquire connections with all transactionImpl coordinators. +*/ +func newTransactionCoordinatorClientImpl(client *client) *transactionCoordinatorClient { + tc := &transactionCoordinatorClient{ + client: client, + blockIfReachMaxPendingOps: true, + semaphore: internal.NewSemaphore(1000), + } + tc.log = client.log.SubLogger(log.Fields{}) + return tc +} + +func (tc *transactionCoordinatorClient) start() error { + r, err := tc.client.lookupService.GetPartitionedTopicMetadata(TransactionCoordinatorAssign) + if err != nil { + return err + } + tc.tcNum = uint64(r.Partitions) + tc.cons = make([]internal.Connection, tc.tcNum) + + //Get connections with all transaction_impl coordinators which is synchronized + for i := uint64(0); i < tc.tcNum; i++ { + err := tc.grabConn(i) + if err != nil { + return err + } + } + return nil +} + +func (tc *transactionCoordinatorClient) grabConn(partition uint64) error { + lr, err := tc.client.lookupService.Lookup(getTCAssignTopicName(partition)) + if err != nil { + tc.log.WithError(err).Warn("Failed to lookup the transaction_impl " + + "coordinator assign topic [" + strconv.FormatUint(partition, 10) + "]") + return err + } + + requestID := tc.client.rpcClient.NewRequestID() + cmdTCConnect := pb.CommandTcClientConnectRequest{ + RequestId: proto.Uint64(requestID), + TcId: proto.Uint64(partition), + } + + res, err := tc.client.rpcClient.Request(lr.LogicalAddr, lr.PhysicalAddr, requestID, + pb.BaseCommand_TC_CLIENT_CONNECT_REQUEST, &cmdTCConnect) + + if err != nil { + tc.log.WithError(err).Error("Failed to connect transaction_impl coordinator " + + strconv.FormatUint(partition, 10)) + return err + } + tc.cons[partition] = res.Cnx + return nil +} + +func (tc *transactionCoordinatorClient) close() { + for _, con := range tc.cons { + con.Close() + } +} + +/* +* +New a transactionImpl which can be used to guarantee exactly-once semantics. +*/ +func (tc *transactionCoordinatorClient) newTransaction(timeout time.Duration) (TxnID, error) { + err := tc.canSendRequest() + if err != nil { + return TxnID{}, err + } + requestID := tc.client.rpcClient.NewRequestID() + nextTcID := tc.nextTCNumber() + cmdNewTxn := &pb.CommandNewTxn{ + RequestId: proto.Uint64(requestID), + TcId: proto.Uint64(nextTcID), + TxnTtlSeconds: proto.Uint64(uint64(timeout.Milliseconds())), + } + + cnx, err := tc.client.rpcClient.RequestOnCnx(tc.cons[nextTcID], requestID, pb.BaseCommand_NEW_TXN, cmdNewTxn) + if err != nil { + return TxnID{}, err + } + + return TxnID{nextTcID, *cnx.Response.NewTxnResponse.TxnidLeastBits}, nil Review Comment: We better use the `tcId` returned by the broker. ```suggestion return TxnID{*cnx.Response.NewTxnResponse.TxnidMostBits, *cnx.Response.NewTxnResponse.TxnidLeastBits}, nil ``` -- 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]
