Merge pull request #35 from arran4/codex/improve-logging-and-error-handling-for-gitlab-repository

Improve gitlab handling

Author: arran4

data_test.go

@@ -78,6 +78,7 @@ func testFuncMap() template.FuncMap {
 			}, nil
 		},
 		"bookmarksOrEditBookmarks": func() (string, error) { return "Category: Demo\nhttps://example.com Home", nil },
+		"bookmarksExist":           func() (bool, error) { return true, nil },
 		"bookmarksSHA":             func() (string, error) { return "sha", nil },
 		"branchOrEditBranch":       func() (string, error) { return "main", nil },
 		"tags": func() ([]*Tag, error) {

funcs.go

@@ -1,6 +1,7 @@
 package gobookmarks
 
 import (
+	"errors"
 	"fmt"
 	"github.com/gorilla/sessions"
 	"golang.org/x/oauth2"
@@ -72,6 +73,9 @@ func NewFuncs(r *http.Request) template.FuncMap {
 			}
 			return Bookmarks(r)
 		},
+		"bookmarksExist": func() (bool, error) {
+			return BookmarksExist(r)
+		},
 		"bookmarksSHA": func() (string, error) {
 			session := r.Context().Value(ContextValues("session")).(*sessions.Session)
 			githubUser, _ := session.Values["GithubUser"].(*User)
@@ -216,3 +220,24 @@ func Bookmarks(r *http.Request) (string, error) {
 	}
 	return bookmarks, nil
 }
+
+func BookmarksExist(r *http.Request) (bool, error) {
+	session := r.Context().Value(ContextValues("session")).(*sessions.Session)
+	githubUser, _ := session.Values["GithubUser"].(*User)
+	token, _ := session.Values["Token"].(*oauth2.Token)
+	ref := r.URL.Query().Get("ref")
+
+	login := ""
+	if githubUser != nil {
+		login = githubUser.Login
+	}
+
+	bookmarks, _, err := GetBookmarks(r.Context(), login, ref, token)
+	if err != nil {
+		if errors.Is(err, ErrRepoNotFound) {
+			return false, nil
+		}
+		return false, fmt.Errorf("bookmarks exist: %w", err)
+	}
+	return bookmarks != "", nil
+}

provider_gitlab.go

@@ -131,13 +131,16 @@ func (GitLabProvider) GetBookmarks(ctx context.Context, user, ref string, token
 		log.Printf("gitlab GetBookmarks client: %v", err)
 		return "", "", err
 	}
+	if ref == "" {
+		ref = "HEAD"
+	}
 	f, _, err := c.RepositoryFiles.GetFile(user+"/"+RepoName, "bookmarks.txt", &gitlab.GetFileOptions{Ref: gitlab.String(ref)})
 	if err != nil {
 		if respErr, ok := err.(*gitlab.ErrorResponse); ok {
 			if respErr.Response != nil && respErr.Response.StatusCode == http.StatusNotFound {
 				return "", "", nil
 			}
-			log.Printf("gitlab GetBookmarks: %v", err)
+			log.Printf("gitlab GetBookmarks get file: %v", err)
 			return "", "", nil
 		}
 		log.Printf("gitlab GetBookmarks: %v", err)
@@ -151,12 +154,35 @@ func (GitLabProvider) GetBookmarks(ctx context.Context, user, ref string, token
 	return string(data), f.LastCommitID, nil
 }
 
+func (GitLabProvider) getDefaultBranch(ctx context.Context, user string, client *gitlab.Client, branch string) (string, error) {
+	p, _, err := client.Projects.GetProject(user+"/"+RepoName, nil)
+	if err != nil {
+		if respErr, ok := err.(*gitlab.ErrorResponse); ok && respErr.Response != nil && respErr.Response.StatusCode == http.StatusNotFound {
+			return "", ErrRepoNotFound
+		}
+		log.Printf("gitlab getDefaultBranch: %v", err)
+		return "", err
+	}
+	if p.DefaultBranch != "" {
+		branch = p.DefaultBranch
+	} else {
+		branch = "main"
+	}
+	return branch, nil
+}
 func (GitLabProvider) UpdateBookmarks(ctx context.Context, user string, token *oauth2.Token, sourceRef, branch, text, expectSHA string) error {
 	c, err := GitLabProvider{}.client(token)
 	if err != nil {
 		log.Printf("gitlab UpdateBookmarks client: %v", err)
 		return err
 	}
+	if branch == "" {
+		branch, err = GitLabProvider{}.getDefaultBranch(ctx, user, c, branch)
+		if err != nil {
+			log.Printf("gitlab UpdateBookmarks default branch: %v", err)
+			return err
+		}
+	}
 	opt := &gitlab.UpdateFileOptions{
 		Branch:        gitlab.String(branch),
 		Content:       gitlab.String(text),
@@ -167,8 +193,12 @@ func (GitLabProvider) UpdateBookmarks(ctx context.Context, user string, token *o
 	}
 	_, _, err = c.RepositoryFiles.UpdateFile(user+"/"+RepoName, "bookmarks.txt", opt)
 	if err != nil {
-		if respErr, ok := err.(*gitlab.ErrorResponse); ok && respErr.Response != nil && respErr.Response.StatusCode == http.StatusNotFound {
-			return ErrRepoNotFound
+		if respErr, ok := err.(*gitlab.ErrorResponse); ok {
+			if respErr.Response != nil && respErr.Response.StatusCode == http.StatusNotFound {
+				return ErrRepoNotFound
+			}
+			log.Printf("gitlab UpdateBookmarks update file: %v", err)
+			return err
 		}
 		log.Printf("gitlab UpdateBookmarks: %v", err)
 		return err
@@ -182,6 +212,13 @@ func (GitLabProvider) CreateBookmarks(ctx context.Context, user string, token *o
 		log.Printf("gitlab CreateBookmarks client: %v", err)
 		return err
 	}
+	if branch == "" {
+		branch, err = GitLabProvider{}.getDefaultBranch(ctx, user, c, branch)
+		if err != nil {
+			log.Printf("gitlab CreateBookmarks default branch: %v", err)
+			return err
+		}
+	}
 	opt := &gitlab.CreateFileOptions{
 		Branch:        gitlab.String(branch),
 		Content:       gitlab.String(text),
@@ -191,14 +228,17 @@ func (GitLabProvider) CreateBookmarks(ctx context.Context, user string, token *o
 	}
 	_, _, err = c.RepositoryFiles.CreateFile(user+"/"+RepoName, "bookmarks.txt", opt)
 	if err != nil {
-		if respErr, ok := err.(*gitlab.ErrorResponse); ok && respErr.Response != nil && respErr.Response.StatusCode == http.StatusNotFound {
-			return ErrRepoNotFound
-		}
-		if err != nil {
-			log.Printf("gitlab CreateBookmarks: %v", err)
+		if respErr, ok := err.(*gitlab.ErrorResponse); ok {
+			if respErr.Response != nil && respErr.Response.StatusCode == http.StatusNotFound {
+				return ErrRepoNotFound
+			}
+			log.Printf("gitlab CreateBookmarks create file: %v", err)
+			return err
 		}
+		log.Printf("gitlab CreateBookmarks: %v", err)
+		return err
 	}
-	return err
+	return nil
 }
 
 func (p GitLabProvider) CreateRepo(ctx context.Context, user string, token *oauth2.Token, name string) error {

templates/indexPage.gohtml

@@ -3,6 +3,9 @@
         You will need to login to see this page:
         <a href="{{ OAuth2URL }}">Login</a><br>
     {{else}}
+        {{- if not bookmarksExist }}
+        <p>Your bookmarks repository was not found. Click <a href="/edit">here</a> to create it.</p>
+        {{- end }}
         {{- range bookmarkPages }}
         <div class="bookmarkPage{{ if useCssColumns }} cssColumns{{ end }}">
             {{- range .Blocks }}