[feature] Implement filters_changed stream event (#2972)

internal/processing/filters/v1/create.go

@@ -83,5 +83,13 @@ func (p *Processor) Create(ctx context.Context, account *gtsmodel.Account, form
 		return nil, gtserror.NewErrorInternalError(err)
 	}
 
-	return p.apiFilter(ctx, filterKeyword)
+	apiFilter, errWithCode := p.apiFilter(ctx, filterKeyword)
+	if errWithCode != nil {
+		return nil, errWithCode
+	}
+
+	// Send a filters changed event.
+	p.stream.FiltersChanged(ctx, account)
+
+	return apiFilter, nil
 }

internal/processing/filters/v1/delete.go

@@ -63,5 +63,8 @@ func (p *Processor) Delete(
 		}
 	}
 
+	// Send a filters changed event.
+	p.stream.FiltersChanged(ctx, account)
+
 	return nil
 }

internal/processing/filters/v1/filters.go

@@ -18,6 +18,7 @@
 package v1
 
 import (
+	"github.com/superseriousbusiness/gotosocial/internal/processing/stream"
 	"github.com/superseriousbusiness/gotosocial/internal/state"
 	"github.com/superseriousbusiness/gotosocial/internal/typeutils"
 )
@@ -25,11 +26,13 @@ import (
 type Processor struct {
 	state     *state.State
 	converter *typeutils.Converter
+	stream    *stream.Processor
 }
 
-func New(state *state.State, converter *typeutils.Converter) Processor {
+func New(state *state.State, converter *typeutils.Converter, stream *stream.Processor) Processor {
 	return Processor{
 		state:     state,
 		converter: converter,
+		stream:    stream,
 	}
 }

internal/processing/filters/v1/update.go

@@ -163,5 +163,13 @@ func (p *Processor) Update(
 		return nil, gtserror.NewErrorInternalError(err)
 	}
 
-	return p.apiFilter(ctx, filterKeyword)
+	apiFilter, errWithCode := p.apiFilter(ctx, filterKeyword)
+	if errWithCode != nil {
+		return nil, errWithCode
+	}
+
+	// Send a filters changed event.
+	p.stream.FiltersChanged(ctx, account)
+
+	return apiFilter, nil
 }

internal/processing/filters/v2/create.go

@@ -71,5 +71,13 @@ func (p *Processor) Create(ctx context.Context, account *gtsmodel.Account, form
 		return nil, gtserror.NewErrorInternalError(err)
 	}
 
-	return p.apiFilter(ctx, filter)
+	apiFilter, errWithCode := p.apiFilter(ctx, filter)
+	if errWithCode != nil {
+		return nil, errWithCode
+	}
+
+	// Send a filters changed event.
+	p.stream.FiltersChanged(ctx, account)
+
+	return apiFilter, nil
 }

internal/processing/filters/v2/delete.go

@@ -49,5 +49,8 @@ func (p *Processor) Delete(
 		return gtserror.NewErrorInternalError(err)
 	}
 
+	// Send a filters changed event.
+	p.stream.FiltersChanged(ctx, account)
+
 	return nil
 }

internal/processing/filters/v2/filters.go

@@ -18,6 +18,7 @@
 package v2
 
 import (
+	"github.com/superseriousbusiness/gotosocial/internal/processing/stream"
 	"github.com/superseriousbusiness/gotosocial/internal/state"
 	"github.com/superseriousbusiness/gotosocial/internal/typeutils"
 )
