Add paths to redirect to the URL for a config file

Author: noah

internal/interactor/interface.go

@@ -96,6 +96,9 @@ type (
 
 		ListRemoteRepos(ctx context.Context, u *ent.User) ([]*extent.RemoteRepo, error)
 
+		GetConfigRedirectURL(ctx context.Context, u *ent.User, r *ent.Repo) (string, error)
+		GetNewFileRedirectURL(ctx context.Context, u *ent.User, r *ent.Repo) (string, error)
+
 		// SCM returns the deployment with UID and SHA.
 		CreateRemoteDeployment(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, e *extent.Env) (*extent.RemoteDeployment, error)
 		CancelDeployment(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, s *ent.DeploymentStatus) error

internal/interactor/mock/pkg.go

@@ -0,0 +1,46 @@
+package github
+
+import (
+	"context"
+	"net/http"
+	"path"
+
+	"github.com/gitploy-io/gitploy/model/ent"
+	"github.com/gitploy-io/gitploy/pkg/e"
+)
+
+func (g *Github) GetConfigRedirectURL(ctx context.Context, u *ent.User, r *ent.Repo) (string, error) {
+	remote, res, err := g.Client(ctx, u.Token).
+		Repositories.
+		Get(ctx, r.Namespace, r.Name)
+	if res.StatusCode == http.StatusForbidden {
+		return "", e.NewError(e.ErrorPermissionRequired, err)
+	} else if res.StatusCode == http.StatusNotFound {
+		return "", e.NewError(e.ErrorCodeEntityNotFound, err)
+	} else if err != nil {
+		return "", e.NewError(e.ErrorCodeInternalError, err)
+	}
+
+	// The latest version file on the main branch.
+	// https://docs.github.com/en/repositories/working-with-files/using-files/getting-permanent-links-to-files
+	url := path.Join(*remote.HTMLURL, "blob", *remote.DefaultBranch, r.ConfigPath)
+	return url, nil
+}
+
+func (g *Github) GetNewFileRedirectURL(ctx context.Context, u *ent.User, r *ent.Repo) (string, error) {
+	remote, res, err := g.Client(ctx, u.Token).
+		Repositories.
+		Get(ctx, r.Namespace, r.Name)
+	if res.StatusCode == http.StatusForbidden {
+		return "", e.NewError(e.ErrorPermissionRequired, err)
+	} else if res.StatusCode == http.StatusNotFound {
+		return "", e.NewError(e.ErrorCodeEntityNotFound, err)
+	} else if err != nil {
+		return "", e.NewError(e.ErrorCodeInternalError, err)
+	}
+
+	// Redirect to the URL to create a configuration file.
+	// https://docs.github.com/en/enterprise-server@3.0/repositories/working-with-files/managing-files/creating-new-files
+	url := path.Join(*remote.HTMLURL, "new", *remote.DefaultBranch, r.ConfigPath)
+	return url, nil
+}

internal/pkg/github/link.go

@@ -247,6 +247,8 @@ func NewRouter(c *RouterConfig) *gin.Engine {
 		}
 
 		root.GET("/signin", w.Signin)
+		root.GET("/link/:namespace/:name/config", w.RedirectToConfig)
+		root.GET("/link/:namespace/:name/config/new", w.RedirectToNewConfig)
 
 		// Static files located at the 'ui/public' directory.
 		r.StaticFile("/favicon.ico", "./favicon.ico")

internal/server/router.go

@@ -20,6 +20,9 @@ type (
 		GetRemoteUserByToken(ctx context.Context, token string) (*extent.RemoteUser, error)
 		ListRemoteOrgsByToken(ctx context.Context, token string) ([]string, error)
 		FindUserByHash(ctx context.Context, hash string) (*ent.User, error)
+		FindRepoOfUserByNamespaceName(ctx context.Context, u *ent.User, namespace, name string) (*ent.Repo, error)
+		GetConfigRedirectURL(ctx context.Context, u *ent.User, r *ent.Repo) (string, error)
+		GetNewFileRedirectURL(ctx context.Context, u *ent.User, r *ent.Repo) (string, error)
 		GetLicense(ctx context.Context) (*extent.License, error)
 	}
 )

internal/server/web/interface.go

@@ -0,0 +1,69 @@
+package web
+
+import (
+	"net/http"
+
+	"github.com/gin-gonic/gin"
+	"go.uber.org/zap"
+
+	gb "github.com/gitploy-io/gitploy/internal/server/global"
+	"github.com/gitploy-io/gitploy/model/ent"
+)
+
+// RedirectToConfig redirects to the URL to read the configuration file.
+func (w *Web) RedirectToConfig(c *gin.Context) {
+	var (
+		namespace = c.Param("namespace")
+		name      = c.Param("name")
+	)
+
+	ctx := c.Request.Context()
+
+	uv, _ := c.Get(gb.KeyUser)
+	u := uv.(*ent.User)
+
+	r, err := w.i.FindRepoOfUserByNamespaceName(ctx, u, namespace, name)
+	if err != nil {
+		w.log.Check(gb.GetZapLogLevel(err), "Failed to get the repository.").Write(zap.Error(err))
+		gb.AbortWithError(c, err)
+		return
+	}
+
+	url, err := w.i.GetConfigRedirectURL(ctx, u, r)
+	if err != nil {
+		w.log.Check(gb.GetZapLogLevel(err), "Failed to get the redirect URL for the configuration file.").Write(zap.Error(err))
+		gb.AbortWithError(c, err)
+		return
+	}
+
+	c.Redirect(http.StatusMovedPermanently, url)
+}
+
+// RedirectToNewConfig redirect to the URL to create a new file.
+func (w *Web) RedirectToNewConfig(c *gin.Context) {
+	var (
+		namespace = c.Param("namespace")
+		name      = c.Param("name")
+	)
+
+	ctx := c.Request.Context()
+
+	uv, _ := c.Get(gb.KeyUser)
+	u := uv.(*ent.User)
+
+	r, err := w.i.FindRepoOfUserByNamespaceName(ctx, u, namespace, name)
+	if err != nil {
+		w.log.Check(gb.GetZapLogLevel(err), "Failed to get the repository.").Write(zap.Error(err))
+		gb.AbortWithError(c, err)
+		return
+	}
+
+	url, err := w.i.GetNewFileRedirectURL(ctx, u, r)
+	if err != nil {
+		w.log.Check(gb.GetZapLogLevel(err), "Failed to get the redirect URL to create a new file.").Write(zap.Error(err))
+		gb.AbortWithError(c, err)
+		return
+	}
+
+	c.Redirect(http.StatusMovedPermanently, url)
+}