mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Carly de FrondevilleandGitHub
68fe1f306a
## What changed? This change adds a flag to `temporal-sql-tool` and `temporal-cassandra-tool`'s `update-schema` and `setup-schema` to specify an embedded schema instead of a path to the schema directory or schema file. ``` NAME: temporal-cassandra-tool update-schema - update cassandra schema to a specific version USAGE: temporal-cassandra-tool update-schema [command options] [arguments...] OPTIONS: --version value, -v value target version for the schema update, defaults to latest --schema-dir value, -d value path to directory containing versioned schema --schema-name value, -s value name of embedded versioned schema, one of: [cassandra/temporal cassandra/visibility] ``` ``` NAME: temporal-sql-tool update-schema - update sql schema to a specific version USAGE: temporal-sql-tool update-schema [command options] [arguments...] OPTIONS: --version value, -v value target version for the schema update, defaults to latest --schema-dir value, -d value path to directory containing versioned schema --schema-name value, -s value name of embedded versioned schema, one of: [mysql/v57/temporal mysql/v57/visibility mysql/v8/temporal mysql/v8/visibility postgresql/v96/temporal postgresql/v96/visibility postgresql/v12/temporal postgresql/v12/visibility] ``` ## Why? We want to embed the db schemas in the `temporal-sql-tool` and `temporal-cassandra-tool` with `go:embed` so that customers can simply specify which schema they want using a flag instead of having to copy the schema files to wherever they're running the db tool and passing the path to the schema. https://github.com/temporalio/temporal/issues/2059 ## How did you test it? I wrote a new unit test for reading the embedded file system, and the existing codepath of the changed functions are all tested by the existing unit tests. I also updated the unit test for config validation to reflect the new changes. I tested this locally with a locally running Postgres. Since the more complex changes are in `updatetask.go`, which is shared by the sql and the cassandra tool, I think there is no need to also test with a real cassandra db. I also built the cassandra command line tool and confirmed that the flags and validation checks behaved as expected. ## Potential risks Schema updates could fail. But the changes are pretty contained to the new `-s` flag which isn't used anywhere in production yet, so the risk is very low. The code for the `-d` flag remained basically the same. ## Is hotfix candidate? No
73 lines
2.3 KiB
Go
73 lines
2.3 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
package schema
|
|
|
|
import (
|
|
"embed"
|
|
"io/fs"
|
|
"path/filepath"
|
|
|
|
"go.temporal.io/server/common/log"
|
|
"go.temporal.io/server/common/log/tag"
|
|
)
|
|
|
|
//go:embed *
|
|
var assets embed.FS
|
|
|
|
// Assets returns a file system with the contents of the schema directory
|
|
func Assets() fs.FS {
|
|
return assets
|
|
}
|
|
|
|
// PathsByDir returns a list of paths to directories within the schema subdirectory that have versioned schemas in them
|
|
func PathsByDir(dbSubDir string) []string {
|
|
logger := log.NewCLILogger()
|
|
efs := Assets()
|
|
dirs := make([]string, 0)
|
|
err := fs.WalkDir(efs, dbSubDir, func(path string, d fs.DirEntry, err error) error {
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if d.IsDir() {
|
|
if d.Name() == "versioned" {
|
|
dirs = append(dirs, filepath.Dir(path))
|
|
return fs.SkipDir
|
|
}
|
|
}
|
|
return nil
|
|
})
|
|
if err != nil {
|
|
logger.Error("error walking embedded schema file system tree, could not generate valid paths", tag.Error(err))
|
|
}
|
|
return dirs
|
|
}
|
|
|
|
func PathsByDB(dbName string) []string {
|
|
if dbName == "sql" {
|
|
return append(PathsByDir("mysql"), PathsByDir("postgresql")...)
|
|
}
|
|
return PathsByDir(dbName)
|
|
}
|