waveterm/pkg/wconfig/settingsconfig.go

393 lines
12 KiB
Go
Raw Normal View History

// Copyright 2024, Command Line Inc.
// SPDX-License-Identifier: Apache-2.0
package wconfig
import (
2024-08-28 03:49:49 +02:00
"bytes"
"encoding/json"
"fmt"
"os"
"path/filepath"
2024-08-28 03:49:49 +02:00
"reflect"
"sort"
"strings"
2024-09-05 23:25:45 +02:00
"github.com/wavetermdev/waveterm/pkg/util/utilfn"
"github.com/wavetermdev/waveterm/pkg/waveobj"
"github.com/wavetermdev/waveterm/pkg/wconfig/defaultconfig"
)
2024-08-28 03:49:49 +02:00
const SettingsFile = "settings.json"
type MetaSettingsType struct {
waveobj.MetaMapType
}
func (m *MetaSettingsType) UnmarshalJSON(data []byte) error {
var metaMap waveobj.MetaMapType
decoder := json.NewDecoder(bytes.NewReader(data))
decoder.UseNumber()
if err := decoder.Decode(&metaMap); err != nil {
return err
}
*m = MetaSettingsType{MetaMapType: metaMap}
return nil
}
func (m MetaSettingsType) MarshalJSON() ([]byte, error) {
return json.Marshal(m.MetaMapType)
}
2024-08-28 03:49:49 +02:00
type SettingsType struct {
AiClear bool `json:"ai:*,omitempty"`
AiBaseURL string `json:"ai:baseurl,omitempty"`
AiApiToken string `json:"ai:apitoken,omitempty"`
AiName string `json:"ai:name,omitempty"`
AiModel string `json:"ai:model,omitempty"`
AiMaxTokens float64 `json:"ai:maxtokens,omitempty"`
AiTimeoutMs float64 `json:"ai:timeoutms,omitempty"`
TermClear bool `json:"term:*,omitempty"`
TermFontSize float64 `json:"term:fontsize,omitempty"`
TermFontFamily string `json:"term:fontfamily,omitempty"`
TermDisableWebGl bool `json:"term:disablewebgl,omitempty"`
2024-09-05 08:08:56 +02:00
EditorMinimapEnabled bool `json:"editor:minimapenabled,omitempty"`
EditorStickyScrollEnabled bool `json:"editor:stickyscrollenabled,omitempty"`
WebClear bool `json:"web:*,omitempty"`
WebOpenLinksInternally bool `json:"web:openlinksinternally,omitempty"`
WebDefaultUrl string `json:"web:defaulturl,omitempty"`
WebDefaultSearch string `json:"web:defaultsearch,omitempty"`
2024-08-28 03:49:49 +02:00
BlockHeaderClear bool `json:"blockheader:*,omitempty"`
BlockHeaderShowBlockIds bool `json:"blockheader:showblockids,omitempty"`
AutoUpdateClear bool `json:"autoupdate:*,omitempty"`
AutoUpdateEnabled bool `json:"autoupdate:enabled,omitempty"`
AutoUpdateIntervalMs float64 `json:"autoupdate:intervalms,omitempty"`
AutoUpdateInstallOnQuit bool `json:"autoupdate:installonquit,omitempty"`
Add release channels (#385) ## New release flow 1. Run "Bump Version" workflow with the desired version bump and the prerelease flag set to `true`. This will push a new version bump to the target branch and create a new git tag. - See below for more info on how the version bumping works. 2. A new "Build Helper" workflow run will kick off automatically for the new tag. Once it is complete, test the new build locally by downloading with the [download script](https://github.com/wavetermdev/thenextwave/blob/main/scripts/artifacts/download-staged-artifact.sh). 3. Release the new build using the [publish script](https://github.com/wavetermdev/thenextwave/blob/main/scripts/artifacts/publish-from-staging.sh). This will trigger electron-updater to distribute the package to beta users. 4. Run "Bump Version" again with a release bump (either `major`, `minor`, or `patch`) and the prerelease flag set to `false`. 6. Release the new build to all channels using the [publish script](https://github.com/wavetermdev/thenextwave/blob/main/scripts/artifacts/publish-from-staging.sh). This will trigger electron-updater to distribute the package to all users. ## Change Summary Creates a new "Bump Version" workflow to manage versioning and tag creation. Build Helper is now automated. ### Version bumps Updates the `version.cjs` script so that an argument can be passed to trigger a version bump. Under the hood, this utilizes NPM's `semver` package. If arguments are present, the version will be bumped. If only a single argument is given, the following are valid inputs: - `none`: No-op. - `patch`: Bumps the patch version. - `minor`: Bumps the minor version. - `major`: Bumps the major version. - '1', 'true': Bumps the prerelease version. If two arguments are given, the first argument must be either `none`, `patch`, `minor`, or `major`. The second argument must be `1` or `true` to bump the prerelease version. ### electron-builder We are now using the release channels support in electron-builder. This will automatically detect the channel being built based on the package version to determine which channel update files need to be generated. See [here](https://www.electron.build/tutorials/release-using-channels.html) for more information. ### Github Actions #### Bump Version This adds a new "Bump Version" workflow for managing versioning and queuing new builds. When run, this workflow will bump the version, create a new tag, and push the changes to the target branch. There is a new dropdown when queuing the "Bump Version" workflow to select what kind of version bump to perform. A bump must always be performed when running a new build to ensure consistency. I had to create a GitHub App to grant write permissions to our main branch for the version bump commits. I've made a separate workflow file to manage the version bump commits, which should help prevent tampering. Thanks to using the GitHub API directly, I am able to make these commits signed! #### Build Helper Build Helper is now triggered when new tags are created, rather than being triggered automatically. This ensures we're always creating artifacts from known checkpoints. ### Settings Adds a new `autoupdate:channel` configuration to the settings file. If unset, the default from the artifact will be used (should correspond to the channel of the artifact when downloaded). ## Future Work I want to add a release workflow that will automatically copy over the corresponding version artifacts to the release bucket when a new GitHub Release is created. I also want to separate versions into separate subdirectories in the release bucket so we can clean them up more-easily. --------- Co-authored-by: wave-builder <builds@commandline.dev> Co-authored-by: wave-builder[bot] <181805596+wave-builder[bot]@users.noreply.github.com>
2024-09-17 22:10:35 +02:00
AutoUpdateChannel string `json:"autoupdate:channel,omitempty"`
2024-08-28 03:49:49 +02:00
WidgetClear bool `json:"widget:*,omitempty"`
WidgetShowHelp bool `json:"widget:showhelp,omitempty"`
WindowClear bool `json:"window:*,omitempty"`
WindowTransparent bool `json:"window:transparent,omitempty"`
WindowBlur bool `json:"window:blur,omitempty"`
WindowOpacity *float64 `json:"window:opacity,omitempty"`
WindowBgColor string `json:"window:bgcolor,omitempty"`
WindowReducedMotion bool `json:"window:reducedmotion,omitempty"`
WindowTileGapSize *int64 `json:"window:tilegapsize,omitempty"`
2024-08-28 03:49:49 +02:00
TelemetryClear bool `json:"telemetry:*,omitempty"`
TelemetryEnabled bool `json:"telemetry:enabled,omitempty"`
}
2024-08-28 03:49:49 +02:00
type ConfigError struct {
File string `json:"file"`
Err string `json:"err"`
}
2024-08-28 03:49:49 +02:00
type FullConfigType struct {
Settings SettingsType `json:"settings" merge:"meta"`
MimeTypes map[string]MimeTypeConfigType `json:"mimetypes"`
DefaultWidgets map[string]WidgetConfigType `json:"defaultwidgets"`
Widgets map[string]WidgetConfigType `json:"widgets"`
Presets map[string]waveobj.MetaMapType `json:"presets"`
TermThemes map[string]TermThemeType `json:"termthemes"`
ConfigErrors []ConfigError `json:"configerrors" configfile:"-"`
}
2024-08-28 03:49:49 +02:00
func readConfigHelper(fileName string, barr []byte, readErr error) (waveobj.MetaMapType, []ConfigError) {
var cerrs []ConfigError
if readErr != nil && !os.IsNotExist(readErr) {
cerrs = append(cerrs, ConfigError{File: "defaults:" + fileName, Err: readErr.Error()})
}
if len(barr) == 0 {
return nil, cerrs
}
var rtn waveobj.MetaMapType
err := json.Unmarshal(barr, &rtn)
if err != nil {
cerrs = append(cerrs, ConfigError{File: "defaults:" + fileName, Err: err.Error()})
}
return rtn, cerrs
}
2024-08-28 03:49:49 +02:00
func ReadDefaultsConfigFile(fileName string) (waveobj.MetaMapType, []ConfigError) {
barr, readErr := defaultconfig.ConfigFS.ReadFile(fileName)
return readConfigHelper("defaults:"+fileName, barr, readErr)
}
2024-08-28 03:49:49 +02:00
func ReadWaveHomeConfigFile(fileName string) (waveobj.MetaMapType, []ConfigError) {
fullFileName := filepath.Join(configDirAbsPath, fileName)
barr, err := os.ReadFile(fullFileName)
return readConfigHelper(fullFileName, barr, err)
}
2024-08-28 03:49:49 +02:00
func WriteWaveHomeConfigFile(fileName string, m waveobj.MetaMapType) error {
fullFileName := filepath.Join(configDirAbsPath, fileName)
barr, err := jsonMarshalConfigInOrder(m)
if err != nil {
return err
}
return os.WriteFile(fullFileName, barr, 0644)
}
2024-08-28 03:49:49 +02:00
// simple merge that overwrites
func mergeMetaMapSimple(m waveobj.MetaMapType, toMerge waveobj.MetaMapType) waveobj.MetaMapType {
if m == nil {
return toMerge
}
if toMerge == nil {
return m
}
for k, v := range toMerge {
if v == nil {
delete(m, k)
continue
}
m[k] = v
}
if len(m) == 0 {
return nil
}
return m
2024-07-31 08:22:41 +02:00
}
2024-08-28 03:49:49 +02:00
func ReadConfigPart(partName string, simpleMerge bool) (waveobj.MetaMapType, []ConfigError) {
defConfig, cerrs1 := ReadDefaultsConfigFile(partName)
userConfig, cerrs2 := ReadWaveHomeConfigFile(partName)
allErrs := append(cerrs1, cerrs2...)
if simpleMerge {
return mergeMetaMapSimple(defConfig, userConfig), allErrs
} else {
return waveobj.MergeMeta(defConfig, userConfig, true), allErrs
}
2024-07-31 08:22:41 +02:00
}
2024-08-28 03:49:49 +02:00
func ReadFullConfig() FullConfigType {
var fullConfig FullConfigType
configRType := reflect.TypeOf(fullConfig)
configRVal := reflect.ValueOf(&fullConfig).Elem()
for fieldIdx := 0; fieldIdx < configRType.NumField(); fieldIdx++ {
field := configRType.Field(fieldIdx)
if field.PkgPath != "" {
continue
}
configFile := field.Tag.Get("configfile")
if configFile == "-" {
continue
}
2024-08-28 07:02:21 +02:00
jsonTag := utilfn.GetJsonTag(field)
2024-08-28 03:49:49 +02:00
if jsonTag == "-" || jsonTag == "" {
continue
}
simpleMerge := field.Tag.Get("merge") == ""
2024-08-28 07:02:21 +02:00
fileName := jsonTag + ".json"
2024-08-28 03:49:49 +02:00
configPart, cerrs := ReadConfigPart(fileName, simpleMerge)
fullConfig.ConfigErrors = append(fullConfig.ConfigErrors, cerrs...)
if configPart != nil {
fieldPtr := configRVal.Field(fieldIdx).Addr().Interface()
utilfn.ReUnmarshal(fieldPtr, configPart)
}
}
return fullConfig
2024-07-31 08:22:41 +02:00
}
2024-08-28 03:49:49 +02:00
func getConfigKeyType(configKey string) reflect.Type {
ctype := reflect.TypeOf(SettingsType{})
for i := 0; i < ctype.NumField(); i++ {
field := ctype.Field(i)
2024-08-28 07:02:21 +02:00
jsonTag := utilfn.GetJsonTag(field)
if jsonTag == configKey {
2024-08-28 03:49:49 +02:00
return field.Type
}
}
return nil
2024-07-31 08:22:41 +02:00
}
2024-08-28 03:49:49 +02:00
func getConfigKeyNamespace(key string) string {
colonIdx := strings.Index(key, ":")
if colonIdx == -1 {
return ""
}
return key[:colonIdx]
2024-07-31 08:22:41 +02:00
}
2024-08-28 03:49:49 +02:00
func orderConfigKeys(m waveobj.MetaMapType) []string {
keys := make([]string, 0, len(m))
for k := range m {
keys = append(keys, k)
}
2024-08-28 03:49:49 +02:00
sort.Slice(keys, func(i, j int) bool {
k1 := keys[i]
k2 := keys[j]
k1ns := getConfigKeyNamespace(k1)
k2ns := getConfigKeyNamespace(k2)
if k1ns != k2ns {
return k1ns < k2ns
}
2024-08-28 03:49:49 +02:00
return k1 < k2
})
return keys
}
func reindentJson(barr []byte, indentStr string) []byte {
if len(barr) < 2 {
return barr
}
2024-08-28 03:49:49 +02:00
if barr[0] != '{' && barr[0] != '[' {
return barr
}
if bytes.Contains(barr, []byte("\n")) {
2024-08-28 03:49:49 +02:00
return barr
}
2024-08-28 03:49:49 +02:00
outputLines := bytes.Split(barr, []byte("\n"))
for i, line := range outputLines {
if i == 0 || i == len(outputLines)-1 {
continue
}
outputLines[i] = append([]byte(indentStr), line...)
}
2024-08-28 03:49:49 +02:00
return bytes.Join(outputLines, []byte("\n"))
}
func jsonMarshalConfigInOrder(m waveobj.MetaMapType) ([]byte, error) {
if len(m) == 0 {
return []byte("{}"), nil
2024-07-31 08:22:41 +02:00
}
2024-08-28 03:49:49 +02:00
var buf bytes.Buffer
orderedKeys := orderConfigKeys(m)
buf.WriteString("{\n")
for idx, key := range orderedKeys {
val := m[key]
keyBarr, err := json.Marshal(key)
if err != nil {
return nil, err
}
valBarr, err := json.MarshalIndent(val, "", " ")
if err != nil {
return nil, err
}
valBarr = reindentJson(valBarr, " ")
buf.WriteString(" ")
buf.Write(keyBarr)
buf.WriteString(": ")
buf.Write(valBarr)
if idx < len(orderedKeys)-1 {
buf.WriteString(",")
}
buf.WriteString("\n")
2024-07-31 08:22:41 +02:00
}
2024-08-28 03:49:49 +02:00
buf.WriteString("}")
return buf.Bytes(), nil
}
var dummyNumber json.Number
func convertJsonNumber(num json.Number, ctype reflect.Type) (interface{}, error) {
// ctype might be int64, float64, string, *int64, *float64, *string
// switch on ctype first
if ctype.Kind() == reflect.Pointer {
ctype = ctype.Elem()
}
if reflect.Int64 == ctype.Kind() {
if ival, err := num.Int64(); err == nil {
return ival, nil
}
return nil, fmt.Errorf("invalid number for int64: %s", num)
}
if reflect.Float64 == ctype.Kind() {
if fval, err := num.Float64(); err == nil {
return fval, nil
}
return nil, fmt.Errorf("invalid number for float64: %s", num)
}
if reflect.String == ctype.Kind() {
return num.String(), nil
}
return nil, fmt.Errorf("cannot convert number to %s", ctype)
}
2024-08-28 07:02:21 +02:00
func SetBaseConfigValue(toMerge waveobj.MetaMapType) error {
2024-08-28 03:49:49 +02:00
m, cerrs := ReadWaveHomeConfigFile(SettingsFile)
if len(cerrs) > 0 {
return fmt.Errorf("error reading config file: %v", cerrs[0])
2024-07-31 08:22:41 +02:00
}
2024-08-28 03:49:49 +02:00
if m == nil {
m = make(waveobj.MetaMapType)
2024-07-31 08:22:41 +02:00
}
2024-08-28 07:02:21 +02:00
for configKey, val := range toMerge {
ctype := getConfigKeyType(configKey)
if ctype == nil {
return fmt.Errorf("invalid config key: %s", configKey)
}
if val == nil {
delete(m, configKey)
} else {
rtype := reflect.TypeOf(val)
if rtype == reflect.TypeOf(dummyNumber) {
convertedVal, err := convertJsonNumber(val.(json.Number), ctype)
if err != nil {
return fmt.Errorf("cannot convert %s: %v", configKey, err)
}
val = convertedVal
rtype = reflect.TypeOf(val)
}
if rtype != ctype {
if ctype == reflect.PointerTo(rtype) {
m[configKey] = &val
} else {
return fmt.Errorf("invalid value type for %s: %T", configKey, val)
}
2024-08-28 07:02:21 +02:00
}
m[configKey] = val
2024-08-28 03:49:49 +02:00
}
2024-07-31 08:22:41 +02:00
}
2024-08-28 03:49:49 +02:00
return WriteWaveHomeConfigFile(SettingsFile, m)
}
type WidgetConfigType struct {
DisplayOrder float64 `json:"display:order,omitempty"`
Icon string `json:"icon,omitempty"`
Color string `json:"color,omitempty"`
Label string `json:"label,omitempty"`
Description string `json:"description,omitempty"`
BlockDef waveobj.BlockDef `json:"blockdef"`
}
type MimeTypeConfigType struct {
Icon string `json:"icon"`
Color string `json:"color"`
}
type TermThemeType struct {
DisplayName string `json:"display:name"`
DisplayOrder float64 `json:"display:order"`
Black string `json:"black"`
Red string `json:"red"`
Green string `json:"green"`
Yellow string `json:"yellow"`
Blue string `json:"blue"`
Magenta string `json:"magenta"`
Cyan string `json:"cyan"`
White string `json:"white"`
BrightBlack string `json:"brightBlack"`
BrightRed string `json:"brightRed"`
BrightGreen string `json:"brightGreen"`
BrightYellow string `json:"brightYellow"`
BrightBlue string `json:"brightBlue"`
BrightMagenta string `json:"brightMagenta"`
BrightCyan string `json:"brightCyan"`
BrightWhite string `json:"brightWhite"`
Gray string `json:"gray"`
CmdText string `json:"cmdtext"`
Foreground string `json:"foreground"`
SelectionBackground string `json:"selectionBackground"`
Background string `json:"background"`
CursorAccent string `json:"cursorAccent"`
}