A workaround for "An error occured while creating pruned lockfile due to an issue with getParentPackage function #15835"

[SunStupic]

The workaround is to comment the line creating with pnpm patch or npm patch. It only works if you don't need a lock file with the generated package.json.

diff --git a/src/plugins/generate-package-json-plugin.js b/src/plugins/generate-package-json-plugin.js
index f98893401c23e3ef312f034ea2025752c77a8247..4e276098f31e9bc43d7e3f29e179a642a06c6700 100644
--- a/src/plugins/generate-package-json-plugin.js
+++ b/src/plugins/generate-package-json-plugin.js
@@ -40,7 +40,9 @@ class GeneratePackageJsonPlugin {
                 });
                 packageJson.main = (_a = packageJson.main) !== null && _a !== void 0 ? _a : this.options.outputFileName;
                 compilation.emitAsset('package.json', new webpack_1.sources.RawSource((0, devkit_1.serializeJson)(packageJson)));
-                compilation.emitAsset((0, lock_file_1.getLockFileName)(), new webpack_1.sources.RawSource((0, js_1.createLockFile)(packageJson)));
+                // This createLockFile conflicts with pnpm. Comment it out for now.
+                // TODO: uncomment it later when we upgrade to newer version of nx
+                // compilation.emitAsset((0, lock_file_1.getLockFileName)(), new webpack_1.sources.RawSource((0, js_1.createLockFile)(packageJson)));
             });
         });
     }

Original issue link: #15835
Paste the original issue description for SEO:

Current Behavior
I am currently serving a NestJS application using the command nx serve api. However, I encounter an error message stating, "An error occurred while creating the pruned lockfile." Despite this error, the application compiles and runs successfully, and it also generates package.json and package-lock.json files in the dist directory. As a result, it is unclear what impact this error has on the process.

The error seems to originate from the getPackageParent function, which is utilized for lock-file generation. To provide a clearer understanding of the current issue, I will outline how this function operates:

The function takes in a path (a string containing a file path or a package path) and a packages object containing package information.
It begins by splitting the path using the delimiter /node_modules/; the split() function returns an array of strings.
The first and last elements of the array are removed using slice(1, -1).
If no elements remain in the array, the package is deemed parentless, and the packages object is returned.
If elements persist in the array, the function attempts to identify the parent package. It retrieves the first element of the array using segments.shift() and searches for the package in the packages object.
Should the package lack a dependencies property, an empty object is created for its dependencies.
The function iterates through the remaining elements in the segments array. For each segment, it locates the corresponding dependency in the parent package and designates it as the new parent package.
If the new parent package is missing a dependencies property, an empty object is created for its dependencies.
Once no elements remain in the segments array, the function has located the parent package and returns the parent package's dependencies object.
At present, the function encounters a failure when consecutive segments return a parent with an undefined dependencies key, leading to the "undefined" error displayed in the failure log section. In the steps to reproduce, I have included a unit test that demonstrates this issue.

Expected Behavior
I would expect no error message.

GitHub Repo
See steps to reproduce below:

Steps to Reproduce
Here is a unit test to demonstrate the issue:

describe('get-package-parent', () => {
    it('should get parent package', () => {
        const fn = () => getPackageParent(PATH, PACKAGES);

        expect(fn).not.toThrow();
    });
});

