fix(store): allow partial initialization

Author: Wondertan

store/store.go

@@ -129,8 +129,8 @@ func (s *Store[H]) Start(ctx context.Context) error {
 	default:
 	}
 
-	if err := s.loadHeadAndTail(ctx); err != nil && !errors.Is(err, header.ErrNotFound) {
-		return err
+	if err := s.init(ctx); err != nil {
+		return fmt.Errorf("header/store: initializing: %w", err)
 	}
 
 	go s.flushLoop()
@@ -433,6 +433,7 @@ func (s *Store[H]) flushLoop() {
 	ctx := context.Background()
 
 	flush := func(headers []H) {
+		log.Debug("flush request", len(headers))
 		s.ensureInit(headers)
 		// add headers to the pending and ensure they are accessible
 		s.pending.Append(headers...)
@@ -557,10 +558,21 @@ func (s *Store[H]) readByKey(ctx context.Context, key datastore.Key) (H, error)
 
 	var h header.Hash
 	if err := h.UnmarshalJSON(b); err != nil {
+		return zero, fmt.Errorf("unmarshaling header hash at %s key: %w", key, err)
+	}
+
+	hdr, err := s.Get(ctx, h)
+	if err != nil {
+		if errors.Is(err, header.ErrNotFound) {
+			derr := s.ds.Delete(ctx, key)
+			if derr != nil {
+				err = errors.Join(err, fmt.Errorf("deleting key %s, header for which was not found: %w", key, derr))
+			}
+		}
 		return zero, err
 	}
 
-	return s.Get(ctx, h)
+	return hdr, nil
 }
 
 func (s *Store[H]) get(ctx context.Context, hash header.Hash) ([]byte, error) {
@@ -661,39 +673,53 @@ func (s *Store[H]) nextTail(ctx context.Context) (tail H, changed bool) {
 	return tail, changed
 }
 
-func (s *Store[H]) loadHeadAndTail(ctx context.Context) error {
+// init loads the head and tail headers and sets them on the store.
+// allows partial initialization of either tail or head if one of the is not found.
+func (s *Store[H]) init(ctx context.Context) error {
 	head, err := s.readByKey(ctx, headKey)
-	if err != nil {
-		return fmt.Errorf("header/store: cannot load headKey: %w", err)
+	if err != nil && !errors.Is(err, header.ErrNotFound) {
+		return fmt.Errorf("reading headKey: %w", err)
+	}
+	if !head.IsZero() {
+		s.contiguousHead.Store(&head)
+		s.heightSub.Init(head.Height())
+		log.Debugw("initialized head", "height", head.Height())
 	}
 
 	tail, err := s.readByKey(ctx, tailKey)
-	if err != nil {
-		return fmt.Errorf("header/store: cannot load tailKey: %w", err)
+	if err != nil && !errors.Is(err, header.ErrNotFound) {
+		return fmt.Errorf("reading tailKey: %w", err)
+	}
+	if !tail.IsZero() {
+		s.tailHeader.Store(&tail)
+		log.Debugw("initialized tail", "height", tail.Height())
 	}
 
-	s.init(head, tail)
 	return nil
 }
 
+// ensureInit initializes the store with the given headers if it is not already initialized.
 func (s *Store[H]) ensureInit(headers []H) {
-	headExist, tailExist := s.contiguousHead.Load() != nil, s.tailHeader.Load() != nil
-	if len(headers) == 0 || (tailExist && headExist) {
+	if len(headers) == 0 {
 		return
-	} else if tailExist || headExist {
-		panic("header/store: head and tail must be both present or absent")
 	}
 
-	tail, head := headers[0], headers[len(headers)-1]
-	s.init(head, tail)
-}
+	if headPtr := s.contiguousHead.Load(); headPtr == nil {
+		head := headers[len(headers)-1]
+		if s.contiguousHead.CompareAndSwap(headPtr, &head) {
+			s.heightSub.Init(head.Height())
+			log.Debugw("initialized head", "height", head.Height())
+		}
+	}
 
-func (s *Store[H]) init(head, tail H) {
-	s.contiguousHead.Store(&head)
-	s.heightSub.Init(head.Height())
-	s.tailHeader.Store(&tail)
+	if tailPtr := s.tailHeader.Load(); tailPtr == nil {
+		tail := headers[0]
+		s.tailHeader.CompareAndSwap(tailPtr, &tail)
+		log.Debugw("initialized tail", "height", tail.Height())
+	}
 }
 
+// deinit deinitializes the store.
 func (s *Store[H]) deinit() {
 	s.cache.Purge()
 	s.heightIndex.cache.Purge()

sync/syncer_tail.go

@@ -61,6 +61,13 @@ func (s *Syncer[H]) renewTail(ctx context.Context, oldTail, head H) (newTail H,
 
 		newTail, err = s.store.Get(ctx, tailHash)
 		if err == nil {
+			if oldTail.IsZero() {
+				// old tail is zero while the requested tail was found locally?
+				// something may go wrong with store, try to recover it with an append
+				if err := s.store.Append(ctx, newTail); err != nil {
+					return newTail, fmt.Errorf("appending tail header %d: %w", newTail.Height(), err)
+				}
+			}
 			return newTail, nil
 		}
 		if !errors.Is(err, header.ErrNotFound) {
@@ -86,6 +93,13 @@ func (s *Syncer[H]) renewTail(ctx context.Context, oldTail, head H) (newTail H,
 			// check if the new tail is below the current head to avoid heightSub blocking
 			newTail, err = s.store.GetByHeight(ctx, tailHeight)
 			if err == nil {
+				if oldTail.IsZero() {
+					// old tail is zero while the requested tail was found locally?
+					// something may go wrong with store, try to recover it with an append
+					if err := s.store.Append(ctx, newTail); err != nil {
+						return newTail, fmt.Errorf("appending tail header %d: %w", newTail.Height(), err)
+					}
+				}
 				return newTail, nil
 			}
 			if !errors.Is(err, header.ErrNotFound) {