fix(offlinegate): fix data race in offlinegate EE-2713 (#6626)

api/http/offlinegate/offlinegate.go

@@ -3,69 +3,48 @@ package offlinegate
 import (
 	"log"
 	"net/http"
-	"sync"
+	"strings"
 	"time"
 
 	httperror "github.com/portainer/libhttp/error"
+	lock "github.com/viney-shih/go-lock"
 )
 
-// OfflineGate is a entity that works similar to a mutex with a signaling
-// Only the caller that have Locked an gate can unlock it, otherw will be blocked with a call to Lock.
+// OfflineGate is an entity that works similar to a mutex with signaling
+// Only the caller that has Locked a gate can unlock it, otherwise it will be blocked with a call to Lock.
 // Gate provides a passthrough http middleware that will wait for a locked gate to be unlocked.
-// For a safety reasons, middleware will timeout
+// For safety reasons, the middleware will timeout
 type OfflineGate struct {
-	lock        *sync.Mutex
-	signalingCh chan interface{}
+	lock *lock.CASMutex
 }
 
 // NewOfflineGate creates a new gate
 func NewOfflineGate() *OfflineGate {
 	return &OfflineGate{
-		lock: &sync.Mutex{},
+		lock: lock.NewCASMutex(),
 	}
 }
 
 // Lock locks readonly gate and returns a function to unlock
 func (o *OfflineGate) Lock() func() {
 	o.lock.Lock()
-	o.signalingCh = make(chan interface{})
-	return o.unlock
-}
-
-func (o *OfflineGate) unlock() {
-	if o.signalingCh == nil {
-		return
-	}
-
-	close(o.signalingCh)
-	o.signalingCh = nil
-	o.lock.Unlock()
-}
-
-// Watch returns a signaling channel.
-// Unless channel is nil, client needs to watch for a signal on a channel to know when gate is unlocked.
-// Signal channel is disposable: onced signaled, has to be disposed and acquired again.
-func (o *OfflineGate) Watch() chan interface{} {
-	return o.signalingCh
+	return o.lock.Unlock
 }
 
 // WaitingMiddleware returns an http handler that waits for the gate to be unlocked before continuing
 func (o *OfflineGate) WaitingMiddleware(timeout time.Duration, next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		signalingCh := o.Watch()
-
-		if signalingCh != nil {
-			if r.Method != "GET" && r.Method != "HEAD" && r.Method != "OPTIONS" {
-				select {
-				case <-signalingCh:
-				case <-time.After(timeout):
-					log.Println("error: Timeout waiting for the offline gate to signal")
-					httperror.WriteError(w, http.StatusRequestTimeout, "Timeout waiting for the offline gate to signal", http.ErrHandlerTimeout)
-				}
-			}
+		if r.Method == "GET" || r.Method == "HEAD" || r.Method == "OPTIONS" || strings.HasPrefix(r.URL.Path, "/api/backup") || strings.HasPrefix(r.URL.Path, "/api/restore") {
+			next.ServeHTTP(w, r)
+			return
 		}
 
+		if !o.lock.RTryLockWithTimeout(timeout) {
+			log.Println("error: Timeout waiting for the offline gate to signal")
+			httperror.WriteError(w, http.StatusRequestTimeout, "Timeout waiting for the offline gate to signal", http.ErrHandlerTimeout)
+			return
+		}
 		next.ServeHTTP(w, r)
-
+		o.lock.RUnlock()
 	})
 }

api/http/offlinegate/offlinegate_test.go

@@ -58,77 +58,6 @@ func Test_hasToBeUnlockedToLockAgain(t *testing.T) {
 
 }
 
-func Test_waitChannelWillBeEmpty_ifGateIsUnlocked(t *testing.T) {
-	o := NewOfflineGate()
-
-	signalingCh := o.Watch()
-	if signalingCh != nil {
-		t.Error("Signaling channel should be empty")
-	}
-}
-
-func Test_startWaitingForSignal_beforeGateGetsUnlocked(t *testing.T) {
-	// scenario:
-	// 1. main routing locks the gate and waits for a consumer to start up
-	// 2. consumer starts up, notifies main and begins waiting for the gate to be unlocked
-	// 3. main unlocks the gate
-	// 4. consumer be able to continue
-
-	o := NewOfflineGate()
-	unlock := o.Lock()
-
-	signalingCh := o.Watch()
-
-	wg := sync.WaitGroup{}
-	wg.Add(1)
-	readerIsReady := sync.WaitGroup{}
-	readerIsReady.Add(1)
-
-	go func(t *testing.T) {
-		readerIsReady.Done()
-
-		// either wait for a signal or timeout
-		select {
-		case <-signalingCh:
-		case <-time.After(10 * time.Second):
-			t.Error("Failed to wait for a signal, exit by timeout")
-		}
-		wg.Done()
-	}(t)
-
-	readerIsReady.Wait()
-	unlock()
-
-	wg.Wait()
-}
-
-func Test_startWaitingForSignal_afterGateGetsUnlocked(t *testing.T) {
-	// scenario:
-	// 1. main routing locks, gets waiting channel and unlocks
-	// 2. consumer starts up and begins waiting for the gate to be unlocked
-	// 3. consumer gets signal immediately and continues
-
-	o := NewOfflineGate()
-	unlock := o.Lock()
-	signalingCh := o.Watch()
-	unlock()
-
-	wg := sync.WaitGroup{}
-	wg.Add(1)
-
-	go func(t *testing.T) {
-		// either wait for a signal or timeout
-		select {
-		case <-signalingCh:
-		case <-time.After(10 * time.Second):
-			t.Error("Failed to wait for a signal, exit by timeout")
-		}
-		wg.Done()
-	}(t)
-
-	wg.Wait()
-}
-
 func Test_waitingMiddleware_executesImmediately_whenNotLocked(t *testing.T) {
 	// scenario:
 	// 1. create an gate