config

Documentation

Overview

Package config provides functionality to load config from YAML files, environment variables, and command-line arguments.

Index

• Variables
• func AddFlag(flags *pflag.FlagSet)
• type Config
  • func Load(flags *pflag.FlagSet) (Config, error)
  • func (c Config) CurrentWiki() (Wiki, error)
• type Discord
• type Duration
  • func (d Duration) AddTo(start time.Time) time.Time
• type Log
• type PatrolExpiring
• type ReportData
• type ReportType
• type Reports
• type Server
• type Timeouts
• type Wiki
• type WikiAuth
• type WikiClient
• type WikiSite

Variables

var (
	// ErrFileNotFound indicates that no config file was found in the home directory, current directory, or at the --config
	// flag path if given.
	ErrFileNotFound = errors.New("config.yaml file not found")

	// ErrWikiNotSet indicates that no wiki was selected via flag or env variable, and no default wiki is configured.
	ErrWikiNotSet = errors.New("wiki not set")

	// ErrWikiNotFound indicates that a wiki was selected that does not exist in the map of wikis.
	ErrWikiNotFound = errors.New("wiki not found")
)

Functions

func AddFlag

func AddFlag(flags *pflag.FlagSet)

AddFlag adds a --config flag for passing a custom config file.

Types

type Config

type Config struct {
	// Discord bot configuration
	Discord Discord `json:"discord"`

	// Logging configuration
	Log Log `json:"log"`

	// HTTP server configuration
	Server *Server `json:"server,omitempty"`

	// User-Agent HTTP header for MediaWiki and Discord API requests
	// https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/User-Agent
	UserAgent string `json:"userAgent"`

	// Target wiki for bot commands
	Wiki string `json:"wiki"`

	// Wiki configurations
	Wikis map[string]Wiki `json:"wikis"`
}

Config represents the configuration for PatrolBot.

func Load

func Load(flags *pflag.FlagSet) (Config, error)

Load sources config from files, environment variables, and command-line flags and returns the merged result. See patrolbot config --help for more on config sources.

func (Config) CurrentWiki

func (c Config) CurrentWiki() (Wiki, error)

CurrentWiki validates and returns the Wiki configuration for the selected wiki.

type Discord

type Discord struct {
	// API version URL, e.g. https://discord.com/api/v10
	// See: https://discord.com/developers/docs/reference#api-versioning
	API string `json:"api"`

	// Application ID
	AppID string `json:"appID"`

	// Public key
	PublicKey string `json:"publicKey"`

	// Bot token
	Token string `json:"token"`
}

Discord represents the Discord bot configuration.

type Duration

type Duration struct {
	Hours int `json:"hours,omitempty" jsonschema:"oneof,minimum=1"`
	Days  int `json:"days,omitempty"  jsonschema:"oneof,minimum=1"`
	Weeks int `json:"weeks,omitempty" jsonschema:"oneof,minimum=1"`
}

Duration represents a span of time expressed in hours, days, or weeks.

func (Duration) AddTo

func (d Duration) AddTo(start time.Time) time.Time

AddTo returns the time obtained by adding the duration to `start`.

The calculation uses calendar arithmetic for weeks and days, and a fixed duration for hours. If multiple fields are set, the largest unit takes precedence: weeks, then days, then hours.

type Log

type Log struct {
	// Level is the minimum severity level that will be logged.
	Level slog.Level `json:"level" jsonschema:"type=string,enum=DEBUG,enum=INFO,enum=WARN,enum=ERROR,default=INFO"`
}

Log represents PatrolBot logging configuration.

type PatrolExpiring

type PatrolExpiring struct {
	// Durations of time before changes reach $wgRCMaxAge and expire from Special:RecentChanges.
	Windows []Duration `json:"windows"`
}

PatrolExpiring represents the configuration for the github.com/iocalebs/patrolbot/internal/report/data.PatrolExpiring data source.

type ReportData

type ReportData struct {
	// Counts unpatrolled edits via API:RecentChanges
	PatrolExpiring *PatrolExpiring `json:"patrolExpiring,omitempty"`
}

