sheerlox / import-from-esm Goto Github PK

Fuzz testing takes a lot of time to run, and decreases the feedback loop of the test workflow running on PRs significantly.

Running it as a separate workflow (e.g. on main commits) would also allow running it for longer, improving its benefits.

Working on: https://github.com/straw-hat-team/nodejs-monorepo/pull/119/files

I had to do the following:

// @ts-expect-error
import importFrom from "import-from-esm";

Since for some reason the type system is confused:

yarn build
src/openapi-web-sdk-generator.ts:2:8 - error TS1192: Module '"/Users/ubi/Developer/github.com/straw-hat-team/nodejs-monorepo/.yarn/cache/import-from-esm-npm-1.2.1-19132a3a23-17275e7d51.zip/node_modules/import-from-esm/index"' has no default export.

2 import importFrom from "import-from-esm";
         ~~~~~~~~~~


Found 1 error in src/openapi-web-sdk-generator.ts:2

Any thoughts?

I am using pnp linker as follow:

• Node Version: v20.10.0

# .yarnrc.yml
compressionLevel: mixed
defaultSemverRangePrefix: ''
enableGlobalCache: false
nodeLinker: pnp
yarnPath: .yarn/releases/yarn-4.0.2.cjs

I am using import-from-esm at https://github.com/straw-hat-team/nodejs-monorepo/tree/master/packages/%40straw-hat/openapi-web-sdk-generator

Here is the config:

# .openapi-web-sdk-generatorrc.yaml
generators:
  - path: '@straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js'
    config:
      outputDir: 'src/lib/services/flashbot-api/operations'
  - path: '@straw-hat/openapi-web-sdk-generator/dist/generators/react-query-fetcher/index.js'
    config:
      outputDir: 'src/lib/services/flashbot-api/react-query'
      packageName: '../operations'

And the package.json

{
  "packageManager": "[email protected]",
  "engines": {
    "node": "20.x"
  },
  "type": "module",
  "scripts": {
    "codegen:sdk": "sht-openapi-web-sdk-generator local --config='./openapi.json'"
  }
}

When I do DEBUG=* yarn codegen:sdk, I get the following outcome:

  @straw-hat/openapi-web-sdk-generator:helpers Configuration file /Users/ubi/Developer/myapp/.openapi-web-sdk-generatorrc.yaml loaded +0ms
  @straw-hat/openapi-web-sdk-generator:open-api-web-sdk-generator Loading Generator: @straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js +0ms
  import-from-esm Executing importFrom('/Users/ubi/Developer/myapp', '@straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js') +0ms
  import-from-esm '@straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js' is not a file module +0ms
  import-from-esm Trying to resolve '@straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js' from 'file:///Users/ubi/Developer/myapp/noop.js' +0ms
  import-from-esm Failed to resolve '@straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js' from 'file:///Users/ubi/Developer/myapp/noop.js': Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@straw-hat/openapi-web-sdk-generator' imported from /Users/ubi/Developer/myapp/noop.js +1ms
  import-from-esm Trying to resolve '@straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js.js' from 'file:///Users/ubi/Developer/myapp/noop.js' +0ms
  import-from-esm Failed to resolve '@straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js.js' from 'file:///Users/ubi/Developer/myapp/noop.js': Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@straw-hat/openapi-web-sdk-generator' imported from /Users/ubi/Developer/myapp/noop.js +1ms
  import-from-esm Trying to resolve '@straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js.mjs' from 'file:///Users/ubi/Developer/myapp/noop.js' +0ms
  import-from-esm Failed to resolve '@straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js.mjs' from 'file:///Users/ubi/Developer/myapp/noop.js': Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@straw-hat/openapi-web-sdk-generator' imported from /Users/ubi/Developer/myapp/noop.js +0ms
  import-from-esm Trying to resolve '@straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js.cjs' from 'file:///Users/ubi/Developer/myapp/noop.js' +0ms
  import-from-esm Failed to resolve '@straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js.cjs' from 'file:///Users/ubi/Developer/myapp/noop.js': Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@straw-hat/openapi-web-sdk-generator' imported from /Users/ubi/Developer/myapp/noop.js +0ms
  import-from-esm Trying to resolve '@straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js.json' from 'file:///Users/ubi/Developer/myapp/noop.js' +0ms
  import-from-esm Failed to resolve '@straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js.json' from 'file:///Users/ubi/Developer/myapp/noop.js': Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@straw-hat/openapi-web-sdk-generator' imported from /Users/ubi/Developer/myapp/noop.js +1ms
  import-from-esm Cannot find module '@straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js' +0ms
    Error: Failed to load configuration file @straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js.
    Cannot find module '@straw-hat/openapi-web-sdk-generator/dist/generators/fetcher/index.js'

If I change the linker to node-modules then it works just fine, so something is broken using pnp linker and this package.

Any thoughts?!

A good way to test import-from-esm alignment with require's specs would be to validate its outcome against require's outcome using the same parameters (only ignoring ERR_REQUIRED_ESM errors from require).

This library is intended to be an almost drop-in replacement of sindresorhus/import-from (from which it is forked) that supports loading ESM & CJS modules like require() does.

