Place the default branch at the top of options (#530)

* feat: Add GetDefaultBranch method to BranchSCM interface

* feat: Add GetDefaultBranch method to BranchSCM interface

* feat: Add getDefaultBranch method to branch API

* feat: Add GetDefaultBranch method to BranchSCM interface

Author: Noah Lee

internal/interactor/interface.go

@@ -61,6 +61,7 @@ type (
 	BranchSCM interface {
 		ListBranches(ctx context.Context, u *ent.User, r *ent.Repo, opt *ListOptions) ([]*extent.Branch, error)
 		GetBranch(ctx context.Context, u *ent.User, r *ent.Repo, branch string) (*extent.Branch, error)
+		GetDefaultBranch(ctx context.Context, u *ent.User, r *ent.Repo) (*extent.Branch, error)
 	}
 
 	TagSCM interface {

internal/interactor/mock/pkg.go

@@ -157,6 +157,26 @@ func (g *Github) GetBranch(ctx context.Context, u *ent.User, r *ent.Repo, branch
 	return mapGithubBranchToBranch(b), nil
 }
 
+func (g *Github) GetDefaultBranch(ctx context.Context, u *ent.User, r *ent.Repo) (*extent.Branch, error) {
+	rr, res, err := g.Client(ctx, u.Token).Repositories.Get(ctx, r.Namespace, r.Name)
+	if res.StatusCode == http.StatusNotFound {
+		return nil, e.NewErrorWithMessage(e.ErrorCodeEntityNotFound, "The default branch is not found.", err)
+	} else if err != nil {
+		return nil, e.NewError(e.ErrorCodeInternalError, err)
+	}
+
+	b, res, err := g.Client(ctx, u.Token).
+		Repositories.
+		GetBranch(ctx, r.Namespace, r.Name, *rr.DefaultBranch, false)
+	if res.StatusCode == http.StatusNotFound {
+		return nil, e.NewErrorWithMessage(e.ErrorCodeEntityNotFound, "The default branch is not found.", err)
+	} else if err != nil {
+		return nil, e.NewError(e.ErrorCodeInternalError, err)
+	}
+
+	return mapGithubBranchToBranch(b), nil
+}
+
 // ListTags list up tags as ordered by commit date.
 // Github GraphQL explore - https://docs.github.com/en/graphql/overview/explorer
 func (g *Github) ListTags(ctx context.Context, u *ent.User, r *ent.Repo, opt *i.ListOptions) ([]*extent.Tag, error) {

internal/pkg/github/repos.go

@@ -32,3 +32,22 @@ func (s *BranchAPI) Get(c *gin.Context) {
 
 	gb.Response(c, http.StatusOK, b)
 }
+
+func (s *BranchAPI) GetDefault(c *gin.Context) {
+	ctx := c.Request.Context()
+
+	uv, _ := c.Get(gb.KeyUser)
+	u := uv.(*ent.User)
+
+	rv, _ := c.Get(KeyRepo)
+	repo := rv.(*ent.Repo)
+
+	b, err := s.i.GetDefaultBranch(ctx, u, repo)
+	if err != nil {
+		s.log.Check(gb.GetZapLogLevel(err), "Failed to get the branch.").Write(zap.Error(err))
+		gb.ResponseWithError(c, err)
+		return
+	}
+
+	gb.Response(c, http.StatusOK, b)
+}

internal/server/api/v1/repos/branch_get.go

@@ -55,6 +55,7 @@ type (
 
 		ListBranches(ctx context.Context, u *ent.User, r *ent.Repo, opt *i.ListOptions) ([]*extent.Branch, error)
 		GetBranch(ctx context.Context, u *ent.User, r *ent.Repo, branch string) (*extent.Branch, error)
+		GetDefaultBranch(ctx context.Context, u *ent.User, r *ent.Repo) (*extent.Branch, error)
 
 		ListTags(ctx context.Context, u *ent.User, r *ent.Repo, opt *i.ListOptions) ([]*extent.Tag, error)
 		GetTag(ctx context.Context, u *ent.User, r *ent.Repo, tag string) (*extent.Tag, error)

internal/server/api/v1/repos/interface.go

@@ -133,6 +133,7 @@ func NewRouter(c *RouterConfig) *gin.Engine {
 		repov1.GET("/:namespace/:name/commits/:sha/statuses", rm.RepoReadPerm(), api.Commits.ListStatuses)
 		repov1.GET("/:namespace/:name/branches", rm.RepoReadPerm(), api.Branch.List)
 		repov1.GET("/:namespace/:name/branches/:branch", rm.RepoReadPerm(), api.Branch.Get)
+		repov1.GET("/:namespace/:name/default-branch", rm.RepoReadPerm(), api.Branch.GetDefault)
 		repov1.GET("/:namespace/:name/tags", rm.RepoReadPerm(), api.Tag.List)
 		repov1.GET("/:namespace/:name/tags/:tag", rm.RepoReadPerm(), api.Tag.Get)
 		repov1.GET("/:namespace/:name/deployments", rm.RepoReadPerm(), api.Deployment.List)

internal/server/api/v1/repos/mock/interactor.go

@@ -52,3 +52,27 @@ export const getBranch = async (
 
   return ret;
 };
+
+export const getDefaultBranch = async (
+  namespace: string,
+  name: string
+): Promise<Branch> => {
+  const response = await _fetch(
+    `${instance}/api/v1/repos/${namespace}/${name}/default-branch`,
+    {
+      headers,
+      credentials: 'same-origin',
+    }
+  );
+
+  if (response.status === StatusCodes.NOT_FOUND) {
+    const message = await response.json().then((data) => data.message);
+    throw new HttpNotFoundError(message);
+  }
+
+  const ret: Branch = await response
+    .json()
+    .then((b: any) => mapDataToBranch(b));
+
+  return ret;
+};

internal/server/router.go

@@ -20,7 +20,7 @@ export {
 } from './deployment';
 export { getConfig } from './config';
 export { listCommits, getCommit, listStatuses } from './commit';
-export { listBranches, getBranch } from './branch';
+export { listBranches, getBranch, getDefaultBranch } from './branch';
 export { listTags, getTag } from './tag';
 export { listUsers, updateUser, deleteUser, getMe, getRateLimit } from './user';
 export { checkSlack } from './chat';

ui/src/apis/branch.ts

@@ -23,6 +23,7 @@ import {
   listDeployments,
   listBranches,
   getBranch,
+  getDefaultBranch,
   listCommits,
   getCommit,
   listStatuses,
@@ -121,7 +122,23 @@ export const fetchBranches = createAsyncThunk<
   const { namespace, name } = getState().repoDeploy;
 
   const branches = await listBranches(namespace, name, firstPage, perPage);
-  return branches;
+
+  const defaultBranch = await getDefaultBranch(namespace, name);
+
+  // Add the default branch, and remove the duplicated one.
+  branches.unshift(defaultBranch);
+
+  const reduced = branches.reduce((acc, cur) => {
+    if (acc.findIndex((b) => b.name === cur.name) === -1) {
+      acc.push(cur);
+    }
+
+    return acc;
+  }, [] as Branch[]);
+
+  console.log(reduced);
+
+  return reduced;
 });
 
 export const checkBranch = createAsyncThunk<