Merge pull request #39 from foomo/sesamy-cli-0.3.1

feat: add emarsys support

README.md

@@ -146,10 +146,19 @@ googleTag:
           - ViewPromotion
           - WorkingLead
 
+
 # --- Google Analytics settings
 googleAnalytics:
   # Enable provider
   enabled: true
+  # Google GTag.js settings
+  googleGTag:
+    # Provision custom client
+    enabled: true
+    # Client priority
+    priority: 10
+    # Patch ecommerce items
+    ecommerceItems: true
   # Google Tag Manager web container settings
   webContainer:
     # Contemplate package config for generated events
@@ -236,6 +245,24 @@ facebook:
           - BeginCheckout
           - GenerateLead
           - ViewItem
+
+# --- Emarsys
+emarsys:
+  # Enable provider
+  enabled: true
+  # Emarsys merchant id
+  merchantId: ''
+  # Name of the event to mark as new page view
+  newPageViewEvent: '''
+  # Google Tag Manager server container settings
+  serverContainer:
+    # Contemplate package config for generated events
+    packages:
+      - path: github.com/foomo/sesamy-go/pkg/event
+        types:
+          - Purchase
+          - ViewItem
+          - ViewItemList
 ```
 
 ## Caveats

cmd/tagmanager/server.go

@@ -3,6 +3,7 @@ package tagmanager
 import (
 	pkgcmd "github.com/foomo/sesamy-cli/pkg/cmd"
 	conversionlinkerprovider "github.com/foomo/sesamy-cli/pkg/provider/conversionlinker"
+	emarsysprovider "github.com/foomo/sesamy-cli/pkg/provider/emarsys"
 	facebookprovider "github.com/foomo/sesamy-cli/pkg/provider/facebook"
 	googleadsprovider "github.com/foomo/sesamy-cli/pkg/provider/googleads"
 	googleanalyticsprovider "github.com/foomo/sesamy-cli/pkg/provider/googleanalytics"
@@ -58,40 +59,47 @@ func NewServer(root *cobra.Command) {
 			}
 
 			if cfg.GoogleAnalytics.Enabled && pkgcmd.Tag(googleanalyticsprovider.Tag, tags) {
-				l.Info("🅿️ Running provider", "name", googleanalyticsprovider.Name)
+				l.Info("🅿️ Running provider", "name", googleanalyticsprovider.Name, "tag", googleanalyticsprovider.Tag)
 				if err := googleanalyticsprovider.Server(tm, cfg.GoogleAnalytics, cfg.RedactVisitorIP); err != nil {
 					return errors.Wrap(err, "failed to provision google analytics")
 				}
 			}
 
 			if cfg.ConversionLinker.Enabled && pkgcmd.Tag(conversionlinkerprovider.Tag, tags) {
-				l.Info("🅿️ Running provider", "name", conversionlinkerprovider.Name)
+				l.Info("🅿️ Running provider", "name", conversionlinkerprovider.Name, "tag", conversionlinkerprovider.Tag)
 				if err := conversionlinkerprovider.Server(tm, cfg.ConversionLinker); err != nil {
 					return errors.Wrap(err, "failed to provision conversion linker")
 				}
 			}
 
 			if cfg.Umami.Enabled && pkgcmd.Tag(umamiprovider.Tag, tags) {
-				l.Info("🅿️ Running provider", "name", umamiprovider.Name)
+				l.Info("🅿️ Running provider", "name", umamiprovider.Name, "tag", umamiprovider.Tag)
 				if err := umamiprovider.Server(tm, cfg.Umami); err != nil {
 					return errors.Wrap(err, "failed to provision umammi")
 				}
 			}
 
 			if cfg.Facebook.Enabled && pkgcmd.Tag(facebookprovider.Tag, tags) {
-				l.Info("🅿️ Running provider", "name", facebookprovider.Name)
+				l.Info("🅿️ Running provider", "name", facebookprovider.Name, "tag", facebookprovider.Tag)
 				if err := facebookprovider.Server(l, tm, cfg.Facebook); err != nil {
 					return errors.Wrap(err, "failed to provision facebook")
 				}
 			}
 
 			if cfg.GoogleAds.Enabled && pkgcmd.Tag(googleadsprovider.Tag, tags) {
-				l.Info("🅿️ Running provider", "name", googleadsprovider.Name)
+				l.Info("🅿️ Running provider", "name", googleadsprovider.Name, "tag", googleadsprovider.Tag)
 				if err := googleadsprovider.Server(l, tm, cfg.GoogleAds); err != nil {
 					return errors.Wrap(err, "failed to provision google ads")
 				}
 			}
 
+			if cfg.Emarsys.Enabled && pkgcmd.Tag(emarsysprovider.Tag, tags) {
+				l.Info("🅿️ Running provider", "name", emarsysprovider.Name, "tag", emarsysprovider.Tag)
+				if err := emarsysprovider.Server(l, tm, cfg.Emarsys); err != nil {
+					return errors.Wrap(err, "failed to provision emarsys")
+				}
+			}
+
 			return nil
 		},
 	}

cmd/tagmanager/web.go

@@ -2,6 +2,7 @@ package tagmanager
 
 import (
 	pkgcmd "github.com/foomo/sesamy-cli/pkg/cmd"
+	emarsysprovider "github.com/foomo/sesamy-cli/pkg/provider/emarsys"
 	googleanaylticsprovider "github.com/foomo/sesamy-cli/pkg/provider/googleanalytics"
 	googletagprovider "github.com/foomo/sesamy-cli/pkg/provider/googletag"
 	"github.com/foomo/sesamy-cli/pkg/tagmanager"
@@ -52,6 +53,12 @@ func NewWeb(root *cobra.Command) {
 				}
 			}
 
+			if cfg.Emarsys.Enabled && pkgcmd.Tag(emarsysprovider.Tag, tags) {
+				if err := emarsysprovider.Web(tm, cfg.Emarsys); err != nil {
+					return errors.Wrap(err, "failed to provision emarsys tag")
+				}
+			}
+
 			return nil
 		},
 	}

pkg/code/section.go

@@ -11,6 +11,13 @@ type Section struct {
 	Parts []string
 }
 
+func (s *Section) Sprint(a ...any) {
+	value := fmt.Sprint(a...)
+	if !slices.Contains(s.Parts, value) {
+		s.Parts = append(s.Parts, value)
+	}
+}
+
 func (s *Section) Sprintf(format string, a ...any) {
 	value := fmt.Sprintf(format, a...)
 	if !slices.Contains(s.Parts, value) {

pkg/config/config.go

@@ -11,5 +11,6 @@ type Config struct {
 	GoogleAnalytics  GoogleAnalytics  `json:"googleAnalytics" yaml:"googleAnalytics"`
 	ConversionLinker ConversionLinker `json:"conversionLinker" yaml:"conversionLinker"`
 	Facebook         Facebook         `json:"facebook" yaml:"facebook"`
+	Emarsys          Emarsys          `json:"emarsys" yaml:"emarsys"`
 	Umami            Umami            `json:"umami" yaml:"umami"`
 }

pkg/config/emarsys.go

@@ -0,0 +1,13 @@
+package config
+
+import (
+	"github.com/foomo/gocontemplate/pkg/contemplate"
+)
+
+type Emarsys struct {
+	Enabled          bool               `json:"enabled" yaml:"enabled"`
+	MerchantID       string             `json:"merchantId" yaml:"merchantId"`
+	NewPageViewEvent string             `json:"newPageViewEvent" yaml:"newPageViewEvent"`
+	WebContainer     contemplate.Config `json:"webContainer" yaml:"webContainer"`
+	ServerContainer  contemplate.Config `json:"serverContainer" yaml:"serverContainer"`
+}

pkg/config/googleanalytics.go

@@ -6,6 +6,7 @@ import (
 
 type GoogleAnalytics struct {
 	Enabled         bool               `json:"enabled" yaml:"enabled"`
+	GoogleGTag      GoogleGTag         `json:"googleGTag" yaml:"googleGTag"`
 	WebContainer    contemplate.Config `json:"webContainer" yaml:"webContainer"`
 	ServerContainer contemplate.Config `json:"serverContainer" yaml:"serverContainer"`
 }

pkg/config/googlegtag.go

@@ -0,0 +1,7 @@
+package config
+
+type GoogleGTag struct {
+	Enabled        bool  `json:"enabled" yaml:"enabled"`
+	Priority       int64 `json:"priority" yaml:"priority"`
+	EcommerceItems bool  `json:"ecommerceItems" yaml:"ecommerceItems"`
+}

pkg/config/googletag.go

@@ -1,10 +1,8 @@
 package config
 
 type GoogleTag struct {
-	TagID        string `json:"tagId" yaml:"tagId"`
-	DebugMode    bool   `json:"debugMode" yaml:"debugMode"`
-	SendPageView bool   `json:"sendPageView" yaml:"sendPageView"`
-	// WebContainer    contemplate.Config `json:"webContainer" yaml:"webContainer"`
-	// ServerContainer contemplate.Config `json:"serverContainer" yaml:"serverContainer"`
-	TypeScript TypeScript `json:"typeScript" yaml:"typeScript"`
+	TagID        string     `json:"tagId" yaml:"tagId"`
+	DebugMode    bool       `json:"debugMode" yaml:"debugMode"`
+	SendPageView bool       `json:"sendPageView" yaml:"sendPageView"`
+	TypeScript   TypeScript `json:"typeScript" yaml:"typeScript"`
 }

pkg/provider/emarsys/constants.go

@@ -0,0 +1,12 @@
+package emarsys
+
+const (
+	Tag                                          = "emarsys"
+	Name                                         = "Emarsys"
+	NameMerchantIDConstant                       = "Emarsys Merchant ID"
+	NameWebEmarsysInitalizationTag               = "Emarsys Initialization"
+	NameWebEmarsysInitalizationTagTemplate       = "Emarsys Initialization"
+	NameServerEmarsysClient                      = "Emarsys Initialization"
+	NameServerEmarsysWebExtendTagTemplate        = "Emarsys Web Extend"
+	NameServerEmarsysInitalizationClientTemplate = "Emarsys Initialization"
+)

pkg/provider/emarsys/server.go

@@ -0,0 +1,67 @@
+package emarsys
+
+import (
+	"log/slog"
+
+	"github.com/foomo/sesamy-cli/pkg/config"
+	serverclientx "github.com/foomo/sesamy-cli/pkg/provider/emarsys/server/client"
+	servertagx "github.com/foomo/sesamy-cli/pkg/provider/emarsys/server/tag"
+	"github.com/foomo/sesamy-cli/pkg/provider/emarsys/server/template"
+	"github.com/foomo/sesamy-cli/pkg/provider/googletag"
+	"github.com/foomo/sesamy-cli/pkg/tagmanager"
+	commontrigger "github.com/foomo/sesamy-cli/pkg/tagmanager/common/trigger"
+	commonvariable "github.com/foomo/sesamy-cli/pkg/tagmanager/common/variable"
+	"github.com/pkg/errors"
+)
+
+func Server(l *slog.Logger, tm *tagmanager.TagManager, cfg config.Emarsys) error {
+	{ // create folder
+		if folder, err := tm.UpsertFolder("Sesamy - " + Name); err != nil {
+			return err
+		} else {
+			tm.SetFolderName(folder.Name)
+		}
+	}
+
+	{ // conversion
+		merchantID, err := tm.UpsertVariable(commonvariable.NewConstant(NameMerchantIDConstant, cfg.MerchantID))
+		if err != nil {
+			return err
+		}
+
+		tagTemplate, err := tm.UpsertCustomTemplate(template.NewEmarsysWebExtendTag(NameServerEmarsysWebExtendTagTemplate))
+		if err != nil {
+			return err
+		}
+
+		clientTemplate, err := tm.UpsertCustomTemplate(template.NewEmarsysInitializationClient(NameServerEmarsysInitalizationClientTemplate))
+		if err != nil {
+			return err
+		}
+
+		_, err = tm.UpsertClient(serverclientx.NewEmarsys(NameServerEmarsysClient, cfg, clientTemplate))
+		if err != nil {
+			return err
+		}
+
+		{ // create tags
+			eventParameters, err := googletag.CreateServerEventTriggers(tm, cfg.ServerContainer)
+			if err != nil {
+				return err
+			}
+
+			for event := range eventParameters {
+				eventTrigger, err := tm.LookupTrigger(commontrigger.EventName(event))
+				if err != nil {
+					return errors.Wrap(err, "failed to lookup event trigger: "+event)
+				}
+
+				if _, err := tm.UpsertTag(servertagx.NewEmarsys(event, cfg.NewPageViewEvent == eventTrigger.Name, merchantID, tagTemplate, eventTrigger)); err != nil {
+					return err
+				}
+			}
+		}
+	}
+
+	return nil
+}

pkg/provider/emarsys/server/client/emarsys.go

@@ -0,0 +1,21 @@
+package client
+
+import (
+	"github.com/foomo/sesamy-cli/pkg/config"
+	"github.com/foomo/sesamy-cli/pkg/utils"
+	"google.golang.org/api/tagmanager/v2"
+)
+
+func NewEmarsys(name string, cfg config.Emarsys, template *tagmanager.CustomTemplate) *tagmanager.Client {
+	return &tagmanager.Client{
+		Name: name,
+		Parameter: []*tagmanager.Parameter{
+			{
+				Key:   "merchantId",
+				Type:  "template",
+				Value: cfg.MerchantID,
+			},
+		},
+		Type: utils.TemplateType(template),
+	}
+}

pkg/provider/emarsys/server/tag/emarsys.go

@@ -0,0 +1,48 @@
+package tag
+
+import (
+	"strconv"
+
+	"github.com/foomo/sesamy-cli/pkg/utils"
+	"google.golang.org/api/tagmanager/v2"
+)
+
+func EmarsysName(v string) string {
+	return "Emarsys - " + v
+}
+
+func NewEmarsys(name string, isNewPageView bool, merchantID *tagmanager.Variable, template *tagmanager.CustomTemplate, triggers ...*tagmanager.Trigger) *tagmanager.Tag {
+	return &tagmanager.Tag{
+		FiringTriggerId: utils.TriggerIDs(triggers),
+		Name:            EmarsysName(name),
+		TagFiringOption: "oncePerEvent",
+		Parameter: []*tagmanager.Parameter{
+			{
+				Key:   "adStorageConsent",
+				Type:  "template",
+				Value: "optional",
+			},
+			{
+				Key:   "isNewPageView",
+				Type:  "boolean",
+				Value: strconv.FormatBool(isNewPageView),
+			},
+			{
+				Key:   "merchantId",
+				Type:  "template",
+				Value: "{{" + merchantID.Name + "}}",
+			},
+			{
+				Key:   "isTestMode",
+				Type:  "boolean",
+				Value: "false",
+			},
+			{
+				Key:   "isDebugMode",
+				Type:  "boolean",
+				Value: "false",
+			},
+		},
+		Type: utils.TemplateType(template),
+	}
+}

pkg/provider/emarsys/server/template/emarsysinitalizationclient.go

@@ -0,0 +1,14 @@
+package template
+
+import (
+	"fmt"
+
+	"google.golang.org/api/tagmanager/v2"
+)
+
+func NewEmarsysInitializationClient(name string) *tagmanager.CustomTemplate {
+	return &tagmanager.CustomTemplate{
+		Name:         name,
+		TemplateData: fmt.Sprintf(EmarsysInitializationClientData, name),
+	}
+}