Skip to content

Commit

Permalink
Handle transient errors in config loading etc.
Browse files Browse the repository at this point in the history
As in: Get the Kubernetes site to build with the new Hugo version.

Updates #10947
  • Loading branch information
bep committed May 17, 2023
1 parent 5251f01 commit 0554213
Show file tree
Hide file tree
Showing 7 changed files with 96 additions and 5 deletions.
20 changes: 19 additions & 1 deletion config/allconfig/allconfig.go
Expand Up @@ -182,6 +182,7 @@ func (c Config) cloneForLang() *Config {
}

func (c *Config) CompileConfig() error {
var transientErr error
s := c.Timeout
if _, err := strconv.Atoi(s); err == nil {
// A number, assume seconds.
Expand Down Expand Up @@ -209,7 +210,8 @@ func (c *Config) CompileConfig() error {
}
f, found := outputFormats.GetByName(format)
if !found {
return fmt.Errorf("unknown output format %q for kind %q", format, kind)
transientErr = fmt.Errorf("unknown output format %q for kind %q", format, kind)
continue
}
kindOutputFormats[kind] = append(kindOutputFormats[kind], f)
}
Expand Down Expand Up @@ -288,6 +290,7 @@ func (c *Config) CompileConfig() error {
IgnoreFile: ignoreFile,
MainSections: c.MainSections,
Clock: clock,
transientErr: transientErr,
}

for _, s := range allDecoderSetups {
Expand Down Expand Up @@ -323,6 +326,11 @@ type ConfigCompiled struct {
IgnoreFile func(filename string) bool
MainSections []string
Clock time.Time

// This is set to the last transient error found during config compilation.
// With themes/modules we compule the configuration in multiple passes, and
// errors with missing output format definitions may resolve itself.
transientErr error
}

// This may be set after the config is compiled.
Expand Down Expand Up @@ -565,6 +573,16 @@ type Configs struct {
configLangs []config.AllProvider
}

// transientErr returns the last transient error found during config compilation.
func (c *Configs) transientErr() error {
for _, l := range c.LanguageConfigSlice {
if l.C.transientErr != nil {
return l.C.transientErr
}
}
return nil
}

func (c *Configs) IsZero() bool {
// A config always has at least one language.
return c == nil || len(c.Languages) == 0
Expand Down
8 changes: 7 additions & 1 deletion config/allconfig/load.go
Expand Up @@ -63,13 +63,19 @@ func LoadConfig(d ConfigSourceDescriptor) (*Configs, error) {
if err != nil {
return nil, fmt.Errorf("failed to load modules: %w", err)
}

if len(l.ModulesConfigFiles) > 0 {
// Config merged in from modules.
// Re-read the config.
configs, err = FromLoadConfigResult(d.Fs, res)
if err != nil {
return nil, fmt.Errorf("failed to create config: %w", err)
return nil, fmt.Errorf("failed to create config from modules config: %w", err)
}
if err := configs.transientErr(); err != nil {
return nil, fmt.Errorf("failed to create config from modules config: %w", err)
}
} else if err := configs.transientErr(); err != nil {
return nil, fmt.Errorf("failed to create config: %w", err)
}

configs.Modules = moduleConfig.ActiveModules
Expand Down
38 changes: 37 additions & 1 deletion hugolib/config_test.go
Expand Up @@ -742,6 +742,42 @@ themeconfigdirparam: {{ site.Params.themeconfigdirparam }}

}

func TestConfigOutputFormatDefinedInTheme(t *testing.T) {
t.Parallel()

files := `
-- hugo.toml --
theme = "mytheme"
[outputFormats]
[outputFormats.myotherformat]
baseName = 'myotherindex'
mediaType = 'text/html'
[outputs]
home = ['myformat']
-- themes/mytheme/hugo.toml --
[outputFormats]
[outputFormats.myformat]
baseName = 'myindex'
mediaType = 'text/html'
-- layouts/index.html --
Home.
`

b, err := NewIntegrationTestBuilder(
IntegrationTestConfig{
T: t,
TxtarString: files,
},
).BuildE()

b.Assert(err, qt.IsNil)
b.AssertFileContent("public/myindex.html", "Home.")

}

func TestReproCommentsIn10947(t *testing.T) {
t.Parallel()

Expand All @@ -768,7 +804,7 @@ title: "My Swedish Section"
---
-- layouts/index.html --
{{ range $i, $e := (slice site .Site) }}
{{ $i }}|AllPages: {{ len .AllPages }}|Sections: {{ if .Sections }}true{{ end }}| Author: {{ .Authors }}|BuildDrafts: {{ .BuildDrafts }}|IsMultiLingual: {{ .IsMultiLingual }}|Param: {{ .Language.Params.myparam }}|
{{ $i }}|AllPages: {{ len .AllPages }}|Sections: {{ if .Sections }}true{{ end }}| Author: {{ .Authors }}|BuildDrafts: {{ .BuildDrafts }}|IsMultiLingual: {{ .IsMultiLingual }}|Param: {{ .Language.Params.myparam }}|Language string: {{ .Language }}|Languages: {{ .Languages }}
{{ end }}
Expand Down
4 changes: 4 additions & 0 deletions hugolib/site.go
Expand Up @@ -273,6 +273,10 @@ func (s *Site) Language() *langs.Language {
return s.language
}

func (s *Site) Languages() langs.Languages {
return s.h.Configs.Languages
}

func (s *Site) isEnabled(kind string) bool {
if kind == kindUnknown {
panic("Unknown kind")
Expand Down
2 changes: 1 addition & 1 deletion hugolib/site_new.go
Expand Up @@ -431,7 +431,7 @@ func (s *Site) GoogleAnalytics() string {
return s.Config().Services.GoogleAnalytics.ID
}

func (s *Site) Param(key string) (any, error) {
func (s *Site) Param(key any) (any, error) {
return resource.Param(s, nil, key)
}

Expand Down
7 changes: 6 additions & 1 deletion langs/language.go
Expand Up @@ -87,7 +87,8 @@ var DeprecationFunc = func(item, alternative string, err bool) {}

const paramsDeprecationWarning = `.Language.Params is deprecated and will be removed in a future release. Use site.Params instead.
Also, for all but custom parameters, you need to use the built in Hugo variables, e.g. site.Title, site.LanguageCode; site.Language.Params.Title will not work.
- For all but custom parameters, you need to use the built in Hugo variables, e.g. site.Title, site.LanguageCode; site.Language.Params.Title will not work.
- All custom parameters needs to be placed below params, e.g. [languages.en.params] in TOML.
See https://gohugo.io/content-management/multilingual/#changes-in-hugo-01120
Expand All @@ -111,6 +112,10 @@ func (l *Language) loadLocation(tzStr string) error {
return nil
}

func (l *Language) String() string {
return l.Lang
}

// Languages is a sortable list of languages.
type Languages []*Language

Expand Down
22 changes: 22 additions & 0 deletions resources/page/site.go
Expand Up @@ -35,6 +35,9 @@ type Site interface {
// Returns the Language configured for this Site.
Language() *langs.Language

// Returns all the languages configured for all sites.
Languages() langs.Languages

GetPage(ref ...string) (Page, error)

// AllPages returns all pages for all languages.
Expand Down Expand Up @@ -94,6 +97,9 @@ type Site interface {
// Returns the Params configured for this site.
Params() maps.Params

// Param is a convenience method to do lookups in Params.
Param(key any) (any, error)

// Returns a map of all the data inside /data.
Data() map[string]any

Expand Down Expand Up @@ -174,6 +180,10 @@ func (s *siteWrapper) Language() *langs.Language {
return s.s.Language()
}

func (s *siteWrapper) Languages() langs.Languages {
return s.s.Languages()
}

func (s *siteWrapper) AllPages() Pages {
return s.s.AllPages()
}
Expand Down Expand Up @@ -254,6 +264,10 @@ func (s *siteWrapper) Params() maps.Params {
return s.s.Params()
}

func (s *siteWrapper) Param(key any) (any, error) {
return s.s.Param(key)
}

func (s *siteWrapper) Data() map[string]any {
return s.s.Data()
}
Expand Down Expand Up @@ -334,6 +348,10 @@ func (t testSite) Current() Site {
return t
}

func (t testSite) Languages() langs.Languages {
return nil
}

func (t testSite) GoogleAnalytics() string {
return ""
}
Expand Down Expand Up @@ -410,6 +428,10 @@ func (s testSite) IsMultiLingual() bool {
return false
}

func (s testSite) Param(key any) (any, error) {
return nil, nil
}

// NewDummyHugoSite creates a new minimal test site.
func NewDummyHugoSite(cfg config.Provider) Site {
return testSite{
Expand Down

0 comments on commit 0554213

Please sign in to comment.