Skip to content

[Bug?]: node: protocol is not supported in plugin factory require #5417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
1 task
JounQin opened this issue May 1, 2023 · 3 comments · Fixed by #5997
Closed
1 task

[Bug?]: node: protocol is not supported in plugin factory require #5417

JounQin opened this issue May 1, 2023 · 3 comments · Fixed by #5997
Labels
bug Something isn't working unreproducible This issue cannot be reproduced on master

Comments

@JounQin
Copy link

JounQin commented May 1, 2023

Self-service

  • I'd be willing to implement a fix

Describe the bug

UsageError: This plugin cannot access the package referenced via node:path which is neither a builtin, nor an exposed entry

To reproduce

const plugin = {
  name: 'plugin-prepare-script',
  factory:
    /**
     * @param {NodeJS.Require} require
     * @returns {import('@yarnpkg/core').Plugin<import('@yarnpkg/core').Hooks>} plugin
     */
    require => ({
      hooks: {
        afterAllInstalled(project) {
          console.log(require('node:path').resolve(project.cwd, 'package.json'))
        },
      },
    }),
}

module.exports = plugin

Environment

System:
    OS: macOS 13.4
    CPU: (10) arm64 Apple M1 Max
  Binaries:
    Node: 18.16.0 - ~/tmp/xfs-598d07fd/node
    Yarn: 3.5.0 - ~/tmp/xfs-598d07fd/yarn
    npm: 9.6.5 - ~/Library/Caches/fnm_multishells/56881_1682947631779/bin/npm

Additional context

No response
@JounQin JounQin added the bug Something isn't working label May 1, 2023
@yarnbot yarnbot added the unreproducible This issue cannot be reproduced on master label May 1, 2023
@yarnbot
Copy link
Collaborator

yarnbot commented May 1, 2023

We couldn't reproduce your issue (all the assertions passed on master).

rgischk pushed a commit to encoway/yarn-scripts-cache that referenced this issue Nov 2, 2023
Migrate to yarn 4
c08d569 
This branch does not yet work, I assume because there is a bug in @yarnpkg/builder. See these issues for details:
* yarnpkg/berry#5417
* yarnpkg/berry#5637
@adrian-gierakowski
Copy link

related issue: #5637

@adrian-gierakowski adrian-gierakowski mentioned this issue Apr 25, 2024
Merged
3 tasks
This was referenced Jun 26, 2024
Closed
Merged
github-merge-queue bot pushed a commit that referenced this issue Aug 25, 2024
@jkowalleck @arcanis
feat(builder): transform node: imports as needed (#6356)
b2f315f 
## What's the problem this PR addresses?

<!-- Describe the rationale of your PR. -->
<!-- Link all issues that it closes. (Closes/Resolves #xxxx.) -->

Yarn plugins used to be forbidden to import/require built-in modules
prefixed with `node:`.
see #6135
see #5417
Fixes #5637

The yarn plugin builder should be aware of this fact and produce bundled
code, that does not contain any `node:` prefixed import/require.

This is especially important when building plugins with 3rd party
dependencies, where the plugin author cannot "fix" the imports to yarn's
needs.

## How did you fix it?

<!-- A detailed description of your implementation. -->

I enabled the plugin-compiler to generate the plugin-code as needed:

I utilized the capability of `esbuild` to strip these `node:` prefixes
from import/require instructions.
Therefore, I added config options to the plugin build process to
instruct `esbuild` to do so.

This is a fix of the plugin builder, which enables plugin authors to
compile their work in a backwards-compatible way, so that the build
result is runnable in old/unpatched versions of yarn. Unpatched
regarding #5997

## Related

The #5997 tries to address the issue from the plugin-runtime side.
This would enable "broken" plugins to be runnable in all future/patched
versions of yarn-core.

## Additionally

This very PR aims to enable plugin authors to create plugins that are
runnable with unpatched versions of yarn-core.
It is considered a friction-free backwards-compatible solution on all
ends. Yet it does not replace #5997.


## Checklist

<!--- Don't worry if you miss something, chores are automatically
tested. -->
<!--- This checklist exists to help you remember doing the chores when
you submit a PR. -->
<!--- Put an `x` in all the boxes that apply. -->
- [x] I have read the [Contributing
Guide](https://yarnpkg.com/advanced/contributing).

<!-- See
https://yarnpkg.com/advanced/contributing#preparing-your-pr-to-be-released
for more details. -->
<!-- Check with `yarn version check` and fix with `yarn version check
-i` -->
- [x] I have set the packages that need to be released for my changes to
be effective.

<!-- The "Testing chores" workflow validates that your PR follows our
guidelines. -->
<!-- If it doesn't pass, click on it to see details as to what your PR
might be missing. -->
- [x] I will check that all automated PR checks pass before the PR gets
reviewed.

---------

Signed-off-by: Jan Kowalleck <[email protected]>
Co-authored-by: Maël Nison <[email protected]>
@jkowalleck
Copy link
Contributor

shoud be fixed via #6356
the next version of yarn plugin builder/bundler should include a feature that solves this behavior for you.

@merceyz merceyz linked a pull request Aug 25, 2024 that will close this issue
fix(core): determine if a module is a builtin using module.isBuiltin #5997
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working unreproducible This issue cannot be reproduced on master
Projects
None yet
Milestone
No milestone
4 participants
@adrian-gierakowski @jkowalleck @JounQin @yarnbot