Skip to content

feat(config): warn on unknown keys #1614

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MD-Mushfiqur123 wants to merge 5 commits into
base: release/v1
Choose a base branch
from
Open

feat(config): warn on unknown keys #1614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
08d28cf
feat(config): warn on unknown keys in config file
MD-Mushfiqur123 Jun 23, 2026
bd2b937
fix: add pass_cmd to known account keys
MD-Mushfiqur123 Jun 23, 2026
3ac50d5
style: fix gofmt alignment in config.go
MD-Mushfiqur123 Jun 23, 2026
ca4ebdb
refactor: use struct reflection for known config keys
MD-Mushfiqur123 Jun 24, 2026
71f1f82
refactor: use diskConfig/rawAccount for key reflection, fix tests
MD-Mushfiqur123 Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
176 changes: 119 additions & 57 deletions config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"os"
"os/exec"
"path/filepath"
"reflect"
"strings"
"sync"

Expand Down Expand Up @@ -651,68 +652,13 @@ func LoadConfig() (*Config, error) {
return nil, err
}

warnUnknownConfigKeys(data)

secureMode := GetSessionKey() != nil

var config Config
var needsMigration bool

type rawAccount struct {
ID string `json:"id"`
Name string `json:"name"`
Email string `json:"email"`
Password string `json:"password,omitempty"`
ServiceProvider string `json:"service_provider"`
FetchEmail string `json:"fetch_email,omitempty"`
SendAsEmail string `json:"send_as_email,omitempty"`
IMAPServer string `json:"imap_server,omitempty"`
IMAPPort int `json:"imap_port,omitempty"`
SMTPServer string `json:"smtp_server,omitempty"`
SMTPPort int `json:"smtp_port,omitempty"`
Insecure bool `json:"insecure,omitempty"`
SMTPUsername string `json:"smtp_username,omitempty"`
SMTPPassword string `json:"smtp_password,omitempty"`
SMIMECert string `json:"smime_cert,omitempty"`
SMIMEKey string `json:"smime_key,omitempty"`
SMIMESignByDefault bool `json:"smime_sign_by_default,omitempty"`
PGPPublicKey string `json:"pgp_public_key,omitempty"`
PGPPrivateKey string `json:"pgp_private_key,omitempty"`
PGPKeySource string `json:"pgp_key_source,omitempty"`
PGPPIN string `json:"pgp_pin,omitempty"`
PGPSignByDefault bool `json:"pgp_sign_by_default,omitempty"`
AuthMethod string `json:"auth_method,omitempty"`
PassCmd string `json:"pass_cmd,omitempty"`
Protocol string `json:"protocol,omitempty"`
JMAPEndpoint string `json:"jmap_endpoint,omitempty"`
POP3Server string `json:"pop3_server,omitempty"`
POP3Port int `json:"pop3_port,omitempty"`
MaildirPath string `json:"maildir_path,omitempty"`
CatchAll bool `json:"catch_all,omitempty"`
}
type diskConfig struct {
Accounts []rawAccount `json:"accounts"`
DisableImages bool `json:"disable_images,omitempty"`
HideTips bool `json:"hide_tips,omitempty"`
DisableNotifications bool `json:"disable_notifications,omitempty"`
DisableDaemon bool `json:"disable_daemon,omitempty"`
EnableSplitPane bool `json:"enable_split_pane,omitempty"`
SplitPaneOrientation string `json:"split_pane_orientation,omitempty"`
EnableThreaded bool `json:"enable_threaded,omitempty"`
EnableDetailedDates bool `json:"enable_detailed_dates,omitempty"`
DisableSpellcheck bool `json:"disable_spellcheck,omitempty"`
DisableSpellSuggestions bool `json:"disable_spell_suggestions,omitempty"`
Theme string `json:"theme,omitempty"`
MailingLists []MailingList `json:"mailing_lists,omitempty"`
DateFormat string `json:"date_format,omitempty"`
Language string `json:"language,omitempty"`
BodyCacheThresholdMB int `json:"body_cache_threshold_mb,omitempty"`
UndoDelaySeconds int `json:"undo_delay_seconds,omitempty"`
PluginSettings map[string]map[string]interface{} `json:"plugin_settings,omitempty"`
HasSeenSetupGuide bool `json:"has_seen_setup_guide,omitempty"`
MouseEnabled *bool `json:"mouse_enabled,omitempty"`
ShowOriginalOnReply bool `json:"show_original_on_reply,omitempty"`
ShowCcBccByDefault bool `json:"show_cc_bcc_by_default,omitempty"`
}

