Skip to content

Commit

Permalink
tpl: Add temporary patch to fix template data race
Browse files Browse the repository at this point in the history
Keep this as a separate commit so we can reapply it if needed.

Fixes #7293
  • Loading branch information
bep committed Jan 29, 2021
1 parent abb3782 commit 8a6f6bd
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 8 deletions.
15 changes: 8 additions & 7 deletions tpl/internal/go_templates/texttemplate/exec.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ package template

import (
"fmt"
"github.com/gohugoio/hugo/tpl/internal/go_templates/fmtsort"
"github.com/gohugoio/hugo/tpl/internal/go_templates/texttemplate/parse"
"io"
"reflect"
"runtime"
"strings"

"github.com/gohugoio/hugo/tpl/internal/go_templates/fmtsort"
"github.com/gohugoio/hugo/tpl/internal/go_templates/texttemplate/parse"
)

// maxExecDepth specifies the maximum stack depth of templates within
Expand Down Expand Up @@ -179,10 +180,7 @@ func errRecover(errp *error) {
// A template may be executed safely in parallel, although if parallel
// executions share a Writer the output may be interleaved.
func (t *Template) ExecuteTemplate(wr io.Writer, name string, data interface{}) error {
var tmpl *Template
if t.common != nil {
tmpl = t.tmpl[name]
}
tmpl := t.Lookup(name)
if tmpl == nil {
return fmt.Errorf("template: no template %q associated with template %q", name, t.name)
}
Expand Down Expand Up @@ -230,6 +228,9 @@ func (t *Template) DefinedTemplates() string {
return ""
}
var b strings.Builder
// temporary Hugo-fix
t.muTmpl.RLock()
defer t.muTmpl.RUnlock()
for name, tmpl := range t.tmpl {
if tmpl.Tree == nil || tmpl.Root == nil {
continue
Expand Down Expand Up @@ -401,7 +402,7 @@ func (s *state) walkRange(dot reflect.Value, r *parse.RangeNode) {

func (s *state) walkTemplate(dot reflect.Value, t *parse.TemplateNode) {
s.at(t)
tmpl := s.tmpl.tmpl[t.Name]
tmpl := s.tmpl.Lookup(t.Name)
if tmpl == nil {
s.errorf("template %q not defined", t.Name)
}
Expand Down
16 changes: 15 additions & 1 deletion tpl/internal/go_templates/texttemplate/template.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@
package template

import (
"github.com/gohugoio/hugo/tpl/internal/go_templates/texttemplate/parse"
"reflect"
"sync"

"github.com/gohugoio/hugo/tpl/internal/go_templates/texttemplate/parse"
)

// common holds the information shared by related templates.
type common struct {
muTmpl sync.RWMutex // protects tmpl (temporary Hugo-fix)
tmpl map[string]*Template // Map from name to defined templates.
option option
// We use two maps, one for parsing and one for execution.
Expand Down Expand Up @@ -88,6 +90,9 @@ func (t *Template) Clone() (*Template, error) {
if t.common == nil {
return nt, nil
}
// temporary Hugo-fix
t.muTmpl.RLock()
defer t.muTmpl.RUnlock()
for k, v := range t.tmpl {
if k == t.name {
nt.tmpl[t.name] = nt
Expand Down Expand Up @@ -124,6 +129,9 @@ func (t *Template) copy(c *common) *Template {
// its definition. If it has been defined and already has that name, the existing
// definition is replaced; otherwise a new template is created, defined, and returned.
func (t *Template) AddParseTree(name string, tree *parse.Tree) (*Template, error) {
// temporary Hugo-fix
t.muTmpl.Lock()
defer t.muTmpl.Unlock()
t.init()
nt := t
if name != t.name {
Expand All @@ -142,6 +150,9 @@ func (t *Template) Templates() []*Template {
return nil
}
// Return a slice so we don't expose the map.
// temporary Hugo-fix
t.muTmpl.RLock()
defer t.muTmpl.RUnlock()
m := make([]*Template, 0, len(t.tmpl))
for _, v := range t.tmpl {
m = append(m, v)
Expand Down Expand Up @@ -182,6 +193,9 @@ func (t *Template) Lookup(name string) *Template {
if t.common == nil {
return nil
}
// temporary Hugo-fix
t.muTmpl.RLock()
defer t.muTmpl.RUnlock()
return t.tmpl[name]
}

Expand Down

0 comments on commit 8a6f6bd

Please sign in to comment.