Add separate checkout info block to buildscripts.

internal/captain/rationalize.go

@@ -6,11 +6,12 @@ import (
 	"github.com/ActiveState/cli/internal/errs"
 	"github.com/ActiveState/cli/internal/locale"
 	"github.com/ActiveState/cli/internal/runbits/rationalize"
-	"github.com/ActiveState/cli/pkg/localcommit"
+	"github.com/ActiveState/cli/pkg/buildscript"
+	"github.com/ActiveState/cli/pkg/checkoutinfo"
 )
 
 func rationalizeError(err *error) {
-	var errInvalidCommitID *localcommit.ErrInvalidCommitID
+	var errInvalidCommitID *checkoutinfo.ErrInvalidCommitID
 
 	switch {
 	case err == nil:
@@ -31,5 +32,11 @@ func rationalizeError(err *error) {
 		*err = errs.WrapUserFacing(*err,
 			locale.Tr("err_commit_id_invalid", errInvalidCommitID.CommitID),
 			errs.SetInput())
+
+	// Outdated build script.
+	case errors.Is(*err, buildscript.ErrOutdatedAtTime):
+		*err = errs.WrapUserFacing(*err,
+			locale.T("err_outdated_buildscript"),
+			errs.SetInput())
 	}
 }

internal/constraints/constraints.go

@@ -82,7 +82,7 @@ func NewPrimeConditional(auth *authentication.Auth, pj projectable, subshellName
 		pjName = pj.Name()
 		pjNamespace = pj.NamespaceString()
 		pjURL = pj.URL()
-		pjCommit = pj.LegacyCommitID() // Not using localcommit due to import cycle. See anti-pattern comment in localcommit pkg.
+		pjCommit = pj.LegacyCommitID() // Not using checkoutinfo due to import cycle. See anti-pattern comment in checkoutinfo pkg.
 		pjBranch = pj.BranchName()
 		pjDir = pj.Dir()
 	}

internal/events/cmdcall/cmdcall.go

@@ -21,6 +21,7 @@ type primeable interface {
 	primer.Configurer
 	primer.Analyticer
 	primer.SvcModeler
+	primer.CheckoutInfoer
 }
 
 // CmdCall manages dependencies for the handling of events triggered by command

internal/locale/locales/en-us.yaml

@@ -1431,6 +1431,8 @@ err_commit_id_invalid_given:
   other: "Invalid commit ID: '{{.V0}}'."
 err_commit_id_not_in_history:
   other: "The project '[ACTIONABLE]{{.V0}}[/RESET]' does not contain the provided commit: '[ACTIONABLE]{{.V1}}[/RESET]'."
+err_outdated_buildscript:
+  other: "[WARNING]Warning:[/RESET] You are using an outdated version of the buildscript. Please run '[ACTIONABLE]state reset LOCAL[/RESET]' in order to reinitialize your buildscript file."
 err_shortcutdir_writable:
   other: Could not continue as we don't have permission to create [ACTIONABLE]{{.V0}}[/RESET].
 move_prompt:

internal/migrator/migrator.go

@@ -1,14 +1,13 @@
 package migrator
 
 import (
-	"path/filepath"
+	"github.com/go-openapi/strfmt"
 
 	"github.com/ActiveState/cli/internal/config"
-	"github.com/ActiveState/cli/internal/constants"
 	"github.com/ActiveState/cli/internal/errs"
 	"github.com/ActiveState/cli/internal/locale"
 	"github.com/ActiveState/cli/internal/logging"
-	"github.com/ActiveState/cli/internal/runbits/buildscript"
+	"github.com/ActiveState/cli/pkg/checkoutinfo"
 	"github.com/ActiveState/cli/pkg/platform/authentication"
 	"github.com/ActiveState/cli/pkg/projectfile"
 )
@@ -26,11 +25,10 @@ func NewMigrator(auth *authentication.Auth, cfg *config.Instance) projectfile.Mi
 			// WARNING: When we return a version along with an error we need to ensure that all updates UP TO THAT VERSION
 			// have completed. Ensure you roll back any partial updates in the case of an error as they will need to be attempted again.
 			case 0:
-				if cfg.GetBool(constants.OptinBuildscriptsConfig) {
-					logging.Debug("Creating buildscript")
-					if err := buildscript_runbit.Initialize(filepath.Dir(project.Path()), auth); err != nil {
-						return v, errs.Wrap(err, "Failed to initialize buildscript")
-					}
+				logging.Debug("Attempting to create buildscript")
+				info := checkoutinfo.New(auth, cfg, project)
+				if err := info.InitializeBuildScript(strfmt.UUID(project.LegacyCommitID())); err != nil {
+					return v, errs.Wrap(err, "Failed to initialize buildscript")
 				}
 			}
 		}

internal/primer/primer.go

