[caching] Add some basic AWS credentials caching (#1955)

Author: mikeland73

go.mod

@@ -40,9 +40,11 @@ require (
 	github.com/wk8/go-ordered-map/v2 v2.1.8
 	github.com/zealic/go2node v0.1.0
 	go.jetpack.io/envsec v0.0.16-0.20240329013200-4174c0acdb00
-	go.jetpack.io/pkg v0.0.0-20240329230128-09e8a66df983
+	go.jetpack.io/pkg v0.0.0-20240404001923-7b42192bf9a5
+	go.jetpack.io/typeid v1.0.0
 	golang.org/x/exp v0.0.0-20240222234643-814bf88cf225
 	golang.org/x/mod v0.16.0
+	golang.org/x/oauth2 v0.18.0
 	golang.org/x/sync v0.6.0
 	golang.org/x/tools v0.19.0
 	gopkg.in/natefinch/lumberjack.v2 v2.2.1
@@ -123,10 +125,8 @@ require (
 	github.com/therootcompany/xz v1.0.1 // indirect
 	github.com/ulikunitz/xz v0.5.11 // indirect
 	github.com/xtgo/uuid v0.0.0-20140804021211-a0b114877d4c // indirect
-	go.jetpack.io/typeid v1.0.0 // indirect
 	go4.org v0.0.0-20230225012048-214862532bf5 // indirect
 	golang.org/x/crypto v0.21.0 // indirect
-	golang.org/x/oauth2 v0.18.0 // indirect
 	golang.org/x/sys v0.18.0 // indirect
 	golang.org/x/term v0.18.0 // indirect
 	golang.org/x/text v0.14.0 // indirect

go.sum

@@ -363,20 +363,10 @@ github.com/yuin/gopher-lua v0.0.0-20190514113301-1cd887cd7036/go.mod h1:gqRgreBU
 github.com/zaffka/mongodb-boltdb-mock v0.0.0-20221014194232-b4bb03fbe3a0/go.mod h1:GsDD1qsG+86MeeCG7ndi6Ei3iGthKL3wQ7PTFigDfNY=
 github.com/zealic/go2node v0.1.0 h1:ofxpve08cmLJBwFdI0lPCk9jfwGWOSD+s6216x0oAaA=
 github.com/zealic/go2node v0.1.0/go.mod h1:GrkFr+HctXwP7vzcU9RsgtAeJjTQ6Ud0IPCQAqpTfBg=
-go.jetpack.io/envsec v0.0.16-0.20240327051701-1c56cf3690d7 h1:f+EANkek7CaHK6LS9RIm9rbOt2WrZYyYFTsXGKUdMgc=
-go.jetpack.io/envsec v0.0.16-0.20240327051701-1c56cf3690d7/go.mod h1:Z4tKIpAkdW4tpNUlToVLg7LZFl688GxWae02m3w//G0=
 go.jetpack.io/envsec v0.0.16-0.20240329013200-4174c0acdb00 h1:Kb+OlWOntAq+1nF+01ntqnQEqSJkFmLLS0RX5sl5zak=
 go.jetpack.io/envsec v0.0.16-0.20240329013200-4174c0acdb00/go.mod h1:dVG2n8fBAGpQczW8yk/6wuXb9uEhzaJF7wGXkGLRRCU=
-go.jetpack.io/pkg v0.0.0-20240327051701-89e2d24bc65e h1:JuyexYMVBsXwMrnmcCYVEOP9+Mrtvo0mAHSGeWdDUS0=
-go.jetpack.io/pkg v0.0.0-20240327051701-89e2d24bc65e/go.mod h1:vpIQT+m8iHO11v6bgMMG6iWfbGE2vxvLr9k7hLb4OeU=
-go.jetpack.io/pkg v0.0.0-20240329001056-e451f5c5e234 h1:MHZNJeQQwxqwVJhaCKtHAkCXrv3sWQkJoVf0i8Pf1Ro=
-go.jetpack.io/pkg v0.0.0-20240329001056-e451f5c5e234/go.mod h1:vpIQT+m8iHO11v6bgMMG6iWfbGE2vxvLr9k7hLb4OeU=
-go.jetpack.io/pkg v0.0.0-20240329204722-f4f14c8a894b h1:yAhOOZjimsf/hxY9d49xmVB+L5H5wkgoKXYqNLx8PFQ=
-go.jetpack.io/pkg v0.0.0-20240329204722-f4f14c8a894b/go.mod h1:vpIQT+m8iHO11v6bgMMG6iWfbGE2vxvLr9k7hLb4OeU=
-go.jetpack.io/pkg v0.0.0-20240329213144-bd03f1a1e491 h1:rD7aVnnpLHUnWKjiiMzWB1wKoJXQ/bsE/bZiei4KZ5Q=
-go.jetpack.io/pkg v0.0.0-20240329213144-bd03f1a1e491/go.mod h1:vpIQT+m8iHO11v6bgMMG6iWfbGE2vxvLr9k7hLb4OeU=
-go.jetpack.io/pkg v0.0.0-20240329230128-09e8a66df983 h1:tUWQOC0f12n8phuq7WGGtRVQ68F/DHPv+hWyR3bQUDA=
-go.jetpack.io/pkg v0.0.0-20240329230128-09e8a66df983/go.mod h1:gtmpVShXMEcZPBFZHswB3oCPYXobeR41b9CMybAjQYw=
+go.jetpack.io/pkg v0.0.0-20240404001923-7b42192bf9a5 h1:uFFlceGNlxqrKA/1umrBvNLTTBNkBU306Uqq1O27agM=
+go.jetpack.io/pkg v0.0.0-20240404001923-7b42192bf9a5/go.mod h1:gtmpVShXMEcZPBFZHswB3oCPYXobeR41b9CMybAjQYw=
 go.jetpack.io/typeid v1.0.0 h1:8gQ+iYGdyiQ0Pr40ydSB/PzMOIwlXX5DTojp1CBeSPQ=
 go.jetpack.io/typeid v1.0.0/go.mod h1:+UPEaECUgFxgAjFPn5Yf9eO/3ft/3xZ98Eahv9JW/GQ=
 go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU=

internal/devbox/providers/nixcache/nixcache.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"errors"
 	"os"
+	"time"
 
 	"github.com/aws/aws-sdk-go-v2/aws"
 	"github.com/aws/aws-sdk-go-v2/service/cognitoidentity/types"
@@ -12,7 +13,9 @@ import (
 	"go.jetpack.io/devbox/internal/nix"
 	"go.jetpack.io/devbox/internal/ux"
 	"go.jetpack.io/pkg/api"
+	nixv1alpha1 "go.jetpack.io/pkg/api/gen/priv/nix/v1alpha1"
 	"go.jetpack.io/pkg/auth"
+	"go.jetpack.io/pkg/filecache"
 )
 
 type Provider struct{}
@@ -59,7 +62,17 @@ func (p *Provider) Config(ctx context.Context) (NixCacheConfig, error) {
 	}
 
 	apiClient := api.NewClient(ctx, build.JetpackAPIHost(), token)
-	binCacheResponse, err := apiClient.GetBinCache(ctx)
+	cache := filecache.New[*nixv1alpha1.GetBinCacheResponse]("devbox/credentials")
+	binCacheResponse, err := cache.GetOrSetWithTime(
+		"aws-nix-bin-cache",
+		func() (*nixv1alpha1.GetBinCacheResponse, time.Time, error) {
+			r, err := apiClient.GetBinCache(ctx)
+			if err != nil || r.GetNixBinCacheUri() == "" {
+				return nil, time.Time{}, err
+			}
+			return r, r.GetNixBinCacheCredentials().Expiration.AsTime(), nil
+		},
+	)
 	if err != nil {
 		return NixCacheConfig{}, err
 	}

internal/nix/search.go

@@ -136,14 +136,14 @@ func SearchNixpkgsAttribute(query string) (map[string]*Info, error) {
 	key := cacheKey(query)
 
 	// Check if the query was already cached, and return the result if so
-	cache := filecache.New("devbox/nix", filecache.WithCacheDir(xdg.CacheSubpath("")))
-	if cachedResults, err := cache.Get(key); err == nil {
-		var results map[string]*Info
-		if err := json.Unmarshal(cachedResults, &results); err != nil {
-			return nil, err
-		}
+	cache := filecache.New(
+		"devbox/nix",
+		filecache.WithCacheDir[map[string]*Info](xdg.CacheSubpath("")),
+	)
+
+	if results, err := cache.Get(key); err == nil {
 		return results, nil
-	} else if !filecacheIsCacheMiss(err) {
+	} else if !filecache.IsCacheMiss(err) {
 		return nil, err // genuine error
 	}
 
@@ -154,27 +154,17 @@ func SearchNixpkgsAttribute(query string) (map[string]*Info, error) {
 	}
 
 	// Save the results to the cache
-	marshalled, err := json.Marshal(infos)
-	if err != nil {
-		return nil, err
-	}
 	// TODO savil: add a SetForever API that does not expire. Time based expiration is not needed here
 	// because we're caching results that are guaranteed to be stable.
 	// TODO savil: Make filecache.cache a public struct so it can be passed into other functions
 	const oneYear = 12 * 30 * 24 * time.Hour
-	if err := cache.Set(key, marshalled, oneYear); err != nil {
+	if err := cache.Set(key, infos, oneYear); err != nil {
 		return nil, err
 	}
 
 	return infos, nil
 }
 
-// read as: filecache.IsCacheMiss(err)
-// TODO savil: this should be implemented in the filecache package
-func filecacheIsCacheMiss(err error) bool {
-	return errors.Is(err, filecache.NotFound) || errors.Is(err, filecache.Expired)
-}
-
 // cacheKey sanitizes the search query to be a valid unix filename.
 // This cache key is used as the filename to store the cache value, and having a
 // representation of the query is important for debuggability.