feat: implement server webhooks

- branch/tag event
- collaborators event
- push event
- repository event

Fixes: #148
Fixes: #56
Fixes: #49

Author: aymanbagabas

git/commit.go

@@ -1,12 +1,20 @@
 package git
 
 import (
+	"regexp"
+
 	"github.com/gogs/git-module"
 )
 
 // ZeroHash is the zero hash.
 var ZeroHash Hash = git.EmptyID
 
+// IsZeroHash returns whether the hash is a zero hash.
+func IsZeroHash(h Hash) bool {
+	pattern := regexp.MustCompile(`^[0]+$`)
+	return pattern.MatchString(h.String())
+}
+
 // Hash represents a git hash.
 type Hash string
 

go.mod

@@ -29,6 +29,8 @@ require (
 	github.com/gobwas/glob v0.2.3
 	github.com/gogs/git-module v1.8.3
 	github.com/golang-jwt/jwt/v5 v5.0.0
+	github.com/google/go-querystring v1.1.0
+	github.com/google/uuid v1.3.0
 	github.com/gorilla/handlers v1.5.1
 	github.com/gorilla/mux v1.8.0
 	github.com/hashicorp/golang-lru/v2 v2.0.5
@@ -64,7 +66,6 @@ require (
 	github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect
 	github.com/go-logfmt/logfmt v0.6.0 // indirect
 	github.com/golang/protobuf v1.5.3 // indirect
-	github.com/google/uuid v1.3.0 // indirect
 	github.com/gorilla/css v1.0.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect

go.sum

@@ -75,8 +75,11 @@ github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaS
 github.com/golang/protobuf v1.5.3 h1:KhyjKVUg7Usr/dYsdSqoFveMYd5ko72D+zANwlG1mmg=
 github.com/golang/protobuf v1.5.3/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
 github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
+github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
+github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
 github.com/google/pprof v0.0.0-20221118152302-e6195bd50e26 h1:Xim43kblpZXfIBQsbuBVKCudVG457BR2GZFIz3uw3hQ=
 github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=

server/backend/collab.go

@@ -7,7 +7,9 @@ import (
 	"github.com/charmbracelet/soft-serve/server/access"
 	"github.com/charmbracelet/soft-serve/server/db"
 	"github.com/charmbracelet/soft-serve/server/db/models"
+	"github.com/charmbracelet/soft-serve/server/proto"
 	"github.com/charmbracelet/soft-serve/server/utils"
+	"github.com/charmbracelet/soft-serve/server/webhook"
 )
 
 // AddCollaborator adds a collaborator to a repository.
@@ -20,11 +22,20 @@ func (d *Backend) AddCollaborator(ctx context.Context, repo string, username str
 	}
 
 	repo = utils.SanitizeRepo(repo)
-	return db.WrapError(
+	r, err := d.Repository(ctx, repo)
+	if err != nil {
+		return err
+	}
+
+	if err := db.WrapError(
 		d.db.TransactionContext(ctx, func(tx *db.Tx) error {
 			return d.store.AddCollabByUsernameAndRepo(ctx, tx, username, repo, level)
 		}),
-	)
+	); err != nil {
+		return err
+	}
+
+	return webhook.SendCollaboratorEvent(ctx, proto.UserFromContext(ctx), r, username, webhook.CollaboratorEventAdded)
 }
 
 // Collaborators returns a list of collaborators for a repository.
@@ -75,9 +86,18 @@ func (d *Backend) IsCollaborator(ctx context.Context, repo string, username stri
 // It implements backend.Backend.
 func (d *Backend) RemoveCollaborator(ctx context.Context, repo string, username string) error {
 	repo = utils.SanitizeRepo(repo)
-	return db.WrapError(
+	r, err := d.Repository(ctx, repo)
+	if err != nil {
+		return err
+	}
+
+	if err := db.WrapError(
 		d.db.TransactionContext(ctx, func(tx *db.Tx) error {
 			return d.store.RemoveCollabByUsernameAndRepo(ctx, tx, username, repo)
 		}),
-	)
+	); err != nil {
+		return err
+	}
+
+	return webhook.SendCollaboratorEvent(ctx, proto.UserFromContext(ctx), r, username, webhook.CollaboratorEventRemoved)
 }

server/backend/hooks.go

@@ -3,10 +3,14 @@ package backend
 import (
 	"context"
 	"io"
+	"os"
 	"sync"
 
+	"github.com/charmbracelet/soft-serve/git"
 	"github.com/charmbracelet/soft-serve/server/hooks"
 	"github.com/charmbracelet/soft-serve/server/proto"
+	"github.com/charmbracelet/soft-serve/server/sshutils"
+	"github.com/charmbracelet/soft-serve/server/webhook"
 )
 
 var _ hooks.Hooks = (*Backend)(nil)
@@ -28,8 +32,52 @@ func (d *Backend) PreReceive(_ context.Context, _ io.Writer, _ io.Writer, repo s
 // Update is called by the git update hook.
 //
 // It implements Hooks.
-func (d *Backend) Update(_ context.Context, _ io.Writer, _ io.Writer, repo string, arg hooks.HookArg) {
+func (d *Backend) Update(ctx context.Context, _ io.Writer, _ io.Writer, repo string, arg hooks.HookArg) {
 	d.logger.Debug("update hook called", "repo", repo, "arg", arg)
+
+	// Find user
+	var user proto.User
+	if pubkey := os.Getenv("SOFT_SERVE_PUBLIC_KEY"); pubkey != "" {
+		pk, _, err := sshutils.ParseAuthorizedKey(pubkey)
+		if err != nil {
+			d.logger.Error("error parsing public key", "err", err)
+			return
+		}
+
+		user, err = d.UserByPublicKey(ctx, pk)
+		if err != nil {
+			d.logger.Error("error finding user from public key", "key", pubkey, "err", err)
+			return
+		}
+	} else if username := os.Getenv("SOFT_SERVE_USERNAME"); username != "" {
+		var err error
+		user, err = d.User(ctx, username)
+		if err != nil {
+			d.logger.Error("error finding user from username", "username", username, "err", err)
+			return
+		}
+	} else {
+		d.logger.Error("error finding user")
+		return
+	}
+
+	// Get repo
+	r, err := d.Repository(ctx, repo)
+	if err != nil {
+		d.logger.Error("error finding repository", "repo", repo, "err", err)
+		return
+	}
+
+	// TODO: run this async
+	// This would probably need something like an RPC server to communicate with the hook process.
+	if git.IsZeroHash(git.Hash(arg.OldSha)) || git.IsZeroHash(git.Hash(arg.NewSha)) {
+		if err := webhook.SendBranchTagEvent(ctx, user, r, arg.RefName, arg.OldSha, arg.NewSha); err != nil {
+			d.logger.Error("error sending branch_tag webhook", "err", err)
+		}
+	}
+	if err := webhook.SendPushEvent(ctx, user, r, arg.RefName, arg.OldSha, arg.NewSha); err != nil {
+		d.logger.Error("error sending push webhook", "err", err)
+	}
 }
 
 // PostUpdate is called by the git post-update hook.

server/backend/repo.go

@@ -21,6 +21,7 @@ import (
 	"github.com/charmbracelet/soft-serve/server/storage"
 	"github.com/charmbracelet/soft-serve/server/task"
 	"github.com/charmbracelet/soft-serve/server/utils"
+	"github.com/charmbracelet/soft-serve/server/webhook"
 )
 
 func (d *Backend) reposPath() string {
@@ -88,7 +89,16 @@ func (d *Backend) CreateRepository(ctx context.Context, name string, user proto.
 		return nil, err
 	}
 
-	return d.Repository(ctx, name)
+	r, err := d.Repository(ctx, name)
+	if err != nil {
+		return nil, err
+	}
+
+	if err := webhook.SendRepositoryEvent(ctx, user, r, webhook.RepositoryEventCreated); err != nil {
+		return r, err
+	}
+
+	return r, nil
 }
 
 // ImportRepository imports a repository from remote.
@@ -197,7 +207,7 @@ func (d *Backend) ImportRepository(_ context.Context, name string, user proto.Us
 			return err
 		}
 
-		return nil
+		return webhook.SendRepositoryEvent(ctx, user, r, webhook.RepositoryEventImported)
 	})
 
 	go func() {
@@ -262,12 +272,18 @@ func (d *Backend) DeleteRepository(ctx context.Context, name string) error {
 		return proto.ErrRepoNotFound
 	}
 
-	return err
+	user := proto.UserFromContext(ctx)
+	r, err := d.Repository(ctx, name)
+	if err != nil {
+		return err
+	}
+
+	return webhook.SendRepositoryEvent(ctx, user, r, webhook.RepositoryEventDeleted)
 }
 
 // DeleteUserRepositories deletes all user repositories.
 func (d *Backend) DeleteUserRepositories(ctx context.Context, username string) error {
-	return d.db.TransactionContext(ctx, func(tx *db.Tx) error {
+	if err := d.db.TransactionContext(ctx, func(tx *db.Tx) error {
 		user, err := d.store.FindUserByUsername(ctx, tx, username)
 		if err != nil {
 			return err
@@ -285,7 +301,11 @@ func (d *Backend) DeleteUserRepositories(ctx context.Context, username string) e
 		}
 
 		return nil
-	})
+	}); err != nil {
+		return db.WrapError(err)
+	}
+
+	return nil
 }
 
 // RenameRepository renames a repository.
@@ -301,6 +321,11 @@ func (d *Backend) RenameRepository(ctx context.Context, oldName string, newName
 	if err := utils.ValidateRepo(newName); err != nil {
 		return err
 	}
+
+	if oldName == newName {
+		return nil
+	}
+
 	oldRepo := oldName + ".git"
 	newRepo := newName + ".git"
 	op := filepath.Join(d.reposPath(), oldRepo)
@@ -331,6 +356,16 @@ func (d *Backend) RenameRepository(ctx context.Context, oldName string, newName
 		return db.WrapError(err)
 	}
 
+	user := proto.UserFromContext(ctx)
+	repo, err := d.Repository(ctx, newName)
+	if err != nil {
+		return err
+	}
+
+	if err := webhook.SendRepositoryEvent(ctx, user, repo, webhook.RepositoryEventRenamed); err != nil {
+		return err
+	}
+
 	return nil
 }
 
@@ -537,7 +572,7 @@ func (d *Backend) SetPrivate(ctx context.Context, name string, private bool) err
 	// Delete cache
 	d.cache.Delete(name)
 
-	return db.WrapError(
+	if err := db.WrapError(
 		d.db.TransactionContext(ctx, func(tx *db.Tx) error {
 			fp := filepath.Join(rp, "git-daemon-export-ok")
 			if !private {
@@ -556,7 +591,23 @@ func (d *Backend) SetPrivate(ctx context.Context, name string, private bool) err
 
 			return d.store.SetRepoIsPrivateByName(ctx, tx, name, private)
 		}),
-	)
+	); err != nil {
+		return err
+	}
+
+	user := proto.UserFromContext(ctx)
+	repo, err := d.Repository(ctx, name)
+	if err != nil {
+		return err
+	}
+
+	if repo.IsPrivate() != !private {
+		if err := webhook.SendRepositoryEvent(ctx, user, repo, webhook.RepositoryEventVisibilityChanged); err != nil {
+			return err
+		}
+	}
+
+	return nil
 }
 
 // SetProjectName sets the project name of a repository.
@@ -651,6 +702,11 @@ func (r *repo) IsHidden() bool {
 	return r.repo.Hidden
 }
 
+// CreatedAt returns the repository's creation time.
+func (r *repo) CreatedAt() time.Time {
+	return r.repo.CreatedAt
+}
+
 // UpdatedAt returns the repository's last update time.
 func (r *repo) UpdatedAt() time.Time {
 	// Try to read the last modified time from the info directory.

server/config/config.go

@@ -40,6 +40,9 @@ type GitConfig struct {
 	// ListenAddr is the address on which the Git daemon will listen.
 	ListenAddr string `env:"LISTEN_ADDR" yaml:"listen_addr"`
 
+	// PublicURL is the public URL of the Git daemon server.
+	PublicURL string `env:"PUBLIC_URL" yaml:"public_url"`
+
 	// MaxTimeout is the maximum number of seconds a connection can take.
 	MaxTimeout int `env:"MAX_TIMEOUT" yaml:"max_timeout"`
 
@@ -157,6 +160,7 @@ func (c *Config) Environ() []string {
 		fmt.Sprintf("SOFT_SERVE_SSH_MAX_TIMEOUT=%d", c.SSH.MaxTimeout),
 		fmt.Sprintf("SOFT_SERVE_SSH_IDLE_TIMEOUT=%d", c.SSH.IdleTimeout),
 		fmt.Sprintf("SOFT_SERVE_GIT_LISTEN_ADDR=%s", c.Git.ListenAddr),
+		fmt.Sprintf("SOFT_SERVE_GIT_PUBLIC_URL=%s", c.Git.PublicURL),
 		fmt.Sprintf("SOFT_SERVE_GIT_MAX_TIMEOUT=%d", c.Git.MaxTimeout),
 		fmt.Sprintf("SOFT_SERVE_GIT_IDLE_TIMEOUT=%d", c.Git.IdleTimeout),
 		fmt.Sprintf("SOFT_SERVE_GIT_MAX_CONNECTIONS=%d", c.Git.MaxConnections),
@@ -304,6 +308,7 @@ func DefaultConfig() *Config {
 		},
 		Git: GitConfig{
 			ListenAddr:     ":9418",
+			PublicURL:      "git://localhost",
 			MaxTimeout:     0,
 			IdleTimeout:    3,
 			MaxConnections: 32,

server/config/file.go

@@ -50,6 +50,10 @@ git:
   # The address on which the Git daemon will listen.
   listen_addr: "{{ .Git.ListenAddr }}"
 
+  # The public URL of the Git daemon server.
+  # This is the address that will be used to clone repositories.
+  public_url: "{{ .Git.PublicURL }}"
+
   # The maximum number of seconds a connection can take.
   # A value of 0 means no timeout.
   max_timeout: {{ .Git.MaxTimeout }}

server/db/migrate/0002_webhooks.go

@@ -0,0 +1,23 @@
+package migrate
+
+import (
+	"context"
+
+	"github.com/charmbracelet/soft-serve/server/db"
+)
+
+const (
+	webhooksName    = "webhooks"
+	webhooksVersion = 2
+)
+
+var webhooks = Migration{
+	Name:    webhooksName,
+	Version: webhooksVersion,
+	Migrate: func(ctx context.Context, tx *db.Tx) error {
+		return migrateUp(ctx, tx, webhooksVersion, webhooksName)
+	},
+	Rollback: func(ctx context.Context, tx *db.Tx) error {
+		return migrateDown(ctx, tx, webhooksVersion, webhooksName)
+	},
+}