@@ -12,24 +12,26 @@ import (
 	"github.com/ActiveState/cli/internal/prompt"
 	"github.com/ActiveState/cli/internal/subshell"
 	"github.com/ActiveState/cli/internal/svcctl"
+	"github.com/ActiveState/cli/pkg/checkoutinfo"
 	"github.com/ActiveState/cli/pkg/platform/authentication"
 	"github.com/ActiveState/cli/pkg/platform/model"
 	"github.com/ActiveState/cli/pkg/project"
 	"github.com/ActiveState/cli/pkg/projectfile"
 )
 
 type Values struct {
-	project     *project.Project
-	projectfile *projectfile.Project
-	output      output.Outputer
-	auth        *authentication.Auth
-	prompt      prompt.Prompter
-	subshell    subshell.SubShell
-	conditional *constraints.Conditional
-	config      *config.Instance
-	ipComm      svcctl.IPCommunicator
-	svcModel    *model.SvcModel
-	analytics   analytics.Dispatcher
+	project      *project.Project
+	projectfile  *projectfile.Project
+	output       output.Outputer
+	auth         *authentication.Auth
+	prompt       prompt.Prompter
+	subshell     subshell.SubShell
+	conditional  *constraints.Conditional
+	config       *config.Instance
+	ipComm       svcctl.IPCommunicator
+	svcModel     *model.SvcModel
+	analytics    analytics.Dispatcher
+	checkoutinfo *checkoutinfo.CheckoutInfo
 }
 
 func New(values ...any) *Values {
@@ -65,12 +67,14 @@ func New(values ...any) *Values {
 			}
 		}
 	}
