Skip to content

Commit 8281025

Browse files
sruehlsruehl
committed
feat(plc4go/spi): add operationInfo to Submit for transaction
1 parent 215605f commit 8281025

File tree

12 files changed

+46
-45
lines changed

12 files changed

+46
-45
lines changed

‎plc4go/internal/bacnetip/Reader.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ func (m *Reader) Read(ctx context.Context, readRequest apiModel.PlcReadRequest)
135135

136136
// Start a new request-transaction (Is ended in the response-handler)
137137
transaction := m.tm.StartTransaction("read")
138-
transaction.Submit(func(transactionContext context.Context, transaction transactions.RequestTransaction) {
138+
transaction.Submit("readOperation", func(transactionContext context.Context, transaction transactions.RequestTransaction) {
139139
ctx, cancel := context.WithCancel(ctx)
140140
context.AfterFunc(transactionContext, cancel)
141141
// Send the over the wire

‎plc4go/internal/cbus/CBusMessageMapper_test.go‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1425,7 +1425,7 @@ func TestMapEncodedReply(t *testing.T) {
14251425
})
14261426
transaction := transactionManager.StartTransaction(t.Name())
14271427
t.Logf("Submitting No-Op to transaction\n%v", transaction)
1428-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
1428+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
14291429
// NO-OP
14301430
})
14311431
args.transaction = transaction
@@ -1502,7 +1502,7 @@ func TestMapEncodedReply(t *testing.T) {
15021502
})
15031503
transaction := transactionManager.StartTransaction(t.Name())
15041504
t.Logf("Submitting No-Op to transaction %v", transaction)
1505-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
1505+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
15061506
// NO-OP
15071507
t.Log("No op-ing")
15081508
})
@@ -1595,7 +1595,7 @@ func TestMapEncodedReply(t *testing.T) {
15951595
assert.NoError(t, transactionManager.Close())
15961596
})
15971597
transaction := transactionManager.StartTransaction(t.Name())
1598-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
1598+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
15991599
// NO-OP
16001600
})
16011601
args.transaction = transaction
@@ -1678,7 +1678,7 @@ func TestMapEncodedReply(t *testing.T) {
16781678
assert.NoError(t, transactionManager.Close())
16791679
})
16801680
transaction := transactionManager.StartTransaction(t.Name())
1681-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
1681+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
16821682
// NO-OP
16831683
})
16841684
args.transaction = transaction
@@ -1744,7 +1744,7 @@ func TestMapEncodedReply(t *testing.T) {
17441744
assert.NoError(t, transactionManager.Close())
17451745
})
17461746
transaction := transactionManager.StartTransaction(t.Name())
1747-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
1747+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
17481748
// NO-OP
17491749
})
17501750
args.transaction = transaction
@@ -1813,7 +1813,7 @@ func TestMapEncodedReply(t *testing.T) {
18131813
assert.NoError(t, transactionManager.Close())
18141814
})
18151815
transaction := transactionManager.StartTransaction(t.Name())
1816-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
1816+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
18171817
// NO-OP
18181818
})
18191819
args.transaction = transaction
@@ -1901,7 +1901,7 @@ func TestMapEncodedReply(t *testing.T) {
19011901
assert.NoError(t, transactionManager.Close())
19021902
})
19031903
transaction := transactionManager.StartTransaction(t.Name())
1904-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
1904+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
19051905
// NO-OP
19061906
})
19071907
args.transaction = transaction
@@ -2007,7 +2007,7 @@ func TestMapEncodedReply(t *testing.T) {
20072007
assert.NoError(t, transactionManager.Close())
20082008
})
20092009
transaction := transactionManager.StartTransaction(t.Name())
2010-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
2010+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
20112011
// NO-OP
20122012
})
20132013
args.transaction = transaction
@@ -2077,7 +2077,7 @@ func TestMapEncodedReply(t *testing.T) {
20772077
assert.NoError(t, transactionManager.Close())
20782078
})
20792079
transaction := transactionManager.StartTransaction(t.Name())
2080-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
2080+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
20812081
// NO-OP
20822082
})
20832083
args.transaction = transaction
@@ -2143,7 +2143,7 @@ func TestMapEncodedReply(t *testing.T) {
21432143
assert.NoError(t, transactionManager.Close())
21442144
})
21452145
transaction := transactionManager.StartTransaction(t.Name())
2146-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
2146+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
21472147
// NO-OP
21482148
})
21492149
args.transaction = transaction
@@ -2209,7 +2209,7 @@ func TestMapEncodedReply(t *testing.T) {
22092209
assert.NoError(t, transactionManager.Close())
22102210
})
22112211
transaction := transactionManager.StartTransaction(t.Name())
2212-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
2212+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
22132213
// NO-OP
22142214
})
22152215
args.transaction = transaction
@@ -2275,7 +2275,7 @@ func TestMapEncodedReply(t *testing.T) {
22752275
assert.NoError(t, transactionManager.Close())
22762276
})
22772277
transaction := transactionManager.StartTransaction(t.Name())
2278-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
2278+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
22792279
// NO-OP
22802280
})
22812281
args.transaction = transaction
@@ -2341,7 +2341,7 @@ func TestMapEncodedReply(t *testing.T) {
23412341
assert.NoError(t, transactionManager.Close())
23422342
})
23432343
transaction := transactionManager.StartTransaction(t.Name())
2344-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
2344+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
23452345
// NO-OP
23462346
})
23472347
args.transaction = transaction
@@ -2427,7 +2427,7 @@ func TestMapEncodedReply(t *testing.T) {
24272427
assert.NoError(t, transactionManager.Close())
24282428
})
24292429
transaction := transactionManager.StartTransaction(t.Name())
2430-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
2430+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
24312431
// NO-OP
24322432
})
24332433
args.transaction = transaction
@@ -2493,7 +2493,7 @@ func TestMapEncodedReply(t *testing.T) {
24932493
assert.NoError(t, transactionManager.Close())
24942494
})
24952495
transaction := transactionManager.StartTransaction(t.Name())
2496-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
2496+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
24972497
// NO-OP
24982498
})
24992499
args.transaction = transaction
@@ -2559,7 +2559,7 @@ func TestMapEncodedReply(t *testing.T) {
25592559
assert.NoError(t, transactionManager.Close())
25602560
})
25612561
transaction := transactionManager.StartTransaction(t.Name())
2562-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
2562+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
25632563
// NO-OP
25642564
})
25652565
args.transaction = transaction
@@ -2625,7 +2625,7 @@ func TestMapEncodedReply(t *testing.T) {
26252625
assert.NoError(t, transactionManager.Close())
26262626
})
26272627
transaction := transactionManager.StartTransaction(t.Name())
2628-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
2628+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
26292629
// NO-OP
26302630
})
26312631
args.transaction = transaction
@@ -2691,7 +2691,7 @@ func TestMapEncodedReply(t *testing.T) {
26912691
assert.NoError(t, transactionManager.Close())
26922692
})
26932693
transaction := transactionManager.StartTransaction(t.Name())
2694-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
2694+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
26952695
// NO-OP
26962696
})
26972697
args.transaction = transaction
@@ -2757,7 +2757,7 @@ func TestMapEncodedReply(t *testing.T) {
27572757
assert.NoError(t, transactionManager.Close())
27582758
})
27592759
transaction := transactionManager.StartTransaction(t.Name())
2760-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
2760+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
27612761
// NO-OP
27622762
})
27632763
args.transaction = transaction
@@ -2839,7 +2839,7 @@ func TestMapEncodedReply(t *testing.T) {
28392839
assert.NoError(t, transactionManager.Close())
28402840
})
28412841
transaction := transactionManager.StartTransaction(t.Name())
2842-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
2842+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
28432843
// NO-OP
28442844
})
28452845
args.transaction = transaction
@@ -2905,7 +2905,7 @@ func TestMapEncodedReply(t *testing.T) {
29052905
assert.NoError(t, transactionManager.Close())
29062906
})
29072907
transaction := transactionManager.StartTransaction(t.Name())
2908-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
2908+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
29092909
// NO-OP
29102910
})
29112911
args.transaction = transaction
@@ -2971,7 +2971,7 @@ func TestMapEncodedReply(t *testing.T) {
29712971
assert.NoError(t, transactionManager.Close())
29722972
})
29732973
transaction := transactionManager.StartTransaction(t.Name())
2974-
transaction.Submit(func(context.Context, transactions.RequestTransaction) {
2974+
transaction.Submit(t.Name(), func(context.Context, transactions.RequestTransaction) {
29752975
// NO-OP
29762976
})
29772977
args.transaction = transaction

‎plc4go/internal/cbus/Reader.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ func (m *Reader) readSync(ctx context.Context, readRequest apiModel.PlcReadReque
127127
func (m *Reader) createMessageTransactionAndWait(ctx context.Context, messageToSend readWriteModel.CBusMessage, addResponseCode func(name string, responseCode apiModel.PlcResponseCode), tagName string, addPlcValue func(name string, plcValue apiValues.PlcValue)) {
128128
// Start a new request-transaction (Is ended in the response-handler)
129129
transaction := m.tm.StartTransaction("read")
130-
transaction.Submit(func(transactionContext context.Context, transaction transactions.RequestTransaction) {
130+
transaction.Submit("readOperation", func(transactionContext context.Context, transaction transactions.RequestTransaction) {
131131
ctx, cancel := context.WithCancel(ctx)
132132
context.AfterFunc(transactionContext, cancel)
133133
m.log.Trace().Interface("transaction", transaction).Msg("Transaction getting handled")

‎plc4go/internal/cbus/Writer.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ func (m *Writer) Write(ctx context.Context, writeRequest apiModel.PlcWriteReques
113113
tagNameCopy := tagName
114114
// Start a new request-transaction (Is ended in the response-handler)
115115
transaction := m.tm.StartTransaction("write")
116-
transaction.Submit(func(transactionContext context.Context, transaction transactions.RequestTransaction) {
116+
transaction.Submit("writeOperation", func(transactionContext context.Context, transaction transactions.RequestTransaction) {
117117
ctx, cancel := context.WithCancel(ctx)
118118
context.AfterFunc(transactionContext, cancel)
119119
// Send the over the wire

‎plc4go/internal/cbus/mocks_test.go‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎plc4go/internal/eip/Reader.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ func (m *Reader) Read(ctx context.Context, readRequest apiModel.PlcReadRequest)
107107
typeIds,
108108
)
109109
transaction := m.tm.StartTransaction("read")
110-
transaction.Submit(func(transactionContext context.Context, transaction transactions.RequestTransaction) {
110+
transaction.Submit("readOperation", func(transactionContext context.Context, transaction transactions.RequestTransaction) {
111111
ctx, cancel := context.WithCancel(ctx)
112112
context.AfterFunc(transactionContext, cancel)
113113
if err := m.messageCodec.SendRequest(ctx, "read", request, func(message spi.Message) bool {

‎plc4go/internal/s7/Reader.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ func (m *Reader) Read(ctx context.Context, readRequest apiModel.PlcReadRequest)
114114
)
115115
// Start a new request-transaction (Is ended in the response-handler)
116116
transaction := m.tm.StartTransaction("read")
117-
transaction.Submit(func(transactionContext context.Context, transaction transactions.RequestTransaction) {
117+
transaction.Submit("readOperation", func(transactionContext context.Context, transaction transactions.RequestTransaction) {
118118
ctx, cancel := context.WithCancel(ctx)
119119
context.AfterFunc(transactionContext, cancel)
120120

‎plc4go/internal/s7/Writer.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ func (m *Writer) Write(ctx context.Context, writeRequest apiModel.PlcWriteReques
107107

108108
// Start a new request-transaction (Is ended in the response-handler)
109109
transaction := m.tm.StartTransaction("write")
110-
transaction.Submit(func(transactionContext context.Context, transaction transactions.RequestTransaction) {
110+
transaction.Submit("writeOperation", func(transactionContext context.Context, transaction transactions.RequestTransaction) {
111111
ctx, cancel := context.WithCancel(ctx)
112112
context.AfterFunc(transactionContext, cancel)
113113
// Send the over the wire

‎plc4go/spi/default/DefaultCodec_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ func TestDefaultExpectation_String(t *testing.T) {
231231
}{
232232
{
233233
name: "string it",
234-
want: "Expectation 00000000-0000-0000-0000-000000000000 (expires at 0001-01-01 00:00:00 +0000 UTC in -2562047h47m16.854775808s)",
234+
want: "Expectation '' 00000000-0000-0000-0000-000000000000 (expires at 0001-01-01 00:00:00 +0000 UTC in -2562047h47m16.854775808s)",
235235
},
236236
}
237237
for _, tt := range tests {

‎plc4go/spi/transactions/RequestTransaction.go‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ type RequestTransaction interface {
4141
// EndRequest signals that this transaction is done
4242
EndRequest() error
4343
// Submit submits a RequestTransactionRunnable to the RequestTransactionManager
44-
Submit(operation RequestTransactionRunnable)
44+
Submit(operationInfo string, operation RequestTransactionRunnable)
4545
// AwaitCompletion wait for this RequestTransaction to finish. Returns an error if it finished unsuccessful
4646
AwaitCompletion(ctx context.Context) error
4747
// IsCompleted indicates that the that this RequestTransaction is completed
@@ -120,7 +120,7 @@ func (t *requestTransaction) EndRequest() error {
120120
return t.parent.endRequest(t)
121121
}
122122

123-
func (t *requestTransaction) Submit(operation RequestTransactionRunnable) {
123+
func (t *requestTransaction) Submit(operationInfo string, operation RequestTransactionRunnable) {
124124
t.stateChangeMutex.Lock()
125125
defer t.stateChangeMutex.Unlock()
126126
if t.completed {
@@ -130,17 +130,17 @@ func (t *requestTransaction) Submit(operation RequestTransactionRunnable) {
130130
if t.operation != nil {
131131
t.log.Warn().Msg("Operation already set")
132132
}
133-
t.log.Trace().Int32("transactionId", t.transactionId).Msg("Submission")
133+
t.log.Trace().Msg("Submission")
134134
t.operation = func(ctx context.Context) {
135-
t.log.Trace().Int32("transactionId", t.transactionId).Msg("Start operation")
135+
t.log.Trace().Str("operationInfo", operationInfo).Msg("Start operation")
136136
operation(ctx, t)
137-
t.log.Trace().Int32("transactionId", t.transactionId).Msg("Completed operation")
137+
t.log.Trace().Str("operationInfo", operationInfo).Msg("Completed operation")
138138
}
139139
t.parent.submitTransaction(t)
140140
}
141141

142142
func (t *requestTransaction) AwaitCompletion(ctx context.Context) error {
143-
t.log.Trace().Int32("transactionId", t.transactionId).Msg("Awaiting completion")
143+
t.log.Trace().Msg("Awaiting completion")
144144
timeout, cancelFunc := context.WithTimeout(ctx, time.Minute*30) // This is intentionally set very high
145145
defer cancelFunc()
146146
for t.getCompletionFuture() == nil {
@@ -151,7 +151,7 @@ func (t *requestTransaction) AwaitCompletion(ctx context.Context) error {
151151
}
152152
}
153153
if err := t.getCompletionFuture().AwaitCompletion(ctx); err != nil {
154-
t.log.Trace().Int32("transactionId", t.transactionId).Msg("Errored")
154+
t.log.Trace().Msg("Errored")
155155
return err
156156
}
157157
stillActive := true
@@ -166,7 +166,7 @@ func (t *requestTransaction) AwaitCompletion(ctx context.Context) error {
166166
}
167167
t.parent.runningRequestMutex.RUnlock()
168168
}
169-
t.log.Trace().Int32("transactionId", t.transactionId).Msg("Completed")
169+
t.log.Trace().Msg("Completed")
170170
return nil
171171
}
172172

0 commit comments

Comments
 (0)