fix FindDocuments bug. was using qap.HeaderCodesEqual

Author: soypat

cmd/boltqap/boltqap.go

@@ -164,7 +164,7 @@ func (q *boltqap) addDoc(doc document) error {
 }
 
 func (q *boltqap) DoProjectDocuments(project string, f func(d document) error) error {
-	return q.db.View(func(tx *bbolt.Tx) error {
+	err := q.db.View(func(tx *bbolt.Tx) error {
 		b := tx.Bucket([]byte(project))
 		if b == nil {
 			return fmt.Errorf("project %q not found", project)
@@ -175,13 +175,13 @@ func (q *boltqap) DoProjectDocuments(project string, f func(d document) error) e
 				log.Println("error reading document from database: ", err.Error())
 				return nil
 			}
-			err = f(doc)
-			if errors.Is(err, ErrEndLookup) {
-				return nil
-			}
-			return err
+			return f(doc)
 		})
 	})
+	if err == nil || errors.Is(err, ErrEndLookup) {
+		return nil
+	}
+	return err
 }
 
 func (q *boltqap) DoDocuments(f func(d document) error) error {
@@ -276,8 +276,8 @@ func (q *boltqap) ImportDocuments(documents []document) (err error) {
 	return nil
 }
 
-// FindMainDocument finds main document ignoring attachment.
-func (q *boltqap) FindMainDocument(target qap.Header) (doc document, err error) {
+// FindDocument finds main document ignoring attachment.
+func (q *boltqap) FindDocument(target qap.Header) (doc document, err error) {
 	err = target.Validate()
 	if err != nil {
 		return document{}, err
@@ -287,7 +287,7 @@ func (q *boltqap) FindMainDocument(target qap.Header) (doc document, err error)
 		if err != nil {
 			return fmt.Errorf("document %s has Header error: %s", d, err)
 		}
-		if qap.HeaderCodesEqual(h, target) {
+		if qap.HeadersEqual(h, target) {
 			doc = d
 			return ErrEndLookup
 		}
@@ -301,7 +301,7 @@ func (q *boltqap) AddRevision(target qap.Header, newrev revision) error {
 	if err != nil {
 		return err
 	}
-	doc, err := q.FindMainDocument(target)
+	doc, err := q.FindDocument(target)
 	if err != nil {
 		return err
 	}

cmd/boltqap/boltqap_test.go

@@ -28,6 +28,48 @@ func TestBoltKey(t *testing.T) {
 	}
 }
 
+func TestBoltStore(t *testing.T) {
+	const testFile = "qap_test.db"
+	q, err := OpenBoltQAP(testFile, nil)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer os.Remove(testFile)
+	defer q.Close()
+	rev, err := qap.ParseRevision("C.3")
+	if err != nil {
+		t.Fatal(err)
+	}
+	time1 := time.Date(2000, 1, 1, 0, 0, 0, 0, time.UTC)
+	doc1 := document{
+		Project:       "SPS",
+		Equipment:     "A",
+		DocType:       "HP",
+		SubmittedBy:   "pato",
+		Number:        1,
+		Location:      "/1/",
+		HumanName:     "human name",
+		FileExtension: "catpart",
+		Revisions:     []revision{{Index: qap.NewRevision(), Description: "first"}, {Index: rev, Description: "second"}},
+		Created:       time1,
+		Revised:       time1,
+	}
+	err = q.CreateProject(doc1.Project)
+	if err != nil {
+		t.Fatal(err)
+	}
+	err = q.addDoc(doc1)
+	if err != nil {
+		t.Fatal(err)
+	}
+	hd, err := doc1.Header()
+	got, err := q.FindDocument(hd)
+	if err != nil {
+		t.Fatal(err)
+	}
+	assertDocEqual(t, got, doc1)
+}
+
 func TestDoDocumentRange(t *testing.T) {
 	const testFile = "qap_test.db"
 	q, err := OpenBoltQAP(testFile, nil)

cmd/boltqap/boltqaphandlers.go

@@ -26,7 +26,7 @@ func (q *boltqap) handleGetDocument(rw http.ResponseWriter, r *http.Request) {
 		return
 	}
 	log.Println("get document", hd.String())
-	doc, err := q.FindMainDocument(hd)
+	doc, err := q.FindDocument(hd)
 	if err != nil {
 		http.Error(rw, err.Error(), http.StatusInternalServerError)
 		return

cmd/boltqap/document.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"log"
 	"net/http"
 	"reflect"
 	"strconv"
@@ -82,13 +83,6 @@ func (d document) records() []string {
 	}
 }
 
-func (d document) Version() string {
-	if len(d.Revisions) == 0 {
-		return qap.NewRevision().String()
-	}
-	return d.Revisions[len(d.Revisions)-1].Index.String()
-}
-
 func docFromRecord(record []string, ignoreTime bool) (document, error) {
 	if len(record) < len(document{}.recordsHeader()) {
 		return document{}, errors.New("not enough record fields to parse document")
@@ -140,16 +134,6 @@ func (d document) key() []byte {
 	return boltKey(d.Created)
 }
 
-func (d *document) AddRevision(rev revision) error {
-	for i := range d.Revisions {
-		if d.Revisions[i].Index == rev.Index {
-			return errors.New("document revision index already exists")
-		}
-	}
-	d.Revisions = append(d.Revisions, rev)
-	return nil
-}
-
 func (d document) Info() (qap.DocInfo, error) {
 	hd, err := d.Header()
 	if err != nil {
@@ -175,6 +159,20 @@ func (d document) Revision() qap.Revision {
 	return d.Revisions[len(d.Revisions)-1].Index
 }
 
+func (d *document) AddRevision(rev revision) error {
+	for i := range d.Revisions {
+		if d.Revisions[i].Index == rev.Index {
+			return errors.New("document revision index already exists")
+		}
+	}
+	d.Revisions = append(d.Revisions, rev)
+	return nil
+}
+
+func (d document) Version() string {
+	return d.Revision().String()
+}
+
 // String returns the Header's document name representation i.e. "SPS-PEC-HP-023
 func (d document) String() string {
 	di, err := d.Info()
@@ -205,7 +203,7 @@ func (d document) Header() (qap.Header, error) {
 	return qap.ParseHeader(fmt.Sprintf("%s-%s-%s-%d.%02d", d.Project, d.Equipment, d.DocType, d.Number, d.Attachment), false)
 }
 
-func (d document) value() []byte {
+func (d *document) value() []byte {
 	b, err := json.Marshal(d)
 	if err != nil {
 		panic("unreachable")
@@ -221,20 +219,22 @@ func consolidateMainDocumentVersions(documents []document) ([]document, error) {
 			return nil, err
 		}
 		rev := doc.Revision()
-		got, ok := mdoc[hd]
+		original, ok := mdoc[hd]
 		if !ok {
 			doc.AddRevision(revision{Index: rev})
 			mdoc[hd] = doc
 			continue
 		}
 		// we have two documents of identical header
-		if got.Revision() == doc.Revision() {
+		if original.Revision() == doc.Revision() {
 			return nil, fmt.Errorf("conflicting document %s rev %s", doc.String(), doc.Revision())
 		}
-		err = doc.AddRevision(revision{Index: rev})
+		err = original.AddRevision(revision{Index: rev})
 		if err != nil {
 			return nil, fmt.Errorf("attempting to merge document %s revision: %s", doc.String(), err)
 		}
+		log.Println("revision ", rev, " added to ", original.String())
+		mdoc[hd] = original
 	}
 	var newDocs []document
 	for _, d := range mdoc {

cmd/boltqap/document_test.go

@@ -1,7 +1,6 @@
 package main
 
 import (
-	"fmt"
 	"testing"
 	"time"
 
@@ -35,51 +34,57 @@ func TestDocumentRecords(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-
-	if err := assertDocEqual(d, dpiped); err != nil {
-		t.Errorf("piped document differs: %s", err)
-	}
+	assertDocEqual(t, d, dpiped)
 }
 
-func assertDocEqual(a, b document) error {
+func assertDocEqual(t *testing.T, a, b document) error {
+	if len(a.Revisions) == len(b.Revisions) {
+		for i := range a.Revisions {
+			if a.Revisions[i] != b.Revisions[i] {
+				t.Errorf("%dth revision not equal %s,%s", i, a.Revisions[i], b.Revisions[i])
+			}
+		}
+	} else {
+		t.Error("revisions lengths unequal")
+	}
 	if a.Revision() != b.Revision() {
-		return fmt.Errorf("Revision not equal %q, %q", a.Revision(), b.Revision())
+		t.Errorf("Revision not equal %q, %q", a.Revision(), b.Revision())
 	}
 	if a.Location != b.Location {
-		return fmt.Errorf("Location not equal %q, %q", a.Location, b.Location)
+		t.Errorf("Location not equal %q, %q", a.Location, b.Location)
 	}
 	if a.SubmittedBy != b.SubmittedBy {
-		return fmt.Errorf("SubmittedBy not equal %q, %q", a.SubmittedBy, b.SubmittedBy)
+		t.Errorf("SubmittedBy not equal %q, %q", a.SubmittedBy, b.SubmittedBy)
 	}
 	if a.Number != b.Number {
-		return fmt.Errorf("Number not equal %d, %d", a.Number, b.Number)
+		t.Errorf("Number not equal %d, %d", a.Number, b.Number)
 	}
 	if a.FileExtension != b.FileExtension {
-		return fmt.Errorf("FileExtension not equal %q, %q", a.FileExtension, b.FileExtension)
+		t.Errorf("FileExtension not equal %q, %q", a.FileExtension, b.FileExtension)
 	}
 	if a.Project != b.Project {
-		return fmt.Errorf("project not equal %q, %q", a.Project, b.Project)
+		t.Errorf("project not equal %q, %q", a.Project, b.Project)
 	}
 	if a.DocType != b.DocType {
-		return fmt.Errorf("DocType not equal %q, %q", a.DocType, b.DocType)
+		t.Errorf("DocType not equal %q, %q", a.DocType, b.DocType)
 	}
 	if a.Attachment != b.Attachment {
-		return fmt.Errorf("Attachment not equal %d, %d", a.Attachment, b.Attachment)
+		t.Errorf("Attachment not equal %d, %d", a.Attachment, b.Attachment)
 	}
 	if a.Created != b.Created {
-		return fmt.Errorf("Created not equal %q, %q", a.Created, b.Created)
+		t.Errorf("Created not equal %q, %q", a.Created, b.Created)
 	}
 	if a.Revised != b.Revised {
-		return fmt.Errorf("Revised not equal %q, %q", a.Revised, b.Revised)
+		t.Errorf("Revised not equal %q, %q", a.Revised, b.Revised)
 	}
 	if a.Deleted != b.Deleted {
-		return fmt.Errorf("deleted not equal %t, %t", a.Deleted, b.Deleted)
+		t.Errorf("deleted not equal %t, %t", a.Deleted, b.Deleted)
 	}
 	if a.HumanName != b.HumanName {
-		return fmt.Errorf("HumanName not equal %q, %q", a.HumanName, b.HumanName)
+		t.Errorf("HumanName not equal %q, %q", a.HumanName, b.HumanName)
 	}
 	if a.Equipment != b.Equipment {
-		return fmt.Errorf("Equipment not equal %q, %q", a.Equipment, b.Equipment)
+		t.Errorf("Equipment not equal %q, %q", a.Equipment, b.Equipment)
 	}
 	return nil
 }

cmd/boltqap/main.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"embed"
+	"encoding/json"
 	"flag"
 	"fmt"
 	"html/template"
@@ -85,6 +86,16 @@ var funcs = template.FuncMap{
 		}
 		return "/qap/doc/" + hd.String()
 	},
+	"debug": func(a any) template.HTML {
+		b, err := json.Marshal(a)
+		if err != nil {
+			b, err = json.Marshal(&a)
+		}
+		if err != nil {
+			return template.HTML(err.Error())
+		}
+		return template.HTML(b)
+	},
 }
 
 func headerURL(hd qap.Header) string {

cmd/boltqap/templates/document.tmpl

@@ -26,7 +26,7 @@
     <p>{{.Description}}</p>
 </div>
 {{else}}
-<p><strong>rev A.1-draft</strong></p>
+<p><strong>rev A.1-draft</strong> (default)</p>
 {{end}}
 
 {{if eq .Attachment 0}}