var raw diskConfig
if err := json.Unmarshal(data, &raw); err != nil {
var legacyConfig legacyConfigFormat
Expand Down Expand Up @@ -957,3 +903,119 @@ func EnsurePGPDir() error {
pgpDir := filepath.Join(dir, "pgp")
return os.MkdirAll(pgpDir, 0700)
}

type rawAccount struct {
ID string `json:"id"`
Name string `json:"name"`
Email string `json:"email"`
Password string `json:"password,omitempty"`
ServiceProvider string `json:"service_provider"`
FetchEmail string `json:"fetch_email,omitempty"`
SendAsEmail string `json:"send_as_email,omitempty"`
IMAPServer string `json:"imap_server,omitempty"`
IMAPPort int `json:"imap_port,omitempty"`
SMTPServer string `json:"smtp_server,omitempty"`
SMTPPort int `json:"smtp_port,omitempty"`
Insecure bool `json:"insecure,omitempty"`
SMTPUsername string `json:"smtp_username,omitempty"`
SMTPPassword string `json:"smtp_password,omitempty"`
SMIMECert string `json:"smime_cert,omitempty"`
SMIMEKey string `json:"smime_key,omitempty"`
SMIMESignByDefault bool `json:"smime_sign_by_default,omitempty"`
PGPPublicKey string `json:"pgp_public_key,omitempty"`
PGPPrivateKey string `json:"pgp_private_key,omitempty"`
PGPKeySource string `json:"pgp_key_source,omitempty"`
PGPPIN string `json:"pgp_pin,omitempty"`
PGPSignByDefault bool `json:"pgp_sign_by_default,omitempty"`
AuthMethod string `json:"auth_method,omitempty"`
PassCmd string `json:"pass_cmd,omitempty"`
Protocol string `json:"protocol,omitempty"`
JMAPEndpoint string `json:"jmap_endpoint,omitempty"`
POP3Server string `json:"pop3_server,omitempty"`
POP3Port int `json:"pop3_port,omitempty"`
MaildirPath string `json:"maildir_path,omitempty"`
CatchAll bool `json:"catch_all,omitempty"`
}

type diskConfig struct {
Accounts []rawAccount `json:"accounts"`
DisableImages bool `json:"disable_images,omitempty"`
HideTips bool `json:"hide_tips,omitempty"`
DisableNotifications bool `json:"disable_notifications,omitempty"`
DisableDaemon bool `json:"disable_daemon,omitempty"`
EnableSplitPane bool `json:"enable_split_pane,omitempty"`
SplitPaneOrientation string `json:"split_pane_orientation,omitempty"`
EnableThreaded bool `json:"enable_threaded,omitempty"`
EnableDetailedDates bool `json:"enable_detailed_dates,omitempty"`
DisableSpellcheck bool `json:"disable_spellcheck,omitempty"`
DisableSpellSuggestions bool `json:"disable_spell_suggestions,omitempty"`
Theme string `json:"theme,omitempty"`
MailingLists []MailingList `json:"mailing_lists,omitempty"`
DateFormat string `json:"date_format,omitempty"`
Language string `json:"language,omitempty"`
BodyCacheThresholdMB int `json:"body_cache_threshold_mb,omitempty"`
UndoDelaySeconds int `json:"undo_delay_seconds,omitempty"`
PluginSettings map[string]map[string]interface{} `json:"plugin_settings,omitempty"`
HasSeenSetupGuide bool `json:"has_seen_setup_guide,omitempty"`
MouseEnabled *bool `json:"mouse_enabled,omitempty"`
ShowOriginalOnReply bool `json:"show_original_on_reply,omitempty"`
ShowCcBccByDefault bool `json:"show_cc_bcc_by_default,omitempty"`
}

var knownConfigKeys map[string]bool
var knownAccountKeys map[string]bool
var knownKeysOnce sync.Once

func initKnownKeys() {
knownConfigKeys = structJSONKeys(diskConfig{})
knownAccountKeys = structJSONKeys(rawAccount{})
}

func structJSONKeys(v any) map[string]bool {
keys := make(map[string]bool)
t := reflect.TypeOf(v)
for i := range t.NumField() {
f := t.Field(i)
tag := f.Tag.Get("json")
if tag == "" || tag == "-" {
continue
}
name, _, _ := strings.Cut(tag, ",")
if name == "" {
name = strings.ToLower(f.Name)
}
keys[name] = true
}
return keys
}

func warnUnknownConfigKeys(data []byte) {
knownKeysOnce.Do(initKnownKeys)

var raw map[string]interface{}
if err := json.Unmarshal(data, &raw); err != nil {
return
}
for key := range raw {
if !knownConfigKeys[key] {
log.Printf("matcha: unknown config key %q", key)
}
if key == "accounts" {
accounts, ok := raw["accounts"].([]interface{})
if !ok {
continue
}
for i, acc := range accounts {
accMap, ok := acc.(map[string]interface{})
if !ok {
continue
}
for accKey := range accMap {
if !knownAccountKeys[accKey] {
log.Printf("matcha: unknown config key in accounts[%d]: %q", i, accKey)
}
}
}
}
}
}
59 changes: 59 additions & 0 deletions config/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@ package config

import (
"encoding/json"
"log"
"os"
"path/filepath"
"reflect"
"strings"
"testing"
"time"

Expand Down Expand Up @@ -711,3 +713,60 @@ func TestPassCmd(t *testing.T) {
t.Errorf("Password not resolved from pass_cmd: got %q", acc.Password)
}
}

func TestWarnUnknownConfigKeys(t *testing.T) {
tests := []struct {
name string
json string
wantsLog []string // substrings we expect in log output
}{
{
"no unknown keys",
`{"accounts": [{"name": "test", "email": "a@b.com", "service_provider": "gmail"}], "theme": "dark"}`,
nil,
},
{
"empty object",
`{}`,
nil,
},
{
"invalid json",
`not json`,
nil,
},
{
"unknown top-level key",
`{"unknown_top": true}`,
[]string{"unknown config key"},
},
{
"unknown account key",
`{"accounts": [{"name": "test", "email": "a@b.com", "service_provider": "gmail", "unknown_field": true}]}`,
[]string{"unknown config key", "accounts[0]"},
},
{
"known keys produce no warnings",
`{"accounts": [{"name": "test", "email": "a@b.com", "service_provider": "gmail", "password": "s3cret"}], "theme": "dark"}`,
nil,
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
var buf strings.Builder
log.SetOutput(&buf)
warnUnknownConfigKeys([]byte(tc.json))
log.SetOutput(os.Stderr)

got := buf.String()
for _, want := range tc.wantsLog {
if !strings.Contains(got, want) {
t.Errorf("expected log to contain %q, got: %s", want, got)
}
}
if len(tc.wantsLog) == 0 && got != "" {
t.Errorf("expected no log output, got: %s", got)
}
})
}
}
Comment on lines +717 to +772

@andrinoff andrinoff Jun 24, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1st of all, this test only tests, that the function will not fail, it doesnt test anything, use assertion

Loading