Merge pull request #297 from netlify/bbot-1131-ignore-root-cache-dirs

Ignore cache directories in root of build directory when deploying

Author: vbrown608

go/porcelain/deploy.go

@@ -42,6 +42,8 @@ const (
 	lfsVersionString = "version https://git-lfs.github.com/spec/v1"
 )
 
+var installDirs = []string{"node_modules/", "bower_components/"}
+
 type uploadType int
 type pointerData struct {
 	SHA  string
@@ -72,6 +74,7 @@ type DeployOptions struct {
 	SiteID            string
 	Dir               string
 	FunctionsDir      string
+	BuildDir          string
 	LargeMediaEnabled bool
 
 	IsDraft bool
@@ -188,8 +191,10 @@ func (n *Netlify) DoDeploy(ctx context.Context, options *DeployOptions, deploy *
 		largeMediaEnabled = deploy.SiteCapabilities.LargeMediaEnabled
 	}
 
+	ignoreInstallDirs := options.Dir == options.BuildDir
+
 	context.GetLogger(ctx).Infof("Getting files info with large media flag: %v", largeMediaEnabled)
-	files, err := walk(options.Dir, options.Observer, largeMediaEnabled)
+	files, err := walk(options.Dir, options.Observer, largeMediaEnabled, ignoreInstallDirs)
 	if err != nil {
 		if options.Observer != nil {
 			options.Observer.OnFailedWalk()
@@ -498,7 +503,7 @@ func (n *Netlify) uploadFile(ctx context.Context, d *models.Deploy, f *FileBundl
 	}
 }
 
-func walk(dir string, observer DeployObserver, useLargeMedia bool) (*deployFiles, error) {
+func walk(dir string, observer DeployObserver, useLargeMedia, ignoreInstallDirs bool) (*deployFiles, error) {
 	files := newDeployFiles()
 
 	err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
@@ -513,7 +518,7 @@ func walk(dir string, observer DeployObserver, useLargeMedia bool) (*deployFiles
 			}
 			rel := forceSlashSeparators(osRel)
 
-			if ignoreFile(rel) {
+			if ignoreFile(rel, ignoreInstallDirs) {
 				return nil
 			}
 
@@ -737,10 +742,18 @@ func goFile(filePath string, i os.FileInfo, observer DeployObserver) bool {
 	return true
 }
 
-func ignoreFile(rel string) bool {
+func ignoreFile(rel string, ignoreInstallDirs bool) bool {
 	if strings.HasPrefix(rel, ".") || strings.Contains(rel, "/.") || strings.HasPrefix(rel, "__MACOS") {
 		return !strings.HasPrefix(rel, ".well-known/")
 	}
+	if !ignoreInstallDirs {
+		return false
+	}
+	for _, ignorePath := range installDirs {
+		if strings.HasPrefix(rel, ignorePath) {
+			return true
+		}
+	}
 	return false
 }
 

go/porcelain/deploy_test.go

@@ -6,13 +6,17 @@ import (
 	"net/http"
 	"net/http/httptest"
 	"net/url"
+	"os"
+	"path/filepath"
 	"strings"
 	"testing"
 
 	"github.com/go-openapi/runtime"
 	apiClient "github.com/go-openapi/runtime/client"
 	"github.com/go-openapi/strfmt"
+	"github.com/netlify/open-api/go/models"
 	"github.com/netlify/open-api/go/plumbing/operations"
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
@@ -131,6 +135,33 @@ func TestConcurrentFileUpload(t *testing.T) {
 	}
 }
 
+func TestWalk_IgnoreNodeModulesInRoot(t *testing.T) {
+	dir, err := ioutil.TempDir("", "deploy")
+	require.Nil(t, err)
+	defer os.RemoveAll(dir)
+
+	err = os.Mkdir(filepath.Join(dir, "node_modules"), os.ModePerm)
+	require.Nil(t, err)
+	err = ioutil.WriteFile(filepath.Join(dir, "node_modules", "root-package"), []byte{}, 0644)
+	require.Nil(t, err)
+
+	err = os.MkdirAll(filepath.Join(dir, "more", "node_modules"), os.ModePerm)
+	require.Nil(t, err)
+	err = ioutil.WriteFile(filepath.Join(dir, "more", "node_modules", "inner-package"), []byte{}, 0644)
+	require.Nil(t, err)
+
+	files, err := walk(dir, mockObserver{}, false, false)
+	require.Nil(t, err)
+	assert.NotNil(t, files.Files["node_modules/root-package"])
+	assert.NotNil(t, files.Files["more/node_modules/inner-package"])
+
+	// When deploy directory == build directory, ignore node_modules in deploy directory root.
+	files, err = walk(dir, mockObserver{}, false, true)
+	require.Nil(t, err)
+	assert.Nil(t, files.Files["node_modules/root-package"])
+	assert.NotNil(t, files.Files["more/node_modules/inner-package"])
+}
+
 func TestReadZipRuntime(t *testing.T) {
 	runtime, err := readZipRuntime("../internal/data/hello-rs-function-test.zip")
 	if err != nil {
@@ -141,3 +172,18 @@ func TestReadZipRuntime(t *testing.T) {
 		t.Fatalf("unexpected runtime value, expected='rs', got='%s'", runtime)
 	}
 }
+
+type mockObserver struct{}
+
+func (m mockObserver) OnSetupWalk() error                         { return nil }
+func (m mockObserver) OnSuccessfulStep(*FileBundle) error         { return nil }
+func (m mockObserver) OnSuccessfulWalk(*models.DeployFiles) error { return nil }
+func (m mockObserver) OnFailedWalk()                              {}
+
+func (m mockObserver) OnSetupDelta(*models.DeployFiles) error                      { return nil }
+func (m mockObserver) OnSuccessfulDelta(*models.DeployFiles, *models.Deploy) error { return nil }
+func (m mockObserver) OnFailedDelta(*models.DeployFiles)                           {}
+
+func (m mockObserver) OnSetupUpload(*FileBundle) error      { return nil }
+func (m mockObserver) OnSuccessfulUpload(*FileBundle) error { return nil }
+func (m mockObserver) OnFailedUpload(*FileBundle)           {}