feat: custom message text (#1801)

* feat: default custom message text

* feat: org custom message text

* feat: org custom message text

* feat: custom messages query side

* feat: default messages

* feat: message text user fields

* feat: check for inactive user

* feat: fix send password reset

* feat: fix custom org text

* feat: add variables to docs

* feat: custom text tests

* feat: fix notifications

* feat: add custom text feature

* feat: add custom text feature

* feat: feature in custom message texts

* feat: add custom text feature in frontend

* feat: merge main

* feat: feature tests

* feat: change phone message in setup

* fix: remove unused code, add event translation

* fix: merge main and fix problems

* fix: english translation file

* fix: migration versions

* fix: setup

* feat: fix pr requests

* feat: fix phone code message

* feat: migration

* feat: setup

* fix: remove unused tests

Co-authored-by: Livio Amstutz <livio.a@gmail.com>

internal/admin/repository/eventsourcing/eventstore/iam.go

@@ -2,16 +2,18 @@ package eventstore
 
 import (
 	"context"
+	"strings"
+
 	"github.com/caos/zitadel/internal/domain"
 	"github.com/caos/zitadel/internal/eventstore/v1"
 	"github.com/caos/zitadel/internal/eventstore/v1/models"
 	iam_view "github.com/caos/zitadel/internal/iam/repository/view"
 	"github.com/caos/zitadel/internal/user/repository/view/model"
-	"strings"
 
 	caos_errs "github.com/caos/zitadel/internal/errors"
 
 	"github.com/caos/logging"
+
 	admin_view "github.com/caos/zitadel/internal/admin/repository/eventsourcing/view"
 	"github.com/caos/zitadel/internal/config/systemdefaults"
 	iam_model "github.com/caos/zitadel/internal/iam/model"
@@ -347,21 +349,21 @@ func (repo *IAMRepository) SearchIAMMembersx(ctx context.Context, request *iam_m
 	return result, nil
 }
 
-func (repo *IAMRepository) GetDefaultMailTexts(ctx context.Context) (*iam_model.MailTextsView, error) {
-	text, err := repo.View.MailTexts(repo.SystemDefaults.IamID)
+func (repo *IAMRepository) GetDefaultMessageTexts(ctx context.Context) (*iam_model.MessageTextsView, error) {
+	text, err := repo.View.MessageTexts(repo.SystemDefaults.IamID)
 	if err != nil {
 		return nil, err
 	}
-	return iam_es_model.MailTextsViewToModel(text, true), err
+	return iam_es_model.MessageTextsViewToModel(text, true), err
 }
 
-func (repo *IAMRepository) GetDefaultMailText(ctx context.Context, textType string, language string) (*iam_model.MailTextView, error) {
-	text, err := repo.View.MailTextByIDs(repo.SystemDefaults.IamID, textType, language)
+func (repo *IAMRepository) GetDefaultMessageText(ctx context.Context, textType, lang string) (*iam_model.MessageTextView, error) {
+	text, err := repo.View.MessageTextByIDs(repo.SystemDefaults.IamID, textType, lang)
 	if err != nil {
 		return nil, err
 	}
 	text.Default = true
-	return iam_es_model.MailTextViewToModel(text), err
+	return iam_es_model.MessageTextViewToModel(text), err
 }
 
 func (repo *IAMRepository) getIAMEvents(ctx context.Context, sequence uint64) ([]*models.Event, error) {

internal/admin/repository/eventsourcing/handler/handler.go

@@ -62,8 +62,8 @@ func Register(configs Configs, bulkLimit, errorCount uint64, view *view.View, es
 			defaults),
 		newMailTemplate(
 			handler{view, bulkLimit, configs.cycleDuration("MailTemplate"), errorCount, es}),
-		newMailText(
-			handler{view, bulkLimit, configs.cycleDuration("MailText"), errorCount, es}),
+		newMessageText(
+			handler{view, bulkLimit, configs.cycleDuration("MessageText"), errorCount, es}),
 		newFeatures(
 			handler{view, bulkLimit, configs.cycleDuration("Features"), errorCount, es}),
 	}

internal/admin/repository/eventsourcing/handler/mail_text.go

@@ -1,108 +0,0 @@
-package handler
-
-import (
-	"github.com/caos/logging"
-	"github.com/caos/zitadel/internal/eventstore/v1"
-
-	es_models "github.com/caos/zitadel/internal/eventstore/v1/models"
-	"github.com/caos/zitadel/internal/eventstore/v1/query"
-	"github.com/caos/zitadel/internal/eventstore/v1/spooler"
-	"github.com/caos/zitadel/internal/iam/repository/eventsourcing/model"
-	iam_es_model "github.com/caos/zitadel/internal/iam/repository/eventsourcing/model"
-	iam_model "github.com/caos/zitadel/internal/iam/repository/view/model"
-)
-
-type MailText struct {
-	handler
-	subscription *v1.Subscription
-}
-
-func newMailText(handler handler) *MailText {
-	h := &MailText{
-		handler: handler,
-	}
-
-	h.subscribe()
-
-	return h
-}
-
-func (m *MailText) subscribe() {
-	m.subscription = m.es.Subscribe(m.AggregateTypes()...)
-	go func() {
-		for event := range m.subscription.Events {
-			query.ReduceEvent(m, event)
-		}
-	}()
-}
-
-const (
-	mailTextTable = "adminapi.mail_texts"
-)
-
-func (m *MailText) ViewModel() string {
-	return mailTextTable
-}
-
-func (_ *MailText) AggregateTypes() []es_models.AggregateType {
-	return []es_models.AggregateType{iam_es_model.IAMAggregate}
-}
-
-func (p *MailText) CurrentSequence() (uint64, error) {
-	sequence, err := p.view.GetLatestMailTextSequence()
-	if err != nil {
-		return 0, err
-	}
-	return sequence.CurrentSequence, nil
-}
-
-func (m *MailText) EventQuery() (*es_models.SearchQuery, error) {
-	sequence, err := m.view.GetLatestMailTextSequence()
-	if err != nil {
-		return nil, err
-	}
-	return es_models.NewSearchQuery().
-		AggregateTypeFilter(m.AggregateTypes()...).
-		LatestSequenceFilter(sequence.CurrentSequence), nil
-}
-
-func (m *MailText) Reduce(event *es_models.Event) (err error) {
-	switch event.AggregateType {
-	case model.IAMAggregate:
-		err = m.processMailText(event)
-	}
-	return err
-}
-
-func (m *MailText) processMailText(event *es_models.Event) (err error) {
-	mailText := new(iam_model.MailTextView)
-	switch event.Type {
-	case model.MailTextAdded:
-		err = mailText.AppendEvent(event)
-	case model.MailTextChanged:
-		err = mailText.SetData(event)
-		if err != nil {
-			return err
-		}
-		mailText, err = m.view.MailTextByIDs(event.AggregateID, mailText.MailTextType, mailText.Language)
-		if err != nil {
-			return err
-		}
-		err = mailText.AppendEvent(event)
-	default:
-		return m.view.ProcessedMailTextSequence(event)
-	}
-	if err != nil {
-		return err
-	}
-	return m.view.PutMailText(mailText, event)
-}
-
-func (m *MailText) OnError(event *es_models.Event, err error) error {
-	logging.LogWithFields("HANDL-5jk84", "id", event.AggregateID).WithError(err).Warn("something went wrong in label mailText handler")
-	return spooler.HandleError(event, err, m.view.GetLatestMailTextFailedEvent, m.view.ProcessedMailTextFailedEvent, m.view.ProcessedMailTextSequence, m.errorCountUntilSkip)
-}
-
-func (o *MailText) OnSuccess() error {
-	return spooler.HandleSuccess(o.view.UpdateMailTextSpoolerRunTimestamp)
-}

internal/admin/repository/eventsourcing/handler/message_text.go

@@ -0,0 +1,116 @@
+package handler
+
+import (
+	"github.com/caos/logging"
+	caos_errs "github.com/caos/zitadel/internal/errors"
+	"github.com/caos/zitadel/internal/eventstore/v1"
+
+	es_models "github.com/caos/zitadel/internal/eventstore/v1/models"
+	"github.com/caos/zitadel/internal/eventstore/v1/query"
+	"github.com/caos/zitadel/internal/eventstore/v1/spooler"
+	"github.com/caos/zitadel/internal/iam/repository/eventsourcing/model"
+	iam_es_model "github.com/caos/zitadel/internal/iam/repository/eventsourcing/model"
+	iam_model "github.com/caos/zitadel/internal/iam/repository/view/model"
+)
+
+type MessageText struct {
+	handler
+	subscription *v1.Subscription
+}
+
+func newMessageText(handler handler) *MessageText {
+	h := &MessageText{
+		handler: handler,
+	}
+
+	h.subscribe()
+
+	return h
+}
+
+func (m *MessageText) subscribe() {
+	m.subscription = m.es.Subscribe(m.AggregateTypes()...)
+	go func() {
+		for event := range m.subscription.Events {
+			query.ReduceEvent(m, event)
+		}
+	}()
+}
+
+const (
+	mailTextTable = "adminapi.message_texts"
+)
+
+func (m *MessageText) ViewModel() string {
+	return mailTextTable
+}
+
+func (_ *MessageText) AggregateTypes() []es_models.AggregateType {
+	return []es_models.AggregateType{iam_es_model.IAMAggregate}
+}
+
+func (p *MessageText) CurrentSequence() (uint64, error) {
+	sequence, err := p.view.GetLatestMessageTextSequence()
+	if err != nil {
+		return 0, err
+	}
+	return sequence.CurrentSequence, nil
+}
+
+func (m *MessageText) EventQuery() (*es_models.SearchQuery, error) {
+	sequence, err := m.view.GetLatestMessageTextSequence()
+	if err != nil {
+		return nil, err
+	}
+	return es_models.NewSearchQuery().
+		AggregateTypeFilter(m.AggregateTypes()...).
+		LatestSequenceFilter(sequence.CurrentSequence), nil
+}
+
+func (m *MessageText) Reduce(event *es_models.Event) (err error) {
+	switch event.AggregateType {
+	case model.IAMAggregate:
+		err = m.processMessageText(event)
+	}
+	return err
+}
+
+func (m *MessageText) processMessageText(event *es_models.Event) (err error) {
+	message := new(iam_model.MessageTextView)
+	switch event.Type {
+	case model.CustomTextSet,
+		model.CustomTextRemoved:
+		text := new(iam_model.CustomText)
+		err = text.SetData(event)
+		if err != nil {
+			return err
+		}
+		message, err = m.view.MessageTextByIDs(event.AggregateID, text.Template, text.Language.String())
+		if err != nil && !caos_errs.IsNotFound(err) {
+			return err
+		}
+		if caos_errs.IsNotFound(err) {
+			err = nil
+			message = new(iam_model.MessageTextView)
+			message.Language = text.Language.String()
+			message.MessageTextType = text.Template
+			message.CreationDate = event.CreationDate
+		}
+		err = message.AppendEvent(event)
+	default:
+		return m.view.ProcessedMessageTextSequence(event)
+	}
+	if err != nil {
+		return err
+	}
+	return m.view.PutMessageText(message, event)
+}
+
+func (m *MessageText) OnError(event *es_models.Event, err error) error {
+	logging.LogWithFields("HANDL-5jk84", "id", event.AggregateID).WithError(err).Warn("something went wrong in label mailText handler")
+	return spooler.HandleError(event, err, m.view.GetLatestMessageTextFailedEvent, m.view.ProcessedMessageTextFailedEvent, m.view.ProcessedMessageTextSequence, m.errorCountUntilSkip)
+}
+
+func (o *MessageText) OnSuccess() error {
+	return spooler.HandleSuccess(o.view.UpdateMessageTextSpoolerRunTimestamp)
+}

internal/admin/repository/eventsourcing/view/mail_texts.go

@@ -1,48 +0,0 @@
-package view
-
-import (
-	"github.com/caos/zitadel/internal/eventstore/v1/models"
-	"github.com/caos/zitadel/internal/iam/repository/view"
-	"github.com/caos/zitadel/internal/iam/repository/view/model"
-	global_view "github.com/caos/zitadel/internal/view/repository"
-)
-
-const (
-	mailTextTable = "adminapi.mail_texts"
-)
-
-func (v *View) MailTexts(aggregateID string) ([]*model.MailTextView, error) {
-	return view.GetMailTexts(v.Db, mailTextTable, aggregateID)
-}
-
-func (v *View) MailTextByIDs(aggregateID string, textType string, language string) (*model.MailTextView, error) {
-	return view.GetMailTextByIDs(v.Db, mailTextTable, aggregateID, textType, language)
-}
-
-func (v *View) PutMailText(template *model.MailTextView, event *models.Event) error {
-	err := view.PutMailText(v.Db, mailTextTable, template)
-	if err != nil {
-		return err
-	}
-	return v.ProcessedMailTextSequence(event)
-}
-
-func (v *View) GetLatestMailTextSequence() (*global_view.CurrentSequence, error) {
-	return v.latestSequence(mailTextTable)
-}
-
-func (v *View) ProcessedMailTextSequence(event *models.Event) error {
-	return v.saveCurrentSequence(mailTextTable, event)
-}
-
-func (v *View) UpdateMailTextSpoolerRunTimestamp() error {
-	return v.updateSpoolerRunSequence(mailTextTable)
-}
-
-func (v *View) GetLatestMailTextFailedEvent(sequence uint64) (*global_view.FailedEvent, error) {
-	return v.latestFailedEvent(mailTextTable, sequence)
-}
-
-func (v *View) ProcessedMailTextFailedEvent(failedEvent *global_view.FailedEvent) error {
-	return v.saveFailedEvent(failedEvent)
-}

internal/admin/repository/eventsourcing/view/message_texts.go

@@ -0,0 +1,48 @@
+package view
+
+import (
+	"github.com/caos/zitadel/internal/eventstore/v1/models"
+	"github.com/caos/zitadel/internal/iam/repository/view"
+	"github.com/caos/zitadel/internal/iam/repository/view/model"
+	global_view "github.com/caos/zitadel/internal/view/repository"
+)
+
+const (
+	messageTextTable = "adminapi.message_texts"
+)
+
+func (v *View) MessageTexts(aggregateID string) ([]*model.MessageTextView, error) {
+	return view.GetMessageTexts(v.Db, messageTextTable, aggregateID)
+}
+
+func (v *View) MessageTextByIDs(aggregateID, textType, lang string) (*model.MessageTextView, error) {
+	return view.GetMessageTextByIDs(v.Db, messageTextTable, aggregateID, textType, lang)
+}
+
+func (v *View) PutMessageText(template *model.MessageTextView, event *models.Event) error {
+	err := view.PutMessageText(v.Db, messageTextTable, template)
+	if err != nil {
+		return err
+	}
+	return v.ProcessedMessageTextSequence(event)
+}
+
+func (v *View) GetLatestMessageTextSequence() (*global_view.CurrentSequence, error) {
+	return v.latestSequence(messageTextTable)
+}
+
+func (v *View) ProcessedMessageTextSequence(event *models.Event) error {
+	return v.saveCurrentSequence(messageTextTable, event)
+}
+
+func (v *View) UpdateMessageTextSpoolerRunTimestamp() error {
+	return v.updateSpoolerRunSequence(messageTextTable)
+}
+
+func (v *View) GetLatestMessageTextFailedEvent(sequence uint64) (*global_view.FailedEvent, error) {
+	return v.latestFailedEvent(messageTextTable, sequence)
+}
+
+func (v *View) ProcessedMessageTextFailedEvent(failedEvent *global_view.FailedEvent) error {
+	return v.saveFailedEvent(failedEvent)
+}