Add TTL to taskfile.Cache #1702
Conversation
jlucktay
force-pushed
the
issue-1402/add-ttl-to-taskfile-cache
branch
from
69629d0
to
6b2ea85
Compare
|
Thank you for the notes @ccoVeille 🙂 🙏 |
Mapped out a flowchart to describe the behaviour of taskfile.Cache, so as to aid technical design and implementation. re go-task#1402
jlucktay
force-pushed
the
issue-1402/add-ttl-to-taskfile-cache
branch
from
ea22989
to
6230c71
Compare
Per the first bullet on this list: https://taskfile.dev/contributing/#2-making-changes
website/versioned_docs/version-latest/experiments/remote_taskfiles.mdx
Outdated
Show resolved
Hide resolved
| var ( | ||
| SLEEPIT, _ = filepath.Abs("./bin/sleepit") | ||
| ) | ||
| var SLEEPIT, _ = filepath.Abs("./bin/sleepit") |
There was a problem hiding this comment.
While you are simply applying a gofumpt on this.
I'm surprised to see:
- the error is ignored
- this variable name is in uppercase
- the variable is apparently used only in one test.
I would expect this variable to be used only where needed and to check the possible error
There was a problem hiding this comment.
Hi !
Thanks for working on this 🔥 To me 24h is too short.
I'll take my example but it can work for other.
We include only taskfiles we own in our company, so I know when I need to fetch a new version. I am always running with offline mode to avoid unecessary http call (and it's faster to not fetch X differents remote taskfiles).
I think we could add an env variable to control the cache duration (this way we do not need to worry about passing the flag each time we download a remote file)
One more thing, the chart does not reflect the real behavior.
As we said, the "offline" first will be done in another PR, you need to update the chart
@pd93 any thought on this?
| } | ||
|
|
||
| func NewCache(dir string) (*Cache, error) { | ||
| // ErrExpired is returned when a cached file has expired. | ||
| var ErrExpired = errors.New("task: cache expired") |
There was a problem hiding this comment.
It should go in the errors package.
You need to be a bit more specific in the error message, for example write wich file is expired
Description
This PR implements part of the remote Taskfiles experiment (#1317) that is currently ongoing.
Implementation notes
taskfile.Cachehas a new privatetime.Durationfield for the TTL setting.The
taskfilepackage has some new exports:const.error:ErrExpired.CacheOptiontype, and aWithTTLfunc returning this type, to help with creation of newCachestructs.The main
taskexecutable has a new flag (currently gated by theTASK_X_REMOTE_TASKFILESexperiment) to override the default cache TTL setting, outlined below.Flow diagram
There is a flowchart sketched out here on this branch to describe the overall flow.
New CLI behaviour
Resolves #1402.