Fixed the issue where the loclfile object has an undefined property causing yaml.dump to report an error.

Author: fzxen

common/changes/@microsoft/rush/bugfix-yaml_dump_error_2024-12-23-08-19.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Fixed the issue where the lockfile object has an nullish value causing yaml.dump to report an error.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}

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

@@ -24,6 +24,7 @@ import type {
   ProjectSnapshot,
   ResolvedDependencies
 } from '@pnpm/lockfile.types';
+import { removeNullishProps } from '../../utilities/objectUtilities';
 
 type DepPath = string & { __brand: 'DepPath' };
 // eslint-disable-next-line @typescript-eslint/typedef
@@ -56,11 +57,13 @@ function revertProjectSnapshot(from: InlineSpecifiersProjectSnapshot): ProjectSn
     from.optionalDependencies == null ? from.optionalDependencies : moveSpecifiers(from.optionalDependencies);
 
   return {
-    ...from,
-    specifiers,
-    dependencies,
-    devDependencies,
-    optionalDependencies
+    ...removeNullishProps({
+      ...from,
+      dependencies,
+      devDependencies,
+      optionalDependencies
+    }),
+    specifiers
   };
 }
 

libraries/rush-lib/src/logic/pnpm/test/PnpmShrinkwrapConverters.test.ts

@@ -38,4 +38,15 @@ describe(convertLockfileV9ToLockfileObject.name, () => {
       'pad-left': '^2.1.0'
     });
   });
+
+  it("no nullish values", () => {
+    const importers = new Map<string, ProjectSnapshot>(Object.entries(lockfile.importers || {}));
+
+    const currentPackage = importers.get('.');
+    const props = Object.keys(currentPackage || {});
+    expect(props).toContain('dependencies');
+    expect(props).toContain('specifiers');
+    expect(props).not.toContain('optionalDependencies');
+    expect(props).not.toContain('devDependencies');
+  });
 });

libraries/rush-lib/src/utilities/objectUtilities.ts

@@ -153,3 +153,18 @@ function isStrictComparable<T>(value: T): boolean {
     value === value && !(value !== null && value !== undefined && (type === 'object' || type === 'function'))
   );
 }
+
+/**
+ * Removes `undefined` and `null` properties from an object.
+ */
+export function removeNullishProps<T extends object>(obj: T): Partial<T> {
+  const result: Partial<T> = {};
+  for (const key in obj) {
+    if (obj.hasOwnProperty(key)) {
+      if (obj[key] !== undefined && obj[key] !== null) {
+        result[key] = obj[key];
+      }
+    }
+  }
+  return result;
+}

libraries/rush-lib/src/utilities/test/objectUtilities.test.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import { objectsAreDeepEqual, cloneDeep, merge } from '../objectUtilities';
+import { objectsAreDeepEqual, cloneDeep, merge, removeNullishProps } from '../objectUtilities';
 
 describe('objectUtilities', () => {
   describe(objectsAreDeepEqual.name, () => {
@@ -147,4 +147,12 @@ describe('objectUtilities', () => {
       expect(merge({ a: { b: 1 } }, { a: { c: 2 } })).toEqual({ a: { b: 1, c: 2 } });
     });
   });
+
+  describe(removeNullishProps.name, () => {
+    it('can remove undefined and null properties', () => {
+      expect(removeNullishProps({ a: 1, b: undefined })).toEqual({ a: 1 });
+      expect(removeNullishProps({ a: 1, b: null })).toEqual({ a: 1 });
+      expect(removeNullishProps({ a: 1, b: undefined, c: null })).toEqual({ a: 1 });
+    });
+  });
 });