+	result.checkoutinfo = checkoutinfo.New(result.auth, result.config, result.project)
 	return result
 }
 
 func (v *Values) SetProject(p *project.Project) {
 	v.project = p
 	v.projectfile = p.Source()
+	v.checkoutinfo = checkoutinfo.New(v.auth, v.config, p)
 }
 
 type Projecter interface {
@@ -118,6 +122,10 @@ type Conditioner interface {
 	Conditional() *constraints.Conditional
 }
 
+type CheckoutInfoer interface {
+	CheckoutInfo() *checkoutinfo.CheckoutInfo
+}
+
 func (v *Values) Project() *project.Project {
 	return v.project
 }
@@ -161,3 +169,7 @@ func (v *Values) Config() *config.Instance {
 func (v *Values) Analytics() analytics.Dispatcher {
 	return v.analytics
 }
+
+func (v *Values) CheckoutInfo() *checkoutinfo.CheckoutInfo {
+	return v.checkoutinfo
+}

internal/runbits/buildplanner/buildplanner.go

@@ -8,7 +8,7 @@ import (
 	"github.com/ActiveState/cli/internal/rtutils/ptr"
 	"github.com/ActiveState/cli/internal/runbits/rationalize"
 	"github.com/ActiveState/cli/pkg/buildplan"
-	"github.com/ActiveState/cli/pkg/localcommit"
+	"github.com/ActiveState/cli/pkg/checkoutinfo"
 	"github.com/ActiveState/cli/pkg/platform/api/buildplanner/request"
 	"github.com/ActiveState/cli/pkg/platform/authentication"
 	"github.com/ActiveState/cli/pkg/platform/model"
@@ -43,7 +43,8 @@ func GetCommit(
 	commitID string,
 	target string,
 	auth *authentication.Auth,
-	out output.Outputer) (commit *bpModel.Commit, rerr error) {
+	out output.Outputer,
+	info *checkoutinfo.CheckoutInfo) (commit *bpModel.Commit, rerr error) {
 	if pj == nil && !namespace.IsValid() {
 		return nil, rationalize.ErrNoProject
 	}
@@ -76,21 +77,21 @@ func GetCommit(
 	switch {
 	// Return the buildplan from this runtime.
 	case !namespaceProvided && !commitIdProvided:
-		localCommitID, err := localcommit.Get(pj.Path())
+		localCommitID, err := info.CommitID()
 		if err != nil {
-			return nil, errs.Wrap(err, "Could not get local commit")
+			return nil, errs.Wrap(err, "Could not get commit ID")
 		}
 
 		bp := bpModel.NewBuildPlannerModel(auth)
-		commit, err = bp.FetchCommit(localCommitID, pj.Owner(), pj.Name(), targetPtr)
+		commit, err = bp.FetchCommit(localCommitID, pj.Owner(), pj.Name(), pj.BranchName(), targetPtr)
 		if err != nil {
 			return nil, errs.Wrap(err, "Failed to fetch commit")
 		}
 
 	// Return buildplan from the given commitID for the current project.
 	case !namespaceProvided && commitIdProvided:
 		bp := bpModel.NewBuildPlannerModel(auth)
-		commit, err = bp.FetchCommit(commitUUID, pj.Owner(), pj.Name(), targetPtr)
+		commit, err = bp.FetchCommit(commitUUID, pj.Owner(), pj.Name(), pj.BranchName(), targetPtr)
 		if err != nil {
 			return nil, errs.Wrap(err, "Failed to fetch commit")
 		}
@@ -114,15 +115,25 @@ func GetCommit(
 		commitUUID = *branchCommitUUID
 
 		bp := bpModel.NewBuildPlannerModel(auth)
-		commit, err = bp.FetchCommit(commitUUID, namespace.Owner, namespace.Project, targetPtr)
+		commit, err = bp.FetchCommit(commitUUID, namespace.Owner, namespace.Project, branch.Label, targetPtr)
 		if err != nil {
 			return nil, errs.Wrap(err, "Failed to fetch commit")
 		}
 
 	// Return the buildplan for the given commitID of the given project.
 	case namespaceProvided && commitIdProvided:
+		pj, err := model.FetchProjectByName(namespace.Owner, namespace.Project, auth)
+		if err != nil {
+			return nil, locale.WrapExternalError(err, "err_fetch_project", "", namespace.String())
+		}
+
+		branch, err := model.DefaultBranchForProject(pj)
+		if err != nil {
+			return nil, errs.Wrap(err, "Could not grab branch for project")
+		}
+
 		bp := bpModel.NewBuildPlannerModel(auth)
-		commit, err = bp.FetchCommit(commitUUID, namespace.Owner, namespace.Project, targetPtr)
+		commit, err = bp.FetchCommit(commitUUID, namespace.Owner, namespace.Project, branch.Label, targetPtr)
 		if err != nil {
 			return nil, errs.Wrap(err, "Failed to fetch commit")
 		}
@@ -143,9 +154,9 @@ func GetCommit(
 		owner = pj.Owner()
 		name = pj.Name()
 		nsString = pj.NamespaceString()
-		commitID, err := localcommit.Get(pj.Path())
+		commitID, err := info.CommitID()
 		if err != nil {
-			return nil, errs.Wrap(err, "Could not get local commit")
+			return nil, errs.Wrap(err, "Could not get commit ID")
 		}
 		localCommitID = &commitID
 	}
@@ -170,8 +181,9 @@ func GetBuildPlan(
 	commitID string,
 	target string,
 	auth *authentication.Auth,
-	out output.Outputer) (bp *buildplan.BuildPlan, rerr error) {
-	commit, err := GetCommit(pj, namespace, commitID, target, auth, out)
+	out output.Outputer,
+	info *checkoutinfo.CheckoutInfo) (bp *buildplan.BuildPlan, rerr error) {
+	commit, err := GetCommit(pj, namespace, commitID, target, auth, out, info)
 	if err != nil {
 		return nil, errs.Wrap(err, "Could not get commit")
 	}

internal/runbits/buildscript/buildscript_test.go

@@ -11,9 +11,19 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
+const testProject = "https://platform.activestate.com/org/project?branch=main&commitID=00000000-0000-0000-0000-000000000000"
+const testTime = "2000-01-01T00:00:00.000Z"
+
+func checkoutInfo(project, time string) string {
+	return "```\n" +
+		"Project: " + project + "\n" +
+		"Time: " + time + "\n" +
+		"```\n"
+}
+
 func TestDiff(t *testing.T) {
 	script, err := buildscript.Unmarshal([]byte(
-		`at_time = "2000-01-01T00:00:00.000Z"
+		checkoutInfo(testProject, testTime) + `
 runtime = solve(
 	at_time = at_time,
 	platforms = [
@@ -38,7 +48,7 @@ main = runtime`))
 	// Generate the difference between the modified script and the original expression.
 	result, err := generateDiff(modifiedScript, script)
 	require.NoError(t, err)
-	assert.Equal(t, `at_time = "2000-01-01T00:00:00.000Z"
+	assert.Equal(t, checkoutInfo(testProject, testTime)+`
 runtime = solve(
 	at_time = at_time,
 	platforms = [
@@ -71,11 +81,16 @@ func TestRealWorld(t *testing.T) {
 	require.NoError(t, err)
 	result, err := generateDiff(script1, script2)
 	require.NoError(t, err)
-	assert.Equal(t, `<<<<<<< local
-at_time = "2023-10-16T22:20:29.000Z"
-=======
-at_time = "2023-08-01T16:20:11.985Z"
->>>>>>> remote
+	assert.Equal(t,
+		"```\n"+
+			"<<<<<<< local\n"+
+			"Project: https://platform.activestate.com/ActiveState-CLI/Merge?branch=main&commitID=d908a758-6a81-40d4-b0eb-87069cd7f07d\n"+
+			"Time: 2024-05-10T00:00:13.138Z\n"+
+			"=======\n"+
+			"Project: https://platform.activestate.com/ActiveState-CLI/Merge?branch=main&commitID=f3263ee4-ac4c-41ee-b778-2585333f49f7\n"+
+			"Time: 2023-08-01T16:20:11.985Z\n"+
+			">>>>>>> remote\n"+
+			"```\n"+`
 runtime = state_tool_artifacts_v1(
 	build_flags = [
 	],