Support old project format with commitID in activestate.yaml. #2829
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| package commitmediator | ||
|
|
||
| import ( | ||
| "github.com/ActiveState/cli/internal/errs" | ||
| "github.com/ActiveState/cli/internal/runbits/legacy/projectmigration" | ||
| "github.com/ActiveState/cli/pkg/localcommit" | ||
| "github.com/go-openapi/strfmt" | ||
| ) | ||
|
|
||
| type projecter interface { | ||
| Dir() string | ||
| URL() string | ||
| Path() string | ||
| LegacyCommitID() string | ||
| } | ||
|
|
||
| // Get returns the given project's commit ID in either the new format (commit file), or the old | ||
| // format (activestate.yaml). | ||
| // If you require the commit file, use localcommit.Get(). | ||
| func Get(proj projecter) (strfmt.UUID, error) { | ||
| if commitID, err := localcommit.Get(proj.Dir()); err == nil { | ||
| return commitID, nil | ||
| } else if localcommit.IsFileDoesNotExistError(err) { | ||
| if migrated, err := projectmigration.PromptAndMigrate(proj); err == nil && migrated { | ||
| return localcommit.Get(proj.Dir()) | ||
| } else if err != nil { | ||
| return "", errs.Wrap(err, "Could not prompt and/or migrate project") | ||
| } | ||
| return strfmt.UUID(proj.LegacyCommitID()), nil | ||
| } else { | ||
| return "", errs.Wrap(err, "Could not get local commit") | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| package projectmigration | ||
|
|
||
| import ( | ||
| "path/filepath" | ||
|
|
||
| "github.com/ActiveState/cli/internal/errs" | ||
| "github.com/ActiveState/cli/internal/fileutils" | ||
| "github.com/ActiveState/cli/internal/locale" | ||
| "github.com/ActiveState/cli/internal/multilog" | ||
| "github.com/ActiveState/cli/internal/output" | ||
| "github.com/ActiveState/cli/internal/prompt" | ||
| "github.com/ActiveState/cli/pkg/localcommit" | ||
| "github.com/ActiveState/cli/pkg/projectfile" | ||
| ) | ||
|
|
||
| type projecter interface { | ||
| Dir() string | ||
| URL() string | ||
| Path() string | ||
| LegacyCommitID() string | ||
| } | ||
|
|
||
| var prompter prompt.Prompter | ||
| var out output.Outputer | ||
| var declined bool | ||
|
|
||
| // Register exists to avoid boilerplate in passing prompt and out to every caller of | ||
| // commitmediator.Get() for retrieving legacy commitId from activestate.yaml. | ||
| // This is an anti-pattern and is only used to make this legacy feature palatable. | ||
| func Register(prompter_ prompt.Prompter, out_ output.Outputer) { | ||
| prompter = prompter_ | ||
| out = out_ | ||
| } | ||
|
|
||
| func PromptAndMigrate(proj projecter) (bool, error) { | ||
| if prompter == nil || out == nil { | ||
| return false, errs.New("projectmigration.Register() has not been called") | ||
| } | ||
|
|
||
| if declined { | ||
| return false, nil | ||
| } | ||
|
|
||
| defaultChoice := false | ||
| if migrate, err := prompter.Confirm("", locale.T("projectmigration_confirm"), &defaultChoice); err == nil && !migrate { | ||
| if out.Config().Interactive { | ||
| out.Notice(locale.Tl("projectmigration_declined", "Migration declined for now")) | ||
| } | ||
| declined = true | ||
| return false, nil | ||
| } else if err != nil { | ||
| return false, errs.Wrap(err, "Could not confirm migration choice") | ||
| } | ||
|
|
||
| if err := localcommit.Set(proj.Dir(), proj.LegacyCommitID()); err != nil { | ||
| return false, errs.Wrap(err, "Could not create local commit file") | ||
| } | ||
|
|
||
| if fileutils.DirExists(filepath.Join(proj.Dir(), ".git")) { | ||
|
There was a problem hiding this comment. Realize this probably wasn't introduced here but we should go up the directory tree to check for this also, since people may not checkout their activestate.yaml inside the same dir as their git repo (eg. TheHomeRepot). You can use: cli/internal/fileutils/fileutils.go Line 422 in 35d1e55 There was a problem hiding this comment. Sadly, that's files only, not directories. Still, I'll do something to walk up the tree. |
||
| err := localcommit.AddToGitIgnore(proj.Dir()) | ||
| if err != nil { | ||
| multilog.Error("Unable to add local commit file to .gitignore: %v", err) | ||
|
There was a problem hiding this comment. This would almost certainly be due to something client-side like permission errors I think? We should probably not log this to rollbar. Or maybe add a check to only log if it's not a permission or IO error. There was a problem hiding this comment. I wasn't able to find a generic ErrIO variable, but I did find ErrPermission, so we'll go with that. |
||
| out.Notice(locale.T("notice_commit_id_gitignore")) | ||
| } | ||
| } | ||
|
|
||
| pf := projectfile.NewProjectField() | ||
| if err := pf.LoadProject(proj.URL()); err != nil { | ||
| return false, errs.Wrap(err, "Could not load activestate.yaml") | ||
| } | ||
| pf.StripCommitID() | ||
| if err := pf.Save(proj.Path()); err != nil { | ||
| return false, errs.Wrap(err, "Could not save activestate.yaml") | ||
| } | ||
|
|
||
| out.Notice(locale.Tl("projectmigration_success", "Your project was successfully migrated")) | ||
|
|
||
| return true, nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rawktron please review
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the full message? We have to give them some context for this. Is there another part of this message?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rawktron That is the full message. Whenever they run a
statecommand that needs to read a commitId from activestate.yaml, this message is presented to them. The ticket did not specify what the prompt should look like, so I came up with this for the time being. Please advise what message you'd like to give.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be something like "State Tool has introduced a new project format to provide enhanced functionality. Your project is currently using the old format and will remain read-only until you migrate to the new project format.
WARNING: After you migrate, older versions of the State Tool will not be able to use your project.
Would you like to perform the migration now?"