Live removal of issue comments using htmx websocket #28958
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| // Copyright 2023 The Gitea Authors. All rights reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package websocket | ||
|
|
||
| import ( | ||
| "code.gitea.io/gitea/modules/web" | ||
| "code.gitea.io/gitea/services/context" | ||
| "code.gitea.io/gitea/services/websocket" | ||
| ) | ||
|
|
||
| func Init(r *web.Route) { | ||
| m := websocket.Init() | ||
|
|
||
| r.Any("/-/ws", func(ctx *context.Context) { | ||
| err := m.HandleRequest(ctx.Resp, ctx.Req) | ||
| if err != nil { | ||
| ctx.ServerError("HandleRequest", err) | ||
| return | ||
| } | ||
| }) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| // Copyright 2024 The Gitea Authors. All rights reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package pubsub | ||
|
|
||
| import ( | ||
| "context" | ||
| "sync" | ||
| ) | ||
|
|
||
| type Memory struct { | ||
| sync.Mutex | ||
|
|
||
| topics map[string]map[*Subscriber]struct{} | ||
| } | ||
|
|
||
| // New creates an in-memory publisher. | ||
| func NewMemory() Broker { | ||
| return &Memory{ | ||
| topics: make(map[string]map[*Subscriber]struct{}), | ||
| } | ||
| } | ||
|
|
||
| func (p *Memory) Publish(_ context.Context, message Message) { | ||
| p.Lock() | ||
|
|
||
| topic, ok := p.topics[message.Topic] | ||
| if !ok { | ||
| p.Unlock() | ||
| return | ||
| } | ||
|
|
||
| for s := range topic { | ||
| go (*s)(message) | ||
| } | ||
| p.Unlock() | ||
| } | ||
|
|
||
| func (p *Memory) Subscribe(c context.Context, topic string, subscriber Subscriber) { | ||
| // Subscribe | ||
| p.Lock() | ||
| _, ok := p.topics[topic] | ||
| if !ok { | ||
| p.topics[topic] = make(map[*Subscriber]struct{}) | ||
| } | ||
| p.topics[topic][&subscriber] = struct{}{} | ||
| p.Unlock() | ||
|
|
||
| // Wait for context to be done | ||
| <-c.Done() | ||
|
|
||
| // Unsubscribe | ||
| p.Lock() | ||
| delete(p.topics[topic], &subscriber) | ||
| if len(p.topics[topic]) == 0 { | ||
| delete(p.topics, topic) | ||
| } | ||
| p.Unlock() | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| // Copyright 2024 The Gitea Authors. All rights reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package pubsub | ||
|
|
||
| import ( | ||
| "context" | ||
| "sync" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestPubsub(t *testing.T) { | ||
| var ( | ||
| wg sync.WaitGroup | ||
|
|
||
| testMessage = Message{ | ||
| Data: []byte("test"), | ||
| Topic: "hello-world", | ||
| } | ||
| ) | ||
|
|
||
| ctx, cancel := context.WithCancelCause( | ||
| context.Background(), | ||
| ) | ||
|
|
||
| broker := NewMemory() | ||
| go func() { | ||
| broker.Subscribe(ctx, "hello-world", func(message Message) { assert.Equal(t, testMessage, message); wg.Done() }) | ||
| }() | ||
| go func() { | ||
| broker.Subscribe(ctx, "hello-world", func(_ Message) { wg.Done() }) | ||
| }() | ||
|
|
||
| // Wait a bit for the subscriptions to be registered | ||
| <-time.After(100 * time.Millisecond) | ||
|
|
||
| wg.Add(2) | ||
| go func() { | ||
| broker.Publish(ctx, testMessage) | ||
| }() | ||
|
|
||
| wg.Wait() | ||
| cancel(nil) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| // Copyright 2024 The Gitea Authors. All rights reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package pubsub | ||
|
|
||
| import "context" | ||
|
|
||
| // Message defines a published message. | ||
| type Message struct { | ||
| // Data is the actual data in the entry. | ||
| Data []byte `json:"data"` | ||
|
|
||
| // Topic is the topic of the message. | ||
| Topic string `json:"topic"` | ||
| } | ||
|
|
||
| // Subscriber receives published messages. | ||
| type Subscriber func(Message) | ||
|
|
||
| type Broker interface { | ||
| Publish(c context.Context, message Message) | ||
| Subscribe(c context.Context, topic string, subscriber Subscriber) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| // Copyright 2024 The Gitea Authors. All rights reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package websocket | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
|
|
||
| issues_model "code.gitea.io/gitea/models/issues" | ||
| user_model "code.gitea.io/gitea/models/user" | ||
| "code.gitea.io/gitea/services/pubsub" | ||
| ) | ||
|
|
||
| func (n *websocketNotifier) DeleteComment(ctx context.Context, doer *user_model.User, c *issues_model.Comment) { | ||
| d, err := json.Marshal(c) | ||
| if err != nil { | ||
| return | ||
| } | ||
|
|
||
| n.pubsub.Publish(ctx, pubsub.Message{ | ||
|
There was a problem hiding this comment. Maybe the topic should still contain the issue and index. And it also includes the actions like delete/create/update. Because I think different pages of the same clients should not share the same web socket client. |
||
| Data: d, | ||
| Topic: fmt.Sprintf("repo:%s/%s", c.RefRepo.OwnerName, c.RefRepo.Name), | ||
| }) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| // Copyright 2024 The Gitea Authors. All rights reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package websocket | ||
|
|
||
| import ( | ||
| "code.gitea.io/gitea/modules/templates" | ||
| notify_service "code.gitea.io/gitea/services/notify" | ||
| "code.gitea.io/gitea/services/pubsub" | ||
|
|
||
| "github.com/olahol/melody" | ||
| ) | ||
|
|
||
| type websocketNotifier struct { | ||
| notify_service.NullNotifier | ||
| m *melody.Melody | ||
| rnd *templates.HTMLRender | ||
| pubsub pubsub.Broker | ||
| } | ||
|
|
||
| // NewNotifier create a new webhooksNotifier notifier | ||
| func newNotifier(m *melody.Melody) notify_service.Notifier { | ||
| return &websocketNotifier{ | ||
| m: m, | ||
| rnd: templates.HTMLRenderer(), | ||
| } | ||
| } | ||
|
|
||
| // htmxAddElementEnd = "<div hx-swap-oob=\"beforebegin:%s\">%s</div>" | ||
| // htmxUpdateElement = "<div hx-swap-oob=\"outerHTML:%s\">%s</div>" | ||
|
|
||
| var htmxRemoveElement = "<div hx-swap-oob=\"delete:%s\"></div>" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| // Copyright 2024 The Gitea Authors. All rights reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package websocket | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/url" | ||
|
|
||
| user_model "code.gitea.io/gitea/models/user" | ||
|
|
||
| "github.com/olahol/melody" | ||
| ) | ||
|
|
||
| type sessionData struct { | ||
| user *user_model.User | ||
| onURL string | ||
| } | ||
|
|
||
| func (d *sessionData) isOnURL(_u1 string) bool { | ||
| if d.onURL == "" { | ||
| return true | ||
| } | ||
|
|
||
| u1, _ := url.Parse(d.onURL) | ||
| u2, _ := url.Parse(_u1) | ||
| return u1.Path == u2.Path | ||
| } | ||
|
|
||
| func getSessionData(s *melody.Session) (*sessionData, error) { | ||
| _data, ok := s.Get("data") | ||
| if !ok { | ||
| return nil, fmt.Errorf("no session data") | ||
| } | ||
|
|
||
| data, ok := _data.(*sessionData) | ||
| if !ok { | ||
| return nil, fmt.Errorf("invalid session data") | ||
| } | ||
|
|
||
| return data, nil | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.