go.temporal.io/server@v1.23.0/common/persistence/schema/version.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package schema
    26  
    27  import (
    28  	"fmt"
    29  
    30  	"github.com/blang/semver/v4"
    31  )
    32  
    33  // VerifyCompatibleVersion ensures that the installed version is greater than or equal to the expected version.
    34  func VerifyCompatibleVersion(
    35  	versionReader VersionReader,
    36  	dbName string,
    37  	expectedVersion string,
    38  ) error {
    39  
    40  	version, err := versionReader.ReadSchemaVersion(dbName)
    41  	if err != nil {
    42  		return fmt.Errorf("unable to read DB schema version keyspace/database: %s error: %v", dbName, err.Error())
    43  	}
    44  	// In most cases, the versions should match. However if after a schema upgrade there is a code
    45  	// rollback, the code version (expected version) would fall lower than the actual version in
    46  	// Cassandra. This check to allow such rollbacks since we only make backwards compatible schema changes.
    47  	versionParsed, _ := semver.ParseTolerant(version)
    48  	expectedVersionParsed, _ := semver.ParseTolerant(expectedVersion)
    49  
    50  	if versionParsed.LT(expectedVersionParsed) {
    51  		return fmt.Errorf("version mismatch for keyspace/database: %q. Expected version: %s cannot be greater than Actual version: %s", dbName, expectedVersion, version)
    52  	}
    53  	return nil
    54  }