From fc77c97547c6b3518e28db1f48bbc7908358d40b Mon Sep 17 00:00:00 2001 From: "Felipe M." Date: Sun, 15 Jun 2025 12:17:54 +0200 Subject: [PATCH 01/11] feat: add configuration options for instagram and twitter plugins --- CLAUDE.md | 5 ++++ docs/plugins.md | 4 +-- .../templates/channel_plugin_config.html | 20 +++++++++++++++ internal/plugin/social/instagram.go | 21 ++++++++++------ internal/plugin/social/twitter.go | 25 ++++++++++++------- 5 files changed, 57 insertions(+), 18 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 35fc410..2191848 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -10,6 +10,11 @@ When creating, modifying, or removing plugins: - Brief description of functionality - Usage instructions with examples - Any configuration requirements +3. **For plugins with configuration options:** + - Set `ConfigRequired: true` in the plugin's BasePlugin struct + - Add corresponding HTML form fields in `internal/admin/templates/channel_plugin_config.html` + - Use conditional template logic: `{{else if eq .ChannelPlugin.PluginID "plugin.id"}}` + - Include proper form labels, help text, and value binding ## Testing diff --git a/docs/plugins.md b/docs/plugins.md index d84aec5..3472a08 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -23,5 +23,5 @@ ### Social Media -- Twitter Link Expander: Automatically converts twitter.com and x.com links to fxtwitter.com links and removes tracking parameters. This allows for better media embedding in chat platforms. -- Instagram Link Expander: Automatically converts instagram.com links to ddinstagram.com links and removes tracking parameters. This allows for better media embedding in chat platforms. +- Twitter Link Expander: Automatically converts twitter.com and x.com links to alternative domain links and removes tracking parameters. This allows for better media embedding in chat platforms. Configure with `domain` option to set replacement domain (default: fxtwitter.com). +- Instagram Link Expander: Automatically converts instagram.com links to alternative domain links and removes tracking parameters. This allows for better media embedding in chat platforms. Configure with `domain` option to set replacement domain (default: ddinstagram.com). diff --git a/internal/admin/templates/channel_plugin_config.html b/internal/admin/templates/channel_plugin_config.html index decf1a2..2719004 100644 --- a/internal/admin/templates/channel_plugin_config.html +++ b/internal/admin/templates/channel_plugin_config.html @@ -19,6 +19,26 @@ Messages containing links to these domains will be blocked. + {{else if eq .ChannelPlugin.PluginID "social.instagram"}} +
+ + +
+ Enter the domain to replace instagram.com links with. Default is ddinstagram.com if left empty. +
+
+ {{else if eq .ChannelPlugin.PluginID "social.twitter"}} +
+ + +
+ Enter the domain to replace twitter.com and x.com links with. Default is fxtwitter.com if left empty. +
+
{{else}}
This plugin doesn't have specific configuration fields implemented yet. diff --git a/internal/plugin/social/instagram.go b/internal/plugin/social/instagram.go index 6b7aa4c..b423b45 100644 --- a/internal/plugin/social/instagram.go +++ b/internal/plugin/social/instagram.go @@ -18,9 +18,10 @@ type InstagramExpander struct { func NewInstagramExpander() *InstagramExpander { return &InstagramExpander{ BasePlugin: plugin.BasePlugin{ - ID: "social.instagram", - Name: "Instagram Link Expander", - Help: "Automatically converts instagram.com links to ddinstagram.com links and removes tracking parameters", + ID: "social.instagram", + Name: "Instagram Link Expander", + Help: "Automatically converts instagram.com links to alternative domain links and removes tracking parameters. Configure 'domain' option to set replacement domain (default: ddinstagram.com)", + ConfigRequired: true, }, } } @@ -32,6 +33,12 @@ func (p *InstagramExpander) OnMessage(msg *model.Message, config map[string]inte return nil } + // Get replacement domain from config, default to ddinstagram.com + replacementDomain := "ddinstagram.com" + if domain, ok := config["domain"].(string); ok && domain != "" { + replacementDomain = domain + } + // Regex to match instagram.com links // Match both http://instagram.com and https://instagram.com formats // Also match www.instagram.com @@ -42,7 +49,7 @@ func (p *InstagramExpander) OnMessage(msg *model.Message, config map[string]inte return nil } - // Replace instagram.com with ddinstagram.com in the message and clean query parameters + // Replace instagram.com with configured domain in the message and clean query parameters transformed := instagramRegex.ReplaceAllStringFunc(msg.Text, func(link string) string { // Parse the URL parsedURL, err := url.Parse(link) @@ -51,13 +58,13 @@ func (p *InstagramExpander) OnMessage(msg *model.Message, config map[string]inte return link } - // Ensure we don't change links that already come from ddinstagram.com + // Ensure we don't change links that already come from the replacement domain if parsedURL.Host != "instagram.com" && parsedURL.Host != "www.instagram.com" { return link } - // Change the host - parsedURL.Host = "d.ddinstagram.com" + // Change the host to the configured domain + parsedURL.Host = replacementDomain // Remove query parameters parsedURL.RawQuery = "" diff --git a/internal/plugin/social/twitter.go b/internal/plugin/social/twitter.go index 553bd07..d98eee6 100644 --- a/internal/plugin/social/twitter.go +++ b/internal/plugin/social/twitter.go @@ -18,9 +18,10 @@ type TwitterExpander struct { func NewTwitterExpander() *TwitterExpander { return &TwitterExpander{ BasePlugin: plugin.BasePlugin{ - ID: "social.twitter", - Name: "Twitter Link Expander", - Help: "Automatically converts twitter.com links to fxtwitter.com links and removes tracking parameters", + ID: "social.twitter", + Name: "Twitter Link Expander", + Help: "Automatically converts twitter.com and x.com links to alternative domain links and removes tracking parameters. Configure 'domain' option to set replacement domain (default: fxtwitter.com)", + ConfigRequired: true, }, } } @@ -32,6 +33,12 @@ func (p *TwitterExpander) OnMessage(msg *model.Message, config map[string]interf return nil } + // Get replacement domain from config, default to fxtwitter.com + replacementDomain := "fxtwitter.com" + if domain, ok := config["domain"].(string); ok && domain != "" { + replacementDomain = domain + } + // Regex to match twitter.com links // Match both http://twitter.com and https://twitter.com formats // Also match www.twitter.com @@ -42,22 +49,22 @@ func (p *TwitterExpander) OnMessage(msg *model.Message, config map[string]interf return nil } - // Replace twitter.com with fxtwitter.com in the message and clean query parameters + // Replace twitter.com/x.com with configured domain in the message and clean query parameters transformed := twitterRegex.ReplaceAllStringFunc(msg.Text, func(link string) string { // Parse the URL parsedURL, err := url.Parse(link) if err != nil { // If parsing fails, just do the simple replacement - link = strings.Replace(link, "twitter.com", "fxtwitter.com", 1) - link = strings.Replace(link, "x.com", "fxtwitter.com", 1) + link = strings.Replace(link, "twitter.com", replacementDomain, 1) + link = strings.Replace(link, "x.com", replacementDomain, 1) return link } - // Change the host + // Change the host to the configured domain if strings.Contains(parsedURL.Host, "twitter.com") { - parsedURL.Host = strings.Replace(parsedURL.Host, "twitter.com", "fxtwitter.com", 1) + parsedURL.Host = strings.Replace(parsedURL.Host, "twitter.com", replacementDomain, 1) } else if strings.Contains(parsedURL.Host, "x.com") { - parsedURL.Host = strings.Replace(parsedURL.Host, "x.com", "fxtwitter.com", 1) + parsedURL.Host = strings.Replace(parsedURL.Host, "x.com", replacementDomain, 1) } // Remove query parameters From 899ac49336e958d98500ad8c65f45d0bc602883f Mon Sep 17 00:00:00 2001 From: "Felipe M." Date: Sun, 15 Jun 2025 13:03:52 +0200 Subject: [PATCH 02/11] chore: split plugin configuration templates --- internal/admin/admin.go | 26 ++++++++++++++-- .../templates/channel_plugin_config.html | 31 ++----------------- .../plugins/security.domainblock.html | 12 +++++++ .../templates/plugins/social.instagram.html | 11 +++++++ .../templates/plugins/social.twitter.html | 11 +++++++ 5 files changed, 60 insertions(+), 31 deletions(-) create mode 100644 internal/admin/templates/plugins/security.domainblock.html create mode 100644 internal/admin/templates/plugins/social.instagram.html create mode 100644 internal/admin/templates/plugins/social.twitter.html diff --git a/internal/admin/admin.go b/internal/admin/admin.go index 2b41820..cfa2595 100644 --- a/internal/admin/admin.go +++ b/internal/admin/admin.go @@ -16,7 +16,7 @@ import ( "github.com/gorilla/sessions" ) -//go:embed templates/*.html +//go:embed templates/*.html templates/plugins/*.html var templateFS embed.FS const ( @@ -90,7 +90,7 @@ func New(cfg *config.Config, database *db.Database, version string) *Admin { } // Parse and register all templates - templateFiles := []string{ + mainTemplateFiles := []string{ "index.html", "login.html", "change_password.html", @@ -101,7 +101,13 @@ func New(cfg *config.Config, database *db.Database, version string) *Admin { "channel_plugin_config.html", } - for _, tf := range templateFiles { + pluginTemplateFiles := []string{ + "plugins/security.domainblock.html", + "plugins/social.instagram.html", + "plugins/social.twitter.html", + } + + for _, tf := range mainTemplateFiles { // Read template content from embedded filesystem content, err := templateFS.ReadFile("templates/" + tf) if err != nil { @@ -120,6 +126,20 @@ func New(cfg *config.Config, database *db.Database, version string) *Admin { panic(err) } + // If this is the channel_plugin_config template, also parse plugin templates + if tf == "channel_plugin_config.html" { + for _, pluginTf := range pluginTemplateFiles { + pluginContent, err := templateFS.ReadFile("templates/" + pluginTf) + if err != nil { + panic(err) + } + t, err = t.Parse(string(pluginContent)) + if err != nil { + panic(err) + } + } + } + templates[tf] = t } diff --git a/internal/admin/templates/channel_plugin_config.html b/internal/admin/templates/channel_plugin_config.html index 2719004..0f229f9 100644 --- a/internal/admin/templates/channel_plugin_config.html +++ b/internal/admin/templates/channel_plugin_config.html @@ -9,36 +9,11 @@
{{if eq .ChannelPlugin.PluginID "security.domainblock"}} -
- - -
- Enter comma-separated list of domains to block (e.g., example.com, evil.org). - Messages containing links to these domains will be blocked. -
-
+ {{template "plugins/security.domainblock.html" .}} {{else if eq .ChannelPlugin.PluginID "social.instagram"}} -
- - -
- Enter the domain to replace instagram.com links with. Default is ddinstagram.com if left empty. -
-
+ {{template "plugins/social.instagram.html" .}} {{else if eq .ChannelPlugin.PluginID "social.twitter"}} -
- - -
- Enter the domain to replace twitter.com and x.com links with. Default is fxtwitter.com if left empty. -
-
+ {{template "plugins/social.twitter.html" .}} {{else}}
This plugin doesn't have specific configuration fields implemented yet. diff --git a/internal/admin/templates/plugins/security.domainblock.html b/internal/admin/templates/plugins/security.domainblock.html new file mode 100644 index 0000000..7ffcc48 --- /dev/null +++ b/internal/admin/templates/plugins/security.domainblock.html @@ -0,0 +1,12 @@ +{{define "plugins/security.domainblock.html"}} +
+ + +
+ Enter comma-separated list of domains to block (e.g., example.com, evil.org). + Messages containing links to these domains will be blocked. +
+
+{{end}} \ No newline at end of file diff --git a/internal/admin/templates/plugins/social.instagram.html b/internal/admin/templates/plugins/social.instagram.html new file mode 100644 index 0000000..a83485d --- /dev/null +++ b/internal/admin/templates/plugins/social.instagram.html @@ -0,0 +1,11 @@ +{{define "plugins/social.instagram.html"}} +
+ + +
+ Enter the domain to replace instagram.com links with. Default is ddinstagram.com if left empty. +
+
+{{end}} \ No newline at end of file diff --git a/internal/admin/templates/plugins/social.twitter.html b/internal/admin/templates/plugins/social.twitter.html new file mode 100644 index 0000000..cb4885f --- /dev/null +++ b/internal/admin/templates/plugins/social.twitter.html @@ -0,0 +1,11 @@ +{{define "plugins/social.twitter.html"}} +
+ + +
+ Enter the domain to replace twitter.com and x.com links with. Default is fxtwitter.com if left empty. +
+
+{{end}} \ No newline at end of file From 3b09a9dd4783f18ab3b416e2357f1010c9423850 Mon Sep 17 00:00:00 2001 From: "Felipe M." Date: Mon, 23 Jun 2025 11:06:17 +0200 Subject: [PATCH 03/11] feat: allow enabling all plugins into a channel --- internal/admin/admin.go | 7 + internal/admin/templates/channel_detail.html | 9 + internal/app/app.go | 28 +- internal/db/db.go | 43 ++- internal/db/db_test.go | 203 ++++++++++++ internal/migration/migrations.go | 58 ++++ internal/model/message.go | 6 + internal/model/message_test.go | 234 +++++++++++++ internal/plugin/plugin.go | 13 + internal/plugin/plugin_test.go | 331 +++++++++++++++++++ 10 files changed, 915 insertions(+), 17 deletions(-) create mode 100644 internal/db/db_test.go create mode 100644 internal/model/message_test.go create mode 100644 internal/plugin/plugin_test.go diff --git a/internal/admin/admin.go b/internal/admin/admin.go index cfa2595..abefb72 100644 --- a/internal/admin/admin.go +++ b/internal/admin/admin.go @@ -564,6 +564,13 @@ func (a *Admin) handleChannelDetail(w http.ResponseWriter, r *http.Request) { return } + // Update enable_all_plugins + enableAllPlugins := r.FormValue("enable_all_plugins") == "true" + if err := a.db.UpdateChannelEnableAllPlugins(id, enableAllPlugins); err != nil { + http.Error(w, "Failed to update channel enable all plugins", http.StatusInternalServerError) + return + } + a.addFlash(w, r, "Channel updated", "success") http.Redirect(w, r, "/admin/channels/"+channelID, http.StatusSeeOther) return diff --git a/internal/admin/templates/channel_detail.html b/internal/admin/templates/channel_detail.html index 78909df..9f9a78d 100644 --- a/internal/admin/templates/channel_detail.html +++ b/internal/admin/templates/channel_detail.html @@ -27,6 +27,15 @@
+
+ +
+ When enabled, all registered plugins will be automatically enabled for this channel. Individual plugin settings will be ignored. +
+
Back to Channels diff --git a/internal/app/app.go b/internal/app/app.go index 9dc38c6..037089f 100644 --- a/internal/app/app.go +++ b/internal/app/app.go @@ -314,11 +314,21 @@ func (a *App) handleMessage(item queue.Item) { } // Process message with plugins - for pluginID, channelPlugin := range channel.Plugins { - if !channel.HasEnabledPlugin(pluginID) { - continue - } + var pluginsToProcess []string + if channel.EnableAllPlugins { + // If EnableAllPlugins is true, process all registered plugins + pluginsToProcess = plugin.GetAvailablePluginIDs() + } else { + // Otherwise, process only explicitly enabled plugins + for pluginID := range channel.Plugins { + if channel.HasEnabledPlugin(pluginID) { + pluginsToProcess = append(pluginsToProcess, pluginID) + } + } + } + + for _, pluginID := range pluginsToProcess { // Get plugin p, err := plugin.Get(pluginID) if err != nil { @@ -326,11 +336,19 @@ func (a *App) handleMessage(item queue.Item) { continue } + // Get plugin configuration (empty map if EnableAllPlugins and plugin not explicitly configured) + var config map[string]interface{} + if channelPlugin, exists := channel.Plugins[pluginID]; exists { + config = channelPlugin.Config + } else { + config = make(map[string]interface{}) + } + // Create cache instance for this plugin pluginCache := cache.New(a.db, pluginID) // Process message and get actions - actions := p.OnMessage(message, channelPlugin.Config, pluginCache) + actions := p.OnMessage(message, config, pluginCache) // Get platform for processing actions platform, err := platform.Get(item.Platform) diff --git a/internal/db/db.go b/internal/db/db.go index 2ca767c..1c54ad4 100644 --- a/internal/db/db.go +++ b/internal/db/db.go @@ -56,7 +56,7 @@ func (d *Database) Close() error { // GetChannelByID retrieves a channel by ID func (d *Database) GetChannelByID(id int64) (*model.Channel, error) { query := ` - SELECT id, platform, platform_channel_id, enabled, channel_raw + SELECT id, platform, platform_channel_id, enabled, enable_all_plugins, channel_raw FROM channels WHERE id = ? ` @@ -67,10 +67,11 @@ func (d *Database) GetChannelByID(id int64) (*model.Channel, error) { platform string platformChannelID string enabled bool + enableAllPlugins bool channelRawJSON string ) - err := row.Scan(&id, &platform, &platformChannelID, &enabled, &channelRawJSON) + err := row.Scan(&id, &platform, &platformChannelID, &enabled, &enableAllPlugins, &channelRawJSON) if err == sql.ErrNoRows { return nil, ErrNotFound } @@ -90,6 +91,7 @@ func (d *Database) GetChannelByID(id int64) (*model.Channel, error) { Platform: platform, PlatformChannelID: platformChannelID, Enabled: enabled, + EnableAllPlugins: enableAllPlugins, ChannelRaw: channelRaw, Plugins: make(map[string]*model.ChannelPlugin), } @@ -110,7 +112,7 @@ func (d *Database) GetChannelByID(id int64) (*model.Channel, error) { // GetChannelByPlatform retrieves a channel by platform and platform channel ID func (d *Database) GetChannelByPlatform(platform, platformChannelID string) (*model.Channel, error) { query := ` - SELECT id, platform, platform_channel_id, enabled, channel_raw + SELECT id, platform, platform_channel_id, enabled, enable_all_plugins, channel_raw FROM channels WHERE platform = ? AND platform_channel_id = ? ` @@ -118,12 +120,13 @@ func (d *Database) GetChannelByPlatform(platform, platformChannelID string) (*mo row := d.db.QueryRow(query, platform, platformChannelID) var ( - id int64 - enabled bool - channelRawJSON string + id int64 + enabled bool + enableAllPlugins bool + channelRawJSON string ) - err := row.Scan(&id, &platform, &platformChannelID, &enabled, &channelRawJSON) + err := row.Scan(&id, &platform, &platformChannelID, &enabled, &enableAllPlugins, &channelRawJSON) if err == sql.ErrNoRows { return nil, ErrNotFound } @@ -143,6 +146,7 @@ func (d *Database) GetChannelByPlatform(platform, platformChannelID string) (*mo Platform: platform, PlatformChannelID: platformChannelID, Enabled: enabled, + EnableAllPlugins: enableAllPlugins, ChannelRaw: channelRaw, Plugins: make(map[string]*model.ChannelPlugin), } @@ -170,11 +174,11 @@ func (d *Database) CreateChannel(platform, platformChannelID string, enabled boo // Insert channel query := ` - INSERT INTO channels (platform, platform_channel_id, enabled, channel_raw) - VALUES (?, ?, ?, ?) + INSERT INTO channels (platform, platform_channel_id, enabled, enable_all_plugins, channel_raw) + VALUES (?, ?, ?, ?, ?) ` - result, err := d.db.Exec(query, platform, platformChannelID, enabled, string(channelRawJSON)) + result, err := d.db.Exec(query, platform, platformChannelID, enabled, false, string(channelRawJSON)) if err != nil { return nil, err } @@ -191,6 +195,7 @@ func (d *Database) CreateChannel(platform, platformChannelID string, enabled boo Platform: platform, PlatformChannelID: platformChannelID, Enabled: enabled, + EnableAllPlugins: false, ChannelRaw: channelRaw, Plugins: make(map[string]*model.ChannelPlugin), } @@ -210,6 +215,18 @@ func (d *Database) UpdateChannel(id int64, enabled bool) error { return err } +// UpdateChannelEnableAllPlugins updates a channel's enable_all_plugins status +func (d *Database) UpdateChannelEnableAllPlugins(id int64, enableAllPlugins bool) error { + query := ` + UPDATE channels + SET enable_all_plugins = ? + WHERE id = ? + ` + + _, err := d.db.Exec(query, enableAllPlugins, id) + return err +} + // DeleteChannel deletes a channel func (d *Database) DeleteChannel(id int64) error { // First delete all channel plugins @@ -456,7 +473,7 @@ func (d *Database) DeleteChannelPluginsByChannel(channelID int64) error { // GetAllChannels retrieves all channels func (d *Database) GetAllChannels() ([]*model.Channel, error) { query := ` - SELECT id, platform, platform_channel_id, enabled, channel_raw + SELECT id, platform, platform_channel_id, enabled, enable_all_plugins, channel_raw FROM channels ` @@ -478,10 +495,11 @@ func (d *Database) GetAllChannels() ([]*model.Channel, error) { platform string platformChannelID string enabled bool + enableAllPlugins bool channelRawJSON string ) - if err := rows.Scan(&id, &platform, &platformChannelID, &enabled, &channelRawJSON); err != nil { + if err := rows.Scan(&id, &platform, &platformChannelID, &enabled, &enableAllPlugins, &channelRawJSON); err != nil { return nil, err } @@ -497,6 +515,7 @@ func (d *Database) GetAllChannels() ([]*model.Channel, error) { Platform: platform, PlatformChannelID: platformChannelID, Enabled: enabled, + EnableAllPlugins: enableAllPlugins, ChannelRaw: channelRaw, Plugins: make(map[string]*model.ChannelPlugin), } diff --git a/internal/db/db_test.go b/internal/db/db_test.go new file mode 100644 index 0000000..88ab470 --- /dev/null +++ b/internal/db/db_test.go @@ -0,0 +1,203 @@ +package db + +import ( + "fmt" + "os" + "testing" + "time" + + "git.nakama.town/fmartingr/butterrobot/internal/model" +) + +func TestEnableAllPlugins(t *testing.T) { + // Create temporary database for testing with unique name + dbFile := fmt.Sprintf("test_db_%d.db", time.Now().UnixNano()) + database, err := New(dbFile) + if err != nil { + t.Fatalf("Failed to create test database: %v", err) + } + defer func() { + _ = database.Close() + // Clean up test database file + _ = os.Remove(dbFile) + }() + + t.Run("CreateChannel with EnableAllPlugins default false", func(t *testing.T) { + channelRaw := map[string]interface{}{ + "name": "test-channel", + } + + channel, err := database.CreateChannel("telegram", "123456", true, channelRaw) + if err != nil { + t.Fatalf("Failed to create channel: %v", err) + } + + if channel.EnableAllPlugins { + t.Errorf("Expected EnableAllPlugins to be false by default, got true") + } + + // Verify it's also false when retrieved from database + retrieved, err := database.GetChannelByID(channel.ID) + if err != nil { + t.Fatalf("Failed to retrieve channel: %v", err) + } + + if retrieved.EnableAllPlugins { + t.Errorf("Expected EnableAllPlugins to be false when retrieved from DB, got true") + } + }) + + t.Run("UpdateChannelEnableAllPlugins", func(t *testing.T) { + // Create a channel + channelRaw := map[string]interface{}{ + "name": "test-channel-2", + } + + channel, err := database.CreateChannel("telegram", "123457", true, channelRaw) + if err != nil { + t.Fatalf("Failed to create channel: %v", err) + } + + // Update EnableAllPlugins to true + err = database.UpdateChannelEnableAllPlugins(channel.ID, true) + if err != nil { + t.Fatalf("Failed to update EnableAllPlugins: %v", err) + } + + // Retrieve and verify + retrieved, err := database.GetChannelByID(channel.ID) + if err != nil { + t.Fatalf("Failed to retrieve channel: %v", err) + } + + if !retrieved.EnableAllPlugins { + t.Errorf("Expected EnableAllPlugins to be true after update, got false") + } + + // Update back to false + err = database.UpdateChannelEnableAllPlugins(channel.ID, false) + if err != nil { + t.Fatalf("Failed to update EnableAllPlugins back to false: %v", err) + } + + // Retrieve and verify again + retrieved, err = database.GetChannelByID(channel.ID) + if err != nil { + t.Fatalf("Failed to retrieve channel: %v", err) + } + + if retrieved.EnableAllPlugins { + t.Errorf("Expected EnableAllPlugins to be false after second update, got true") + } + }) + + t.Run("GetChannelByPlatform includes EnableAllPlugins", func(t *testing.T) { + // Create a channel + channelRaw := map[string]interface{}{ + "name": "test-channel-3", + } + + channel, err := database.CreateChannel("slack", "C123456", true, channelRaw) + if err != nil { + t.Fatalf("Failed to create channel: %v", err) + } + + // Enable all plugins + err = database.UpdateChannelEnableAllPlugins(channel.ID, true) + if err != nil { + t.Fatalf("Failed to update EnableAllPlugins: %v", err) + } + + // Retrieve by platform + retrieved, err := database.GetChannelByPlatform("slack", "C123456") + if err != nil { + t.Fatalf("Failed to retrieve channel by platform: %v", err) + } + + if !retrieved.EnableAllPlugins { + t.Errorf("Expected EnableAllPlugins to be true when retrieved by platform, got false") + } + }) + + t.Run("GetAllChannels includes EnableAllPlugins", func(t *testing.T) { + // Create multiple channels with different EnableAllPlugins settings + channelRaw1 := map[string]interface{}{"name": "channel-1"} + channelRaw2 := map[string]interface{}{"name": "channel-2"} + + channel1, err := database.CreateChannel("platform1", "ch1", true, channelRaw1) + if err != nil { + t.Fatalf("Failed to create channel1: %v", err) + } + + channel2, err := database.CreateChannel("platform2", "ch2", true, channelRaw2) + if err != nil { + t.Fatalf("Failed to create channel2: %v", err) + } + + // Enable all plugins for channel2 only + err = database.UpdateChannelEnableAllPlugins(channel2.ID, true) + if err != nil { + t.Fatalf("Failed to update EnableAllPlugins for channel2: %v", err) + } + + // Get all channels + channels, err := database.GetAllChannels() + if err != nil { + t.Fatalf("Failed to get all channels: %v", err) + } + + // Find our test channels + var foundChannel1, foundChannel2 *model.Channel + for _, ch := range channels { + if ch.ID == channel1.ID { + foundChannel1 = ch + } + if ch.ID == channel2.ID { + foundChannel2 = ch + } + } + + if foundChannel1 == nil { + t.Fatalf("Channel1 not found in GetAllChannels result") + } + if foundChannel2 == nil { + t.Fatalf("Channel2 not found in GetAllChannels result") + } + + if foundChannel1.EnableAllPlugins { + t.Errorf("Expected channel1 EnableAllPlugins to be false, got true") + } + if !foundChannel2.EnableAllPlugins { + t.Errorf("Expected channel2 EnableAllPlugins to be true, got false") + } + }) + + t.Run("Migration applied correctly", func(t *testing.T) { + // Test that we can create a channel and the enable_all_plugins column exists + // This implicitly tests that migration 4 was applied correctly + channelRaw := map[string]interface{}{ + "name": "migration-test-channel", + } + + channel, err := database.CreateChannel("test-platform", "migration-test", true, channelRaw) + if err != nil { + t.Fatalf("Failed to create channel after migration: %v", err) + } + + // Try to update EnableAllPlugins - this would fail if the column doesn't exist + err = database.UpdateChannelEnableAllPlugins(channel.ID, true) + if err != nil { + t.Fatalf("Failed to update EnableAllPlugins - migration may not have been applied: %v", err) + } + + // Verify the value was set correctly + retrieved, err := database.GetChannelByID(channel.ID) + if err != nil { + t.Fatalf("Failed to retrieve channel: %v", err) + } + + if !retrieved.EnableAllPlugins { + t.Errorf("EnableAllPlugins should be true after update") + } + }) +} \ No newline at end of file diff --git a/internal/migration/migrations.go b/internal/migration/migrations.go index 9004a9b..11aa716 100644 --- a/internal/migration/migrations.go +++ b/internal/migration/migrations.go @@ -10,6 +10,7 @@ func init() { Register(1, "Initial schema with bcrypt passwords", migrateInitialSchemaUp, migrateInitialSchemaDown) Register(2, "Add reminders table", migrateRemindersUp, migrateRemindersDown) Register(3, "Add cache table", migrateCacheUp, migrateCacheDown) + Register(4, "Add enable_all_plugins column to channels", migrateEnableAllPluginsUp, migrateEnableAllPluginsDown) } // Initial schema creation with bcrypt passwords - version 1 @@ -154,3 +155,60 @@ func migrateCacheDown(db *sql.DB) error { _, err := db.Exec(`DROP TABLE IF EXISTS cache`) return err } + +// Add enable_all_plugins column to channels table - version 4 +func migrateEnableAllPluginsUp(db *sql.DB) error { + _, err := db.Exec(` + ALTER TABLE channels ADD COLUMN enable_all_plugins BOOLEAN NOT NULL DEFAULT 0 + `) + return err +} + +func migrateEnableAllPluginsDown(db *sql.DB) error { + // SQLite doesn't support DROP COLUMN, so we need to recreate the table + tx, err := db.Begin() + if err != nil { + return err + } + defer func() { + _ = tx.Rollback() // Ignore rollback errors + }() + + // Create backup table + _, err = tx.Exec(` + CREATE TABLE channels_backup ( + id INTEGER PRIMARY KEY AUTOINCREMENT, + platform TEXT NOT NULL, + platform_channel_id TEXT NOT NULL, + enabled BOOLEAN NOT NULL DEFAULT 0, + channel_raw TEXT NOT NULL, + UNIQUE(platform, platform_channel_id) + ) + `) + if err != nil { + return err + } + + // Copy data excluding enable_all_plugins column + _, err = tx.Exec(` + INSERT INTO channels_backup (id, platform, platform_channel_id, enabled, channel_raw) + SELECT id, platform, platform_channel_id, enabled, channel_raw FROM channels + `) + if err != nil { + return err + } + + // Drop original table + _, err = tx.Exec(`DROP TABLE channels`) + if err != nil { + return err + } + + // Rename backup table + _, err = tx.Exec(`ALTER TABLE channels_backup RENAME TO channels`) + if err != nil { + return err + } + + return tx.Commit() +} diff --git a/internal/model/message.go b/internal/model/message.go index 26ec5da..8b38830 100644 --- a/internal/model/message.go +++ b/internal/model/message.go @@ -44,11 +44,17 @@ type Channel struct { PlatformChannelID string ChannelRaw map[string]interface{} Enabled bool + EnableAllPlugins bool Plugins map[string]*ChannelPlugin } // HasEnabledPlugin checks if a plugin is enabled for this channel func (c *Channel) HasEnabledPlugin(pluginID string) bool { + // If EnableAllPlugins is true, all plugins are considered enabled + if c.EnableAllPlugins { + return true + } + plugin, exists := c.Plugins[pluginID] if !exists { return false diff --git a/internal/model/message_test.go b/internal/model/message_test.go new file mode 100644 index 0000000..d94c5ea --- /dev/null +++ b/internal/model/message_test.go @@ -0,0 +1,234 @@ +package model + +import ( + "testing" +) + +func TestChannel_HasEnabledPlugin(t *testing.T) { + t.Run("EnableAllPlugins false - plugin not in map", func(t *testing.T) { + channel := &Channel{ + ID: 1, + Platform: "telegram", + PlatformChannelID: "123456", + Enabled: true, + EnableAllPlugins: false, + Plugins: make(map[string]*ChannelPlugin), + } + + // Plugin not in map should return false + result := channel.HasEnabledPlugin("nonexistent.plugin") + if result { + t.Errorf("Expected HasEnabledPlugin to return false for nonexistent plugin, got true") + } + }) + + t.Run("EnableAllPlugins false - plugin disabled", func(t *testing.T) { + channel := &Channel{ + ID: 1, + Platform: "telegram", + PlatformChannelID: "123456", + Enabled: true, + EnableAllPlugins: false, + Plugins: map[string]*ChannelPlugin{ + "test.plugin": { + ID: 1, + ChannelID: 1, + PluginID: "test.plugin", + Enabled: false, + Config: make(map[string]any), + }, + }, + } + + // Disabled plugin should return false + result := channel.HasEnabledPlugin("test.plugin") + if result { + t.Errorf("Expected HasEnabledPlugin to return false for disabled plugin, got true") + } + }) + + t.Run("EnableAllPlugins false - plugin enabled", func(t *testing.T) { + channel := &Channel{ + ID: 1, + Platform: "telegram", + PlatformChannelID: "123456", + Enabled: true, + EnableAllPlugins: false, + Plugins: map[string]*ChannelPlugin{ + "test.plugin": { + ID: 1, + ChannelID: 1, + PluginID: "test.plugin", + Enabled: true, + Config: make(map[string]any), + }, + }, + } + + // Enabled plugin should return true + result := channel.HasEnabledPlugin("test.plugin") + if !result { + t.Errorf("Expected HasEnabledPlugin to return true for enabled plugin, got false") + } + }) + + t.Run("EnableAllPlugins true - plugin not in map", func(t *testing.T) { + channel := &Channel{ + ID: 1, + Platform: "telegram", + PlatformChannelID: "123456", + Enabled: true, + EnableAllPlugins: true, + Plugins: make(map[string]*ChannelPlugin), + } + + // When EnableAllPlugins is true, any plugin should be considered enabled + result := channel.HasEnabledPlugin("nonexistent.plugin") + if !result { + t.Errorf("Expected HasEnabledPlugin to return true when EnableAllPlugins is true, got false") + } + }) + + t.Run("EnableAllPlugins true - plugin disabled", func(t *testing.T) { + channel := &Channel{ + ID: 1, + Platform: "telegram", + PlatformChannelID: "123456", + Enabled: true, + EnableAllPlugins: true, + Plugins: map[string]*ChannelPlugin{ + "test.plugin": { + ID: 1, + ChannelID: 1, + PluginID: "test.plugin", + Enabled: false, + Config: make(map[string]any), + }, + }, + } + + // When EnableAllPlugins is true, even disabled plugins should be considered enabled + result := channel.HasEnabledPlugin("test.plugin") + if !result { + t.Errorf("Expected HasEnabledPlugin to return true when EnableAllPlugins is true (even for disabled plugin), got false") + } + }) + + t.Run("EnableAllPlugins true - plugin enabled", func(t *testing.T) { + channel := &Channel{ + ID: 1, + Platform: "telegram", + PlatformChannelID: "123456", + Enabled: true, + EnableAllPlugins: true, + Plugins: map[string]*ChannelPlugin{ + "test.plugin": { + ID: 1, + ChannelID: 1, + PluginID: "test.plugin", + Enabled: true, + Config: make(map[string]any), + }, + }, + } + + // When EnableAllPlugins is true, enabled plugins should also return true + result := channel.HasEnabledPlugin("test.plugin") + if !result { + t.Errorf("Expected HasEnabledPlugin to return true when EnableAllPlugins is true, got false") + } + }) + + t.Run("EnableAllPlugins true - multiple plugins", func(t *testing.T) { + channel := &Channel{ + ID: 1, + Platform: "telegram", + PlatformChannelID: "123456", + Enabled: true, + EnableAllPlugins: true, + Plugins: map[string]*ChannelPlugin{ + "plugin1": { + ID: 1, + ChannelID: 1, + PluginID: "plugin1", + Enabled: true, + Config: make(map[string]any), + }, + "plugin2": { + ID: 2, + ChannelID: 1, + PluginID: "plugin2", + Enabled: false, + Config: make(map[string]any), + }, + }, + } + + // All plugins should be enabled when EnableAllPlugins is true + testCases := []string{"plugin1", "plugin2", "plugin3", "any.plugin"} + for _, pluginID := range testCases { + result := channel.HasEnabledPlugin(pluginID) + if !result { + t.Errorf("Expected HasEnabledPlugin('%s') to return true when EnableAllPlugins is true, got false", pluginID) + } + } + }) +} + +func TestChannelName(t *testing.T) { + t.Run("Returns PlatformChannelID when ChannelRaw is nil", func(t *testing.T) { + channel := &Channel{ + PlatformChannelID: "test-id", + ChannelRaw: nil, + } + + result := channel.ChannelName() + if result != "test-id" { + t.Errorf("Expected channel name to be 'test-id', got '%s'", result) + } + }) + + t.Run("Returns name from ChannelRaw when available", func(t *testing.T) { + channel := &Channel{ + PlatformChannelID: "test-id", + ChannelRaw: map[string]interface{}{ + "name": "Test Channel", + }, + } + + result := channel.ChannelName() + if result != "Test Channel" { + t.Errorf("Expected channel name to be 'Test Channel', got '%s'", result) + } + }) + + t.Run("Returns title from nested chat object (Telegram style)", func(t *testing.T) { + channel := &Channel{ + PlatformChannelID: "test-id", + ChannelRaw: map[string]interface{}{ + "chat": map[string]interface{}{ + "title": "Telegram Group", + }, + }, + } + + result := channel.ChannelName() + if result != "Telegram Group" { + t.Errorf("Expected channel name to be 'Telegram Group', got '%s'", result) + } + }) + + t.Run("Falls back to PlatformChannelID when no valid name found", func(t *testing.T) { + channel := &Channel{ + PlatformChannelID: "fallback-id", + ChannelRaw: map[string]interface{}{ + "other_field": "value", + }, + } + + result := channel.ChannelName() + if result != "fallback-id" { + t.Errorf("Expected channel name to fallback to 'fallback-id', got '%s'", result) + } + }) +} \ No newline at end of file diff --git a/internal/plugin/plugin.go b/internal/plugin/plugin.go index 8d1f970..8f8413a 100644 --- a/internal/plugin/plugin.go +++ b/internal/plugin/plugin.go @@ -47,6 +47,19 @@ func GetAvailablePlugins() map[string]model.Plugin { return result } +// GetAvailablePluginIDs returns a slice of all registered plugin IDs +func GetAvailablePluginIDs() []string { + pluginsMu.RLock() + defer pluginsMu.RUnlock() + + result := make([]string, 0, len(plugins)) + for pluginID := range plugins { + result = append(result, pluginID) + } + + return result +} + // ClearRegistry clears all registered plugins (for testing) func ClearRegistry() { pluginsMu.Lock() diff --git a/internal/plugin/plugin_test.go b/internal/plugin/plugin_test.go new file mode 100644 index 0000000..e0b68d3 --- /dev/null +++ b/internal/plugin/plugin_test.go @@ -0,0 +1,331 @@ +package plugin + +import ( + "testing" + + "git.nakama.town/fmartingr/butterrobot/internal/model" +) + +// Mock plugin for testing +type testPlugin struct { + BasePlugin +} + +func (p *testPlugin) OnMessage(msg *model.Message, config map[string]interface{}, cache model.CacheInterface) []*model.MessageAction { + return []*model.MessageAction{ + { + Type: model.ActionSendMessage, + Message: &model.Message{ + Text: "test response", + Chat: msg.Chat, + Channel: msg.Channel, + }, + }, + } +} + +func TestGetAvailablePluginIDs(t *testing.T) { + // Clear registry before test + ClearRegistry() + + // Register test plugins + testPlugin1 := &testPlugin{ + BasePlugin: BasePlugin{ + ID: "test.plugin1", + Name: "Test Plugin 1", + }, + } + testPlugin2 := &testPlugin{ + BasePlugin: BasePlugin{ + ID: "test.plugin2", + Name: "Test Plugin 2", + }, + } + + Register(testPlugin1) + Register(testPlugin2) + + // Test GetAvailablePluginIDs + pluginIDs := GetAvailablePluginIDs() + + if len(pluginIDs) != 2 { + t.Errorf("Expected 2 plugin IDs, got %d", len(pluginIDs)) + } + + // Check that both plugin IDs are present + found1, found2 := false, false + for _, id := range pluginIDs { + if id == "test.plugin1" { + found1 = true + } + if id == "test.plugin2" { + found2 = true + } + } + + if !found1 { + t.Errorf("Expected to find test.plugin1 in plugin IDs") + } + if !found2 { + t.Errorf("Expected to find test.plugin2 in plugin IDs") + } +} + +func TestEnableAllPluginsProcessingLogic(t *testing.T) { + // Clear registry before test + ClearRegistry() + + // Register test plugins + testPlugin1 := &testPlugin{ + BasePlugin: BasePlugin{ + ID: "ping", + Name: "Ping Plugin", + }, + } + testPlugin2 := &testPlugin{ + BasePlugin: BasePlugin{ + ID: "echo", + Name: "Echo Plugin", + }, + } + testPlugin3 := &testPlugin{ + BasePlugin: BasePlugin{ + ID: "help", + Name: "Help Plugin", + }, + } + + Register(testPlugin1) + Register(testPlugin2) + Register(testPlugin3) + + t.Run("EnableAllPlugins false - only explicitly enabled plugins", func(t *testing.T) { + // Create a channel with EnableAllPlugins = false and only some plugins enabled + channel := &model.Channel{ + ID: 1, + Platform: "telegram", + PlatformChannelID: "123456", + Enabled: true, + EnableAllPlugins: false, + Plugins: map[string]*model.ChannelPlugin{ + "ping": { + ID: 1, + ChannelID: 1, + PluginID: "ping", + Enabled: true, + Config: map[string]interface{}{"key": "value"}, + }, + "echo": { + ID: 2, + ChannelID: 1, + PluginID: "echo", + Enabled: false, // Disabled + Config: map[string]interface{}{}, + }, + // help plugin not configured + }, + } + + // Simulate the plugin processing logic from handleMessage + var pluginsToProcess []string + + if channel.EnableAllPlugins { + pluginsToProcess = GetAvailablePluginIDs() + } else { + for pluginID := range channel.Plugins { + if channel.HasEnabledPlugin(pluginID) { + pluginsToProcess = append(pluginsToProcess, pluginID) + } + } + } + + // Should only have "ping" since echo is disabled and help is not configured + if len(pluginsToProcess) != 1 { + t.Errorf("Expected 1 plugin to process, got %d: %v", len(pluginsToProcess), pluginsToProcess) + } + + if len(pluginsToProcess) > 0 && pluginsToProcess[0] != "ping" { + t.Errorf("Expected ping plugin to be processed, got %s", pluginsToProcess[0]) + } + }) + + t.Run("EnableAllPlugins true - all registered plugins", func(t *testing.T) { + // Create a channel with EnableAllPlugins = true + channel := &model.Channel{ + ID: 1, + Platform: "telegram", + PlatformChannelID: "123456", + Enabled: true, + EnableAllPlugins: true, + Plugins: map[string]*model.ChannelPlugin{ + "ping": { + ID: 1, + ChannelID: 1, + PluginID: "ping", + Enabled: true, + Config: map[string]interface{}{"key": "value"}, + }, + "echo": { + ID: 2, + ChannelID: 1, + PluginID: "echo", + Enabled: false, // Disabled, but should still be processed + Config: map[string]interface{}{}, + }, + // help plugin not configured, but should still be processed + }, + } + + // Simulate the plugin processing logic from handleMessage + var pluginsToProcess []string + + if channel.EnableAllPlugins { + pluginsToProcess = GetAvailablePluginIDs() + } else { + for pluginID := range channel.Plugins { + if channel.HasEnabledPlugin(pluginID) { + pluginsToProcess = append(pluginsToProcess, pluginID) + } + } + } + + // Should have all 3 registered plugins + if len(pluginsToProcess) != 3 { + t.Errorf("Expected 3 plugins to process, got %d: %v", len(pluginsToProcess), pluginsToProcess) + } + + // Check that all plugins are included + expectedPlugins := map[string]bool{"ping": false, "echo": false, "help": false} + for _, pluginID := range pluginsToProcess { + if _, exists := expectedPlugins[pluginID]; exists { + expectedPlugins[pluginID] = true + } else { + t.Errorf("Unexpected plugin in processing list: %s", pluginID) + } + } + + for pluginID, found := range expectedPlugins { + if !found { + t.Errorf("Expected plugin %s to be in processing list", pluginID) + } + } + }) + + t.Run("Plugin configuration handling", func(t *testing.T) { + // Test the configuration logic from handleMessage + channel := &model.Channel{ + ID: 1, + Platform: "telegram", + PlatformChannelID: "123456", + Enabled: true, + EnableAllPlugins: true, + Plugins: map[string]*model.ChannelPlugin{ + "ping": { + ID: 1, + ChannelID: 1, + PluginID: "ping", + Enabled: true, + Config: map[string]interface{}{"configured": "value"}, + }, + }, + } + + testCases := []struct { + pluginID string + expectedConfig map[string]interface{} + }{ + { + pluginID: "ping", + expectedConfig: map[string]interface{}{"configured": "value"}, + }, + { + pluginID: "echo", // Not explicitly configured + expectedConfig: map[string]interface{}{}, + }, + } + + for _, tc := range testCases { + // Simulate the config retrieval logic from handleMessage + var config map[string]interface{} + if channelPlugin, exists := channel.Plugins[tc.pluginID]; exists { + config = channelPlugin.Config + } else { + config = make(map[string]interface{}) + } + + if len(config) != len(tc.expectedConfig) { + t.Errorf("Plugin %s: expected config length %d, got %d", tc.pluginID, len(tc.expectedConfig), len(config)) + } + + for key, expectedValue := range tc.expectedConfig { + if actualValue, exists := config[key]; !exists || actualValue != expectedValue { + t.Errorf("Plugin %s: expected config[%s] = %v, got %v", tc.pluginID, key, expectedValue, actualValue) + } + } + } + }) +} + +func TestPluginRegistry(t *testing.T) { + // Clear registry before test + ClearRegistry() + + testPlugin := &testPlugin{ + BasePlugin: BasePlugin{ + ID: "test.registry", + Name: "Test Registry Plugin", + }, + } + + t.Run("Register and Get plugin", func(t *testing.T) { + Register(testPlugin) + + retrieved, err := Get("test.registry") + if err != nil { + t.Errorf("Failed to get registered plugin: %v", err) + } + + if retrieved.GetID() != "test.registry" { + t.Errorf("Expected plugin ID 'test.registry', got '%s'", retrieved.GetID()) + } + }) + + t.Run("Get nonexistent plugin", func(t *testing.T) { + _, err := Get("nonexistent.plugin") + if err == nil { + t.Errorf("Expected error when getting nonexistent plugin, got nil") + } + + if err != model.ErrPluginNotFound { + t.Errorf("Expected ErrPluginNotFound, got %v", err) + } + }) + + t.Run("GetAvailablePlugins", func(t *testing.T) { + plugins := GetAvailablePlugins() + + if len(plugins) != 1 { + t.Errorf("Expected 1 plugin in registry, got %d", len(plugins)) + } + + if plugin, exists := plugins["test.registry"]; !exists { + t.Errorf("Expected to find test.registry in available plugins") + } else if plugin.GetID() != "test.registry" { + t.Errorf("Expected plugin ID 'test.registry', got '%s'", plugin.GetID()) + } + }) + + t.Run("ClearRegistry", func(t *testing.T) { + ClearRegistry() + + plugins := GetAvailablePlugins() + if len(plugins) != 0 { + t.Errorf("Expected 0 plugins after clearing registry, got %d", len(plugins)) + } + + _, err := Get("test.registry") + if err == nil { + t.Errorf("Expected error when getting plugin after clearing registry, got nil") + } + }) +} \ No newline at end of file From 368c45cd1357e5c20b283a775c68f849b9146db8 Mon Sep 17 00:00:00 2001 From: "Felipe M." Date: Mon, 23 Jun 2025 11:18:47 +0200 Subject: [PATCH 04/11] fix: twitter plugin replacement logic --- internal/plugin/social/twitter.go | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/internal/plugin/social/twitter.go b/internal/plugin/social/twitter.go index d98eee6..f2c6cc9 100644 --- a/internal/plugin/social/twitter.go +++ b/internal/plugin/social/twitter.go @@ -54,17 +54,12 @@ func (p *TwitterExpander) OnMessage(msg *model.Message, config map[string]interf // Parse the URL parsedURL, err := url.Parse(link) if err != nil { - // If parsing fails, just do the simple replacement - link = strings.Replace(link, "twitter.com", replacementDomain, 1) - link = strings.Replace(link, "x.com", replacementDomain, 1) return link } // Change the host to the configured domain - if strings.Contains(parsedURL.Host, "twitter.com") { - parsedURL.Host = strings.Replace(parsedURL.Host, "twitter.com", replacementDomain, 1) - } else if strings.Contains(parsedURL.Host, "x.com") { - parsedURL.Host = strings.Replace(parsedURL.Host, "x.com", replacementDomain, 1) + if strings.Contains(parsedURL.Host, "twitter.com") || strings.Contains(parsedURL.Host, "x.com") { + parsedURL.Host = replacementDomain } // Remove query parameters From e0ff369cffcc644714c86f9c4889b893cc9e73a9 Mon Sep 17 00:00:00 2001 From: "Felipe M." Date: Mon, 23 Jun 2025 11:19:22 +0200 Subject: [PATCH 05/11] chore: make format --- internal/db/db_test.go | 2 +- internal/model/message_test.go | 2 +- internal/plugin/plugin_test.go | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/internal/db/db_test.go b/internal/db/db_test.go index 88ab470..beb485d 100644 --- a/internal/db/db_test.go +++ b/internal/db/db_test.go @@ -200,4 +200,4 @@ func TestEnableAllPlugins(t *testing.T) { t.Errorf("EnableAllPlugins should be true after update") } }) -} \ No newline at end of file +} diff --git a/internal/model/message_test.go b/internal/model/message_test.go index d94c5ea..d2dfedc 100644 --- a/internal/model/message_test.go +++ b/internal/model/message_test.go @@ -231,4 +231,4 @@ func TestChannelName(t *testing.T) { t.Errorf("Expected channel name to fallback to 'fallback-id', got '%s'", result) } }) -} \ No newline at end of file +} diff --git a/internal/plugin/plugin_test.go b/internal/plugin/plugin_test.go index e0b68d3..0bfd207 100644 --- a/internal/plugin/plugin_test.go +++ b/internal/plugin/plugin_test.go @@ -328,4 +328,4 @@ func TestPluginRegistry(t *testing.T) { t.Errorf("Expected error when getting plugin after clearing registry, got nil") } }) -} \ No newline at end of file +} From 35c14ce8a81add52f6508516e428d2e7888875a2 Mon Sep 17 00:00:00 2001 From: "Felipe M." Date: Mon, 23 Jun 2025 11:20:21 +0200 Subject: [PATCH 06/11] chore: update CLAUDE.md --- CLAUDE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 2191848..0261dd2 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -18,9 +18,9 @@ When creating, modifying, or removing plugins: ## Testing -Before committing plugin changes: +After every session that contains changes to files: -1. Check files are properly formatted: Run `make format` +1. Check files are properly formatted running `make format` 2. Check code style and linting: Run `make lint` 3. Test the plugin functionality: Run `make test` 4. Verify documentation accuracy From 0edf41c792c1ac0fa33e5026067ec00b5c6c4439 Mon Sep 17 00:00:00 2001 From: "Felipe M." Date: Mon, 23 Jun 2025 11:32:34 +0200 Subject: [PATCH 07/11] fix: markdown parse mode breaking some plugins --- internal/platform/telegram/telegram.go | 14 ++- internal/plugin/fun/hltb.go | 9 +- internal/plugin/help/help.go | 2 + internal/plugin/social/twitter.go | 1 + internal/plugin/social/twitter_test.go | 120 +++++++++++++++++++++++++ 5 files changed, 140 insertions(+), 6 deletions(-) create mode 100644 internal/plugin/social/twitter_test.go diff --git a/internal/platform/telegram/telegram.go b/internal/platform/telegram/telegram.go index 24714f2..07c65a9 100644 --- a/internal/platform/telegram/telegram.go +++ b/internal/platform/telegram/telegram.go @@ -233,9 +233,17 @@ func (t *TelegramPlatform) SendMessage(msg *model.Message) error { // Prepare payload payload := map[string]interface{}{ - "chat_id": chatID, - "text": msg.Text, - "parse_mode": "Markdown", + "chat_id": chatID, + "text": msg.Text, + } + + // Set parse_mode based on plugin preference or default to Markdown + if msg.Raw != nil && msg.Raw["parse_mode"] != nil { + // Plugin explicitly set parse_mode + payload["parse_mode"] = msg.Raw["parse_mode"] + } else { + // Default to Markdown for backward compatibility + payload["parse_mode"] = "Markdown" } // Add reply if needed diff --git a/internal/plugin/fun/hltb.go b/internal/plugin/fun/hltb.go index 227d637..f94f2ba 100644 --- a/internal/plugin/fun/hltb.go +++ b/internal/plugin/fun/hltb.go @@ -131,12 +131,15 @@ func (p *HLTBPlugin) OnMessage(msg *model.Message, config map[string]interface{} Channel: msg.Channel, } + // Set parse mode for markdown formatting + if responseMsg.Raw == nil { + responseMsg.Raw = make(map[string]interface{}) + } + responseMsg.Raw["parse_mode"] = "Markdown" + // Add game cover as attachment if available if game.GameImage != "" { imageURL := p.getFullImageURL(game.GameImage) - if responseMsg.Raw == nil { - responseMsg.Raw = make(map[string]interface{}) - } responseMsg.Raw["image_url"] = imageURL } diff --git a/internal/plugin/help/help.go b/internal/plugin/help/help.go index 88b25dd..4e6215a 100644 --- a/internal/plugin/help/help.go +++ b/internal/plugin/help/help.go @@ -74,6 +74,7 @@ func (p *HelpPlugin) OnMessage(msg *model.Message, config map[string]interface{} Chat: msg.Chat, ReplyTo: msg.ID, Channel: msg.Channel, + Raw: map[string]interface{}{"parse_mode": "Markdown"}, } return []*model.MessageAction{ @@ -151,6 +152,7 @@ func (p *HelpPlugin) OnMessage(msg *model.Message, config map[string]interface{} Chat: msg.Chat, ReplyTo: msg.ID, Channel: msg.Channel, + Raw: map[string]interface{}{"parse_mode": "Markdown"}, } return []*model.MessageAction{ diff --git a/internal/plugin/social/twitter.go b/internal/plugin/social/twitter.go index f2c6cc9..69bd979 100644 --- a/internal/plugin/social/twitter.go +++ b/internal/plugin/social/twitter.go @@ -75,6 +75,7 @@ func (p *TwitterExpander) OnMessage(msg *model.Message, config map[string]interf Chat: msg.Chat, ReplyTo: msg.ID, Channel: msg.Channel, + Raw: map[string]interface{}{"parse_mode": ""}, } action := &model.MessageAction{ diff --git a/internal/plugin/social/twitter_test.go b/internal/plugin/social/twitter_test.go new file mode 100644 index 0000000..d94cad4 --- /dev/null +++ b/internal/plugin/social/twitter_test.go @@ -0,0 +1,120 @@ +package social + +import ( + "testing" + + "git.nakama.town/fmartingr/butterrobot/internal/model" +) + +func TestTwitterExpander_OnMessage(t *testing.T) { + plugin := NewTwitterExpander() + + tests := []struct { + name string + input string + config map[string]interface{} + expected string + hasReply bool + }{ + { + name: "Twitter URL with default domain", + input: "https://twitter.com/user/status/123456789", + config: map[string]interface{}{}, + expected: "https://fxtwitter.com/user/status/123456789", + hasReply: true, + }, + { + name: "X.com URL with custom domain", + input: "https://x.com/elonmusk/status/987654321", + config: map[string]interface{}{"domain": "vxtwitter.com"}, + expected: "https://vxtwitter.com/elonmusk/status/987654321", + hasReply: true, + }, + { + name: "Twitter URL with tracking parameters", + input: "https://twitter.com/openai/status/555?ref_src=twsrc%5Etfw&s=20", + config: map[string]interface{}{}, + expected: "https://fxtwitter.com/openai/status/555", + hasReply: true, + }, + { + name: "www.twitter.com URL", + input: "https://www.twitter.com/user/status/789", + config: map[string]interface{}{"domain": "nitter.net"}, + expected: "https://nitter.net/user/status/789", + hasReply: true, + }, + { + name: "Mixed text with Twitter URL", + input: "Check this out: https://twitter.com/user/status/123 amazing!", + config: map[string]interface{}{}, + expected: "Check this out: https://fxtwitter.com/user/status/123 amazing!", + hasReply: true, + }, + { + name: "No Twitter URLs", + input: "Just some regular text https://youtube.com/watch?v=abc", + config: map[string]interface{}{}, + expected: "", + hasReply: false, + }, + { + name: "Empty message", + input: "", + config: map[string]interface{}{}, + expected: "", + hasReply: false, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + msg := &model.Message{ + ID: "test_msg", + Text: tt.input, + Chat: "test_chat", + Channel: &model.Channel{ + ID: 1, + Platform: "telegram", + PlatformChannelID: "test_chat", + }, + } + + actions := plugin.OnMessage(msg, tt.config, nil) + + if !tt.hasReply { + if len(actions) != 0 { + t.Errorf("Expected no actions, got %d", len(actions)) + } + return + } + + if len(actions) != 1 { + t.Errorf("Expected 1 action, got %d", len(actions)) + return + } + + action := actions[0] + if action.Type != model.ActionSendMessage { + t.Errorf("Expected ActionSendMessage, got %s", action.Type) + } + + if action.Message == nil { + t.Error("Expected message in action, got nil") + return + } + + if action.Message.Text != tt.expected { + t.Errorf("Expected '%s', got '%s'", tt.expected, action.Message.Text) + } + + if action.Message.ReplyTo != msg.ID { + t.Errorf("Expected ReplyTo '%s', got '%s'", msg.ID, action.Message.ReplyTo) + } + + if action.Message.Raw == nil || action.Message.Raw["parse_mode"] != "" { + t.Error("Expected parse_mode to be empty string to disable markdown parsing") + } + }) + } +} \ No newline at end of file From bdc797d5c107136a1e7afec0244fcf2b109b2c0d Mon Sep 17 00:00:00 2001 From: "Felipe M." Date: Mon, 23 Jun 2025 11:34:27 +0200 Subject: [PATCH 08/11] chore: make format --- internal/platform/telegram/telegram.go | 2 +- internal/plugin/social/twitter_test.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/internal/platform/telegram/telegram.go b/internal/platform/telegram/telegram.go index 07c65a9..d35bb6b 100644 --- a/internal/platform/telegram/telegram.go +++ b/internal/platform/telegram/telegram.go @@ -236,7 +236,7 @@ func (t *TelegramPlatform) SendMessage(msg *model.Message) error { "chat_id": chatID, "text": msg.Text, } - + // Set parse_mode based on plugin preference or default to Markdown if msg.Raw != nil && msg.Raw["parse_mode"] != nil { // Plugin explicitly set parse_mode diff --git a/internal/plugin/social/twitter_test.go b/internal/plugin/social/twitter_test.go index d94cad4..c0e1681 100644 --- a/internal/plugin/social/twitter_test.go +++ b/internal/plugin/social/twitter_test.go @@ -117,4 +117,4 @@ func TestTwitterExpander_OnMessage(t *testing.T) { } }) } -} \ No newline at end of file +} From 3a5b5c216ddc3c719c095bbf7bf40d80e344b391 Mon Sep 17 00:00:00 2001 From: "Felipe M." Date: Mon, 23 Jun 2025 11:35:30 +0200 Subject: [PATCH 09/11] chore: try to ensure that code is checked after each session --- CLAUDE.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 0261dd2..cb4e70a 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -18,10 +18,12 @@ When creating, modifying, or removing plugins: ## Testing -After every session that contains changes to files: +**CRITICAL**: After making ANY changes to code files, you MUST run these commands in order: -1. Check files are properly formatted running `make format` -2. Check code style and linting: Run `make lint` -3. Test the plugin functionality: Run `make test` +1. **Format code**: `make format` - Format all code according to project standards +2. **Lint code**: `make lint` - Check code style and quality (must show "0 issues") +3. **Run tests**: `make test` - Run all tests to ensure functionality works 4. Verify documentation accuracy 5. Ensure all examples work as described + +**These commands are MANDATORY after every code change, no exceptions.** From 60ceaffd82dd209877f38771e719fc426dfff725 Mon Sep 17 00:00:00 2001 From: "Felipe M." Date: Mon, 23 Jun 2025 11:43:42 +0200 Subject: [PATCH 10/11] fix: enable all plugins help text --- internal/admin/templates/channel_detail.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/internal/admin/templates/channel_detail.html b/internal/admin/templates/channel_detail.html index 9f9a78d..7e12d57 100644 --- a/internal/admin/templates/channel_detail.html +++ b/internal/admin/templates/channel_detail.html @@ -32,7 +32,7 @@ Enable All Plugins -
+
When enabled, all registered plugins will be automatically enabled for this channel. Individual plugin settings will be ignored.
@@ -124,4 +124,4 @@
-{{end}} \ No newline at end of file +{{end}} From 377b1723c31975c9cb43587a949c2014e2ae81ae Mon Sep 17 00:00:00 2001 From: "Felipe M." Date: Tue, 24 Jun 2025 08:10:56 +0200 Subject: [PATCH 11/11] fix: default parse mode to text --- internal/platform/telegram/telegram.go | 6 +++--- internal/plugin/social/twitter.go | 1 - 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/internal/platform/telegram/telegram.go b/internal/platform/telegram/telegram.go index d35bb6b..b015793 100644 --- a/internal/platform/telegram/telegram.go +++ b/internal/platform/telegram/telegram.go @@ -237,13 +237,13 @@ func (t *TelegramPlatform) SendMessage(msg *model.Message) error { "text": msg.Text, } - // Set parse_mode based on plugin preference or default to Markdown + // Set parse_mode based on plugin preference or default to empty string if msg.Raw != nil && msg.Raw["parse_mode"] != nil { // Plugin explicitly set parse_mode payload["parse_mode"] = msg.Raw["parse_mode"] } else { - // Default to Markdown for backward compatibility - payload["parse_mode"] = "Markdown" + // Default to empty string (no formatting) + payload["parse_mode"] = "" } // Add reply if needed diff --git a/internal/plugin/social/twitter.go b/internal/plugin/social/twitter.go index 69bd979..f2c6cc9 100644 --- a/internal/plugin/social/twitter.go +++ b/internal/plugin/social/twitter.go @@ -75,7 +75,6 @@ func (p *TwitterExpander) OnMessage(msg *model.Message, config map[string]interf Chat: msg.Chat, ReplyTo: msg.ID, Channel: msg.Channel, - Raw: map[string]interface{}{"parse_mode": ""}, } action := &model.MessageAction{