package.json is not defined by "exports" #444

evdama · 2020-05-11T13:51:08Z

Describe the bug

'./package.json' is not defined by "exports" when upgrading from v7.0.3 to v8.0.0

To Reproduce

Steps to reproduce the behavior:

upgrading from v7.0.3 to v8.0.0 and running npm build in a Svelte project
See error

Expected behavior

A rollup bundle without an error as shown below.

Runtime

OS: macOS
Runtime: Node.js
Runtime Version: 14.1.0

Additional context

This is the command line output after upgrading from v7.0.3 to v8.0.0 in a Svelte project

> Package subpath './package.json' is not defined by "exports" in /Users/sa/0/edm/node_modules/uuid/package.json
Error [ERR_PACKAGE_PATH_NOT_EXPORTED]: Package subpath './package.json' is not defined by "exports" in /Users/sa/0/edm/node_modules/uuid/package.json
    at applyExports (internal/modules/cjs/loader.js:491:9)
    at resolveExports (internal/modules/cjs/loader.js:507:23)
    at Function.Module._findPath (internal/modules/cjs/loader.js:635:31)
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:1007:27)
    at Function.requireRelative.resolve (/Users/sa/0/edm/node_modules/require-relative/index.js:30:17)
    at tryResolve (/Users/sa/0/edm/node_modules/rollup-plugin-svelte/index.js:50:19)
    at Object.resolveId (/Users/sa/0/edm/node_modules/rollup-plugin-svelte/index.js:177:21)
    at /Users/sa/0/edm/node_modules/rollup/dist/shared/rollup.js:18217:25

I found some additional information in a SO post that might very well be related to the issue I'm seeing https://stackoverflow.com/questions/61621828/getting-strange-error-using-uuid-npm-module-what-am-i-doing-wrong/61730597#61730597

The text was updated successfully, but these errors were encountered:

ctavan · 2020-05-11T13:54:21Z

@evdama could you provide actual steps that let me reproduce your error (meaning, code that I can execute)? "grading from v7.0.3 to v8.0.0 and running npm build in a Svelte project" does not really help since I have no clue about the details of your project…

evdama · 2020-05-11T13:56:52Z

I'm using uuid inside my server.js like so

import { v4 as uuidv4 } from 'uuid'

... more code...


const setNonceMiddleware = ( request, response, next ) => {
  try {
    response.locals.nonce = uuidv4()
    next()
  } catch ( error ) {
    console.error ( 'error from setNonceMiddleware: ', error )
  }
}

I don't use uuid anywhere else in my app, just the snippet above. I'll also provide a gist of my rollup config that might help, it's a Sapper (Svelte) project with a client and a server as well as a serviceworker section: https://gist.github.com/7b56754df52b5b26b1db3f2873cee726

ctavan · 2020-05-11T14:02:24Z

OK, this is strange.

Judging from the stack trace of your error this looks much more like an issue with https://github.com/sveltejs/rollup-plugin-svelte though…

Apparently the svelte rollup plugin uses require-relative under the hood:

    at Function.requireRelative.resolve (/Users/sa/0/edm/node_modules/require-relative/index.js:30:17)

which likely has problems with modern Node.js module loading since its latest version has been published 6 years ago:

I don't think we could or should solve this in this library here. I think the right place to report this issue would be https://github.com/sveltejs/rollup-plugin-svelte/issues

evdama · 2020-05-11T17:09:03Z

@ctavan thanks much, I'm trying to catch one of the svelte devs (@Conduitry) on discord, ask him what he thinks is best i.e. me filling an issue about an outdated require-relative that's used in rollup-plugin-svelte

ctavan · 2020-05-11T17:46:48Z

@evdama I dug a little bit into it, I think it's a problem directly in the svelte rollup plugin, see sveltejs/rollup-plugin-svelte#104

Danny-A · 2020-05-12T06:35:34Z

It is not only a Svelte Rollup problem.

I upgraded to v8.0.0 in my React Native project and encountered the exact same problem.

ctavan · 2020-05-12T06:47:27Z

@Danny-A can you specify what you mean by "exact same problem"? Do you get exactly the same stack trace? Do you use svelte and rollup-plugin-svelte within react-native (is that even possible)?

ctavan · 2020-05-12T06:48:44Z

@TrySound I think you are more familiar with use cases of requiring package.json files from npm modules in bundler pipelines. Is this something that npm modules should generally support? Is this a documented requirement for e.g. rollup?

Danny-A · 2020-05-12T06:59:04Z

@ctavan Sorry for the lack of context. I get a Warning in RN. I don't get a stack trace and I am not using rollup.

warn Package uuid has been ignored because it contains invalid configuration. Reason: Package subpath './package.json' is not defined by "exports" in /Users/danny/Projecten/***/mobile/node_modules/uuid/package.json

TrySound · 2020-05-12T09:11:46Z

There is no any requirement for bundlers because they mostly do not support native node modules. Perhaps package.json should always be in exports list. See here
ai/nanoevents#44 (comment)
https://unpkg.com/nanoevents@5.1.6/package.json

