sessions: add OnDestroy event, relative to: #969

sessions/provider.go

@@ -12,9 +12,10 @@ type (
 		// we don't use RWMutex because all actions have read and write at the same action function.
 		// (or write to a *Session's value which is race if we don't lock)
 		// narrow locks are fasters but are useless here.
-		mu       sync.Mutex
-		sessions map[string]*Session
-		db       Database
+		mu               sync.Mutex
+		sessions         map[string]*Session
+		db               Database
+		destroyListeners []DestroyListener
 	}
 )
 
@@ -108,6 +109,19 @@ func (p *provider) Read(sid string, expires time.Duration) *Session {
 	return p.Init(sid, expires) // if not found create new
 }
 
+func (p *provider) registerDestroyListener(ln DestroyListener) {
+	if ln == nil {
+		return
+	}
+	p.destroyListeners = append(p.destroyListeners, ln)
+}
+
+func (p *provider) fireDestroy(sid string) {
+	for _, ln := range p.destroyListeners {
+		ln(sid)
+	}
+}
+
 // Destroy destroys the session, removes all sessions and flash values,
 // the session itself and updates the registered session databases,
 // this called from sessionManager which removes the client's cookie also.
@@ -131,6 +145,9 @@ func (p *provider) DestroyAll() {
 }
 
 func (p *provider) deleteSession(sess *Session) {
-	delete(p.sessions, sess.sid)
-	p.db.Release(sess.sid)
+	sid := sess.sid
+
+	delete(p.sessions, sid)
+	p.db.Release(sid)
+	p.fireDestroy(sid)
 }

sessions/sessions.go

@@ -107,6 +107,20 @@ func (s *Sessions) UpdateExpiration(ctx context.Context, expires time.Duration)
 	}
 }
 
+// DestroyListener is the form of a destroy listener.
+// Look `OnDestroy` for more.
+type DestroyListener func(sid string)
+
+// OnDestroy registers one or more destroy listeners.
+// A destroy listener is fired when a session has been removed entirely from the server (the entry) and client-side (the cookie).
+// Note that if a destroy listener is blocking, then the session manager will delay respectfully,
+// use a goroutine inside the listener to avoid that behavior.
+func (s *Sessions) OnDestroy(listeners ...DestroyListener) {
+	for _, ln := range listeners {
+		s.provider.registerDestroyListener(ln)
+	}
+}
+
 // Destroy remove the session data and remove the associated cookie.
 func (s *Sessions) Destroy(ctx context.Context) {
 	cookieValue := GetCookie(ctx, s.config.Cookie)