ReportData represents the configuration for the data sources used for a report type.

type ReportType

type ReportType struct {
	// File name of the template to use for the report
	Template string `json:"template"`

	// Discord channel to post the report to
	DiscordChannelID string `json:"discordChannelID"`

	// Description of the report type in 100 characters or less
	Description string `json:"description"`

	// Data to use in the report
	Data ReportData `json:"data"`
}

ReportType represents the configuration for a specific report type.

type Reports

type Reports struct {
	// Path to directory containing report templates
	TemplateDir string `json:"templateDir" jsonschema:"minLength=1"`

	// Discord server (guild) ID to post reports in
	DiscordServerID string `json:"discordServerID"`

	// Defines the types of reports that can be generated using the `report` command
	Types map[string]ReportType `json:"types"`
}

Reports represents the configuration for generating reports.

type Server

type Server struct {
	// Port to listen on
	Port int `json:"port"`

	// HTTP server timeouts as durations, e.g. "2s" or "500ms"
	// See: https://pkg.go.dev/net/http#Server
	Timeouts Timeouts `json:"timeouts"`
}

Server represents the configuration for the PatrolBot HTTP server.

type Timeouts

type Timeouts struct {
	ReadTimeout       time.Duration `json:"readTimeout"       jsonschema:"type=string"`
	ReadHeaderTimeout time.Duration `json:"readHeaderTimeout" jsonschema:"type=string"`
	WriteTimeout      time.Duration `json:"writeTimeout"      jsonschema:"type=string"`
	IdleTimeout       time.Duration `json:"idleTimeout"       jsonschema:"type=string"`
}

Timeouts represents the configuration for the PatrolBot HTTP server timeouts.

type Wiki

type Wiki struct {
	// MediaWiki site information that PatrolBot needs to be aware of.
	Site WikiSite `json:"site"`

	// Authentication credentials for the MediaWiki API
	// See https://www.mediawiki.org/wiki/API:Login
	Auth WikiAuth `json:"auth"`

	// Configuration for the HTTP client used for MediaWiki API requests.
	Client WikiClient `json:"client"`

	// Configuration for the wiki's reports
	Reports Reports `json:"reports"`
}

Wiki represents the configuration for a particular MediaWiki instance.

type WikiAuth

type WikiAuth struct {
	// Special:BotPasswords username (e.g. PhantomCaleb@PatrolBot)
	Username string `json:"username"`

	// Special:BotPasswords password
	Password string `json:"password"`
}

WikiAuth represents the configuration for the bot's MediaWiki API login credentials.

type WikiClient

type WikiClient struct {
	// Request timeout as a string, e.g. "2s" or "500ms"
	// A timeout of zero means no timeout
	Timeout time.Duration `json:"timeout" jsonschema:"type=string,minLength=1"`

	// From HTTP header for API requests
	// https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/From
	From string `json:"from"`
}

WikiClient represents configuration for the HTTP client used for MediaWiki API requests.

type WikiSite

type WikiSite struct {
	// Wiki URL (e.g. https://en.wikipedia.org)
	URL string `json:"url"`

	// Wiki script path - typically "/w"
	// See https://www.mediawiki.org/wiki/Manual:$wgScriptPath
	ScriptPath string `json:"scriptPath"`

	// Wiki article path without /$1 ending - typically "/wiki"
	// See https://www.mediawiki.org/wiki/Manual:$wgArticlePath
	ArticlePath string `json:"articlePath"`

	// The wiki's recent changes retention period in days
	// See https://www.mediawiki.org/wiki/Manual:$wgRCMaxAge
	RCMaxAgeDays int `json:"rcMaxAgeDays"`

	// Maximum results that can be shown in the wikis' Special:RecentChanges
	// See https://www.mediawiki.org/wiki/Manual:$wgRCLinkLimits
	RCLinkLimit int `json:"rcLinkLimit"`
}

WikiSite represents MediaWiki instance configuration (namely $wg variables) that PatrolBot needs to be aware of.