It appears that react-native and some bundlers rely on being able to introspect the package.json file of a npm module. After adding the `exports` field to package.json, only the paths defined in that field are accessible to Node.js. In order to support introspection of the package.json file itself it has to be listed as an export as well. See also: ai/nanoevents#44 (comment) Fixes #444

ctavan · 2020-05-13T13:04:06Z

For the time being the warning can simply be ignored for uuid, the functionality is not affected!

I think it might make more sense to actually fix this in react-native instead of adding this workaround to every single module on npm. If you agree, feel free to give your 👍 for react-native-community/cli#1168

ljharb · 2020-05-18T20:41:24Z

In general, I think it's a good idea for packages to explicitly add "./package.json": "./package.json" to their "exports" field.

However, unless the ecosystem is consistently willing to do this, tooling will have to determine a different mechanism for accessing package.jsons - something like findPackageJSONFrom(path.dirname(require.resolve('pkg'))).

ctavan · 2020-05-18T21:21:20Z

To rephrase @ljharb's suggestion (assuming Node.js won't change the current behavior, see nodejs/node#33460):

Packages that rely on meta information for other tools from their package.json must export it.
Tools must be able to handle dependencies which don't export package.json gracefully (i.e. without crashing).
- Tools which make use of meta information from package.json could warn if packages don't export package.json in order to help package maintainers decide if they need to export it or not.

It appears that react-native and some bundlers rely on being able to introspect the package.json file of a npm module. After adding the `exports` field to package.json, only the paths defined in that field are accessible to Node.js. In order to support introspection of the package.json file itself it has to be listed as an export as well. See also: ai/nanoevents#44 (comment) Fixes #444