function getPackageParent(path: any, packages: any) {

    const segments = path.split(/\/?node_modules\//).slice(1, -1);

    if (!segments.length) {
        return packages;
    }

    let parent = packages[segments.shift()];

    if (!parent.dependencies) {
        parent.dependencies = {};
    }

    while (segments.length) {
        parent = parent.dependencies[segments.shift()];

        if (!parent?.dependencies) {
            parent.dependencies = {};
        }
    }

    return parent.dependencies;
}

const PATH = 'node_modules/mailparser/node_modules/html-to-text/node_modules/htmlparser2/node_modules/domhandler';

const PACKAGES = {
    mailparser: {
        version: '3.6.4',
        resolved: 'https://registry.npmjs.org/mailparser/-/mailparser-3.6.4.tgz',
        integrity: 'sha512-4bDgbLdlcBKX8jtVskfn/G93nZo3lf7pyuLbAQ031SHQLihEqxtRwHrb9SXMTqiTkEGlOdpDrZE5uH18O+2A+A==',
        requires: {
            'encoding-japanese': '2.0.0',
            he: '1.2.0',
            'html-to-text': '9.0.4',
            'iconv-lite': '0.6.3',
            libmime: '5.2.1',
            'linkify-it': '4.0.1',
            mailsplit: '5.4.0',
            nodemailer: '6.9.1',
            tlds: '1.236.0',
        },
        dependencies: {
            '@selderee/plugin-htmlparser2': [Object],
            'dom-serializer': [Object],
            domhandler: [Object],
            domutils: [Object],
            entities: [Object],
            'html-to-text': [Object],
        },
    },
    'html-to-text': {
        version: '8.2.1',
        resolved: 'https://registry.npmjs.org/html-to-text/-/html-to-text-8.2.1.tgz',
        integrity: 'sha512-aN/3JvAk8qFsWVeE9InWAWueLXrbkoVZy0TkzaGhoRBC2gCFEeRLDDJN3/ijIGHohy6H+SZzUQWN/hcYtaPK8w==',
        requires: {
            '@selderee/plugin-htmlparser2': '^0.6.0',
            deepmerge: '^4.2.2',
            he: '^1.2.0',
            htmlparser2: '^6.1.0',
            minimist: '^1.2.6',
            selderee: '^0.6.0',
        },
    },
    htmlparser2: {
        version: '6.1.0',
        resolved: 'https://registry.npmjs.org/htmlparser2/-/htmlparser2-6.1.0.tgz',
        integrity: 'sha512-gyyPk6rgonLFEDGoeRgQNaEUvdJ4ktTmmUh/h2t7s+M8oPpIPxgNACWa+6ESR57kXstwqPiCut0V8NRpcwgU7A==',
        requires: {
            domelementtype: '^2.0.1',
            domhandler: '^4.0.0',
            domutils: '^2.5.2',
            entities: '^2.0.0',
        },
    },
};
Nx Report
>  NX   Ran target test for project shared-api-util-wrappers (6s)
 
         With additional flags:
           --silent=false
 
    ✖    1/1 failed
    ✔    0/1 succeeded [0 read from cache]
 
josh@mli-GL553VW:~/WebStormProjects/mcclelland-labs$ nx report

 >  NX   Report complete - copy this into the issue template

   Node : 16.19.0
   OS   : linux x64
   npm  : 8.19.3
   
   nx                      : 15.8.7
   @nrwl/js                : 15.8.7
   @nrwl/jest              : 15.8.7
   @nrwl/linter            : 15.8.7
   @nrwl/workspace         : 15.8.7
   @nrwl/angular           : 15.8.7
   @nrwl/cli               : 15.8.7
   @nrwl/cypress           : 15.8.7
   @nrwl/devkit            : 15.8.7
   @nrwl/eslint-plugin-nx  : 15.8.7
   @nrwl/nest              : 15.8.7
   @nrwl/node              : 15.8.7
   @nrwl/nx-plugin         : 15.8.7
   @nrwl/tao               : 15.8.7
   @nrwl/webpack           : 15.8.7
   typescript              : 4.9.5
   ---------------------------------------
   Local workspace plugins:
         @mcclelland-labs/create-manifest-file
         @mcclelland-labs/make-certificate
Failure Logs
>  NX   An error occured while creating pruned lockfile

   Please open an issue at `https://github.com/nrwl/nx/issues/new?template=1-bug.yml` and provide a reproduction.
   To prevent the build from breaking we are returning the root lock file.
   If you run `npm install --package-lock-only` in your output folder it will regenerate the correct pruned lockfile.

Original error: Cannot set properties of undefined (setting 'dependencies')


   TypeError: Cannot set properties of undefined (setting 'dependencies')
    at getPackageParent (/home/josh/WebStormProjects/mcclelland-labs/node_modules/nx/src/lock-file/npm-parser.js:252:33)
    at /home/josh/WebStormProjects/mcclelland-labs/node_modules/nx/src/lock-file/npm-parser.js:231:9
    at Array.forEach (<anonymous>)
    at mapV1Snapshots (/home/josh/WebStormProjects/mcclelland-labs/node_modules/nx/src/lock-file/npm-parser.js:230:20)
    at stringifyNpmLockfile (/home/josh/WebStormProjects/mcclelland-labs/node_modules/nx/src/lock-file/npm-parser.js:212:31)
    at createLockFile (/home/josh/WebStormProjects/mcclelland-labs/node_modules/nx/src/lock-file/lock-file.js:136:58)
    at /home/josh/WebStormProjects/mcclelland-labs/node_modules/@nrwl/webpack/src/plugins/generate-package-json-plugin.js:42:131
    at fn (/home/josh/WebStormProjects/mcclelland-labs/node_modules/webpack/lib/Compilation.js:478:10)
    at _next0 (eval at create (/home/josh/WebStormProjects/mcclelland-labs/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:21:1)
    at eval (eval at create (/home/josh/WebStormProjects/mcclelland-labs/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:34:1)
Additional Information
No response

[hinogi]

Still in issue not only for pnpm