chore: more stuff in lockfile

Author: ThomasRooney

lockfile/io.go

@@ -39,13 +39,15 @@ func Load(data []byte, opts ...LoadOption) (*LockFile, error) {
 		lf.TrackedFiles = sequencedmap.New[string, TrackedFile]()
 	}
 
-	// Migrate old "integrity" field to "last_write_checksum"
+	// Migrate old fields to new structure
 	for path := range lf.TrackedFiles.Keys() {
 		tf, ok := lf.TrackedFiles.Get(path)
 		if !ok {
 			continue
 		}
 
+		modified := false
+
 		// Check if integrity exists in AdditionalProperties
 		if tf.AdditionalProperties != nil {
 			if integrity, ok := tf.AdditionalProperties["integrity"].(string); ok {
@@ -55,8 +57,23 @@ func Load(data []byte, opts ...LoadOption) (*LockFile, error) {
 				}
 				// Remove from AdditionalProperties
 				delete(tf.AdditionalProperties, "integrity")
-				lf.TrackedFiles.Set(path, tf)
+				modified = true
 			}
+
+			// Migrate old "pristine_blob_hash" to "pristine_git_object"
+			if pristineBlobHash, ok := tf.AdditionalProperties["pristine_blob_hash"].(string); ok {
+				// Migrate to PristineGitObject if not already set
+				if tf.PristineGitObject == "" {
+					tf.PristineGitObject = pristineBlobHash
+				}
+				// Remove from AdditionalProperties
+				delete(tf.AdditionalProperties, "pristine_blob_hash")
+				modified = true
+			}
+		}
+
+		if modified {
+			lf.TrackedFiles.Set(path, tf)
 		}
 	}
 

lockfile/lockfile.go

@@ -21,23 +21,35 @@ type TrackedFile struct {
 	// UUID embedded in the file header. Allows detecting "Moves/Renames".
 	ID string `yaml:"id,omitempty"`
 
-	// The Merge Base (Reference)
-	// The Git Blob SHA-1 of the PURE generated file from the PREVIOUS run.
-	// We pass this to `git cat-file -p` to get the BASE content.
-	PristineBlobHash string `yaml:"pristine_blob_hash,omitempty"`
-
 	// The Dirty Check (Optimization)
 	// The SHA-1 of the file content exactly as written to disk last time.
 	// If Disk_SHA == LastWriteChecksum, we skip the merge (Fast Path).
 	LastWriteChecksum string `yaml:"last_write_checksum,omitempty"`
 
+	// The O(1) Lookup Key
+	// Stores the Blob Hash of the file from the PREVIOUS run.
+	// Only populated if persistentEdits is enabled.
+	PristineGitObject string `yaml:"pristine_git_object,omitempty"`
+
 	AdditionalProperties map[string]any `yaml:",inline"`
 }
 
