-
Notifications
You must be signed in to change notification settings - Fork 390
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(plc4go/spi): split up request transaction into separate file
- Loading branch information
Showing
5 changed files
with
501 additions
and
401 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| /* | ||
| * 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 ( | ||
| "context" | ||
| "fmt" | ||
| "github.com/apache/plc4x/plc4go/spi/pool" | ||
| "github.com/pkg/errors" | ||
| "github.com/rs/zerolog" | ||
| "github.com/rs/zerolog/log" | ||
| "sync" | ||
| "time" | ||
| ) | ||
|
|
||
| // RequestTransaction represents a transaction | ||
| type RequestTransaction interface { | ||
| fmt.Stringer | ||
| // FailRequest signals that this transaction has failed | ||
| FailRequest(err error) error | ||
| // EndRequest signals that this transaction is done | ||
| EndRequest() error | ||
| // Submit submits a RequestTransactionRunnable to the RequestTransactionManager | ||
| Submit(operation RequestTransactionRunnable) | ||
| // AwaitCompletion wait for this RequestTransaction to finish. Returns an error if it finished unsuccessful | ||
| AwaitCompletion(ctx context.Context) error | ||
| // IsCompleted indicates that the that this RequestTransaction is completed | ||
| IsCompleted() bool | ||
| } | ||
|
|
||
| /////////////////////////////////////// | ||
| /////////////////////////////////////// | ||
| // | ||
| // Internal section | ||
| // | ||
|
|
||
| type requestTransaction struct { | ||
| parent *requestTransactionManager | ||
| transactionId int32 | ||
|
|
||
| /** The initial operation to perform to kick off the request */ | ||
| operation pool.Runnable | ||
| completionFuture pool.CompletionFuture | ||
|
|
||
| stateChangeMutex sync.Mutex | ||
| completed bool | ||
|
|
||
| transactionLog zerolog.Logger | ||
| } | ||
|
|
||
| // | ||
| // Internal section | ||
| // | ||
| /////////////////////////////////////// | ||
| /////////////////////////////////////// | ||
|
|
||
| func (t *requestTransaction) FailRequest(err error) error { | ||
| t.stateChangeMutex.Lock() | ||
| defer t.stateChangeMutex.Unlock() | ||
| if t.completed { | ||
| return errors.Wrap(err, "calling fail on a already completed transaction") | ||
| } | ||
| t.transactionLog.Trace().Msg("Fail the request") | ||
| t.completed = true | ||
| return t.parent.failRequest(t, err) | ||
| } | ||
|
|
||
| func (t *requestTransaction) EndRequest() error { | ||
| t.stateChangeMutex.Lock() | ||
| defer t.stateChangeMutex.Unlock() | ||
| if t.completed { | ||
| return errors.New("calling end on a already completed transaction") | ||
| } | ||
| t.transactionLog.Trace().Msg("Ending the request") | ||
| t.completed = true | ||
| // Remove it from Running Requests | ||
| return t.parent.endRequest(t) | ||
| } | ||
|
|
||
| func (t *requestTransaction) Submit(operation RequestTransactionRunnable) { | ||
| t.stateChangeMutex.Lock() | ||
| defer t.stateChangeMutex.Unlock() | ||
| if t.completed { | ||
| t.transactionLog.Warn().Msg("calling submit on a already completed transaction") | ||
| return | ||
| } | ||
| if t.operation != nil { | ||
| t.transactionLog.Warn().Msg("Operation already set") | ||
| } | ||
| t.transactionLog.Trace().Msgf("Submission of transaction %d", t.transactionId) | ||
| t.operation = func() { | ||
| t.transactionLog.Trace().Msgf("Start execution of transaction %d", t.transactionId) | ||
| operation(t) | ||
| t.transactionLog.Trace().Msgf("Completed execution of transaction %d", t.transactionId) | ||
| } | ||
| t.parent.submitTransaction(t) | ||
| } | ||
|
|
||
| func (t *requestTransaction) AwaitCompletion(ctx context.Context) error { | ||
| timeout, cancelFunc := context.WithTimeout(ctx, time.Minute*30) // This is intentionally set very high | ||
| defer cancelFunc() | ||
| for t.completionFuture == nil { | ||
| time.Sleep(time.Millisecond * 10) | ||
| if err := timeout.Err(); err != nil { | ||
| log.Error().Msg("Timout after a long time. This means something is very of here") | ||
| return errors.Wrap(err, "Error waiting for completion future to be set") | ||
| } | ||
| } | ||
| if err := t.completionFuture.AwaitCompletion(ctx); err != nil { | ||
| return err | ||
| } | ||
| stillActive := true | ||
| for stillActive { | ||
| stillActive = false | ||
| for _, runningRequest := range t.parent.runningRequests { | ||
| if runningRequest.transactionId == t.transactionId { | ||
| stillActive = true | ||
| break | ||
| } | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (t *requestTransaction) IsCompleted() bool { | ||
| return t.completed | ||
| } | ||
|
|
||
| func (t *requestTransaction) String() string { | ||
| return fmt.Sprintf("Transaction{tid:%d}", t.transactionId) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.