Adding initial retry layer version (#14954)

* Adding initial retry layer version

* Some simplification around the generated code

* Generating retry layer again

* Improving naming generation in store generated layers

* Address PR review comments

* Updating store layers

* Addressing PR review comments

* fixing lint errors

* Updating store layers

* Adding license header

* Applying the retry layer to the reaction_store

* Regenerating retry layer
Этот коммит содержится в:
Jesús Espino
2020-08-12 20:05:16 +02:00
коммит произвёл GitHub
родитель c89c56ab2e
Коммит 1b141678fe
12 изменённых файлов: 9780 добавлений и 3549 удалений

Просмотреть файл

@@ -28,6 +28,10 @@ func isError(typeName string) bool {
return strings.Contains(typeName, APP_ERROR_TYPE) || strings.Contains(typeName, ERROR_TYPE)
}
func isAppError(typeName string) bool {
return strings.Contains(typeName, APP_ERROR_TYPE)
}
func main() {
if err := buildTimerLayer(); err != nil {
log.Fatal(err)
@@ -35,6 +39,22 @@ func main() {
if err := buildOpenTracingLayer(); err != nil {
log.Fatal(err)
}
if err := buildRetryLayer(); err != nil {
log.Fatal(err)
}
}
func buildRetryLayer() error {
code, err := generateLayer("RetryLayer", "retry_layer.go.tmpl")
if err != nil {
return err
}
formatedCode, err := format.Source(code)
if err != nil {
return err
}
return ioutil.WriteFile(path.Join("retrylayer/retrylayer.go"), formatedCode, 0644)
}
func buildTimerLayer() error {
@@ -213,19 +233,33 @@ func generateLayer(name, templateFile string) ([]byte, error) {
},
"genResultsVars": func(results []string) string {
vars := []string{}
for i := range results {
vars = append(vars, fmt.Sprintf("resultVar%d", i))
for i, typeName := range results {
if isError(typeName) {
vars = append(vars, "err")
} else if i == 0 {
vars = append(vars, "result")
} else {
vars = append(vars, fmt.Sprintf("resultVar%d", i))
}
}
return strings.Join(vars, ", ")
},
"errorToBoolean": func(results []string) string {
for i, typeName := range results {
for _, typeName := range results {
if isError(typeName) {
return fmt.Sprintf("resultVar%d == nil", i)
return fmt.Sprintf("err == nil")
}
}
return "true"
},
"isAppError": func(results []string) bool {
for _, typeName := range results {
if isAppError(typeName) {
return true
}
}
return false
},
"errorPresent": func(results []string) bool {
for _, typeName := range results {
if isError(typeName) {
@@ -235,9 +269,9 @@ func generateLayer(name, templateFile string) ([]byte, error) {
return false
},
"errorVar": func(results []string) string {
for i, typeName := range results {
for _, typeName := range results {
if isError(typeName) {
return fmt.Sprintf("resultVar%d", i)
return "err"
}
}
return ""
@@ -262,6 +296,19 @@ func generateLayer(name, templateFile string) ([]byte, error) {
}
return strings.Join(paramsWithType, ", ")
},
"joinParamsWithTypeOutsideStore": func(params []methodParam) string {
paramsWithType := []string{}
for _, param := range params {
if param.Type == "ChannelSearchOpts" || param.Type == "UserGetByIdsOpts" {
paramsWithType = append(paramsWithType, fmt.Sprintf("%s store.%s", param.Name, param.Type))
} else if param.Type == "*UserGetByIdsOpts" {
paramsWithType = append(paramsWithType, fmt.Sprintf("%s *store.UserGetByIdsOpts", param.Name))
} else {
paramsWithType = append(paramsWithType, fmt.Sprintf("%s %s", param.Name, param.Type))
}
}
return strings.Join(paramsWithType, ", ")
},
}
t := template.Must(template.New(templateFile).Funcs(myFuncs).ParseFiles("layer_generators/" + templateFile))

104
store/layer_generators/retry_layer.go.tmpl Обычный файл
Просмотреть файл

@@ -0,0 +1,104 @@
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
// Code generated by "make store-layers"
// DO NOT EDIT
package retrylayer
import (
"context"
"github.com/lib/pq"
"github.com/mattermost/mattermost-server/v5/model"
"github.com/mattermost/mattermost-server/v5/store"
"github.com/pkg/errors"
"github.com/go-sql-driver/mysql"
)
const mySQLDeadlockCode = uint16(1213)
type {{.Name}} struct {
store.Store
{{range $index, $element := .SubStores}} {{$index}}Store store.{{$index}}Store
{{end}}
}
{{range $index, $element := .SubStores}}func (s *{{$.Name}}) {{$index}}() store.{{$index}}Store {
return s.{{$index}}Store
}
{{end}}
{{range $index, $element := .SubStores}}type {{$.Name}}{{$index}}Store struct {
store.{{$index}}Store
Root *{{$.Name}}
}
{{end}}
func isRepeatableError(err error) bool {
var pqErr *pq.Error
var mysqlErr *mysql.MySQLError
switch {
case errors.As(errors.Cause(err), &pqErr):
if pqErr.Code == "40001" || pqErr.Code == "40P01" {
return true
}
case errors.As(errors.Cause(err), &mysqlErr):
if mysqlErr.Number == mySQLDeadlockCode {
return true
}
}
return false
}
{{range $substoreName, $substore := .SubStores}}
{{range $index, $element := $substore.Methods}}
func (s *{{$.Name}}{{$substoreName}}Store) {{$index}}({{$element.Params | joinParamsWithTypeOutsideStore}}) {{$element.Results | joinResultsForSignature}} {
{{if $element.Results | len | eq 0}}
s.{{$substoreName}}Store.{{$index}}({{$element.Params | joinParams}})
{{else}}
{{if $element.Results | errorPresent}}
{{if $element.Results | isAppError}}
return s.{{$substoreName}}Store.{{$index}}({{$element.Params | joinParams}})
{{else}}
tries := 0
for {
{{$element.Results | genResultsVars}} := s.{{$substoreName}}Store.{{$index}}({{$element.Params | joinParams}})
if {{$element.Results | errorVar}} == nil {
return {{$element.Results | genResultsVars}}
}
if !isRepeatableError({{$element.Results | errorVar}}) {
return {{$element.Results | genResultsVars}}
}
tries++
if tries >= 3 {
{{$element.Results | errorVar}} = errors.Wrap({{$element.Results | errorVar}}, "giving up after 3 consecutive repeatable transaction failures")
return {{$element.Results | genResultsVars}}
}
}
{{end}}
{{else}}
return s.{{$substoreName}}Store.{{$index}}({{$element.Params | joinParams}})
{{end}}
{{end}}
}
{{end}}
{{end}}
{{range $index, $element := .Methods}}
func (s *{{$.Name}}) {{$index}}({{$element.Params | joinParamsWithTypeOutsideStore}}) {{$element.Results | joinResultsForSignature}} {
{{if $element.Results | len | eq 0}}s.Store.{{$index}}({{$element.Params | joinParams}})
{{else}}return s.Store.{{$index}}({{$element.Params | joinParams}})
{{end}}}
{{end}}
func New(childStore store.Store) *{{.Name}} {
newStore := {{.Name}}{
Store: childStore,
}
{{range $substoreName, $substore := .SubStores}}
newStore.{{$substoreName}}Store = &{{$.Name}}{{$substoreName}}Store{{"{"}}{{$substoreName}}Store: childStore.{{$substoreName}}(), Root: &newStore}{{end}}
return &newStore
}