diff options
Diffstat (limited to 'hugofs/stacktracer_fs.go')
-rw-r--r-- | hugofs/stacktracer_fs.go | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/hugofs/stacktracer_fs.go b/hugofs/stacktracer_fs.go new file mode 100644 index 000000000..d4db164ca --- /dev/null +++ b/hugofs/stacktracer_fs.go @@ -0,0 +1,70 @@ +// Copyright 2019 The Hugo Authors. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package hugofs + +import ( + "fmt" + "os" + "regexp" + "runtime" + + "github.com/gohugoio/hugo/common/types" + + "github.com/spf13/afero" +) + +// Make sure we don't accidently use this in the real Hugo. +var _ types.DevMarker = (*stacktracerFs)(nil) + +// NewStacktracerFs wraps the given fs printing stack traces for file creates +// matching the given regexp pattern. +func NewStacktracerFs(fs afero.Fs, pattern string) afero.Fs { + return &stacktracerFs{Fs: fs, re: regexp.MustCompile(pattern)} +} + +// stacktracerFs can be used in hard-to-debug development situations where +// you get some input you don't understand where comes from. +type stacktracerFs struct { + afero.Fs + + // Will print stacktrace for every file creates matching this pattern. + re *regexp.Regexp +} + +func (fs *stacktracerFs) DevOnly() { +} + +func (fs *stacktracerFs) onCreate(filename string) { + if fs.re.MatchString(filename) { + trace := make([]byte, 1500) + runtime.Stack(trace, true) + fmt.Printf("\n===========\n%q:\n%s\n", filename, trace) + } +} + +func (fs *stacktracerFs) Create(name string) (afero.File, error) { + f, err := fs.Fs.Create(name) + if err == nil { + fs.onCreate(name) + } + return f, err +} + +func (fs *stacktracerFs) OpenFile(name string, flag int, perm os.FileMode) (afero.File, error) { + f, err := fs.Fs.OpenFile(name, flag, perm) + if err == nil && isWrite(flag) { + fs.onCreate(name) + } + return f, err +} |