[rush] ERROR: unacceptable kind of an object to dump (undefined)

[octogonz]

Summary

In this Zulip thread, Ethan reports an error that appears to be a regression introduced by Rush 5.146.0:

ERROR: unacceptable kind of an object to dump [object Undefined]

This is the YAML serializer telling us that it encountered an undefined value in one of the objects to be serialized (which is not supported by strict serializers).

I'm guessing it might be this change in PnpmShrinkWrapFileConverters.ts.

Repro steps

(We haven't isolated a repro yet. I was unable to repro in the Rush Stach repository.)

Expected result:

Actual result:

Details

rush --debug update prints:

Running "pnpm install" in /home/devuser/git/align-ts/common/temp


Invoking package manager: /home/devuser/.rush/node-v20.18.0/pnpm-9.13.2/node_modules/pnpm/bin/pnpm.cjs install --store /home/devuser/git/align-ts/common/temp/pnpm-store --config.cacheDir=/home/devuser/git/align-ts/common/temp/pnpm-store --config.stateDir=/home/devuser/git/align-ts/common/temp/pnpm-store --no-prefer-frozen-lockfile --strict-peer-dependencies --config.auto-install-peers=false --config.resolutionMode=highest --config.ignoreCompatibilityDb --recursive --link-workspace-packages false --reporter default

Scope: all 101 workspace projects
../../apps/admin-api-example             |  WARN  deprecated [email protected]
...onflict-resolution-components-example |  WARN  deprecated @babel/[email protected]
 WARN  21 deprecated subdependencies found: @babel/[email protected], @babel/[email protected], @babel/[email protected], @babel/[email protected], @babel/[email protected], @humanwhocodes/[email protected], @humanwhocodes/[email protected], @types/[email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected]
.                                        |    +2117 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Progress: resolved 2098, reused 2015, downloaded 0, added 2117, done
Done in 8.7s


ERROR: unacceptable kind of an object to dump [object Undefined]

YAMLException: unacceptable kind of an object to dump [object Undefined]
    at writeNode (/home/devuser/.nvm/versions/node/v20.18.0/lib/node_modules/@microsoft/rush/node_modules/js-yaml/lib/js-yaml/dumper.js:756:13)
    at writeBlockMapping (/home/devuser/.nvm/versions/node/v20.18.0/lib/node_modules/@microsoft/rush/node_modules/js-yaml/lib/js-yaml/dumper.js:634:10)
    at writeNode (/home/devuser/.nvm/versions/node/v20.18.0/lib/node_modules/@microsoft/rush/node_modules/js-yaml/lib/js-yaml/dumper.js:727:9)
    at writeBlockMapping (/home/devuser/.nvm/versions/node/v20.18.0/lib/node_modules/@microsoft/rush/node_modules/js-yaml/lib/js-yaml/dumper.js:634:10)
    at writeNode (/home/devuser/.nvm/versions/node/v20.18.0/lib/node_modules/@microsoft/rush/node_modules/js-yaml/lib/js-yaml/dumper.js:727:9)
    at writeBlockMapping (/home/devuser/.nvm/versions/node/v20.18.0/lib/node_modules/@microsoft/rush/node_modules/js-yaml/lib/js-yaml/dumper.js:634:10)
    at writeNode (/home/devuser/.nvm/versions/node/v20.18.0/lib/node_modules/@microsoft/rush/node_modules/js-yaml/lib/js-yaml/dumper.js:727:9)
    at dump (/home/devuser/.nvm/versions/node/v20.18.0/lib/node_modules/@microsoft/rush/node_modules/js-yaml/lib/js-yaml/dumper.js:817:7)
    at Proxy.safeDump (/home/devuser/.nvm/versions/node/v20.18.0/lib/node_modules/@microsoft/rush/node_modules/js-yaml/lib/js-yaml/dumper.js:823:10)
    at PnpmShrinkwrapFile._serializeInternal (/home/devuser/.nvm/versions/node/v20.18.0/lib/node_modules/@microsoft/rush/node_modules/@microsoft/rush-lib/dist/commons.js:23494:27)

Standard questions

Please answer these questions to help us investigate your issue more quickly:

Question	Answer
rushVersion from rush.json?	5.147.0
Node.js version (node -v)?	20.15.0

[octogonz]

Likely a regression from [rush-lib] Support pnpm lockfile v9 #5009

@fzxen

[fzxen]

@octogonz you are right. The following code caused this issue.

rushstack/libraries/rush-lib/src/logic/pnpm/PnpmShrinkWrapFileConverters.ts

Lines 51 to 64 in 724aa51

	const dependencies: ResolvedDependencies | undefined =
	from.dependencies == null ? from.dependencies : moveSpecifiers(from.dependencies);
	const devDependencies: ResolvedDependencies | undefined =
	from.devDependencies == null ? from.devDependencies : moveSpecifiers(from.devDependencies);
	const optionalDependencies: ResolvedDependencies | undefined =
	from.optionalDependencies == null ? from.optionalDependencies : moveSpecifiers(from.optionalDependencies);
	return {
	...from,
	specifiers,
	dependencies,
	devDependencies,
	optionalDependencies
	};

After I set the preventManualShrinkwrapChanges field in the pnpm-config.json file to true, I successfully reproduced this problem.

I will submit a PR to fix the issue later.

[octogonz]

Thank you! 🙏

[lemke-ethan]

FWIW, here is a repo that you can use to reproduce this error: https://github.com/lemke-ethan/rush-pnpm-unacceptable-kind-of-an-object-to-dump.

[octogonz]

🚀 This is fixed in Rush 5.147.2