Implement checkpoint description auto-incrementing logic and ensure checkpoint lists are managed consistently by removing sorting from get_checkpoints and using unshift for new entries

Author: robertpiosik

packages/vscode/src/commands/checkpoints-command/actions/create-checkpoint.ts

@@ -4,7 +4,7 @@ import { WorkspaceProvider } from '../../../context/providers/workspace-provider
 import type { Checkpoint } from '../types'
 import { copy_workspace_to_dir } from './copy-workspace-to-dir'
 import { get_checkpoints } from './get-checkpoints'
-import { get_checkpoint_path } from '../utils'
+import { get_checkpoint_path, get_incremented_description } from '../utils'
 
 export const create_checkpoint = async (
   workspace_provider: WorkspaceProvider,
@@ -29,37 +29,20 @@ export const create_checkpoint = async (
         await copy_workspace_to_dir(checkpoint_dir_uri, workspace_provider)
 
         const checkpoints = await get_checkpoints(context)
-        let final_description = description
-        if (title == 'Created by user' && description === undefined) {
-          const user_checkpoints = checkpoints.filter(
-            (c) => c.title == 'Created by user'
-          )
-          const first_custom_index = user_checkpoints.findIndex(
-            (c) => !c.description?.match(/^\(\d+\)$/)
-          )
 
-          const relevant_checkpoints =
-            first_custom_index === -1
-              ? user_checkpoints
-              : user_checkpoints.slice(0, first_custom_index)
-
-          const user_checkpoint_numbers = relevant_checkpoints.map((c) =>
-            parseInt(c.description!.match(/^\((\d+)\)$/)![1], 10)
-          )
+        const final_description = get_incremented_description(
+          title,
+          description,
+          checkpoints
+        )
 
-          const max_num =
-            user_checkpoint_numbers.length > 0
-              ? Math.max(...user_checkpoint_numbers)
-              : 0
-          final_description = `(${max_num + 1})`
-        }
         const new_checkpoint: Checkpoint = {
           title,
           timestamp,
           description: final_description
         }
 
-        checkpoints.push(new_checkpoint)
+        checkpoints.unshift(new_checkpoint)
         await context.workspaceState.update(CHECKPOINTS_STATE_KEY, checkpoints)
       }
     )

packages/vscode/src/commands/checkpoints-command/actions/get-checkpoints.ts

@@ -27,5 +27,5 @@ export const get_checkpoints = async (
     )
   }
 
-  return valid_checkpoints.sort((a, b) => b.timestamp - a.timestamp)
+  return valid_checkpoints
 }

packages/vscode/src/commands/checkpoints-command/actions/promote-temporary-checkpoint.ts

@@ -1,6 +1,7 @@
 import * as vscode from 'vscode'
 import { CHECKPOINTS_STATE_KEY } from '../../../constants/state-keys'
 import type { Checkpoint } from '../types'
+import { get_incremented_description } from '../utils'
 
 export const promote_temporary_checkpoint = async (params: {
   context: vscode.ExtensionContext
@@ -13,11 +14,20 @@ export const promote_temporary_checkpoint = async (params: {
       CHECKPOINTS_STATE_KEY,
       []
     ) ?? []
-  checkpoints.push({
+
+  checkpoints.sort((a, b) => b.timestamp - a.timestamp)
+
+  const final_description = get_incremented_description(
+    params.title,
+    params.description,
+    checkpoints
+  )
+
+  checkpoints.unshift({
     ...params.temp_checkpoint,
     is_temporary: false,
     title: params.title,
-    description: params.description
+    description: final_description
   })
   await params.context.workspaceState.update(CHECKPOINTS_STATE_KEY, checkpoints)
 }

packages/vscode/src/commands/checkpoints-command/utils/get-incremented-description.ts

@@ -0,0 +1,46 @@
+import type { Checkpoint } from '../types'
+
+export const get_incremented_description = (
+  title: string,
+  description: string | undefined,
+  checkpoints: Checkpoint[]
+): string | undefined => {
+  if (checkpoints.length == 0) {
+    return description
+  }
+
+  const most_recent = checkpoints[0]
+
+  if (most_recent.title != title) {
+    return description
+  }
+
+  const most_recent_desc = most_recent.description || ''
+  const normalized_desc = description || ''
+
+  const counter_pattern = /^(.*?)\s*\((\d+)\)$/
+  const match = most_recent_desc.match(counter_pattern)
+
+  let base_desc: string
+  let counter: number
+
+  if (match) {
+    base_desc = match[1].trim()
+    counter = parseInt(match[2], 10)
+  } else {
+    base_desc = most_recent_desc
+    counter = 0
+  }
+
+  const current_matches = normalized_desc === base_desc
+
+  if (current_matches) {
+    const next_counter = counter + 1
+    if (normalized_desc == '') {
+      return `(${next_counter})`
+    }
+    return `(${next_counter}) ${normalized_desc}`
+  }
+
+  return description
+}

packages/vscode/src/commands/checkpoints-command/utils/index.ts

@@ -1,4 +1,5 @@
 export * from './clean-directory'
 export * from './copy-optimised-recursively'
 export * from './get-checkpoint-path'
+export * from './get-incremented-description'
 export * from './sync-directory'