1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-04-21 07:37:45 +00:00
hugo/testscripts/commands
Bjørn Erik Pedersen 7285e74090
all: Rework page store, add a dynacache, improve partial rebuilds, and some general spring cleaning
There are some breaking changes in this commit, see .

Closes 
Closes 

This fixes a set of bugs (see issue list) and it is also paying some technical debt accumulated over the years. We now build with Staticcheck enabled in the CI build.

The performance should be about the same as before for regular sized Hugo sites, but it should perform and scale much better to larger data sets, as objects that uses lots of memory (e.g. rendered Markdown, big JSON files read into maps with transform.Unmarshal etc.) will now get automatically garbage collected if needed. Performance on partial rebuilds when running the server in fast render mode should be the same, but the change detection should be much more accurate.

A list of the notable new features:

* A new dependency tracker that covers (almost) all of Hugo's API and is used to do fine grained partial rebuilds when running the server.
* A new and simpler tree document store which allows fast lookups and prefix-walking in all dimensions (e.g. language) concurrently.
* You can now configure an upper memory limit allowing for much larger data sets and/or running on lower specced PCs.
We have lifted the "no resources in sub folders" restriction for branch bundles (e.g. sections).
Memory Limit
* Hugos will, by default, set aside a quarter of the total system memory, but you can set this via the OS environment variable HUGO_MEMORYLIMIT (in gigabytes). This is backed by a partitioned LRU cache used throughout Hugo. A cache that gets dynamically resized in low memory situations, allowing Go's Garbage Collector to free the memory.

New Dependency Tracker: Hugo has had a rule based coarse grained approach to server rebuilds that has worked mostly pretty well, but there have been some surprises (e.g. stale content). This is now revamped with a new dependency tracker that can quickly calculate the delta given a changed resource (e.g. a content file, template, JS file etc.). This handles transitive relations, e.g. $page -> js.Build -> JS import, or $page1.Content -> render hook -> site.GetPage -> $page2.Title, or $page1.Content -> shortcode -> partial -> site.RegularPages -> $page2.Content -> shortcode ..., and should also handle changes to aggregated values (e.g. site.Lastmod) effectively.

This covers all of Hugo's API with 2 known exceptions (a list that may not be fully exhaustive):

Changes to files loaded with template func os.ReadFile may not be handled correctly. We recommend loading resources with resources.Get
Changes to Hugo objects (e.g. Page) passed in the template context to lang.Translate may not be detected correctly. We recommend having simple i18n templates without too much data context passed in other than simple types such as strings and numbers.
Note that the cachebuster configuration (when A changes then rebuild B) works well with the above, but we recommend that you revise that configuration, as it in most situations should not be needed. One example where it is still needed is with TailwindCSS and using changes to hugo_stats.json to trigger new CSS rebuilds.

