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.

Sign up for GitHub

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

[wip] Support yarn "resolutions" #34

Closed
wants to merge 2 commits into from
Closed

[wip] Support yarn "resolutions" #34

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba1a3ef
[build yarn app] Merge workspace global "resolutions" into local package
geropl Sep 2, 2020
20d610b
[build yarn] Persist package's "resolutions" into generated package.json
geropl Sep 2, 2020
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
83 changes: 78 additions & 5 deletions pkg/leeway/build.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ import (

log "github.com/sirupsen/logrus"
"golang.org/x/xerrors"

"github.com/imdario/mergo"
)

// PkgNotBuiltErr is used when a package's dependency hasn't been built yet
Expand Down Expand Up @@ -74,7 +76,7 @@ const (
// buildProcessVersions contain the current version of the respective build processes.
// Increment this value if you change any of the build procedures.
var buildProcessVersions = map[PackageType]int{
YarnPackage: 6,
YarnPackage: 8,
GoPackage: 1,
DockerPackage: 1,
GenericPackage: 1,
Expand Down Expand Up @@ -569,7 +571,7 @@ yarn install --frozenlockfile --prod --cache-folder _temp_yarn_cache
rm -r yarn.lock _temp_yarn_cache
`

installerPackageJSONTemplate = `{"name":"local","version":"%s","license":"UNLICENSED","dependencies":{"%s":"%s"}}`
installerPackageJSONTemplate = `{"name":"local","version":"%s","license":"UNLICENSED","dependencies":{"%s":"%s"}, "resolutions":{"%s"}}`
)

// buildYarn implements the build process for Typescript packages.
Expand Down Expand Up @@ -688,7 +690,12 @@ func (p *Package) buildYarn(buildctx *buildContext, wd, result string) (err erro
packageJSONFiles = fs
}
packageJSONFiles = append(packageJSONFiles, pkgYarnLock)
packageJSON["files"] = packageJSONFiles
packageJSON["files"] = packageJSONFiles

_, err = mergeYarnWorkspaceResolutions(p.C.W.Origin, packageJSON)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not keen on the assumption that the package.json is in the workspace root.
I'd rather see this as a config field resolutionsFrom or something. That file would then become AdditionalSource of the yarn package.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@csweichel I wondered whether there already is an (implicit) relation between leeway and yarn; especially with regards to nested workspaces? Or do we "just" call yarn and are 100% yarn-workspace-agnostic? If there already were such an (implicit) relation it might be nice to make that explicit and derive the package.json for this use case from that.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leeway is built on the assumption that all packages of a workspace, including yarn packages, can stand on their own. In that sense, it even assumes that yarn workspaces don't exist.

The only concession we're making to Yarn here is a yarn.lock that resides outside of the package. It's still explicitly listed in the package definition, becomes part of a package's source list and does not imply anything else about the package's structure - just that the yarn lock is outside the package directory. Really, this is something I'd love to get rid of today rather than tomorrow.

if err != nil {
return xerrors.Errorf("cannot merge yarn workspace resolutions into component's package.json: %w", err)
}

modifiedPackageJSON = true
}
Expand All @@ -698,6 +705,11 @@ func (p *Package) buildYarn(buildctx *buildContext, wd, result string) (err erro
// different things. This yarn cache can't handle that.
packageJSON["version"] = fmt.Sprintf("0.0.0-%s", version)

_, err = mergeYarnWorkspaceResolutions(p.C.W.Origin, packageJSON)
if err != nil {
return xerrors.Errorf("cannot merge yarn workspace resolutions into component's package.json: %w", err)
}

modifiedPackageJSON = true
}
if modifiedPackageJSON {
Expand Down Expand Up @@ -749,11 +761,25 @@ func (p *Package) buildYarn(buildctx *buildContext, wd, result string) (err erro
}
}

var resolutionsStrs []string
if rres, ok := packageJSON["resolutions"]; ok {
res, ok := rres.(map[string]string)
if !ok {
fmt.Println(rres)
return xerrors.Errorf("invalid component package.json: resolutions section is not a map[string]string")
}

for k, v := range res {
resolutionsStrs = append(resolutionsStrs, fmt.Sprintf("\"%s\": \"%s\"", k, v))
}
}
resolutionStr := strings.Join(resolutionsStrs, ", ")

if cfg.Packaging == YarnOfflineMirror {
builtinScripts := map[string]string{
"get_yarn_lock.sh": getYarnLockScript,
"install.sh": installScript,
"installer-package.json": fmt.Sprintf(installerPackageJSONTemplate, version, pkgname, pkgversion),
"installer-package.json": fmt.Sprintf(installerPackageJSONTemplate, version, pkgname, pkgversion, resolutionStr),
}
for fn, script := range builtinScripts {
err = ioutil.WriteFile(filepath.Join(wd, "_mirror", fn), []byte(script), 0755)
Expand All @@ -779,7 +805,7 @@ func (p *Package) buildYarn(buildctx *buildContext, wd, result string) (err erro
if err != nil {
return err
}
err = ioutil.WriteFile(filepath.Join(wd, "_pkg", "package.json"), []byte(fmt.Sprintf(installerPackageJSONTemplate, version, pkgname, pkgversion)), 0755)
err = ioutil.WriteFile(filepath.Join(wd, "_pkg", "package.json"), []byte(fmt.Sprintf(installerPackageJSONTemplate, version, pkgname, pkgversion, resolutionStr)), 0755)
if err != nil {
return err
}
Expand All @@ -801,6 +827,53 @@ func (p *Package) buildYarn(buildctx *buildContext, wd, result string) (err erro
return executeCommandsForPackage(buildctx, p, wd, commands)
}

// mergeYarnWorkspaceResolutions reads the "resolutions" property of the package.json of the Yarn workspace, and - if
// present - merges that into the local package's package.json "resolution" section.
// This mimics the behaviour of yarn which applies "resolutions" specified in the workspace root to all packages in
// the workspace
func mergeYarnWorkspaceResolutions(workspaceOrigin string, componentPackageJSON map[string]interface{}) (bool, error) {
wsRootPkgJSONFilename := filepath.Join(workspaceOrigin, "package.json")
var wsRootPackageJSON map[string]interface{}
fc, err := ioutil.ReadFile(wsRootPkgJSONFilename)
if err != nil {
return false, xerrors.Errorf("cannot read package.json from workspace root: %w", err)
}
err = json.Unmarshal(fc, &wsRootPackageJSON)
if err != nil {
return false, xerrors.Errorf("cannot parse package.json from workspace root: %w", err)
}

rawWsResolutions, ok := wsRootPackageJSON["resolutions"]
if !ok {
// workspace root package.json has no "resolutions", nothing to do here
return false, nil
}
wsResolutions, ok := rawWsResolutions.(map[string]string)
if !ok {
fmt.Println(rawWsResolutions)
return false, xerrors.Errorf("invalid workspace root package.json: resolutions section is not a map[string]string")
}

var pkgResolutions map[string]string
rawPkgResolutions, ok := componentPackageJSON["resolutions"]
if ok {
pkgResolutions, ok = rawPkgResolutions.(map[string]string)
if !ok {
fmt.Println(rawPkgResolutions)
return false, xerrors.Errorf("invalid component package.json: resolutions section is not a map[string]string")
}
} else {
pkgResolutions = make(map[string]string)
}

err = mergo.Merge(&pkgResolutions, wsResolutions, mergo.WithOverride) // workspace resolutions override package-local resolutions
if err != nil {
return false, err
}
componentPackageJSON["resolutions"] = pkgResolutions
return true, nil
}

// buildGo implements the build process for Go packages.
// If you change anything in this process that's not backwards compatible, make sure you increment buildProcessVersions accordingly.
func (p *Package) buildGo(buildctx *buildContext, wd, result string) (err error) {
Expand Down