Make yarn mutex configurable

Author: Christian Weichel

cmd/root.go

@@ -5,6 +5,7 @@ import (
 	"os"
 	"strings"
 
+	"github.com/gookit/color"
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 	"github.com/typefox/leeway/pkg/leeway"
@@ -29,25 +30,27 @@ var (
 var rootCmd = &cobra.Command{
 	Use:   "leeway",
 	Short: "A caching meta-build system",
-	Long: `Leeway is a heavily caching build system for Go, Typescript and Docker projects. It knows three core concepts:
+	Long: color.Render(`<light_yellow>Leeway is a heavily caching build system</> for Go, Typescript and Docker projects. It knows three core concepts:
   Workspace: the workspace is the root of all operations. All component names are relative to this path. No relevant
              file must be placed outside the workspace. The workspace root is marked with a WORKSPACE file.
   Component: a component is single piece of standalone software. Every folder in the workspace which contains a BUILD file
              is a component. Components are identifed by their path relative to the workspace root.
   Package:   packages are the buildable unit in leeway. Every component can define multiple packages in its build file.
              Packages are identified by their name prefixed with the component name, e.g. some-component:pkg
 
-Configuration
+<white>Configuration</>
 Leeway is configured exclusively through the WORKSPACE/BUILD files and environment variables. The following environment
 variables have an effect on leeway:
-  LEEWAY_WORKSPACE_ROOT       Contains the path where to look for a WORKSPACE file. Can also be set using --workspace.
-  LEEWAY_REMOTE_CACHE_BUCKET  Enables remote caching using GCP buckets. Set this variable to the bucket name used for caching.
+       <light_blue>LEEWAY_WORKSPACE_ROOT</>  Contains the path where to look for a WORKSPACE file. Can also be set using --workspace.
+  <light_blue>LEEWAY_REMOTE_CACHE_BUCKET</>  Enables remote caching using GCP buckets. Set this variable to the bucket name used for caching.
                               When this variable is set, leeway expects "gsutil" in the path configured and authenticated so
-							  that it can work with the bucket.
-  LEEWAY_CACHE_DIR            Location of the local build cache. The directory does not have to exist yet.
-  LEEWAY_BUILD_DIR            Working location of leeway (i.e. where the actual builds happen). This location will see heavy I/O
+                              that it can work with the bucket.
+            <light_blue>LEEWAY_CACHE_DIR</>  Location of the local build cache. The directory does not have to exist yet.
+            <light_blue>LEEWAY_BUILD_DIR</>  Working location of leeway (i.e. where the actual builds happen). This location will see heavy I/O
                               which makes it advisable to place this on a fast SSD or in RAM.
-`,
+           <light_blue>LEEWAY_YARN_MUTEX</>  Configures the mutex flag leeway will pass to yarn. Defaults to "network".
+                              See https://yarnpkg.com/lang/en/docs/cli/#toc-concurrency-and-mutex for possible values.
+`),
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {
 		if verbose {
 			log.SetLevel(log.DebugLevel)

pkg/leeway/build.go

@@ -65,6 +65,11 @@ const (
 	// EnvvarBuildDir names the environment variable we take the build dir location from
 	EnvvarBuildDir = "LEEWAY_BUILD_DIR"
 
+	// EnvvarYarnMutex configures the mutex flag leeway will pass to yarn.
+	// See https://yarnpkg.com/lang/en/docs/cli/#toc-concurrency-and-mutex for possible values.
+	// Defaults to "network".
+	EnvvarYarnMutex = "LEEWAY_YARN_MUTEX"
+
 	// dockerImageNamesFiles is the name of the file store in poushed Docker build artifacts
 	// which contains the names of the Docker images we just pushed
 	dockerImageNamesFiles = "imgnames.txt"
@@ -162,7 +167,7 @@ func Build(pkg *Package, localCache Cache, remoteCache RemoteCache) error {
 	allpkg := append(requirements, pkg)
 
 	ctx, err := newBuildContext(localCache)
-	var errs []string
+	unresolvedArgs := make(map[string][]string)
 	for _, dep := range allpkg {
 		_, exists := ctx.LocalCache.Location(dep)
 		if exists {
@@ -171,14 +176,24 @@ func Build(pkg *Package, localCache Cache, remoteCache RemoteCache) error {
 
 		ua, err := FindUnresolvedArguments(dep)
 		if err != nil {
-			errs = append(errs, err.Error())
+			return err
 		}
-		if len(ua) != 0 {
-			errs = append(errs, fmt.Sprintf("%s: cannot build with unresolved arguments: %s", dep.FullName(), strings.Join(ua, ", ")))
+		for _, arg := range ua {
+			pkgs, ok := unresolvedArgs[arg]
+			if !ok {
+				pkgs = []string{}
+			}
+			pkgs = append(pkgs, dep.FullName())
+			unresolvedArgs[arg] = pkgs
 		}
 	}
-	if len(errs) != 0 {
-		return xerrors.Errorf(strings.Join(errs, "\n"))
+	if len(unresolvedArgs) != 0 {
+		var msg string
+		for arg, pkgs := range unresolvedArgs {
+			cleanArg := strings.TrimSuffix(strings.TrimPrefix(arg, "${"), "}")
+			msg += fmt.Sprintf("cannot build with unresolved argument \"%s\": use -D%s=value to set the argument\n\t%s appears in %s\n\n", arg, cleanArg, arg, strings.Join(pkgs, ", "))
+		}
+		return xerrors.Errorf(msg)
 	}
 
 	err = remoteCache.Download(ctx.LocalCache, requirements)
@@ -431,7 +446,11 @@ func (p *Package) buildTypescript(buildctx *buildContext, wd, result string) (er
 
 	// The yarn cache cannot handly conccurency proplery and needs to be looked.
 	// Make sure that all our yarn install calls lock the yarn cache.
-	yarnMutex := "file://" + filepath.Join(buildctx.BuildDir(), "yarn-mutex")
+	yarnMutex := os.Getenv(EnvvarYarnMutex)
+	if yarnMutex == "" {
+		log.Debug("%s is not set, defaulting to \"network\"", EnvvarYarnMutex)
+		yarnMutex = "network"
+	}
 	yarnCache := filepath.Join(buildctx.BuildDir(), "yarn-cache")
 	commands = append(commands, []string{"yarn", "install", "--mutex", yarnMutex, "--cache-folder", yarnCache})
 	if len(cfg.BuildCmd) == 0 {