refactor(plc4go/spi): move transaction manager to own package

apache · May 31, 2023 · 09147a8 · 09147a8
1 parent 4389991
commit 09147a8
Show file tree

Hide file tree

Showing 8 changed files with 182 additions and 19 deletions.
diff --git a/plc4go/spi/RequestTransactionManager.go → ...transactions/RequestTransactionManager.go b/plc4go/spi/RequestTransactionManager.go → ...transactions/RequestTransactionManager.go
@@ -17,7 +17,7 @@
  * under the License.
  */
 
-package spi
+package transactions
 
 import (
 	"container/list"
@@ -42,7 +42,7 @@ func init() {
 	sharedExecutorInstance.Start()
 }
 
-type RequestTransactionRunnable func(transaction RequestTransaction)
+type RequestTransactionRunnable func(RequestTransaction)
 
 // RequestTransaction represents a transaction
 type RequestTransaction interface {
@@ -107,7 +107,7 @@ type requestTransaction struct {
 
 type requestTransactionManager struct {
 	runningRequests []*requestTransaction
-	// How many Transactions are allowed to run at the same time?
+	// How many transactions are allowed to run at the same time?
 	numberOfConcurrentRequests int
 	// Assigns each request a Unique Transaction Id, especially important for failure handling
 	transactionId    int32
@@ -139,12 +139,12 @@ func (r *requestTransactionManager) SetNumberOfConcurrentRequests(numberOfConcur
 }
 
 func (r *requestTransactionManager) submitTransaction(transaction *requestTransaction) {
-	// Add this Request with this transaction i the Worklog
-	// Put Transaction into Worklog
+	// Add this Request with the transaction i the work log
+	// Put Transaction into work log
 	r.workLogMutex.Lock()
 	r.workLog.PushFront(transaction)
 	r.workLogMutex.Unlock()
-	// Try to Process the Worklog
+	// Try to Process the work log
 	r.processWorklog()
 }
 

diff --git a/plc4go/spi/RequestTransactionManager_test.go → ...actions/RequestTransactionManager_test.go b/plc4go/spi/RequestTransactionManager_test.go → ...actions/RequestTransactionManager_test.go
@@ -17,7 +17,7 @@
  * under the License.
  */
 
-package spi
+package transactions
 
 import (
 	"container/list"
@@ -443,7 +443,7 @@ func Test_requestTransaction_AwaitCompletion(t1 *testing.T) {
 							r := &requestTransaction{}
 							go func() {
 								time.Sleep(100 * time.Millisecond)
-								// We fake a ending transaction like that
+								// We fake an ending transaction like that
 								r.transactionId = 1
 							}()
 							return r

diff --git a/plc4go/spi/transactions/mock_CompletionFuture_test.go b/plc4go/spi/transactions/mock_CompletionFuture_test.go
diff --git a/...k_RequestTransactionManagerOption_test.go → ...k_RequestTransactionManagerOption_test.go b/...k_RequestTransactionManagerOption_test.go → ...k_RequestTransactionManagerOption_test.go
diff --git a/...pi/mock_RequestTransactionManager_test.go → ...ns/mock_RequestTransactionManager_test.go b/...pi/mock_RequestTransactionManager_test.go → ...ns/mock_RequestTransactionManager_test.go
diff --git a/...i/mock_RequestTransactionRunnable_test.go → ...s/mock_RequestTransactionRunnable_test.go b/...i/mock_RequestTransactionRunnable_test.go → ...s/mock_RequestTransactionRunnable_test.go
diff --git a/plc4go/spi/mock_RequestTransaction_test.go → ...nsactions/mock_RequestTransaction_test.go b/plc4go/spi/mock_RequestTransaction_test.go → ...nsactions/mock_RequestTransaction_test.go
diff --git a/plc4go/spi/transactions/mock_requirements.go b/plc4go/spi/transactions/mock_requirements.go
@@ -0,0 +1,31 @@
+/*
+ * 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 transactions
+
+import (
+	"github.com/apache/plc4x/plc4go/spi/utils"
+)
+
+// Note this file is a Helper for mockery to generate use mocks from other package
+
+// Deprecated: don't use it in productive code
+type CompletionFuture interface {
+	utils.CompletionFuture
+}