Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[plugins] Add env var to control github cache ttl #2314

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 23 additions & 5 deletions internal/plugin/github.go
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,28 @@ func (p *githubPlugin) FileContent(subpath string) ([]byte, error) {
if err != nil {
return nil, err
}

// Cache for 24 hours. Once we store the plugin in the lockfile, we
// should cache this indefinitely and only invalidate if the plugin
// is updated.
ttl := 24 * time.Hour

// This is a stopgap until plugin is stored in lockfile.
// DEVBOX_X indicates this is an experimental env var.
// Use DEVBOX_X_GITHUB_PLUGIN_CACHE_TTL to override the default TTL.
// e.g. DEVBOX_X_GITHUB_PLUGIN_CACHE_TTL=1h will cache the plugin for 1 hour.
// Note: If you want to disable cache, we recommend using a low second value instead of zero to
// ensure only one network request is made.
ttlStr := os.Getenv("DEVBOX_X_GITHUB_PLUGIN_CACHE_TTL")
if ttlStr != "" {
ttl, err = time.ParseDuration(ttlStr)
if err != nil {
return nil, err
}
}

return githubCache.GetOrSet(
contentURL,
contentURL+ttlStr,
func() ([]byte, time.Duration, error) {
req, err := p.request(contentURL)
if err != nil {
Expand All @@ -96,10 +116,8 @@ func (p *githubPlugin) FileContent(subpath string) ([]byte, error) {
if err != nil {
return nil, 0, err
}
// Cache for 24 hours. Once we store the plugin in the lockfile, we
// should cache this indefinitely and only invalidate if the plugin
// is updated.
return body, 24 * time.Hour, nil

return body, ttl, nil
},
)
}
Expand Down
Loading