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>
2025-12-03 11:12:29 +00:00 · 2021-06-10 13:49:10 +02:00
parent 67462eefe0
commit bdf3887f9e
107 changed files with 4930 additions and 2715 deletions
--- a/internal/management/repository/eventsourcing/eventstore/org.go
+++ b/internal/management/repository/eventsourcing/eventstore/org.go
@@ -548,19 +548,19 @@ func (repo *OrgRepository) GetMailTemplate(ctx context.Context) (*iam_model.Mail
 	return iam_es_model.MailTemplateViewToModel(template), err
 }

-func (repo *OrgRepository) GetDefaultMailTexts(ctx context.Context) (*iam_model.MailTextsView, error) {
-	texts, err := repo.View.MailTextsByAggregateID(repo.SystemDefaults.IamID)
+func (repo *OrgRepository) GetDefaultMessageTexts(ctx context.Context) (*iam_model.MessageTextsView, error) {
+	texts, err := repo.View.MessageTextsByAggregateID(repo.SystemDefaults.IamID)
 	if err != nil {
 		return nil, err
 	}
-	return iam_es_model.MailTextsViewToModel(texts, true), err
+	return iam_es_model.MessageTextsViewToModel(texts, true), err
 }

-func (repo *OrgRepository) GetMailTexts(ctx context.Context) (*iam_model.MailTextsView, error) {
+func (repo *OrgRepository) GetMessageTexts(ctx context.Context) (*iam_model.MessageTextsView, error) {
 	defaultIn := false
-	texts, err := repo.View.MailTextsByAggregateID(authz.GetCtxData(ctx).OrgID)
+	texts, err := repo.View.MessageTextsByAggregateID(authz.GetCtxData(ctx).OrgID)
 	if errors.IsNotFound(err) || len(texts) == 0 {
-		texts, err = repo.View.MailTextsByAggregateID(repo.SystemDefaults.IamID)
+		texts, err = repo.View.MessageTextsByAggregateID(repo.SystemDefaults.IamID)
 		if err != nil {
 			return nil, err
 		}
@@ -569,7 +569,31 @@ func (repo *OrgRepository) GetMailTexts(ctx context.Context) (*iam_model.MailTex
 	if err != nil {
 		return nil, err
 	}
-	return iam_es_model.MailTextsViewToModel(texts, defaultIn), err
+	return iam_es_model.MessageTextsViewToModel(texts, defaultIn), err
+}
+
+func (repo *OrgRepository) 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.MessageTextViewToModel(text), err
+}
+
+func (repo *OrgRepository) GetMessageText(ctx context.Context, orgID, textType, lang string) (*iam_model.MessageTextView, error) {
+	text, err := repo.View.MessageTextByIDs(orgID, textType, lang)
+	if errors.IsNotFound(err) {
+		result, err := repo.GetDefaultMessageText(ctx, textType, lang)
+		if err != nil {
+			return nil, err
+		}
+		return result, nil
+	}
+	if err != nil {
+		return nil, err
+	}
+	return iam_es_model.MessageTextViewToModel(text), err
 }

 func (repo *OrgRepository) getOrgChanges(ctx context.Context, orgID string, lastSequence uint64, limit uint64, sortAscending bool, auditLogRetention time.Duration) (*org_model.OrgChanges, error) {
--- a/internal/management/repository/eventsourcing/handler/handler.go
+++ b/internal/management/repository/eventsourcing/handler/handler.go
@@ -77,8 +77,8 @@ func Register(configs Configs, bulkLimit, errorCount uint64, view *view.View, es
 			handler{view, bulkLimit, configs.cycleDuration("OrgIAMPolicy"), errorCount, es}),
 		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}),
 	}
--- a/internal/management/repository/eventsourcing/handler/mail_text.go
+++ b/internal/management/repository/eventsourcing/handler/mail_text.go
@@ -1,111 +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"
-	iam_es_model "github.com/caos/zitadel/internal/iam/repository/eventsourcing/model"
-	iam_model "github.com/caos/zitadel/internal/iam/repository/view/model"
-	"github.com/caos/zitadel/internal/org/repository/eventsourcing/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 = "management.mail_texts"
-)
-
-func (m *MailText) ViewModel() string {
-	return mailTextTable
-}
-
-func (_ *MailText) AggregateTypes() []es_models.AggregateType {
-	return []es_models.AggregateType{model.OrgAggregate, 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.OrgAggregate, iam_es_model.IAMAggregate:
-		err = m.processMailText(event)
-	}
-	return err
-}
-
-func (m *MailText) processMailText(event *es_models.Event) (err error) {
-	text := new(iam_model.MailTextView)
-	switch event.Type {
-	case iam_es_model.MailTextAdded, model.MailTextAdded:
-		err = text.AppendEvent(event)
-	case iam_es_model.MailTextChanged, model.MailTextChanged:
-		err = text.SetData(event)
-		if err != nil {
-			return err
-		}
-		text, err = m.view.MailTextByIDs(event.AggregateID, text.MailTextType, text.Language)
-		if err != nil {
-			return err
-		}
-		text.ChangeDate = event.CreationDate
-		err = text.AppendEvent(event)
-	case model.MailTextRemoved:
-		err = text.SetData(event)
-		return m.view.DeleteMailText(event.AggregateID, text.MailTextType, text.Language, event)
-	default:
-		return m.view.ProcessedMailTextSequence(event)
-	}
-	if err != nil {
-		return err
-	}
-	return m.view.PutMailText(text, event)
-}
-
-func (m *MailText) OnError(event *es_models.Event, err error) error {
-	logging.LogWithFields("SPOOL-4Djo9", "id", event.AggregateID).WithError(err).Warn("something went wrong in label text 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)
-}
--- a/internal/management/repository/eventsourcing/handler/message_text.go
+++ b/internal/management/repository/eventsourcing/handler/message_text.go
@@ -0,0 +1,122 @@
+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"
+	iam_es_model "github.com/caos/zitadel/internal/iam/repository/eventsourcing/model"
+	iam_model "github.com/caos/zitadel/internal/iam/repository/view/model"
+	"github.com/caos/zitadel/internal/org/repository/eventsourcing/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 (
+	messageTextTable = "management.message_texts"
+)
+
+func (m *MessageText) ViewModel() string {
+	return messageTextTable
+}
+
+func (_ *MessageText) AggregateTypes() []es_models.AggregateType {
+	return []es_models.AggregateType{model.OrgAggregate, 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.OrgAggregate, iam_es_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 iam_es_model.CustomTextSet, model.CustomTextSet,
+		iam_es_model.CustomTextRemoved, 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)
+	case model.CustomTextMessageRemoved:
+		text := new(iam_model.CustomText)
+		err = text.SetData(event)
+		if err != nil {
+			return err
+		}
+		return m.view.DeleteMessageText(event.AggregateID, text.Template, text.Language.String(), 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("SPOOL-4Djo9", "id", event.AggregateID).WithError(err).Warn("something went wrong in label text 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)
+}
--- a/internal/management/repository/eventsourcing/view/mail_texts.go
+++ b/internal/management/repository/eventsourcing/view/mail_texts.go
@@ -1,57 +0,0 @@
-package view
-
-import (
-	"github.com/caos/zitadel/internal/errors"
-	"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 = "management.mail_texts"
-)
-
-func (v *View) MailTextsByAggregateID(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) DeleteMailText(aggregateID string, textType string, language string, event *models.Event) error {
-	err := view.DeleteMailText(v.Db, mailTextTable, aggregateID, textType, language)
-	if err != nil && !errors.IsNotFound(err) {
-		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)
-}
--- a/internal/management/repository/eventsourcing/view/message_texts.go
+++ b/internal/management/repository/eventsourcing/view/message_texts.go
@@ -0,0 +1,57 @@
+package view
+
+import (
+	"github.com/caos/zitadel/internal/errors"
+	"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 = "management.message_texts"
+)
+
+func (v *View) MessageTextsByAggregateID(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) DeleteMessageText(aggregateID, textType, lang string, event *models.Event) error {
+	err := view.DeleteMessageText(v.Db, messageTextTable, aggregateID, textType, lang)
+	if err != nil && !errors.IsNotFound(err) {
+		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)
+}
--- a/internal/management/repository/org.go
+++ b/internal/management/repository/org.go
@@ -44,8 +44,10 @@ type OrgRepository interface {
 	GetDefaultMailTemplate(ctx context.Context) (*iam_model.MailTemplateView, error)
 	GetMailTemplate(ctx context.Context) (*iam_model.MailTemplateView, error)

-	GetDefaultMailTexts(ctx context.Context) (*iam_model.MailTextsView, error)
-	GetMailTexts(ctx context.Context) (*iam_model.MailTextsView, error)
+	GetDefaultMessageTexts(ctx context.Context) (*iam_model.MessageTextsView, error)
+	GetMessageTexts(ctx context.Context) (*iam_model.MessageTextsView, error)
+	GetDefaultMessageText(ctx context.Context, textType string, language string) (*iam_model.MessageTextView, error)
+	GetMessageText(ctx context.Context, orgID, textType, language string) (*iam_model.MessageTextView, error)

 	GetLabelPolicy(ctx context.Context) (*iam_model.LabelPolicyView, error)
 	GetPreviewLabelPolicy(ctx context.Context) (*iam_model.LabelPolicyView, error)