Document Store: Previously, a little simplified, we split the document store (where we store pages and resources) in a tree per language. This worked pretty well, but the structure made some operations harder than they needed to be. We have now restructured it into one Radix tree for all languages. Internally the language is considered to be a dimension of that tree, and the tree can be viewed in all dimensions concurrently. This makes some operations re. language simpler (e.g. finding translations is just a slice range), but the idea is that it should also be relatively inexpensive to add more dimensions if needed (e.g. role).

Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
Fixes 
2024-01-27 16:28:14 +01:00
..
commands_errors.txt Fix "unknown command" message when no suggestion 2023-05-22 18:54:34 +02:00
completion.txt
config.txt Add --format to hugo config 2023-05-22 20:26:02 +02:00
config__cachedir.txt Use os.UserCacheDir as first fallback if cacheDir is not set 2023-07-27 20:59:47 +02:00
convert.txt
deploy.txt deploy: Fix deploy defaults for non-zero flag values (e.g. maxDeletes, invalidateCDN) 2023-06-18 19:38:34 +02:00
deprecate.txt Add a field prefix to the deprecated log statements 2023-11-01 16:40:26 +01:00
env.txt
gen.txt commands/gen: Remove default highlight style 2023-09-14 12:08:52 +02:00
hugo.txt Fix regression when loading config -e is empty or HUGO_ENV or HUGO_ENVIRONMENT is set 2023-05-24 16:39:31 +02:00
hugo__configdir.txt commands: Fail the build when no config file or config dir 2023-05-27 16:56:54 +02:00
hugo__errors.txt
hugo__flags.txt commands: Fail the build when no config file or config dir 2023-05-27 16:56:54 +02:00
hugo__noconfig.txt Don't create the public folder unless needed 2023-05-28 12:55:44 +02:00
hugo__path-warnings-postprocess.txt Fix false path warnings with resources.PostProcess 2023-06-27 21:55:35 +02:00
hugo__path-warnings.txt Fix false path warnings with resources.PostProcess 2023-06-27 21:55:35 +02:00
hugo__processingstats.txt all: Rework page store, add a dynacache, improve partial rebuilds, and some general spring cleaning 2024-01-27 16:28:14 +01:00
hugo__processingstats2.txt all: Rework page store, add a dynacache, improve partial rebuilds, and some general spring cleaning 2024-01-27 16:28:14 +01:00
hugo__publishdir_in_config.txt
hugo__watch.txt Don't inject livereload script on hugo -w 2023-06-02 09:04:00 +02:00
hugo_configdev_env.txt Fix regression when loading config -e is empty or HUGO_ENV or HUGO_ENVIRONMENT is set 2023-05-24 16:39:31 +02:00
hugo_configdev_environment.txt Fix regression when loading config -e is empty or HUGO_ENV or HUGO_ENVIRONMENT is set 2023-05-24 16:39:31 +02:00
hugo_configprod.txt Fix regression when loading config -e is empty or HUGO_ENV or HUGO_ENVIRONMENT is set 2023-05-24 16:39:31 +02:00
hugo_printpathwarnings.txt Re-add --printUnusedTemplates and --printPathWarnings 2023-05-19 11:37:05 +02:00
hugo_printunusedtemplates.txt Re-add --printUnusedTemplates and --printPathWarnings 2023-05-19 11:37:05 +02:00
import_jekyll.txt
list.txt commands: Make all list commands list what 'all' did before 2023-05-22 12:27:19 +02:00
mod.txt commands: Handle hugo mod get --help 2023-06-29 08:53:50 +02:00
mod__disable.txt Fix it so disable a module does not disable transitive dependency required by others 2023-08-23 18:05:18 +02:00
mod__themesdir.txt commands: Reinstate some of the removed build flags (e.g. --theme) to new and mod 2023-05-28 12:55:44 +02:00
mod_get.txt Fix so hugo get -u updates transitively 2023-10-22 16:32:01 +02:00
mod_get_u.txt Fix so hugo get -u updates transitively 2023-10-22 16:32:01 +02:00
mod_npm.txt all: Rework page store, add a dynacache, improve partial rebuilds, and some general spring cleaning 2024-01-27 16:28:14 +01:00
mod_npm_withexisting.txt all: Rework page store, add a dynacache, improve partial rebuilds, and some general spring cleaning 2024-01-27 16:28:14 +01:00
mod_tidy.txt
mod_vendor.txt testscripts: Make mod vendor test stable 2023-08-23 20:52:09 +02:00
new.txt testscripts: Move hugo new tests to where they belong 2023-08-30 10:31:08 +02:00
new_content.txt Delay the creation of cache directories until they're used 2023-08-30 16:39:06 +03:00
new_content_archetypedir.txt all: Rework page store, add a dynacache, improve partial rebuilds, and some general spring cleaning 2024-01-27 16:28:14 +01:00
noop.txt Make sure resources directory isn't created in hugo new theme 2023-08-23 22:50:35 +02:00
server.txt all: Rework page store, add a dynacache, improve partial rebuilds, and some general spring cleaning 2024-01-27 16:28:14 +01:00
server__edit_config.txt
server__edit_content.txt
server__multihost.txt
server__watch_hugo_stats.txt commands: Move testscript into its correct place 2023-07-19 19:54:36 +02:00
server__watch_moduleconfig.txt Fix module config watch regression 2023-08-01 09:05:53 +02:00
server_disablelivereload.txt Re-instate disableLiveReload as a config option (and not just a flag) 2023-07-19 19:50:37 +02:00
server_disablelivereload__config.txt Re-instate disableLiveReload as a config option (and not just a flag) 2023-07-19 19:50:37 +02:00
server_render_static_to_disk.txt Fix --renderStaticToDisk regression 2023-05-27 16:56:54 +02:00
server_render_to_memory.txt Fix handling of aliases (e.g. hugo serve) 2023-06-13 10:47:51 +02:00
version.txt