Merge branch 'release/1.3.1'

CHANGELOG.md

@@ -4,6 +4,14 @@ Change Log
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [v1.3.1] - 2018-03-10
+
+### Fixed
+
+- Adding additional locking during message delivery to prevent race condition
+  that could lose messages.
+
+
 ## [v1.3.0] - 2018-02-28
 
 ### Added
@@ -13,6 +21,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 - Reverse message display sort order in the UI; now newest first.
 
+
 ## [v1.2.0] - 2017-12-27
 
 ### Changed
@@ -31,6 +40,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
   types
 - Fixed panic when `monitor.history` set to 0
 
+
 ## [v1.2.0-rc1] - 2017-01-29
 
 ### Added
@@ -57,6 +67,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Allow increased local-part length of 128 chars for Mailgun
 - RedHat and Ubuntu now use systemd instead of legacy init systems
 
+
 ## [v1.1.0] - 2016-09-03
 
 ### Added
@@ -65,6 +76,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Fixed
 - Log and continue when unable to delete oldest message during cap enforcement
 
+
 ## [v1.1.0-rc2] - 2016-03-06
 
 ### Added
@@ -75,6 +87,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Shutdown hang in retention scanner
 - Display empty subject as `(No Subject)`
 
+
 ## [v1.1.0-rc1] - 2016-03-04
 
 ### Added
@@ -89,6 +102,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - RESTful API moved to `/api/v1` base URI
 - More graceful shutdown on Ctrl-C or when errors encountered
 
+
 ## [v1.0] - 2014-04-14
 
 ### Added
@@ -98,6 +112,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
   specific message.
 
 [Unreleased]:  https://github.com/jhillyerd/inbucket/compare/master...develop
+[v1.3.1]:      https://github.com/jhillyerd/inbucket/compare/v1.3.0...v1.3.1
 [v1.3.0]:      https://github.com/jhillyerd/inbucket/compare/v1.2.0...v1.3.0
 [v1.2.0]:      https://github.com/jhillyerd/inbucket/compare/1.2.0-rc2...1.2.0
 [v1.2.0-rc2]:  https://github.com/jhillyerd/inbucket/compare/1.2.0-rc1...1.2.0-rc2

datastore/datastore.go

@@ -5,6 +5,7 @@ import (
 	"errors"
 	"io"
 	"net/mail"
+	"sync"
 	"time"
 
 	"github.com/jhillyerd/enmime"
@@ -22,6 +23,8 @@ var (
 type DataStore interface {
 	MailboxFor(emailAddress string) (Mailbox, error)
 	AllMailboxes() ([]Mailbox, error)
+	// LockFor is a temporary hack to fix #77 until Datastore revamp
+	LockFor(emailAddress string) (*sync.RWMutex, error)
 }
 
 // Mailbox is an interface to get and manipulate messages in a DataStore

datastore/lock.go

@@ -0,0 +1,19 @@
+package datastore
+
+import (
+	"strconv"
+	"sync"
+)
+
+type HashLock [4096]sync.RWMutex
+
+func (h *HashLock) Get(hash string) *sync.RWMutex {
+	if len(hash) < 3 {
+		return nil
+	}
+	i, err := strconv.ParseInt(hash[0:3], 16, 0)
+	if err != nil {
+		return nil
+	}
+	return &h[i]
+}

datastore/lock_test.go

@@ -0,0 +1,61 @@
+package datastore_test
+
+import (
+	"testing"
+
+	"github.com/jhillyerd/inbucket/datastore"
+)
+
+func TestHashLock(t *testing.T) {
+	hl := &datastore.HashLock{}
+
+	// Invalid hashes
+	testCases := []struct {
+		name, input string
+	}{
+		{"empty", ""},
+		{"short", "a0"},
+		{"badhex", "zzzzzzzzzzzzzzzzzzzzzzz"},
+	}
+	for _, tc := range testCases {
+		t.Run(tc.input, func(t *testing.T) {
+			l := hl.Get(tc.input)
+			if l != nil {
+				t.Errorf("Expected nil lock for %s %q, got %v", tc.name, tc.input, l)
+			}
+		})
+	}
+
+	// Valid hashes
+	testStrings := []string{
+		"deadbeef",
+		"00000000",
+		"ffffffff",
+	}
+	for _, ts := range testStrings {
+		t.Run(ts, func(t *testing.T) {
+			l := hl.Get(ts)
+			if l == nil {
+				t.Errorf("Expeced non-nil lock for hex string %q", ts)
+			}
+		})
+	}
+
+	a := hl.Get("deadbeef")
+	b := hl.Get("deadbeef")
+	if a != b {
+		t.Errorf("Expected identical locks for identical hashes, got: %p != %p", a, b)
+	}
+
+	a = hl.Get("deadbeef")
+	b = hl.Get("d3adb33f")
+	if a == b {
+		t.Errorf("Expected different locks for different hashes, got: %p == %p", a, b)
+	}
+
+	a = hl.Get("deadbeef")
+	b = hl.Get("deadb33f")
+	if a != b {
+		t.Errorf("Expected identical locks for identical leading hashes, got: %p != %p", a, b)
+	}
+}

datastore/testing.go

@@ -3,6 +3,7 @@ package datastore
 import (
 	"io"
 	"net/mail"
+	"sync"
 	"time"
 
 	"github.com/jhillyerd/enmime"
@@ -26,6 +27,10 @@ func (m *MockDataStore) AllMailboxes() ([]Mailbox, error) {
 	return args.Get(0).([]Mailbox), args.Error(1)
 }
 
+func (m *MockDataStore) LockFor(name string) (*sync.RWMutex, error) {
+	return &sync.RWMutex{}, nil
+}
+
 // MockMailbox is a shared mock for unit testing
 type MockMailbox struct {
 	mock.Mock

filestore/fstore.go

@@ -51,6 +51,7 @@ func countGenerator(c chan int) {
 // FileDataStore implements DataStore aand is the root of the mail storage
 // hiearchy.  It provides access to Mailbox objects
 type FileDataStore struct {
+	hashLock   datastore.HashLock
 	path       string
 	mailPath   string
 	messageCap int
@@ -139,6 +140,15 @@ func (ds *FileDataStore) AllMailboxes() ([]datastore.Mailbox, error) {
 	return mailboxes, nil
 }
 
+func (ds *FileDataStore) LockFor(emailAddress string) (*sync.RWMutex, error) {
+	name, err := stringutil.ParseMailboxName(emailAddress)
+	if err != nil {
+		return nil, err
+	}
+	hash := stringutil.HashMailboxName(name)
+	return ds.hashLock.Get(hash), nil
+}
+
 // FileMailbox implements Mailbox, manages the mail for a specific user and
 // correlates to a particular directory on disk.
 type FileMailbox struct {

smtpd/handler.go

@@ -402,7 +402,19 @@ func (ss *Session) dataHandler() {
 			if ss.server.storeMessages {
 				// Create a message for each valid recipient
 				for _, r := range recipients {
-					if ok := ss.deliverMessage(r, msgBuf); ok {
+					// TODO temporary hack to fix #77 until datastore revamp
+					mu, err := ss.server.dataStore.LockFor(r.localPart)
+					if err != nil {
+						ss.logError("Failed to get lock for %q: %s", r.localPart, err)
+						// Delivery failure
+						ss.send(fmt.Sprintf("451 Failed to store message for %v", r.localPart))
+						ss.reset()
+						return
+					}
+					mu.Lock()
+					ok := ss.deliverMessage(r, msgBuf)
+					mu.Unlock()
+					if ok {
 						expReceivedTotal.Add(1)
 					} else {
 						// Delivery failure