appview: introduce email notifications for @ mentions on issue/pr comments #393

+7 -1

appview/pages/markup/markdown.go

··· 45 45 Sanitizer Sanitizer 46 46 } 47 47 48 48 - func (rctx *RenderContext) RenderMarkdown(source string) string { 48 48 + func NewMarkdown() goldmark.Markdown { 49 49 md := goldmark.New( 50 50 goldmark.WithExtensions( 51 51 extension.GFM, ··· 59 59 extension.NewFootnote( 60 60 extension.WithFootnoteIDPrefix([]byte("footnote")), 61 61 ), 62 62 + AtExt, 62 63 ), 63 64 goldmark.WithParserOptions( 64 65 parser.WithAutoHeadingID(), 65 66 ), 66 67 goldmark.WithRendererOptions(html.WithUnsafe()), 67 68 ) 69 69 + return md 70 70 + } 71 71 + 72 72 + func (rctx *RenderContext) RenderMarkdown(source string) string { 73 73 + md := NewMarkdown() 68 74 69 75 if rctx != nil { 70 76 var transformers []util.PrioritizedValue

+134

appview/pages/markup/markdown_at_extension.go

··· 1 1 + // heavily inspired by: https://github.com/kaleocheng/goldmark-extensions 2 2 + 3 3 + package markup 4 4 + 5 5 + import ( 6 6 + "regexp" 7 7 + 8 8 + "github.com/yuin/goldmark" 9 9 + "github.com/yuin/goldmark/ast" 10 10 + "github.com/yuin/goldmark/parser" 11 11 + "github.com/yuin/goldmark/renderer" 12 12 + "github.com/yuin/goldmark/renderer/html" 13 13 + "github.com/yuin/goldmark/text" 14 14 + "github.com/yuin/goldmark/util" 15 15 + ) 16 16 + 17 17 + // An AtNode struct represents an AtNode 18 18 + type AtNode struct { 19 19 + handle string 20 20 + ast.BaseInline 21 21 + } 22 22 + 23 23 + var _ ast.Node = &AtNode{} 24 24 + 25 25 + // Dump implements Node.Dump. 26 26 + func (n *AtNode) Dump(source []byte, level int) { 27 27 + ast.DumpHelper(n, source, level, nil, nil) 28 28 + } 29 29 + 30 30 + // KindAt is a NodeKind of the At node. 31 31 + var KindAt = ast.NewNodeKind("At") 32 32 + 33 33 + // Kind implements Node.Kind. 34 34 + func (n *AtNode) Kind() ast.NodeKind { 35 35 + return KindAt 36 36 + } 37 37 + 38 38 + var atRegexp = regexp.MustCompile(`(^|\s|\()(@)([a-zA-Z0-9.-]+)(\b)`) 39 39 + 40 40 + type atParser struct{} 41 41 + 42 42 + // NewAtParser return a new InlineParser that parses 43 43 + // at expressions. 44 44 + func NewAtParser() parser.InlineParser { 45 45 + return &atParser{} 46 46 + } 47 47 + 48 48 + func (s *atParser) Trigger() []byte { 49 49 + return []byte{'@'} 50 50 + } 51 51 + 52 52 + func (s *atParser) Parse(parent ast.Node, block text.Reader, pc parser.Context) ast.Node { 53 53 + line, segment := block.PeekLine() 54 54 + m := atRegexp.FindSubmatchIndex(line) 55 55 + if m == nil { 56 56 + return nil 57 57 + } 58 58 + block.Advance(m[1]) 59 59 + node := &AtNode{} 60 60 + node.AppendChild(node, ast.NewTextSegment(text.NewSegment(segment.Start, segment.Start+m[1]))) 61 61 + node.handle = string(node.Text(block.Source())[1:]) 62 62 + return node 63 63 + } 64 64 + 65 65 + // atHtmlRenderer is a renderer.NodeRenderer implementation that 66 66 + // renders At nodes. 67 67 + type atHtmlRenderer struct { 68 68 + html.Config 69 69 + } 70 70 + 71 71 + // NewAtHTMLRenderer returns a new AtHTMLRenderer. 72 72 + func NewAtHTMLRenderer(opts ...html.Option) renderer.NodeRenderer { 73 73 + r := &atHtmlRenderer{ 74 74 + Config: html.NewConfig(), 75 75 + } 76 76 + for _, opt := range opts { 77 77 + opt.SetHTMLOption(&r.Config) 78 78 + } 79 79 + return r 80 80 + } 81 81 + 82 82 + // RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs. 83 83 + func (r *atHtmlRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer) { 84 84 + reg.Register(KindAt, r.renderAt) 85 85 + } 86 86 + 87 87 + func (r *atHtmlRenderer) renderAt(w util.BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error) { 88 88 + if entering { 89 89 + w.WriteString(`<a href="/@`) 90 90 + w.WriteString(n.(*AtNode).handle) 91 91 + w.WriteString(`" class="text-red-500">`) 92 92 + } else { 93 93 + w.WriteString("</a>") 94 94 + } 95 95 + return ast.WalkContinue, nil 96 96 + } 97 97 + 98 98 + type atExt struct{} 99 99 + 100 100 + // At is an extension that allow you to use at expression like '@user.bsky.social' . 101 101 + var AtExt = &atExt{} 102 102 + 103 103 + func (e *atExt) Extend(m goldmark.Markdown) { 104 104 + m.Parser().AddOptions(parser.WithInlineParsers( 105 105 + util.Prioritized(NewAtParser(), 500), 106 106 + )) 107 107 + m.Renderer().AddOptions(renderer.WithNodeRenderers( 108 108 + util.Prioritized(NewAtHTMLRenderer(), 500), 109 109 + )) 110 110 + } 111 111 + 112 112 + // FindUserMentions returns Set of user handles from given markup soruce. 113 113 + // It doesn't guarntee unique DIDs 114 114 + func FindUserMentions(source string) []string { 115 115 + var ( 116 116 + mentions []string 117 117 + mentionsSet = make(map[string]struct{}) 118 118 + md = NewMarkdown() 119 119 + sourceBytes = []byte(source) 120 120 + root = md.Parser().Parse(text.NewReader(sourceBytes)) 121 121 + ) 122 122 + ast.Walk(root, func(n ast.Node, entering bool) (ast.WalkStatus, error) { 123 123 + if entering && n.Kind() == KindAt { 124 124 + handle := n.(*AtNode).handle 125 125 + mentionsSet[handle] = struct{}{} 126 126 + return ast.WalkSkipChildren, nil 127 127 + } 128 128 + return ast.WalkContinue, nil 129 129 + }) 130 130 + for handle := range mentionsSet { 131 131 + mentions = append(mentions, handle) 132 132 + } 133 133 + return mentions 134 134 + }

+18 -16

appview/issues/issues.go

··· 260 260 return 261 261 } 262 262 263 263 - commentId := mathrand.IntN(1000000) 264 264 - rkey := tid.TID() 265 265 - 266 266 - err := db.NewIssueComment(rp.db, &db.Comment{ 263 263 + comment := &db.Comment{ 267 264 OwnerDid: user.Did, 268 265 RepoAt: f.RepoAt(), 269 266 Issue: issueIdInt, 270 270 - CommentId: commentId, 267 267 + CommentId: mathrand.IntN(1000000), 271 268 Body: body, 272 272 - Rkey: rkey, 273 273 - }) 269 269 + Rkey: tid.TID(), 270 270 + } 271 271 + 272 272 + err := db.NewIssueComment(rp.db, comment) 274 273 if err != nil { 275 274 log.Println("failed to create comment", err) 276 275 rp.pages.Notice(w, "issue-comment", "Failed to create comment.") ··· 278 277 } 279 278 280 279 createdAt := time.Now().Format(time.RFC3339) 281 281 - commentIdInt64 := int64(commentId) 282 282 - ownerDid := user.Did 283 283 - issueAt, err := db.GetIssueAt(rp.db, f.RepoAt(), issueIdInt) 280 280 + commentIdInt64 := int64(comment.CommentId) 281 281 + issue, err := db.GetIssue(rp.db, f.RepoAt(), issueIdInt) 284 282 if err != nil { 285 285 - log.Println("failed to get issue at", err) 283 283 + log.Println("failed to get issue", err) 286 284 rp.pages.Notice(w, "issue-comment", "Failed to create comment.") 287 285 return 288 286 } 289 287 290 290 - atUri := f.RepoAt().String() 288 288 + atUri := comment.RepoAt.String() 291 289 client, err := rp.oauth.AuthorizedClient(r) 292 290 if err != nil { 293 291 log.Println("failed to get authorized client", err) ··· 297 295 _, err = client.RepoPutRecord(r.Context(), &comatproto.RepoPutRecord_Input{ 298 296 Collection: tangled.RepoIssueCommentNSID, 299 297 Repo: user.Did, 300 300 - Rkey: rkey, 298 298 + Rkey: comment.Rkey, 301 299 Record: &lexutil.LexiconTypeDecoder{ 302 300 Val: &tangled.RepoIssueComment{ 303 301 Repo: &atUri, 304 304 - Issue: issueAt, 302 302 + Issue: issue.AtUri().String(), 305 303 CommentId: &commentIdInt64, 306 306 - Owner: &ownerDid, 304 304 + Owner: &comment.OwnerDid, 307 305 Body: body, 308 306 CreatedAt: createdAt, 309 307 }, ··· 315 313 return 316 314 } 317 315 318 318 - rp.pages.HxLocation(w, fmt.Sprintf("/%s/issues/%d#comment-%d", f.OwnerSlashRepo(), issueIdInt, commentId)) 316 316 + mentions := markup.FindUserMentions(comment.Body) 317 317 + 318 318 + rp.notifier.NewIssueComment(r.Context(), &f.Repo, issue, comment, mentions) 319 319 + 320 320 + rp.pages.HxLocation(w, fmt.Sprintf("/%s/issues/%d#comment-%d", f.OwnerSlashRepo(), comment.Issue, comment.CommentId)) 319 321 return 320 322 } 321 323 }

+3 -8

appview/email/email.go

··· 1 1 package email 2 2 3 3 import ( 4 4 - "fmt" 5 4 "net" 6 5 "regexp" 7 6 "strings" ··· 11 10 12 11 type Email struct { 13 12 From string 14 14 - To string 15 13 Subject string 16 14 Text string 17 15 Html string 18 16 APIKey string 19 17 } 20 18 21 21 - func SendEmail(email Email) error { 19 19 + func SendEmail(email Email, recipients ...string) error { 22 20 client := resend.NewClient(email.APIKey) 23 21 _, err := client.Emails.Send(&resend.SendEmailRequest{ 24 22 From: email.From, 25 25 - To: []string{email.To}, 23 23 + To: recipients, 26 24 Subject: email.Subject, 27 25 Text: email.Text, 28 26 Html: email.Html, 29 27 }) 30 30 - if err != nil { 31 31 - return fmt.Errorf("error sending email: %w", err) 32 32 - } 33 33 - return nil 28 28 + return err 34 29 } 35 30 36 31 func IsValidEmail(email string) bool {

+1 -2

appview/signup/signup.go

··· 149 149 em := email.Email{ 150 150 APIKey: s.config.Resend.ApiKey, 151 151 From: s.config.Resend.SentFrom, 152 152 - To: emailId, 153 152 Subject: "Verify your Tangled account", 154 153 Text: `Copy and paste this code below to verify your account on Tangled. 155 154 ` + code, ··· 157 156 <p><code>` + code + `</code></p>`, 158 157 } 159 158 160 160 - err = email.SendEmail(em) 159 159 + err = email.SendEmail(em, emailId) 161 160 if err != nil { 162 161 s.l.Error("failed to send email", "error", err) 163 162 s.pages.Notice(w, noticeId, "Failed to send email.")

+2

appview/state/state.go

··· 20 20 "tangled.sh/tangled.sh/core/appview/cache/session" 21 21 "tangled.sh/tangled.sh/core/appview/config" 22 22 "tangled.sh/tangled.sh/core/appview/db" 23 23 + "tangled.sh/tangled.sh/core/appview/email" 23 24 "tangled.sh/tangled.sh/core/appview/notify" 24 25 "tangled.sh/tangled.sh/core/appview/oauth" 25 26 "tangled.sh/tangled.sh/core/appview/pages" ··· 133 134 spindlestream.Start(ctx) 134 135 135 136 var notifiers []notify.Notifier 137 137 + notifiers = append(notifiers, email.NewEmailNotifier(d, res, config)) 136 138 if !config.Core.Dev { 137 139 notifiers = append(notifiers, posthogService.NewPosthogNotifier(posthog)) 138 140 }

+7

appview/db/db.go

··· 678 678 return err 679 679 }) 680 680 681 681 + runMigration(conn, "add-email-notif-preference-to-profile", func(tx *sql.Tx) error { 682 682 + _, err := tx.Exec(` 683 683 + alter table profile add column email_notif_preference integer not null default 0 check (email_notif_preference in (0, 1, 2)); -- disable, metion, enable 684 684 + `) 685 685 + return err 686 686 + }) 687 687 + 681 688 return &DB{db}, nil 682 689 } 683 690

+22

appview/db/email.go

··· 299 299 _, err := e.Exec(query, code, did, email) 300 300 return err 301 301 } 302 302 + 303 303 + func GetUserEmailPreference(e Execer, did string) (EmailPreference, error) { 304 304 + var preference EmailPreference 305 305 + err := e.QueryRow(` 306 306 + select email_notif_preference 307 307 + from profile 308 308 + where did = ? 309 309 + `, did).Scan(&preference) 310 310 + if err != nil { 311 311 + return preference, err 312 312 + } 313 313 + return preference, nil 314 314 + } 315 315 + 316 316 + func UpdateSettingsEmailPreference(e Execer, did string, preference EmailPreference) error { 317 317 + _, err := e.Exec(` 318 318 + update profile 319 319 + set email_notif_preference = ? 320 320 + where did = ? 321 321 + `, preference, did) 322 322 + return err 323 323 + }

+32 -6

appview/db/profile.go

··· 183 183 Links [5]string 184 184 Stats [2]VanityStat 185 185 PinnedRepos [6]syntax.ATURI 186 186 + 187 187 + // settings 188 188 + EmailNotifPreference EmailPreference 189 189 + } 190 190 + 191 191 + type EmailPreference int 192 192 + 193 193 + const ( 194 194 + EmailNotifDisabled EmailPreference = iota 195 195 + EmailNotifMention 196 196 + EmailNotifEnabled 197 197 + ) 198 198 + 199 199 + func (p EmailPreference) IsDisabled() bool { 200 200 + return p == EmailNotifDisabled 201 201 + } 202 202 + 203 203 + func (p EmailPreference) IsMention() bool { 204 204 + return p == EmailNotifMention 205 205 + } 206 206 + 207 207 + func (p EmailPreference) IsEnabled() bool { 208 208 + return p == EmailNotifEnabled 186 209 } 187 210 188 211 func (p Profile) IsLinksEmpty() bool { ··· 280 303 did, 281 304 description, 282 305 include_bluesky, 283 283 - location 306 306 + location, 307 307 + email_notif_preference 284 308 ) 285 285 - values (?, ?, ?, ?)`, 309 309 + values (?, ?, ?, ?, ?)`, 286 310 profile.Did, 287 311 profile.Description, 288 312 includeBskyValue, 289 313 profile.Location, 314 314 + profile.EmailNotifPreference, 290 315 ) 291 316 292 317 if err != nil { ··· 367 392 did, 368 393 description, 369 394 include_bluesky, 370 370 - location 395 395 + location, 396 396 + email_notif_preference 371 397 from 372 398 profile 373 399 %s`, ··· 383 409 var profile Profile 384 410 var includeBluesky int 385 411 386 386 - err = rows.Scan(&profile.ID, &profile.Did, &profile.Description, &includeBluesky, &profile.Location) 412 412 + err = rows.Scan(&profile.ID, &profile.Did, &profile.Description, &includeBluesky, &profile.Location, &profile.EmailNotifPreference) 387 413 if err != nil { 388 414 return nil, err 389 415 } ··· 462 488 463 489 includeBluesky := 0 464 490 err := e.QueryRow( 465 465 - `select description, include_bluesky, location from profile where did = ?`, 491 491 + `select description, include_bluesky, location, email_notif_preference from profile where did = ?`, 466 492 did, 467 467 - ).Scan(&profile.Description, &includeBluesky, &profile.Location) 493 493 + ).Scan(&profile.Description, &includeBluesky, &profile.Location, &profile.EmailNotifPreference) 468 494 if err == sql.ErrNoRows { 469 495 profile := Profile{} 470 496 profile.Did = did

+4 -3

appview/pages/pages.go

··· 307 307 } 308 308 309 309 type SettingsParams struct { 310 310 - LoggedInUser *oauth.User 311 311 - PubKeys []db.PublicKey 312 312 - Emails []db.Email 310 310 + LoggedInUser *oauth.User 311 311 + PubKeys []db.PublicKey 312 312 + Emails []db.Email 313 313 + EmailNotifPreference db.EmailPreference 313 314 } 314 315 315 316 func (p *Pages) Settings(w io.Writer, params SettingsParams) error {

+20

appview/pages/templates/settings.html

··· 93 93 {{ define "emails" }} 94 94 <h2 class="text-sm font-bold py-2 px-6 uppercase dark:text-gray-300">email addresses</h2> 95 95 <section class="rounded bg-white dark:bg-gray-800 drop-shadow-sm px-6 py-4 mb-6 w-full lg:w-fit"> 96 96 + <form 97 97 + hx-post="/settings/email/preference" 98 98 + hx-swap="none" 99 99 + hx-indicator="#email-preference-spinner" 100 100 + > 101 101 + <select 102 102 + name="preference" 103 103 + class="p-1 border border-gray-200 bg-white dark:bg-gray-700 dark:text-white dark:border-gray-600" 104 104 + > 105 105 + <option value="enable" {{ if .EmailNotifPreference.IsEnabled }}selected{{ end }}>Enable Email Notifications</option> 106 106 + <option value="mention" {{ if .EmailNotifPreference.IsMention }}selected{{ end }}>Only on Mentions</option> 107 107 + <option value="disable" {{ if .EmailNotifPreference.IsDisabled }}selected{{ end }}>Disable Email Notifications</option> 108 108 + </select> 109 109 + <button type="submit" class="btn text-base"> 110 110 + <span>Save Preference</span> 111 111 + <span id="email-preference-spinner" class="group"> 112 112 + {{ i "loader-circle" "w-4 h-4 animate-spin hidden group-[.htmx-request]:inline" }} 113 113 + </span> 114 114 + </button> 115 115 + </form> 96 116 <p class="mb-8 dark:text-gray-300">Commits authored using emails listed here will be associated with your Tangled profile.</p> 97 117 <div id="email-list" class="flex flex-col gap-6 mb-8"> 98 118 {{ range $index, $email := .Emails }}

+30 -3

appview/email/notifier.go

··· 69 69 }, nil 70 70 } 71 71 72 72 + func (n *EmailNotifier) buildPullEmail(ctx context.Context, repo *db.Repo, pull *db.Pull, comment *db.PullComment) (Email, error) { 73 73 + commentOwner, err := n.idResolver.ResolveIdent(ctx, comment.OwnerDid) 74 74 + if err != nil || commentOwner.Handle.IsInvalidHandle() { 75 75 + return Email{}, fmt.Errorf("resolve comment owner did: %w", err) 76 76 + } 77 77 + repoOwnerSlashName, err := n.repoOwnerSlashName(ctx, repo) 78 78 + if err != nil { 79 79 + return Email{}, nil 80 80 + } 81 81 + baseUrl := n.Config.Core.AppviewHost 82 82 + url := fmt.Sprintf("%s/%s/pulls/%d#comment-%d", baseUrl, repoOwnerSlashName, comment.PullId, comment.ID) 83 83 + return Email{ 84 84 + APIKey: n.Config.Resend.ApiKey, 85 85 + From: n.Config.Resend.SentFrom, 86 86 + Subject: fmt.Sprintf("[%s] %s (pr#%d)", repoOwnerSlashName, pull.Title, pull.PullId), 87 87 + Html: fmt.Sprintf(`<p><b>@%s</b> mentioned you</p><a href="%s">View it on tangled.sh</a>.`, commentOwner.Handle.String(), url), 88 88 + }, nil 89 89 + } 90 90 + 72 91 func (n *EmailNotifier) gatherRecipientEmails(ctx context.Context, handles []string) []string { 73 92 recipients := []string{} 74 93 for _, handle := range handles { ··· 109 128 } 110 129 } 111 130 112 112 - // func (n *EmailNotifier) NewPullComment(ctx context.Context, comment *db.PullComment, []string) { 113 113 - // n.usersMentioned(ctx, mentions) 114 114 - // } 131 131 + func (n *EmailNotifier) NewPullComment(ctx context.Context, repo *db.Repo, pull *db.Pull, comment *db.PullComment, mentions []string) { 132 132 + email, err := n.buildPullEmail(ctx, repo, pull, comment) 133 133 + if err != nil { 134 134 + log.Println("failed to create pull-email:", err) 135 135 + } 136 136 + recipients := n.gatherRecipientEmails(ctx, mentions) 137 137 + log.Println("sending email to:", recipients) 138 138 + if err = SendEmail(email); err != nil { 139 139 + log.Println("error sending email:", err) 140 140 + } 141 141 + }

+3 -1

appview/pulls/pulls.go

··· 668 668 return 669 669 } 670 670 671 671 - s.notifier.NewPullComment(r.Context(), comment) 671 671 + mentions := markup.FindUserMentions(comment.Body) 672 672 + 673 673 + s.notifier.NewPullComment(r.Context(), &f.Repo, pull, comment, mentions) 672 674 673 675 s.pages.HxLocation(w, fmt.Sprintf("/%s/pulls/%d#comment-%d", f.OwnerSlashRepo(), pull.PullId, commentId)) 674 676 return