Class: Kafka::TransactionManager

Inherits:
Object
  • Object
show all
Defined in:
lib/kafka/transaction_manager.rb

Constant Summary collapse

DEFAULT_TRANSACTION_TIMEOUT =

60 seconds

60
TRANSACTION_RESULT_COMMIT =
true
TRANSACTION_RESULT_ABORT =
false

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cluster:, logger:, idempotent: false, transactional: false, transactional_id: nil, transactional_timeout: DEFAULT_TRANSACTION_TIMEOUT) ⇒ TransactionManager

Returns a new instance of TransactionManager


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
# File 'lib/kafka/transaction_manager.rb', line 13

def initialize(
  cluster:,
  logger:,
  idempotent: false,
  transactional: false,
  transactional_id: nil,
  transactional_timeout: DEFAULT_TRANSACTION_TIMEOUT
)
  @cluster = cluster
  @logger = TaggedLogger.new(logger)

  @transactional = transactional
  @transactional_id = transactional_id
  @transactional_timeout = transactional_timeout
  @transaction_state = Kafka::TransactionStateMachine.new(logger: logger)
  @transaction_partitions = {}

  # If transactional mode is enabled, idempotent must be enabled
  @idempotent = transactional || idempotent

  @producer_id = -1
  @producer_epoch = 0

  @sequences = {}
end

Instance Attribute Details

#producer_epochObject (readonly)

Returns the value of attribute producer_epoch


11
12
13
# File 'lib/kafka/transaction_manager.rb', line 11

def producer_epoch
  @producer_epoch
end

#producer_idObject (readonly)

Returns the value of attribute producer_id


11
12
13
# File 'lib/kafka/transaction_manager.rb', line 11

def producer_id
  @producer_id
end

#transactional_idObject (readonly)

Returns the value of attribute transactional_id


11
12
13
# File 'lib/kafka/transaction_manager.rb', line 11

def transactional_id
  @transactional_id
end

Instance Method Details

#abort_transactionObject


186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
# File 'lib/kafka/transaction_manager.rb', line 186

def abort_transaction
  force_transactional!

  if @transaction_state.aborting_transaction?
    @logger.warn("Transaction is being aborted")
    return
  end

  unless @transaction_state.in_transaction?
    raise 'Transaction is not valid to abort'
  end

  @transaction_state.transition_to!(TransactionStateMachine::ABORTING_TRANSACTION)

  @logger.info "Aborting transaction #{@transactional_id}, Producer ID: #{@producer_id} (Epoch #{@producer_epoch})"

  response = transaction_coordinator.end_txn(
    transactional_id: @transactional_id,
    producer_id: @producer_id,
    producer_epoch: @producer_epoch,
    transaction_result: TRANSACTION_RESULT_ABORT
  )
  Protocol.handle_error(response.error_code)

  @logger.info "Transaction #{@transactional_id} is aborted, Producer ID: #{@producer_id} (Epoch #{@producer_epoch})"

  complete_transaction

  nil
rescue
  @transaction_state.transition_to!(TransactionStateMachine::ERROR)
  raise
end

#add_partitions_to_transaction(topic_partitions) ⇒ Object


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
# File 'lib/kafka/transaction_manager.rb', line 94

def add_partitions_to_transaction(topic_partitions)
  force_transactional!

  if @transaction_state.uninitialized?
    raise 'Transaction is uninitialized'
  end

  # Extract newly created partitions
  new_topic_partitions = {}
  topic_partitions.each do |topic, partitions|
    partitions.each do |partition|
      @transaction_partitions[topic] ||= {}
      if !@transaction_partitions[topic][partition]
        new_topic_partitions[topic] ||= []
        new_topic_partitions[topic] << partition

        @logger.info "Adding parition #{topic}/#{partition}  to transaction #{@transactional_id}, Producer ID: #{@producer_id} (Epoch #{@producer_epoch})"
      end
    end
  end

  unless new_topic_partitions.empty?
    response = transaction_coordinator.add_partitions_to_txn(
      transactional_id: @transactional_id,
      producer_id: @producer_id,
      producer_epoch: @producer_epoch,
      topics: new_topic_partitions
    )

    # Update added topic partitions
    response.errors.each do |tp|
      tp.partitions.each do |p|
        Protocol.handle_error(p.error_code)
        @transaction_partitions[tp.topic] ||= {}
        @transaction_partitions[tp.topic][p.partition] = true
      end
    end
  end

  nil
rescue
  @transaction_state.transition_to!(TransactionStateMachine::ERROR)
  raise
end

#begin_transactionObject


139
140
141
142
143
144
145
146
147
148
149
150
151
# File 'lib/kafka/transaction_manager.rb', line 139

def begin_transaction
  force_transactional!
  raise 'Transaction has already started' if @transaction_state.in_transaction?
  raise 'Transaction is not ready' unless @transaction_state.ready?
  @transaction_state.transition_to!(TransactionStateMachine::IN_TRANSACTION)

  @logger.info "Begin transaction #{@transactional_id}, Producer ID: #{@producer_id} (Epoch #{@producer_epoch})"

  nil