It appears that react-native and some bundlers rely on being able to introspect the package.json file of a npm module. After adding the `exports` field to package.json, only the paths defined in that field are accessible to Node.js. In order to support introspection of the package.json file itself it has to be listed as an export as well (see: ai/nanoevents#44 (comment)). It is currently being discussed to change Node.js' behavior again, see: nodejs/node#33460 Until then, adding package.json to the exports field should result in minimum breakage. Fixes #444

ctavan · 2020-05-20T18:59:51Z

Just release uuid@8.1.0 which now exports package.json, so the problem reported here should be gone for now.

dmnsgn · 2020-06-09T09:19:32Z

Hi @ctavan ,

I am seeing the same error using the latest version 8.1.0 but for the v4 exports:

Package subpath './v4' is not defined by "exports" in /Users/path-to-project/nested/in/node-modules-folder/node_modules/uuid/package.json

$ node -v
v14.4.0

Tools such as Components.js and react-native require introspection of the package.json file. Since the new export syntax does not imply package.json resolution yet (nodejs/node#33460), this has to be exported explicitly. Ideally, this would be something that is done implicitly by Node.js, but this is something that is still being discussed at nodejs/node#33460. So until then, this has to be added explictly to avoid breaking other tooling. Related to uuidjs/uuid#444

Apparently, React Native and various bundler tools expect to be able to import/require package.json, which will fail if `exports` is being used but not exporting package.json: uuidjs/uuid#444 Fixes #107

If you are using bundlers like metro in rn-native (or tools that make use of metainformation of packages) you will recieve an import warning like: ``` warn Package pretty-bytes has been ignored because it contains invalid configuration. Reason: Package subpath './package.json' is not defined by "exports" in /Users/****/Applications/****/****/app/node_modules/pretty-bytes/package.json ``` There was a similar Issue in `uuidjs`, for discussion you can see this issue uuidjs/uuid#444 (comment)

Apparently, React Native and various bundler tools expect to be able to import/require package.json, which will fail if `exports` is being used but not exporting package.json: uuidjs/uuid#444 Fixes #107

ctavan mentioned this issue May 11, 2020

Plugin incompatible with Node.js exports package.json field sveltejs/rollup-plugin-svelte#104

Closed

ctavan mentioned this issue May 12, 2020

fix: export package.json required by react-native and bundlers #449

Merged

demchenkoalex mentioned this issue May 13, 2020

Warning when starting with react-native locize/i18next-locize-backend#325

Closed

ctavan mentioned this issue May 13, 2020

Package subpath './package.json' is not defined by "exports" react-native-community/cli#1168

Closed

jpaquim mentioned this issue May 18, 2020

Handle non-exported package.json files sveltejs/rollup-plugin-svelte#108

Closed

ctavan mentioned this issue May 18, 2020

Special treatment for package.json resolution and exports? nodejs/node#33460

Closed

1 task

ctavan mentioned this issue May 18, 2020

Handle ERR_PACKAGE_PATH_NOT_EXPORTED gracefully sveltejs/rollup-plugin-svelte#109

Closed

ctavan mentioned this issue May 20, 2020

Metro Bundler ignores make-plural eemeli/make-plural#15

Closed

ctavan closed this as completed in #449 May 20, 2020

focusaurus mentioned this issue May 28, 2020

Crash on start: MODULE_NOT_FOUND error with apollo-engine-reporting > uuid reactioncommerce/reaction#6254

Closed

3 tasks

rubensworks mentioned this issue Nov 3, 2021

Manually export package.json to support introspective tools RubenVerborgh/AsyncIterator#34

Merged

ljosberinn mentioned this issue Nov 17, 2021

Not support node v17 vercel/next.js#31514

Closed

jaredh159 mentioned this issue Nov 22, 2021

CommonJS Support jaredh159/tailwind-react-native-classnames#93

Merged

This was referenced Jan 26, 2022

Not Exporting package.json in @magic-ext/solana magiclabs/magic-js#272

Closed

Added "./package.json" to "exports" field magiclabs/magic-js#273

Closed

delventhalz mentioned this issue Jan 26, 2022

Build fails with "flatted" dependency: './package.json' is not defined by "exports" sveltejs/rollup-plugin-svelte#193

Closed

MichaelLangbein mentioned this issue Jan 31, 2022

Build(deps): bump three from 0.132.2 to 0.137.0 dlr-eoc/ukis-frontend-libraries#111

Closed

ctjlewis mentioned this issue Mar 11, 2022

why is there a package.json export for package.json? tsmodule/tsmodule#1

Closed

bencooper222 mentioned this issue Jun 7, 2022

uuid pinned dependency has import issues aws/aws-sdk-js#4120

Open

hatem-72 mentioned this issue Jul 11, 2022

[package.json] Add ./package.json to exports moment/luxon#1239

Merged

ianprime0509 mentioned this issue Jul 15, 2022

fix: export package.json ianprime0509/pitchy#108

Merged

ianprime0509 mentioned this issue Jul 15, 2022

Installation issues with latest react native ianprime0509/pitchy#107

Closed

manniL mentioned this issue Oct 2, 2022

build: add package.json to subpath exports unjs/h3#186

Merged

xPaw mentioned this issue Oct 12, 2022

Export package.json sql-formatter-org/sql-formatter#499

Merged

Reeywhaar mentioned this issue Nov 21, 2022

Add package.json to exports badrap/valita#30

Closed

tastydev mentioned this issue Nov 30, 2022

fix(package.json): add package.json to exports sindresorhus/pretty-bytes#77

Closed

msotnikov mentioned this issue Dec 5, 2022

Export package.json d3/d3#3608

Closed

Kekananen mentioned this issue Jan 18, 2023

Error - Package subpath ./package.json is not defined by exports in package.json duerrsimon/bioicons#24

Open

darshkpatel mentioned this issue May 7, 2023

fix: define package.json export single-spa/single-spa-react#168

Merged

KillyMXI mentioned this issue May 17, 2023

Using in a React Native app html-to-text/node-html-to-text#291

Closed

p-desaintchamas mentioned this issue May 25, 2023

fix: add package.json to exports sidorares/node-mysql2#2026

Merged

Tobbe mentioned this issue Jun 27, 2023

internal(rwfw) Add bins as scripts redwoodjs/redwood#8754

Merged

leonardogbxv mentioned this issue Aug 24, 2023

"./package.json" is not defined by "exports" warning in React Native dcodeIO/long.js#126

Open

smcgivern mentioned this issue Jan 2, 2024

Transitive loading of @types/node breaks Request/Response (etc.) types cloudflare/workerd#1298

Open

JimAllanson mentioned this issue Apr 4, 2024

Export package.json from exports list in package.json to support introspection by build tools apollographql/apollo-server#7865

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

package.json is not defined by "exports" #444

package.json is not defined by "exports" #444

evdama commented May 11, 2020 •

edited

ctavan commented May 11, 2020

evdama commented May 11, 2020 •

edited

ctavan commented May 11, 2020

evdama commented May 11, 2020

ctavan commented May 11, 2020

Danny-A commented May 12, 2020

ctavan commented May 12, 2020

ctavan commented May 12, 2020

Danny-A commented May 12, 2020

TrySound commented May 12, 2020 •

edited

ctavan commented May 13, 2020

ljharb commented May 18, 2020

ctavan commented May 18, 2020

ctavan commented May 20, 2020

dmnsgn commented Jun 9, 2020

package.json is not defined by "exports" #444

package.json is not defined by "exports" #444

Comments

evdama commented May 11, 2020 • edited

Describe the bug

To Reproduce

Expected behavior

Runtime

Additional context

ctavan commented May 11, 2020

evdama commented May 11, 2020 • edited

ctavan commented May 11, 2020

evdama commented May 11, 2020

ctavan commented May 11, 2020

Danny-A commented May 12, 2020

ctavan commented May 12, 2020

ctavan commented May 12, 2020

Danny-A commented May 12, 2020

TrySound commented May 12, 2020 • edited

ctavan commented May 13, 2020

ljharb commented May 18, 2020

ctavan commented May 18, 2020

ctavan commented May 20, 2020

dmnsgn commented Jun 9, 2020

evdama commented May 11, 2020 •

edited

evdama commented May 11, 2020 •

edited

TrySound commented May 12, 2020 •

edited