Since import-from uses createRequire() under the hood, it throws the ERR_REQUIRE_ESM error when trying to import a pure ESM module.

The Node.js modules documentation states:

Due to the synchronous nature of require(), it is not possible to use it to load ECMAScript module files. Attempting to do so will throw a ERR_REQUIRE_ESM error. Use import() instead.

Switching from require() to a dynamic import() has a lot of implications, but these are the ones I encountered issues with:

• import() is asynchronous,
• file extensions must be specified for relative path,
• "dependencies (without an explicit path) for a given module are searched for relative to the module loading them" (source).

This library will provide a module loading strategy as close to CJS' as possible, as well as work around the above issues (except the first one, nothing can be done about this).

It's only breaking change from import-from should be adding an await in front of the importFrom() calls, and a .default when importing default exports.

Resources

• CommonJS module resolution strategy: https://nodejs.org/api/modules.html#all-together
• https://www.npmjs.com/package/import-meta-resolve

When an import throws an invalid module type for the file extension as follows:

This file is being treated as an ES module because it has a '.js' file extension and '/home/sherlox/workspace/OPENSOURCE/IMPORT_FROM/import-from-esm-repro-1/package.json' contains "type": "module". To treat it as a CommonJS script, rename it to use the '.cjs' file extension.

the error is caught by import-from-esm, which then throws the generic Cannot find module error message.

import-from-esm should not obfuscate this message, so the end user can understand the real cause of the issue.

Currently, the only way to see this error is by using DEBUG=import-from-esm.

Steps to reproduce:

npm install
cd playground/
npm install
npx semantic-release

Reproduction repo

Description

Add the ability to import an NPM package that contains an index.json file or has a main field pointing to a JSON file.

References

• semantic-release/commit-analyzer#537 (comment)
• semantic-release/semantic-release#3037 (comment)
• sheerlox/semantic-release@4009af3
• https://github.com/semantic-release/semantic-release/blob/02f2cb1c8b0e33b9ed3d7c27038423be61f7a7e0/test/get-config.test.js#L323-L347

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• ci(action): update actions/checkout digest to a5ac7e5
• ci(action): update actions/download-artifact digest to 65a9edc
• ci(action): update actions/upload-artifact digest to 6546280
• ci(action): update actions/setup-node action to v4.0.2
• ci(action): update github/codeql-action action to v3.25.8
• ci(action): update ossf/scorecard-action action to v2.3.3
• chore(deps): update dependency xo to v0.58.0
• ci(action): update actions/checkout action to v4.1.6
• ci(action): update actions/download-artifact action to v4.1.7
• ci(action): update actions/upload-artifact action to v4.3.3
• ci(action): update sonarsource/sonarcloud-github-action action to v2.2.0
• ci(action): update step-security/harden-runner action to v2.8.0
• chore(deps): update dependency knip to v5
• chore(deps): update dependency semantic-release to v24
• chore(deps): lock file maintenance
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• chore(deps): update dependency ava to v6

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

As in Case 2 in semantic-release/commit-analyzer#589, import-from-esm does not seem to resolve exports in package.json correctly.

Case 2

It's about my contribution semantic-release/commit-analyzer#588. Perform the following steps on latest master branch:

npm i [email protected] -D

Add the new test/presets.test.js

import test from "ava";
import { stub } from "sinon";
import { analyzeCommits } from "../index.js";

const cwd = process.cwd();

test.beforeEach((t) => {
  const log = stub();
  t.context.log = log;
  t.context.logger = { log };
});

test('Accept "preset" option', async (t) => {
  const commits = [
    { hash: "123", message: "Fix: First fix (fixes #123)" },
    { hash: "456", message: "Update: Second feature (fixes #456)" },
  ];
  const releaseType = await analyzeCommits({ preset: "techor" }, { cwd, commits, logger: t.context.logger });

  t.is(releaseType, null);
});

npm test

> Cannot find module 'conventional-changelog-techor'

If I remove the "exports": { ... }" section from "node_modules/conventional-changelog-techor/package.json", it will work.

So this is a problem with import-from-esm itself, regardless of whether it is a monorepo or not.

When I change import-from-esm back to import-from everything still works. This means that the changes in v11.1 did not include tests for the new functionality (#537), and these tests would have failed before v11.1. Changes add a lot of uncertainty.

Ran into an issue when using semantic-release with a shared config (CommonJS) using subpaths.

With a destination package @example/package/subpath, assuming the target file in the package @example/package exists in ./subpath/index.js, I get something like the following:

import-from-esm Trying to resolve '@example/package/subpath' from 'file:///Users/lukiffer/.npm/_npx/db57d9b03a028fc5/node_modules/semantic-release/lib/noop.js' +0ms
  import-from-esm Failed to resolve '@example/package/subpath' from 'file:///Users/lukiffer/.npm/_npx/db57d9b03a028fc5/node_modules/semantic-release/lib/noop.js': Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@example/package' imported from /Users/lukiffer/.npm/_npx/db57d9b03a028fc5/node_modules/semantic-release/lib/noop.js +0ms

If I instead move and rename the target file from ./subpath/index.js to ./subpath.cjs this works as expected.

I'm not sure if this is something that import-from previously masked or if ./subpath/index.js should actually be checked, and if so why it's failing to find the root package.