mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
Allow rendering static files to disk and dynamic to memory in server mode
Updates #9625
This commit is contained in:
parent
b9a1be2f99
commit
7d8011ed63
8 changed files with 69 additions and 25 deletions
|
@ -92,6 +92,7 @@ type commandeer struct {
|
|||
languagesConfigured bool
|
||||
languages langs.Languages
|
||||
doLiveReload bool
|
||||
renderStaticToDisk bool
|
||||
fastRenderMode bool
|
||||
showErrorInBrowser bool
|
||||
wasError bool
|
||||
|
@ -368,8 +369,9 @@ func (c *commandeer) loadConfig() error {
|
|||
}
|
||||
|
||||
createMemFs := config.GetBool("renderToMemory")
|
||||
c.renderStaticToDisk = config.GetBool("renderStaticToDisk")
|
||||
|
||||
if createMemFs {
|
||||
if createMemFs && !c.renderStaticToDisk {
|
||||
// Rendering to memoryFS, publish to Root regardless of publishDir.
|
||||
config.Set("publishDir", "/")
|
||||
}
|
||||
|
@ -380,6 +382,14 @@ func (c *commandeer) loadConfig() error {
|
|||
if c.destinationFs != nil {
|
||||
// Need to reuse the destination on server rebuilds.
|
||||
fs.Destination = c.destinationFs
|
||||
} else if createMemFs && c.renderStaticToDisk {
|
||||
// Writes the dynamic output on memory,
|
||||
// while serve others directly from publishDir
|
||||
publishDir := config.GetString("publishDir")
|
||||
writableFs := afero.NewBasePathFs(afero.NewMemMapFs(), publishDir)
|
||||
publicFs := afero.NewOsFs()
|
||||
fs.Destination = afero.NewCopyOnWriteFs(afero.NewReadOnlyFs(publicFs), writableFs)
|
||||
fs.DestinationStatic = publicFs
|
||||
} else if createMemFs {
|
||||
// Hugo writes the output to memory instead of the disk.
|
||||
fs.Destination = new(afero.MemMapFs)
|
||||
|
@ -397,11 +407,13 @@ func (c *commandeer) loadConfig() error {
|
|||
|
||||
changeDetector.PrepareNew()
|
||||
fs.Destination = hugofs.NewHashingFs(fs.Destination, changeDetector)
|
||||
fs.DestinationStatic = hugofs.NewHashingFs(fs.DestinationStatic, changeDetector)
|
||||
c.changeDetector = changeDetector
|
||||
}
|
||||
|
||||
if c.Cfg.GetBool("logPathWarnings") {
|
||||
fs.Destination = hugofs.NewCreateCountingFs(fs.Destination)
|
||||
fs.DestinationStatic = hugofs.NewCreateCountingFs(fs.DestinationStatic)
|
||||
}
|
||||
|
||||
// To debug hard-to-find path issues.
|
||||
|
|
|
@ -652,6 +652,9 @@ func (c *commandeer) copyStaticTo(sourceFs *filesystems.SourceFilesystem) (uint6
|
|||
syncer.ChmodFilter = chmodFilter
|
||||
syncer.SrcFs = fs
|
||||
syncer.DestFs = c.Fs.Destination
|
||||
if c.renderStaticToDisk {
|
||||
syncer.DestFs = c.Fs.DestinationStatic
|
||||
}
|
||||
// Now that we are using a unionFs for the static directories
|
||||
// We can effectively clean the publishDir on initial sync
|
||||
syncer.Delete = c.Cfg.GetBool("cleanDestinationDir")
|
||||
|
|
|
@ -51,6 +51,7 @@ type serverCmd struct {
|
|||
disableLiveReload bool
|
||||
navigateToChanged bool
|
||||
renderToDisk bool
|
||||
renderStaticToDisk bool
|
||||
serverAppend bool
|
||||
serverInterface string
|
||||
serverPort int
|
||||
|
@ -101,6 +102,7 @@ of a second, you will be able to save and see your changes nearly instantly.`,
|
|||
cc.cmd.Flags().BoolVar(&cc.renderToDisk, "renderToDisk", false, "render to Destination path (default is render to memory & serve from there)")
|
||||
cc.cmd.Flags().BoolVar(&cc.disableFastRender, "disableFastRender", false, "enables full re-renders on changes")
|
||||
cc.cmd.Flags().BoolVar(&cc.disableBrowserError, "disableBrowserError", false, "do not show build errors in the browser")
|
||||
cc.cmd.Flags().BoolVar(&cc.renderStaticToDisk, "renderStaticToDisk", false, "render static files to disk but dynamic files render to memory.")
|
||||
|
||||
cc.cmd.Flags().String("memstats", "", "log memory usage to this file")
|
||||
cc.cmd.Flags().String("meminterval", "100ms", "interval to poll memory usage (requires --memstats), valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".")
|
||||
|
@ -141,6 +143,7 @@ func (sc *serverCmd) server(cmd *cobra.Command, args []string) error {
|
|||
|
||||
cfgInit := func(c *commandeer) error {
|
||||
c.Set("renderToMemory", !sc.renderToDisk)
|
||||
c.Set("renderStaticToDisk", sc.renderStaticToDisk)
|
||||
if cmd.Flags().Changed("navigateToChanged") {
|
||||
c.Set("navigateToChanged", sc.navigateToChanged)
|
||||
}
|
||||
|
@ -332,6 +335,8 @@ func (f *fileServer) createEndpoint(i int) (*http.ServeMux, string, string, erro
|
|||
if i == 0 {
|
||||
if f.s.renderToDisk {
|
||||
jww.FEEDBACK.Println("Serving pages from " + absPublishDir)
|
||||
} else if f.s.renderStaticToDisk {
|
||||
jww.FEEDBACK.Println("Serving pages from memory and static files from " + absPublishDir)
|
||||
} else {
|
||||
jww.FEEDBACK.Println("Serving pages from memory")
|
||||
}
|
||||
|
|
|
@ -56,6 +56,9 @@ func (s *staticSyncer) syncsStaticEvents(staticEvents []fsnotify.Event) error {
|
|||
syncer.ChmodFilter = chmodFilter
|
||||
syncer.SrcFs = sourceFs.Fs
|
||||
syncer.DestFs = c.Fs.Destination
|
||||
if c.renderStaticToDisk {
|
||||
syncer.DestFs = c.Fs.DestinationStatic
|
||||
}
|
||||
|
||||
// prevent spamming the log on changes
|
||||
logger := helpers.NewDistinctErrorLogger()
|
||||
|
@ -101,7 +104,11 @@ func (s *staticSyncer) syncsStaticEvents(staticEvents []fsnotify.Event) error {
|
|||
toRemove := filepath.Join(publishDir, relPath)
|
||||
|
||||
logger.Println("File no longer exists in static dir, removing", toRemove)
|
||||
if c.renderStaticToDisk {
|
||||
_ = c.Fs.DestinationStatic.RemoveAll(toRemove)
|
||||
} else {
|
||||
_ = c.Fs.Destination.RemoveAll(toRemove)
|
||||
}
|
||||
} else if err == nil {
|
||||
// If file still exists, sync it
|
||||
logger.Println("Syncing", relPath, "to", publishDir)
|
||||
|
|
|
@ -35,6 +35,9 @@ type Fs struct {
|
|||
// Destination is Hugo's destination file system.
|
||||
Destination afero.Fs
|
||||
|
||||
// Destination used for `renderStaticToDisk`
|
||||
DestinationStatic afero.Fs
|
||||
|
||||
// Os is an OS file system.
|
||||
// NOTE: Field is currently unused.
|
||||
Os afero.Fs
|
||||
|
@ -71,6 +74,7 @@ func newFs(base afero.Fs, cfg config.Provider) *Fs {
|
|||
return &Fs{
|
||||
Source: base,
|
||||
Destination: base,
|
||||
DestinationStatic: base,
|
||||
Os: &afero.OsFs{},
|
||||
WorkingDir: getWorkingDirFs(base, cfg),
|
||||
}
|
||||
|
|
|
@ -71,6 +71,9 @@ type BaseFs struct {
|
|||
// A read-only filesystem starting from the project workDir.
|
||||
WorkDir afero.Fs
|
||||
|
||||
// The filesystem used for renderStaticToDisk.
|
||||
PublishFsStatic afero.Fs
|
||||
|
||||
theBigFs *filesystemsCollector
|
||||
|
||||
// Locks.
|
||||
|
@ -438,6 +441,7 @@ func NewBase(p *paths.Paths, logger loggers.Logger, options ...func(*BaseFs) err
|
|||
|
||||
publishFs := hugofs.NewBaseFileDecorator(afero.NewBasePathFs(fs.Destination, p.AbsPublishDir))
|
||||
sourceFs := hugofs.NewBaseFileDecorator(afero.NewBasePathFs(fs.Source, p.WorkingDir))
|
||||
publishFsStatic := afero.NewBasePathFs(fs.Source, p.AbsPublishDir)
|
||||
|
||||
// Same as sourceFs, but no decoration. This is what's used by os.ReadDir etc.
|
||||
workDir := afero.NewBasePathFs(afero.NewReadOnlyFs(fs.Source), p.WorkingDir)
|
||||
|
@ -446,6 +450,7 @@ func NewBase(p *paths.Paths, logger loggers.Logger, options ...func(*BaseFs) err
|
|||
SourceFs: sourceFs,
|
||||
WorkDir: workDir,
|
||||
PublishFs: publishFs,
|
||||
PublishFsStatic: publishFsStatic,
|
||||
buildMu: lockedfile.MutexAt(filepath.Join(p.WorkingDir, lockFileBuild)),
|
||||
}
|
||||
|
||||
|
|
|
@ -36,6 +36,7 @@ func newPagesProcessor(h *HugoSites, sp *source.SourceSpec) *pagesProcessor {
|
|||
m: s.pageMap,
|
||||
errorSender: s.h,
|
||||
itemChan: make(chan interface{}, config.GetNumWorkerMultiplier()*2),
|
||||
renderStaticToDisk: h.Cfg.GetBool("renderStaticToDisk"),
|
||||
}
|
||||
}
|
||||
return &pagesProcessor{
|
||||
|
@ -118,6 +119,8 @@ type sitePagesProcessor struct {
|
|||
ctx context.Context
|
||||
itemChan chan interface{}
|
||||
itemGroup *errgroup.Group
|
||||
|
||||
renderStaticToDisk bool
|
||||
}
|
||||
|
||||
func (p *sitePagesProcessor) Process(item interface{}) error {
|
||||
|
@ -162,7 +165,12 @@ func (p *sitePagesProcessor) copyFile(fim hugofs.FileMetaInfo) error {
|
|||
|
||||
defer f.Close()
|
||||
|
||||
return s.publish(&s.PathSpec.ProcessingStats.Files, target, f)
|
||||
fs := s.PublishFs
|
||||
if p.renderStaticToDisk {
|
||||
fs = s.PublishFsStatic
|
||||
}
|
||||
|
||||
return s.publish(&s.PathSpec.ProcessingStats.Files, target, f, fs)
|
||||
}
|
||||
|
||||
func (p *sitePagesProcessor) doProcess(item interface{}) error {
|
||||
|
|
|
@ -1824,10 +1824,10 @@ func (s *Site) lookupTemplate(layouts ...string) (tpl.Template, bool) {
|
|||
return nil, false
|
||||
}
|
||||
|
||||
func (s *Site) publish(statCounter *uint64, path string, r io.Reader) (err error) {
|
||||
func (s *Site) publish(statCounter *uint64, path string, r io.Reader, fs afero.Fs) (err error) {
|
||||
s.PathSpec.ProcessingStats.Incr(statCounter)
|
||||
|
||||
return helpers.WriteToDisk(filepath.Clean(path), r, s.BaseFs.PublishFs)
|
||||
return helpers.WriteToDisk(filepath.Clean(path), r, fs)
|
||||
}
|
||||
|
||||
func (s *Site) kindFromFileInfoOrSections(fi *fileInfo, sections []string) string {
|
||||
|
|
Loading…
Reference in a new issue