rescue
  @transaction_state.transition_to!(TransactionStateMachine::ERROR)
  raise
end

#closeObject


253
254
255
256
257
258
259
260
261
# File 'lib/kafka/transaction_manager.rb', line 253

def close
  if in_transaction?
    @logger.warn("Aborting pending transaction ...")
    abort_transaction
  elsif @transaction_state.aborting_transaction? || @transaction_state.committing_transaction?
    @logger.warn("Transaction is finishing. Sleeping until finish!")
    sleep 5
  end
end

#commit_transactionObject


153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/kafka/transaction_manager.rb', line 153

def commit_transaction
  force_transactional!

  if @transaction_state.committing_transaction?
    @logger.warn("Transaction is being committed")
    return
  end

  unless @transaction_state.in_transaction?
    raise 'Transaction is not valid to commit'
  end

  @transaction_state.transition_to!(TransactionStateMachine::COMMITTING_TRANSACTION)

  @logger.info "Commiting transaction #{@transactional_id}, Producer ID: #{@producer_id} (Epoch #{@producer_epoch})"

  response = transaction_coordinator.end_txn(
    transactional_id: @transactional_id,
    producer_id: @producer_id,
    producer_epoch: @producer_epoch,
    transaction_result: TRANSACTION_RESULT_COMMIT
  )
  Protocol.handle_error(response.error_code)

  @logger.info "Transaction #{@transactional_id} is committed, Producer ID: #{@producer_id} (Epoch #{@producer_epoch})"
  complete_transaction

  nil
rescue
  @transaction_state.transition_to!(TransactionStateMachine::ERROR)
  raise
end

#error?Boolean

Returns:

  • (Boolean)

249
250
251
# File 'lib/kafka/transaction_manager.rb', line 249

def error?
  @transaction_state.error?
end

#idempotent?Boolean

Returns:

  • (Boolean)

39
40
41
# File 'lib/kafka/transaction_manager.rb', line 39

def idempotent?
  @idempotent == true
end

#in_transaction?Boolean

Returns:

  • (Boolean)

245
246
247
# File 'lib/kafka/transaction_manager.rb', line 245

def in_transaction?
  @transaction_state.in_transaction?
end

#init_producer_id(force = false) ⇒ Object


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/kafka/transaction_manager.rb', line 47

def init_producer_id(force = false)
  return if @producer_id >= 0 && !force

  response = transaction_coordinator.init_producer_id(
    transactional_id: @transactional_id,
    transactional_timeout: @transactional_timeout
  )
  Protocol.handle_error(response.error_code)

  # Reset producer id
  @producer_id = response.producer_id
  @producer_epoch = response.producer_epoch

  # Reset sequence
  @sequences = {}

  @logger.debug "Current Producer ID is #{@producer_id} and Producer Epoch is #{@producer_epoch}"
end

#init_transactionsObject


76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/kafka/transaction_manager.rb', line 76

def init_transactions
  force_transactional!
  unless @transaction_state.uninitialized?
    @logger.warn("Transaction already initialized!")
    return
  end
  init_producer_id(true)
  @transaction_partitions = {}
  @transaction_state.transition_to!(TransactionStateMachine::READY)

  @logger.info "Transaction #{@transactional_id} is initialized, Producer ID: #{@producer_id} (Epoch #{@producer_epoch})"

  nil
rescue
  @transaction_state.transition_to!(TransactionStateMachine::ERROR)
  raise
end

#next_sequence_for(topic, partition) ⇒ Object


66
67
68
69
# File 'lib/kafka/transaction_manager.rb', line 66

def next_sequence_for(topic, partition)
  @sequences[topic] ||= {}
  @sequences[topic][partition] ||= 0
end

#send_offsets_to_txn(offsets:, group_id:) ⇒ Object


220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'lib/kafka/transaction_manager.rb', line 220

def send_offsets_to_txn(offsets:, group_id:)
  force_transactional!

  unless @transaction_state.in_transaction?
    raise 'Transaction is not valid to send offsets'
  end

  add_response = transaction_coordinator.add_offsets_to_txn(
    transactional_id: @transactional_id,
    producer_id: @producer_id,
    producer_epoch: @producer_epoch,
    group_id: group_id
  )
  Protocol.handle_error(add_response.error_code)

  send_response = transaction_coordinator.txn_offset_commit(
    transactional_id: @transactional_id,
    group_id: group_id,
    producer_id: @producer_id,
    producer_epoch: @producer_epoch,
    offsets: offsets
  )
  Protocol.handle_error(send_response.error_code)
end

#transactional?Boolean

Returns:

  • (Boolean)

43
44
45
# File 'lib/kafka/transaction_manager.rb', line 43

def transactional?
  @transactional == true && !@transactional_id.nil?
end

#update_sequence_for(topic, partition, sequence) ⇒ Object


71
72
73
74
# File 'lib/kafka/transaction_manager.rb', line 71

def update_sequence_for(topic, partition, sequence)
  @sequences[topic] ||= {}
  @sequences[topic][partition] = sequence
end