Skip to content

Importing causes side effect of changing module resolution for transitive dependencies for other imports in 5.6Β #60062

@thomasballinger

Description

@thomasballinger

πŸ”Ž Search Terms

"module resolution cache", "5.6 cache"

πŸ•— Version & Regression Information

  • This changed between versions 5.5.4 and 5.6.2

⏯ Playground Link

No response

πŸ’» Code

Importing dependency B that transitively imports dependency D can pollute the cache for dependency C which also needs dependency D. In the example I observed this caused the types used for D to be CommonJS types for D when ESM should have been used, just because C imported D as CommonJs. This behavior changed in TypeScript 5.6.


import { Aggregate } from '@convex-dev/aggregate'
import { Migrations } from '@convex-dev/migrations'

Both of these packages transitively import convex.

The @convex-dev/aggregate package is "broken:" it uses export conditions to point '.' (see https://unpkg.com/browse/@convex-dev/aggregate@0.1.6/package.json) to point to a file in a directory with a package.json with "type": "commonjs" (see https://unpkg.com/browse/@convex-dev/aggregate@0.1.6/dist/esm/package.json), when based on the directory names that doesn't really make sense.

@convex-dev/migrations works more like you'd expect, a similar layout but the package.json at dist/esm/package.json more reasonably has "type": "module".

πŸ™ Actual behavior

In 5.5.6, just adding the import

`import { Aggregate } from '@convex-dev/aggregate` 

is enough to change the resolution of package 'convex' used by '@convex-dev/migrations'.

tsc --traceResolution with import { Aggregate } from '@convex-dev/aggregate: cache is used to resolve 'convex/server' to /Users/tomb/memory-palace/node_modules/convex/dist/cjs-types/server/index.d.ts
(partial output)

======== Resolving module 'convex/server' from '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/esm/client/index.d.ts'. ========
Explicitly specified module resolution kind: 'Bundler'.
Resolving in CJS mode with conditions 'import', 'types'.
File '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/esm/client/package.json' does not exist according to earlier cached lookups.
File '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/esm/package.json' exists according to earlier cached lookups.
Loading module 'convex/server' from 'node_modules' folder, target file types: TypeScript, JavaScript, Declaration, JSON.
Searching all ancestor node_modules directories for preferred extensions: TypeScript, Declaration.
Directory '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/esm/client/node_modules' does not exist, skipping all lookups in it.
Directory '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/esm/node_modules' does not exist, skipping all lookups in it.
Directory '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/node_modules' does not exist, skipping all lookups in it.
Directory '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/node_modules' does not exist, skipping all lookups in it.
Resolution for module 'convex/server' was found in cache from location '/Users/tomb/memory-palace/node_modules/@convex-dev'.
======== Module name 'convex/server' was successfully resolved to '/Users/tomb/memory-palace/node_modules/convex/dist/cjs-types/server/index.d.ts' with Package ID 'convex/dist/cjs-types/server/index.d.ts@1.16.2+@auth0/auth0-react@2.0.2+react@18.2.0+react-dom@18.2.0'. ========

tsc --traceResolution with import { Aggregate } from '@convex-dev/aggregate commented out: cache is not used, 'convex/server' resolved to /Users/tomb/memory-palace/node_modules/convex/dist/esm-types/server/index.d.ts
(partial output)

======== Resolving module 'convex/server' from '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/esm/client/index.d.ts'. ========
Explicitly specified module resolution kind: 'Bundler'.
Resolving in CJS mode with conditions 'import', 'types'.
File '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/esm/client/package.json' does not exist according to earlier cached lookups.
File '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/esm/package.json' exists according to earlier cached lookups.
Loading module 'convex/server' from 'node_modules' folder, target file types: TypeScript, JavaScript, Declaration, JSON.
Searching all ancestor node_modules directories for preferred extensions: TypeScript, Declaration.
Directory '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/esm/client/node_modules' does not exist, skipping all lookups in it.
Directory '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/esm/node_modules' does not exist, skipping all lookups in it.
Directory '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/node_modules' does not exist, skipping all lookups in it.
Directory '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/node_modules' does not exist, skipping all lookups in it.
Directory '/Users/tomb/memory-palace/node_modules/@convex-dev/node_modules' does not exist, skipping all lookups in it.
File '/Users/tomb/memory-palace/node_modules/convex/server/package.json' exists according to earlier cached lookups.
File '/Users/tomb/memory-palace/node_modules/convex/package.json' exists according to earlier cached lookups.
Entering conditional exports.
Saw non-matching condition 'require'.
Matched 'exports' condition 'import'.
Entering conditional exports.
Matched 'exports' condition 'types'.
Using 'exports' subpath './server' with target './dist/esm-types/server/index.d.ts'.
File '/Users/tomb/memory-palace/node_modules/convex/dist/esm-types/server/index.d.ts' exists - use it as a name resolution result.
Resolved under condition 'types'.
Exiting conditional exports.
Resolved under condition 'import'.
Exiting conditional exports.
Resolving real path for '/Users/tomb/memory-palace/node_modules/convex/dist/esm-types/server/index.d.ts', result '/Users/tomb/memory-palace/node_modules/convex/dist/esm-types/server/index.d.ts'.
======== Module name 'convex/server' was successfully resolved to '/Users/tomb/memory-palace/node_modules/convex/dist/esm-types/server/index.d.ts' with Package ID 'convex/dist/esm-types/server/index.d.ts@1.16.2+@auth0/auth0-react@2.0.2+react@18.2.0+react-dom@18.2.0'. ========

πŸ™‚ Expected behavior

In 5.5.4, adding

`import { Aggregate } from '@convex-dev/aggregate` 

has no effect on the resolution of package 'convex' used by '@convex-dev/migrations'.

tsc --traceResolution with import { Aggregate } from '@convex-dev/aggregate commented out
(partial output)

======== Resolving module 'convex/server' from '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/esm/client/index.d.ts'. ========
Explicitly specified module resolution kind: 'Bundler'.
Resolving in CJS mode with conditions 'import', 'types'.
File '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/esm/client/package.json' does not exist.
File '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/esm/package.json' exists according to earlier cached lookups.
Loading module 'convex/server' from 'node_modules' folder, target file types: TypeScript, JavaScript, Declaration, JSON.
Searching all ancestor node_modules directories for preferred extensions: TypeScript, Declaration.
Directory '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/esm/client/node_modules' does not exist, skipping all lookups in it.
Directory '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/esm/node_modules' does not exist, skipping all lookups in it.
Directory '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/dist/node_modules' does not exist, skipping all lookups in it.
Directory '/Users/tomb/memory-palace/node_modules/@convex-dev/migrations/node_modules' does not exist, skipping all lookups in it.
Directory '/Users/tomb/memory-palace/node_modules/@convex-dev/node_modules' does not exist, skipping all lookups in it.
File '/Users/tomb/memory-palace/node_modules/convex/server/package.json' exists according to earlier cached lookups.
File '/Users/tomb/memory-palace/node_modules/convex/package.json' exists according to earlier cached lookups.
Entering conditional exports.
Saw non-matching condition 'require'.
Matched 'exports' condition 'import'.
Entering conditional exports.
Matched 'exports' condition 'types'.
Using 'exports' subpath './server' with target './dist/esm-types/server/index.d.ts'.
File '/Users/tomb/memory-palace/node_modules/convex/dist/esm-types/server/index.d.ts' exists - use it as a name resolution result.
Resolved under condition 'types'.
Exiting conditional exports.
Resolved under condition 'import'.
Exiting conditional exports.
Resolving real path for '/Users/tomb/memory-palace/node_modules/convex/dist/esm-types/server/index.d.ts', result '/Users/tomb/memory-palace/node_modules/convex/dist/esm-types/server/index.d.ts'.
======== Module name 'convex/server' was successfully resolved to '/Users/tomb/memory-palace/node_modules/convex/dist/esm-types/server/index.d.ts' with Package ID 'convex/dist/esm-types/server/index.d.ts@1.16.2+@auth0/auth0-react@2.0.2+react@18.2.0+react-dom@18.2.0'. ========

Additional information about the issue

Restating the issue: Having already resolved a module import causes important steps to be skipped:

Resolution for module 'convex/server' was found in cache from location '/Users/tomb/memory-palace/node_modules/@convex-dev'.

seems to indicate that exports condition logic is being skipped inappropriately for this cached lookup: because it had been found before from a place where exports condition "require" matched, that was used instead of re-resolving now that "require" would not have matched.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Needs More InfoThe issue still hasn't been fully clarified

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions