config

Documentation

Index

• Constants
• Variables
• type Config
  • func (conf Config) AppURL(appID apps.AppID) string
  • func (conf Config) GetPluginVersionInfo() map[string]interface{}
  • func (conf *Config) InfoTemplateData() map[string]string
  • func (conf Config) Loggable() []interface{}
  • func (conf Config) StaticURL(appID apps.AppID, name string) string
• type Configurable
• type Service
  • func NewService(mm *pluginapi.Client, pliginManifest model.Manifest, botUserID string, ...) (Service, error)
• type StoredConfig
• type TestService
  • func NewTestConfigService(testConfig *Config) *TestService
  • func NewTestService(testConfig *Config) (*TestService, *plugintest.API)
  • func (s *TestService) Get() Config
  • func (s *TestService) I18N() *i18n.Bundle
  • func (s *TestService) MattermostAPI() *pluginapi.Client
  • func (s *TestService) MattermostConfig() configservice.ConfigService
  • func (s *TestService) NewBaseLogger() utils.Logger
  • func (s *TestService) Reconfigure(map[string]any, utils.Logger, ...Configurable) error
  • func (s *TestService) StoreConfig(sc StoredConfig, _ utils.Logger) error
  • func (s *TestService) Telemetry() *telemetry.Telemetry
  • func (s TestService) WithMattermostAPI(mm *pluginapi.Client) *TestService
  • func (s TestService) WithMattermostConfig(mmconfig model.Config) *TestService

Constants

const (
	MattermostSessionIDHeader = "Mattermost-Session-Id"
	MattermostPluginIDHeader  = "Mattermost-Plugin-Id"
	MattermostUserIDHeader    = "Mattermost-User-Id"
)

const (
	Repository     = "mattermost-plugin-apps"
	CommandTrigger = "apps"
	ManifestsFile  = "manifests.json"

	BotUsername    = "appsbot"
	BotDisplayName = "Mattermost Apps"
	BotDescription = "Mattermost Apps Registry and API proxy."
)

Internal configuration apps.of mattermost-plugin-apps

const (
	// Top-level path(s) for HTTP example apps.
	HelloHTTPPath = "/example/hello"

	WebSocketEventRefreshBindings = "refresh_bindings"
	WebSocketEventPluginEnabled   = "plugin_enabled"
	WebSocketEventPluginDisabled  = "plugin_disabled"
)

const (
	PropTeamID    = "team_id"
	PropChannelID = "channel_id"
	PropUserAgent = "user_agent_type"
)

const (
	RequestTimeout = time.Second * 30
)

Variables

var BuildDate string

var BuildHash string

var BuildHashShort string

Types

type Config

type Config struct {
	StoredConfig

	PluginManifest model.Manifest
	BuildDate      string
	BuildHash      string
	BuildHashShort string

	MattermostCloudMode bool

	BotUserID          string
	MattermostSiteURL  string
	MattermostLocalURL string
	PluginURL          string
	PluginURLPath      string

	// Maximum size of incoming remote webhook messages
	MaxWebhookSize int

	AWSRegion    string
	AWSAccessKey string
	AWSSecretKey string
	AWSS3Bucket  string
}

Config represents the the metadata handed to all request runners (command, http).

Config should be abbreviated as `conf`.

func (Config) AppURL

func (conf Config) AppURL(appID apps.AppID) string

func (Config) GetPluginVersionInfo

func (conf Config) GetPluginVersionInfo() map[string]interface{}

func (*Config) InfoTemplateData

func (conf *Config) InfoTemplateData() map[string]string

func (Config) Loggable

func (conf Config) Loggable() []interface{}

func (Config) StaticURL

func (conf Config) StaticURL(appID apps.AppID, name string) string

StaticURL returns the URL to a static asset.

type Configurable

type Configurable interface {
	Configure(Config, utils.Logger) error
}

type Service

type Service interface {
	Get() Config
	MattermostAPI() *pluginapi.Client
	MattermostConfig() configservice.ConfigService
	I18N() *i18n.Bundle
	Telemetry() *telemetry.Telemetry
	NewBaseLogger() utils.Logger

	Reconfigure(map[string]any, utils.Logger, ...Configurable) error
	StoreConfig(StoredConfig, utils.Logger) error
}

func NewService

func NewService(mm *pluginapi.Client, pliginManifest model.Manifest, botUserID string, telemetry *telemetry.Telemetry, i18nBundle *i18n.Bundle, log utils.Logger) (Service, error)

type StoredConfig

type StoredConfig struct {
	// InstalledApps is a list of all apps installed on the Mattermost instance.
	//
	// For each installed app, an entry of string(AppID) -> sha1(App) is added,
	// and the App struct is stored in KV under app_<sha1(App)>. Implementation
	// in `store.App`.
	InstalledApps map[string]string `json:"installed_apps,omitempty"`

	// LocalManifests is a list of locally-stored manifests. Local is in
	// contrast to the "global" list of manifests which in the initial version
	// is loaded from S3.
	//
	// For each installed app, an entry of string(AppID) -> sha1(Manifest) is
	// added, and the Manifest struct is stored in KV under
	// manifest_<sha1(Manifest)>. Implementation in `store.Manifest`.
	LocalManifests map[string]string `json:"local_manifests,omitempty"`

	DeveloperMode bool `json:"developer_mode"`
	AllowHTTPApps bool `json:"allow_http_apps"`

	LogChannelID    string `json:"log_channel_id,omitempty"`
	LogChannelLevel int    `json:"log_channel_level,omitempty"`
	LogChannelJSON  bool   `json:"log_channel_json,omitempty"`
}

StoredConfig represents the data stored in and managed with the Mattermost config.

StoredConfig should be abbreviated as sc.

type TestService

type TestService struct {
	// contains filtered or unexported fields
}

func NewTestConfigService

func NewTestConfigService(testConfig *Config) *TestService

func NewTestService

func NewTestService(testConfig *Config) (*TestService, *plugintest.API)

func (*TestService) Get

func (s *TestService) Get() Config

func (*TestService) I18N

func (s *TestService) I18N() *i18n.Bundle

func (*TestService) MattermostAPI

func (s *TestService) MattermostAPI() *pluginapi.Client

func (*TestService) MattermostConfig

func (s *TestService) MattermostConfig() configservice.ConfigService

func (*TestService) NewBaseLogger

func (s *TestService) NewBaseLogger() utils.Logger

func (*TestService) Reconfigure

func (s *TestService) Reconfigure(map[string]any, utils.Logger, ...Configurable) error

func (*TestService) StoreConfig

func (s *TestService) StoreConfig(sc StoredConfig, _ utils.Logger) error

func (*TestService) Telemetry

func (s *TestService) Telemetry() *telemetry.Telemetry

func (TestService) WithMattermostAPI

func (s TestService) WithMattermostAPI(mm *pluginapi.Client) *TestService

func (TestService) WithMattermostConfig

func (s TestService) WithMattermostConfig(mmconfig model.Config) *TestService