@@ -25,11 +26,13 @@ import (
 type Processor struct {
 	state     *state.State
 	converter *typeutils.Converter
+	stream    *stream.Processor
 }
 
-func New(state *state.State, converter *typeutils.Converter) Processor {
+func New(state *state.State, converter *typeutils.Converter, stream *stream.Processor) Processor {
 	return Processor{
 		state:     state,
 		converter: converter,
+		stream:    stream,
 	}
 }

internal/processing/filters/v2/keywordcreate.go

@@ -63,5 +63,8 @@ func (p *Processor) KeywordCreate(ctx context.Context, account *gtsmodel.Account
 		return nil, gtserror.NewErrorInternalError(err)
 	}
 
+	// Send a filters changed event.
+	p.stream.FiltersChanged(ctx, account)
+
 	return p.converter.FilterKeywordToAPIFilterKeyword(ctx, filterKeyword), nil
 }

internal/processing/filters/v2/keyworddelete.go

@@ -49,5 +49,8 @@ func (p *Processor) KeywordDelete(
 		return gtserror.NewErrorInternalError(err)
 	}
 
+	// Send a filters changed event.
+	p.stream.FiltersChanged(ctx, account)
+
 	return nil
 }

internal/processing/filters/v2/keywordupdate.go

@@ -62,5 +62,8 @@ func (p *Processor) KeywordUpdate(
 		return nil, gtserror.NewErrorInternalError(err)
 	}
 
+	// Send a filters changed event.
+	p.stream.FiltersChanged(ctx, account)
+
 	return p.converter.FilterKeywordToAPIFilterKeyword(ctx, filterKeyword), nil
 }

internal/processing/filters/v2/statuscreate.go

@@ -62,5 +62,8 @@ func (p *Processor) StatusCreate(ctx context.Context, account *gtsmodel.Account,
 		return nil, gtserror.NewErrorInternalError(err)
 	}
 
+	// Send a filters changed event.
+	p.stream.FiltersChanged(ctx, account)
+
 	return p.converter.FilterStatusToAPIFilterStatus(ctx, filterStatus), nil
 }

internal/processing/filters/v2/statusdelete.go

@@ -49,5 +49,8 @@ func (p *Processor) StatusDelete(
 		return gtserror.NewErrorInternalError(err)
 	}
 
+	// Send a filters changed event.
+	p.stream.FiltersChanged(ctx, account)
+
 	return nil
 }

internal/processing/filters/v2/update.go

@@ -121,5 +121,13 @@ func (p *Processor) Update(
 	filter.Keywords = filterKeywords
 	filter.Statuses = filterStatuses
 
-	return p.apiFilter(ctx, filter)
+	apiFilter, errWithCode := p.apiFilter(ctx, filter)
+	if errWithCode != nil {
+		return nil, errWithCode
+	}
+
+	// Send a filters changed event.
+	p.stream.FiltersChanged(ctx, account)
+
+	return apiFilter, nil
 }

internal/processing/processor.go

@@ -189,8 +189,8 @@ func NewProcessor(
 	processor.account = account.New(&common, state, converter, mediaManager, federator, filter, parseMentionFunc)
 	processor.admin = admin.New(state, cleaner, converter, mediaManager, federator.TransportController(), emailSender)
 	processor.fedi = fedi.New(state, &common, converter, federator, filter)
-	processor.filtersv1 = filtersv1.New(state, converter)
-	processor.filtersv2 = filtersv2.New(state, converter)
+	processor.filtersv1 = filtersv1.New(state, converter, &processor.stream)
+	processor.filtersv2 = filtersv2.New(state, converter, &processor.stream)
 	processor.list = list.New(state, converter)
 	processor.markers = markers.New(state, converter)
 	processor.polls = polls.New(&common, state, converter)

internal/processing/stream/filterschanged.go

@@ -0,0 +1,36 @@
+// GoToSocial
+// Copyright (C) GoToSocial Authors admin@gotosocial.org
+// SPDX-License-Identifier: AGPL-3.0-or-later
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package stream
+
+import (
+	"context"
+
+	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+	"github.com/superseriousbusiness/gotosocial/internal/stream"
+)
+
+// FiltersChanged streams a filters changed event to any open, appropriate streams belonging to the given account.
+// Filter changes have no payload.
+func (p *Processor) FiltersChanged(ctx context.Context, account *gtsmodel.Account) {
+	p.streams.Post(ctx, account.ID, stream.Message{
+		Event: stream.EventTypeFiltersChanged,
+		Stream: []string{
+			stream.TimelineHome,
+		},
+	})
+}