feat(issue): redesign issue name

Author: yeqown

cmd/gitlab-flow/commands.go

@@ -67,6 +67,11 @@ func getFeatureCommand() *cli.Command {
 				Usage:    "input the `featureBranchName`",
 				Required: false,
 			},
+			&cli.BoolFlag{
+				Name:     "parse-issue-compatible",
+				Usage:    "switch to parse issue name in comptaible mode",
+				Required: false,
+			},
 		},
 		Subcommands: getFeatureSubCommands(),
 	}

cmd/gitlab-flow/support.go

@@ -86,6 +86,7 @@ func getOpFeatureContext(c *cli.Context) *types.OpFeatureContext {
 	return &types.OpFeatureContext{
 		ForceCreateMergeRequest: c.Bool("force-create-mr"),
 		FeatureBranchName:       c.String("feature-branch-name"),
+		ParseIssueCompatible:    c.Bool("parse-issue-compatible"),
 	}
 }
 

internal/dash_impl.go

@@ -112,25 +112,25 @@ func (d dashImpl) FeatureDetail(branchName string) ([]byte, error) {
 			return nil, errors.Wrap(errInvalidFeatureName, "dashImpl.FeatureDetail.CurrentBranch")
 		}
 		branchName = out
-	}
 
-	// if current branch name could be parsed to feature branch name, then use it.
-	if !isFeatureName(branchName) {
-		out, ok := tryParseFeatureNameFrom(branchName)
-		if !ok {
-			log.
-				WithFields(log.Fields{
-					"branchName": branchName,
-					"out":        out,
-					"ok":         ok,
-				}).
-				Debug("dashImpl.FeatureDetail could not parse branch name by default")
-			return nil, errors.Wrap(errInvalidFeatureName, "dashImpl.FeatureDetail.tryParseFeatureNameFrom")
+		// if current branch name could be parsed to feature branch name, then use it.
+		if !isFeatureName(branchName) {
+			out, ok := tryParseFeatureNameFrom(branchName, false)
+			if !ok {
+				log.
+					WithFields(log.Fields{
+						"branchName": branchName,
+						"out":        out,
+						"ok":         ok,
+					}).
+					Debug("dashImpl.FeatureDetail could not parse branch name by default")
+				return nil, errors.Wrap(errInvalidFeatureName, "dashImpl.FeatureDetail.tryParseFeatureNameFrom")
+			}
+			branchName = out
 		}
-		branchName = out
 	}
-	branchName = genFeatureBranchName(branchName)
 
+	branchName = genFeatureBranchName(branchName)
 	// locate branch
 	branch, err := d.repo.QueryBranch(&repository.BranchDO{
 		ProjectID:  d.ctx.Project.ID,

internal/flow.go

@@ -93,6 +93,7 @@ const (
 	FeatureBranchPrefix         = "feature/"
 	HotfixBranchPrefix          = "hotfix/"
 	ConflictResolveBranchPrefix = "conflict-resolve/"
+	IssueBranchPrefix           = "issue/"
 )
 
 // genFeatureBranchName
@@ -107,24 +108,25 @@ func genFeatureBranchName(name string) string {
 // tryParseFeatureNameFrom try parse feature name from issue name or other cases.
 // if branchName has no prefix, which means tryParseFeatureNameFrom could judge it.
 // otherwise, branchName must have prefix, which was one of flow branch prefixes.
-func tryParseFeatureNameFrom(branchName string) (string, bool) {
+func tryParseFeatureNameFrom(branchName string, comptaible bool) (string, bool) {
 	arr := strings.Split(branchName, "/")
 	if len(arr) < 2 {
-		// FIXME(@yeqown): maybe old issue name, so try parse it.
-		if out := parseFeaturenameFromIssueName(branchName); out != "" {
-			return out, true
-		}
 		return "", false
 	}
 
-	prefix := arr[0]
+	prefix := arr[0] + "/"
 	switch prefix {
 	case FeatureBranchPrefix:
 		// pass
 	case HotfixBranchPrefix:
 		// pass
 	case ConflictResolveBranchPrefix:
 		// pass
+	case IssueBranchPrefix:
+		out := strings.Join(arr[1:], "/")
+		if out = parseFeatureFromIssueName(out, comptaible); out != "" {
+			return out, true
+		}
 	case "":
 		fallthrough
 	default:
@@ -149,30 +151,47 @@ func genHotfixBranchName(name string) string {
 	return HotfixBranchPrefix + name
 }
 
-// genMRTitle
-func genMRTitle(srcBranch, targetBranch string) string {
+// genMergeRequestName generate merge request name.
+func genMergeRequestName(srcBranch, targetBranch string) string {
 	return fmt.Sprintf("Merge %s into %s", srcBranch, targetBranch)
 }
 
 // genIssueBranchName .
-// @result = 1-milestoneTitle as default
-// fmt.Sprintf("%d-%s", issue.IID, milestone.Title)
+// @result = issue/milestoneTitle-1 as default
 func genIssueBranchName(name string, issueIID int) string {
-	if strings.HasPrefix(name, strconv.Itoa(issueIID)+"-") {
+	if strings.HasPrefix(name, IssueBranchPrefix) {
 		return name
 	}
 
-	return fmt.Sprintf("%d-%s", issueIID, name)
+	return IssueBranchPrefix + name + "-" + strconv.Itoa(issueIID)
 }
 
-func parseFeaturenameFromIssueName(issueName string) string {
-	idx := strings.Index(issueName, "-")
+// parseFeatureFromIssueName parse issue name to feature name, there are
+// two different cases:
+// 1. "1-milestoneName"
+// 2. "issue/milestoneName-1"
+//
+// TODO(@yeqown): comptaible with old.
+func parseFeatureFromIssueName(issueName string, compatible bool) string {
+	// if comptaible, try parse "1-milestoneName"
+	if compatible {
+		// DONE(@yeqown): support "1-milestoneName"
+		idx := strings.Index(issueName, "-")
+		if idx == -1 {
+			return ""
+		}
+
+		return issueName[idx+1:]
+	}
+
+	issueName = strings.TrimPrefix(issueName, IssueBranchPrefix)
+	idx := strings.LastIndex(issueName, "-")
 	if idx == -1 {
 		//	not errCouldNotFound
 		return ""
 	}
 
-	return issueName[idx+1:]
+	return issueName[:idx]
 }
 
 // chooseOneProjectInteractively if there are not only one project matched from local or remote,

internal/flow_impl.go

@@ -331,7 +331,7 @@ func (f flowImpl) FeatureFinishIssue(opc *types.OpFeatureContext, issueBranchNam
 
 	// DONE(@yeqown) get feature branch name from issueBranchName
 	if opc.FeatureBranchName == "" {
-		opc.FeatureBranchName = parseFeaturenameFromIssueName(issueBranchName)
+		opc.FeatureBranchName = parseFeatureFromIssueName(issueBranchName, opc.ParseIssueCompatible)
 	}
 	if opc.FeatureBranchName == "" {
 		return errInvalidFeatureName
@@ -386,7 +386,7 @@ func (f flowImpl) FeatureFinishIssue(opc *types.OpFeatureContext, issueBranchNam
 	}
 issueCreateMR:
 	// not hit, so create one
-	title := genMRTitle(issueBranchName, opc.FeatureBranchName)
+	title := genMergeRequestName(issueBranchName, opc.FeatureBranchName)
 	desc := ""
 	result, err := f.createMergeRequest(title, desc, milestoneID, issueIID, issueBranchName, opc.FeatureBranchName)
 	if err != nil {
@@ -473,7 +473,7 @@ func (f flowImpl) HotfixFinish(hotfixBranchName string) error {
 	}
 
 	// then create MR to master
-	title := genMRTitle(hotfixBranchName, types.MasterBranch.String())
+	title := genMergeRequestName(hotfixBranchName, types.MasterBranch.String())
 	result, err := f.createMergeRequest(
 		title, issue.Desc, 0, issue.IssueIID, hotfixBranchName, types.MasterBranch.String())
 	if err != nil {
@@ -958,7 +958,7 @@ featureCreateMR:
 	}
 	// create MR
 	targetBranch := targetBranchName.String()
-	title := genMRTitle(featureBranchName, targetBranch)
+	title := genMergeRequestName(featureBranchName, targetBranch)
 	result, err := f.createMergeRequest(
 		title, milestone.Desc, milestone.MilestoneID, 0, featureBranch.BranchName, targetBranch)
 	if err != nil {

internal/flow_test.go

@@ -0,0 +1,38 @@
+package internal
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/suite"
+)
+
+type testFlowSuite struct {
+	suite.Suite
+}
+
+func (s *testFlowSuite) SetupAllSuite() {
+
+}
+
+func (s testFlowSuite) Test_genIssueName() {
+	name := genIssueBranchName("milestone-test", 123)
+	s.Equal(IssueBranchPrefix+"milestone-test-123", name)
+
+	feature := parseFeatureFromIssueName(name, false)
+	s.Equal("milestone-test", feature)
+
+	feature2, ok := tryParseFeatureNameFrom(name, false)
+	s.True(ok)
+	s.Equal("milestone-test", feature2)
+}
+
+func (s testFlowSuite) Test_parseFeatureFromIssueName_comptaible() {
+	name := "123-milestone-test"
+	feature := parseFeatureFromIssueName(name, true)
+	s.Equal("milestone-test", feature)
+
+}
+
+func Test_flowSuite(t *testing.T) {
+	suite.Run(t, new(testFlowSuite))
+}

internal/types/context.go

@@ -120,4 +120,7 @@ type OpFeatureContext struct {
 	ForceCreateMergeRequest bool
 	// FeatureBranchName specify which branch name to use in the lifecycle of feature operations.
 	FeatureBranchName string
+
+	// ParseIssueCompatible if this is true, means parse issueName to feature in compatible way.
+	ParseIssueCompatible bool
 }