+type PersistentEdits struct {
+	// Maps to refs/speakeasy/gen/<UUID>
+	GenerationID string `yaml:"generation_id,omitempty"`
+
+	// Parent Commit (Links history for compression)
+	PristineCommitHash string `yaml:"pristine_commit_hash,omitempty"`
+
+	// Content Checksum (Enables No-Op/Determinism check)
+	PristineTreeHash string `yaml:"pristine_tree_hash,omitempty"`
+}
+
 type LockFile struct {
 	LockVersion          string                       `yaml:"lockVersion"`
 	ID                   string                       `yaml:"id"`
 	Management           Management                   `yaml:"management"`
+	PersistentEdits      *PersistentEdits             `yaml:"persistentEdits,omitempty"`
 	Features             map[string]map[string]string `yaml:"features,omitempty"`
 	TrackedFiles         TrackedFiles                 `yaml:"trackedFiles,omitempty"`
 	Examples             Examples                     `yaml:"examples,omitempty"`

lockfile/lockfile_test.go

@@ -45,24 +45,88 @@ func TestLoad_NewStructure(t *testing.T) {
 lockVersion: "2.0.0"
 id: "test-uuid"
 management: {}
+persistentEdits:
+  generation_id: "uuid-550e"
+  pristine_commit_hash: "a1b2c3"
+  pristine_tree_hash: "tree-e5f6"
+trackedFiles:
+  "pkg/models/user.go":
+    id: "uuid-breadcrumb-123"
+    last_write_checksum: "sha1:file-hash-789"
+    pristine_git_object: "blob-123"
+`)
+
+	lf, err := lockfile.Load(newYAML)
+	require.NoError(t, err)
+
+	// Verify persistentEdits
+	require.NotNil(t, lf.PersistentEdits)
+	assert.Equal(t, "uuid-550e", lf.PersistentEdits.GenerationID)
+	assert.Equal(t, "a1b2c3", lf.PersistentEdits.PristineCommitHash)
+	assert.Equal(t, "tree-e5f6", lf.PersistentEdits.PristineTreeHash)
+
+	// Verify tracked file
+	tf, ok := lf.TrackedFiles.Get("pkg/models/user.go")
+	require.True(t, ok)
+
+	assert.Equal(t, "uuid-breadcrumb-123", tf.ID)
+	assert.Equal(t, "sha1:file-hash-789", tf.LastWriteChecksum)
+	assert.Equal(t, "blob-123", tf.PristineGitObject)
+}
+
+func TestLoad_MigratesPristineBlobHashToGitObject(t *testing.T) {
+	// Legacy lockfile YAML with 'pristine_blob_hash' field
+	legacyYAML := []byte(`
+lockVersion: "2.0.0"
+id: "test-uuid"
+management: {}
 trackedFiles:
   "src/model.go":
     id: "file-uuid-123"
     pristine_blob_hash: "git-hash-456"
     last_write_checksum: "sha1:file-hash-789"
 `)
 
-	lf, err := lockfile.Load(newYAML)
+	lf, err := lockfile.Load(legacyYAML)
 	require.NoError(t, err)
+	require.NotNil(t, lf)
 
+	// Verify the file exists in tracked files
 	tf, ok := lf.TrackedFiles.Get("src/model.go")
 	require.True(t, ok)
 
+	// Verify migration
+	assert.Equal(t, "git-hash-456", tf.PristineGitObject, "Should migrate pristine_blob_hash to pristine_git_object")
+
+	// Verify cleanup
+	_, exists := tf.AdditionalProperties["pristine_blob_hash"]
+	assert.False(t, exists, "Should remove pristine_blob_hash from AdditionalProperties")
+
+	// Verify other properties preserved
 	assert.Equal(t, "file-uuid-123", tf.ID)
-	assert.Equal(t, "git-hash-456", tf.PristineBlobHash)
 	assert.Equal(t, "sha1:file-hash-789", tf.LastWriteChecksum)
 }
 
+func TestLoad_OmitsEmptyPersistentEdits(t *testing.T) {
+	// Lockfile YAML without persistentEdits section
+	yamlWithoutPE := []byte(`
+lockVersion: "2.0.0"
+id: "test-uuid"
+management: {}
+trackedFiles:
+  "src/file.go":
+    id: "file-uuid"
+    last_write_checksum: "sha1:hash"
+`)
+
+	lf, err := lockfile.Load(yamlWithoutPE)
+	require.NoError(t, err)
+	require.NotNil(t, lf)
+
+	// Verify persistentEdits is nil when not present
+	assert.Nil(t, lf.PersistentEdits, "PersistentEdits should be nil when not in YAML")
+}
+
 func TestNew_CreatesValidLockFile(t *testing.T) {
 	lf := lockfile.New()
 	require.NotNil(t, lf)
@@ -71,4 +135,5 @@ func TestNew_CreatesValidLockFile(t *testing.T) {
 	assert.NotEmpty(t, lf.ID)
 	assert.NotNil(t, lf.TrackedFiles)
 	assert.Equal(t, 0, lf.TrackedFiles.Len())
+	assert.Nil(t, lf.PersistentEdits, "PersistentEdits should be nil in new lockfile")
 }