Artifact [a0e88497f6]

Artifact a0e88497f69748129bff1c34fe40fefce2a0422c414c252bf4e911c74036fb5c:

• File internal/checkout/observer.go — part of check-in [6273a0750d] at 2026-07-22 23:03:24 on branch trunk — fix: correct go.mod module path to go-libfossil (#76) (#117)

  * fix: correct go.mod module path to go-libfossil (#76)

  The module directive still declared github.com/danmestas/libfossil after the repository was renamed to go-libfossil. pkg.go.dev/godoc scraping matches the declared module path against its hosting path, so the stale path broke SDK doc generation.

  Rename the module path across all four in-repo modules (root, the two db/driver submodules, observer/otel, and docs/site) and every internal import, plus the release workflow, the doc-generation script, and the docs.

  No tag has been published under the go-libfossil path yet, so the cross-module requires cannot resolve from the proxy. Add replace directives pointing the in-repo requires at their local directories so GOWORK=off builds and the CI matrix resolve without a published version. These replaces are ignored by downstream consumers and can be dropped once new-path tags are cut.

  * Guard releases against replace directives; regenerate SDK docs

  The go-libfossil rename bridges the in-repo modules with `replace` directives. Go refuses a main module that carries them, so a tag cut while they are present breaks `go install .../cmd/libfossil@<tag>` and every `@version` fetch of the driver submodules. Add a Release workflow step that fails the job before anything is published if any tracked go.mod still contains a replace directive, so the bridge is a CI-enforced TODO rather than a silent landmine. The step comment records what unblocks a release: re-tag the submodules with the corrected module paths, bump the root requires, then drop the replace blocks.

  Regenerate the SDK reference docs. The previous pass only substituted URLs over the pre-existing generated files, leaving stale signatures (Repo.Timeline was still documented as taking LogOpts rather than TimelineOpts). Note that gomarkdoc must be run outside a git worktree — inside one it silently strips every source link.

  Also reword the README rename note, which read as though the import path had not changed, and re-sort the ncruces require block. (user: [email protected], size: 2905) [annotate] [blame] [check-ins using]

package checkout

import (
	"context"

	libfossil "github.com/danmestas/go-libfossil/internal/fsltype"
)

// ExtractStart describes the beginning of an extract or update operation.
type ExtractStart struct {
	Operation string          // "extract" or "update"
	TargetRID libfossil.FslID
}

// ExtractEnd describes the result of an extract or update operation.
type ExtractEnd struct {
	Operation    string
	TargetRID    libfossil.FslID
	FilesWritten int
	FilesRemoved int
	Conflicts    int
	Err          error
}

// ScanEnd describes the result of a ScanChanges operation.
type ScanEnd struct {
	FilesScanned int
	FilesChanged int
	FilesMissing int
	FilesExtra   int
}

// CommitStart describes the beginning of a commit operation.
type CommitStart struct {
	FilesEnqueued int
	Branch        string
	User          string
}

// CommitEnd describes the result of a commit operation.
type CommitEnd struct {
	RID         libfossil.FslID
	UUID        string
	FilesCommit int
	Err         error
}

// Observer receives lifecycle callbacks during checkout operations.
// A single Observer instance may be shared across multiple concurrent operations.
// Pass nil for no-op default.
//
// Performance: nopObserver implements all methods as empty functions.
// The only cost on the hot path is one indirect call per invocation (~2ns).
type Observer interface {
	// Extract/update lifecycle.
	ExtractStarted(ctx context.Context, e ExtractStart) context.Context
	ExtractFileCompleted(ctx context.Context, name string, change UpdateChange)
	ExtractCompleted(ctx context.Context, e ExtractEnd)

	// Scan lifecycle.
	ScanStarted(ctx context.Context) context.Context
	ScanCompleted(ctx context.Context, e ScanEnd)

	// Commit lifecycle.
	CommitStarted(ctx context.Context, e CommitStart) context.Context
	CommitCompleted(ctx context.Context, e CommitEnd)

	// Per-error recording — called on individual errors.
	Error(ctx context.Context, err error)
}

// nopObserver is the default observer that does nothing.
type nopObserver struct{}

func (nopObserver) ExtractStarted(ctx context.Context, _ ExtractStart) context.Context {
	return ctx
}
func (nopObserver) ExtractFileCompleted(_ context.Context, _ string, _ UpdateChange) {}
func (nopObserver) ExtractCompleted(_ context.Context, _ ExtractEnd)                 {}
func (nopObserver) ScanStarted(ctx context.Context) context.Context                  { return ctx }
func (nopObserver) ScanCompleted(_ context.Context, _ ScanEnd)                       {}
func (nopObserver) CommitStarted(ctx context.Context, _ CommitStart) context.Context {
	return ctx
}
func (nopObserver) CommitCompleted(_ context.Context, _ CommitEnd) {}
func (nopObserver) Error(_ context.Context, _ error)              {}

// resolveObserver returns obs if non-nil, otherwise nopObserver{}.
func resolveObserver(obs Observer) Observer {
	if obs == nil {
		return nopObserver{}
	}
	return obs
}