feat: add cnpm to corepack #333

elrrrrrrr · 2023-12-05T15:59:16Z

add cnpm to corepack, closes #331

✍️ update config.json and add registry information for cnpm.
~~🪝 Add a post-install hook to install cnpm-related dependencies.~~

Fixes: #331

aduh95 · 2023-12-05T17:58:51Z

2. 🪝 Add a post-install hook to install cnpm-related dependencies.

Could it be possible to drop that and download ready-to-be-used code instead?

config.json

sources/corepackUtils.ts

> 修改构建配置，将 cnpm 运行依赖进行 bundle 处理，see nodejs/corepack#333 1. 期望 cnpm 能直接集成在 corepack 中作为 nodejs 预置的包管理器 2. 目前其他 pnpm、npm 和 yarn 都会做 bundle 处理，cnpm 由于集成了 npm，只能继续使用 bundleDeps 的方式打包 corepack 通过 tgz 进行分发，没有时机执行相关依赖安装。尝试过两种方式进行 bundle: 1. ❎ 通过 esbuild，无法处理 require.resolve npm 的场景，考虑到依赖稳定性需要将 npm 一并 bundle 2. ✅ 通过 bundleDeps 配置两种方式都需要通过 `npm` mode 进行安装目前 bundle 后 tgz 体积为 `8.7M`，和 pnpm，yarn 相比差距较大 (~2M)

.gitignore

aduh95

You probably want to update sync.yml so the version of cnpm in config.json stays up-to-date

tests/main.test.ts

elrrrrrrr · 2023-12-14T11:19:28Z

Just a gentle ping 🙏🏻 @aduh95 @arcanis @merceyz
If there's anything more needed from my side, please let me know.
Eagerly awaiting your feedback

.github/workflows/sync.yml

sources/nodeUtils.ts

tests/main.test.ts

anonrig · 2023-12-14T13:11:55Z

cc @nodejs/security-wg

legendecas

I confirm that cnpm is a helpful alternative to npm in China where registry.npmjs.org may be hardly reachable for common users. https://registry.npmmirror.com is a mirror of registry.npmjs.org for users based in China to get better access to npm packages.

It would definitely help users get started with Node.js and install npm dependencies in China.

I support adding cnpm and npmmirror.com to corepack.

Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>

tests/main.test.ts

joyeecheung · 2023-12-14T17:17:34Z

Can't review the code per-se myself, but I can also confirm that cnpm is a trust-worthy alternative primarily sponsored by Alibaba to help Node.js developers in China work around the network issues in the public network in China & create private registries within a company.

config.json

Co-authored-by: Kristoffer K. <merceyz@users.noreply.github.com>

arcanis · 2023-12-15T09:38:38Z

I'm not familiar with cnpm, so couple of questions:

What makes cnpm more useful than setting a custom registry in one's configuration? Why does a whole package manager need to be built around that (rather than configure the local mirror)?
Does it mean that the cnpm default registry is subject to local CN legislation? Is it potentially a problem to provide that in the default Node.js installs (note that I'd have the same question if we were to change, say, pnpm to a EU mirror)?
Is it a wrapper around npm with a different registry? I see you implemented a similar install strategy as pnpm; are there other differencies?

elrrrrrrr · 2023-12-15T16:00:49Z

@arcanis

Thank you for your interest and questions about cnpm. I am pleased to provide you with the following clarifications:

Why does a whole package manager need to be built around

Indeed, we offer a complete read-only mirror service capability. Developers can directly configure the registry address and use yarn, pnpm, or any package manager of their choice. However, we still provide an independent client, mainly to handle the following scenarios:

Binary Mirror: We implement a binary mirror, as detailed at https://github.com/cnpm/binary-mirror-config, to accelerate the download of binary files, such as Puppeteer ([Bug]: Compatibility issues with PUPPETEER_DOWNLOAD_HOST puppeteer/puppeteer#10131). All binaries
npminstall protocol: The npminstall protocol has evolved over time and now has several different versions. It is still under maintenance. Additionally, we are compatible with the npm mode and npm-generated package-lock.json by default.

Does it mean that the cnpm default registry is subject to local CN legislation

Like all websites accessible within China, cnpm aligns with the country's internet and data regulations. For over 10 years, it has been reliably serving users while adhering to Mainland China's regulatory requirements. This compliance ensures that cnpm's default registry undergoes thorough network filing and security scanning, aligning with local policy standards. Our commitment is to provide reliable and compliant services to developers, not just in China but globally, always mindful of the legal nuances in different regions.

Are there other differencies?

cnpm includes npm to ensure maximum compatibility. In the corporate environment, we also offer some extended capabilities. We continue to advance related open-source work, including:

Providing faster dependency resolution. Changes on the registry side have been released, allowing the registry to directly parse semver expressions: https://registry.npmmirror.com/node/>=16 < 20
Offering the fastest dependency installer, rapid, available at https://github.com/cnpm/rapid. (currently beta)
Installing custom node runtime environments for projects through the package manager.

These features, in addition to changes on the registry side, also require client-side adaptation.

Please let me know if you have any further questions or need more information. 🙏🏻

aladdin-add · 2024-02-01T02:53:49Z

Whether or not to support setting registry to https://registry.npmmirror.com/ when not using cnpm?

aduh95 · 2024-02-12T23:07:28Z

config.json

+              "versions": "versions",
+              "tags": "dist-tags"
+            }
+          }


We should probably provide mentioned for the npm package, see #339

Suggested change

}

},

"npmRegistry": {

"type": "npm",

"package": "cnpm"

},

aduh95 · 2024-02-12T23:07:56Z

sources/types.ts

  Npm = `npm`,
  Pnpm = `pnpm`,
  Yarn = `yarn`,
+  Cnpm = `cnpm`,


nit: ASCII/alphabetical order

Suggested change

Npm = `npm`,

Pnpm = `pnpm`,

Yarn = `yarn`,

Cnpm = `cnpm`,

Cnpm = `cnpm`,

Npm = `npm`,

Pnpm = `pnpm`,

Yarn = `yarn`,

elrrrrrrr changed the title ~~add support for cnpm~~ feat: add cnpm to corepack Dec 5, 2023

aduh95 reviewed Dec 5, 2023

View reviewed changes

config.json Outdated Show resolved Hide resolved

merceyz requested changes Dec 5, 2023

View reviewed changes

sources/corepackUtils.ts Outdated Show resolved Hide resolved

sources/corepackUtils.ts Outdated Show resolved Hide resolved

elrrrrrrr mentioned this pull request Dec 6, 2023

feat: bundle deps of cnpm cnpm/cnpm#428

Merged

elrrrrrrr force-pushed the cnpm branch from 4d7edbc to 447045d Compare December 6, 2023 16:13

aduh95 reviewed Dec 6, 2023

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

aduh95 reviewed Dec 6, 2023

View reviewed changes

elrrrrrrr force-pushed the cnpm branch 2 times, most recently from 229e83f to 966b3ec Compare December 7, 2023 11:40

aduh95 reviewed Dec 7, 2023

View reviewed changes

tests/main.test.ts Outdated Show resolved Hide resolved

aduh95 reviewed Dec 7, 2023

View reviewed changes

tests/main.test.ts Outdated Show resolved Hide resolved

feat: add cnpm

faaac09

elrrrrrrr force-pushed the cnpm branch from ce897e9 to faaac09 Compare December 7, 2023 14:55

chore: bump version

f281d19

elrrrrrrr force-pushed the cnpm branch 2 times, most recently from 0999d8b to 6856b78 Compare December 8, 2023 03:12

chore: ci

de5f2a6

elrrrrrrr force-pushed the cnpm branch from 6856b78 to de5f2a6 Compare December 8, 2023 07:00

update Nock files

b1a8d92

elrrrrrrr marked this pull request as ready for review December 8, 2023 14:42

elrrrrrrr requested review from arcanis, aduh95 and merceyz December 13, 2023 09:39

aduh95 reviewed Dec 14, 2023

View reviewed changes

.github/workflows/sync.yml Outdated Show resolved Hide resolved

anonrig reviewed Dec 14, 2023

View reviewed changes

sources/nodeUtils.ts Outdated Show resolved Hide resolved

tests/main.test.ts Show resolved Hide resolved

legendecas approved these changes Dec 14, 2023

View reviewed changes

elrrrrrrr and others added 5 commits December 14, 2023 21:39

Update .github/workflows/sync.yml

e3bc1c5

Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>

Update sources/nodeUtils.ts

4af1855

Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>

Update tests/main.test.ts

b994028

Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>

update Nock files

160dcd3

Update tests/main.test.ts

2162567

Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>

aduh95 reviewed Dec 14, 2023

View reviewed changes

tests/main.test.ts Outdated Show resolved Hide resolved

revert Update tests/main.test.ts

dd8f8a4

merceyz reviewed Dec 14, 2023

View reviewed changes

config.json Outdated Show resolved Hide resolved

Update config.json

8ac771a

Co-authored-by: Kristoffer K. <merceyz@users.noreply.github.com>

MylesBorins mentioned this pull request Jan 11, 2024

enable corepack by default nodejs/node#50963

Open

aduh95 approved these changes Jan 31, 2024

View reviewed changes

aduh95 mentioned this pull request Jan 31, 2024

[WIP] Add support for bun #307

Open

Merge branch 'main' of https://github.com/nodejs/corepack

f3de099

aduh95 reviewed Feb 12, 2024

View reviewed changes

darcyclarke mentioned this pull request Feb 29, 2024

build: enable yarn and pnpm Corepack binaries by default nodejs/node#51886

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add cnpm to corepack #333

feat: add cnpm to corepack #333

elrrrrrrr commented Dec 5, 2023 •

edited by aduh95

aduh95 commented Dec 5, 2023

aduh95 left a comment

elrrrrrrr commented Dec 14, 2023

anonrig commented Dec 14, 2023

legendecas left a comment

joyeecheung commented Dec 14, 2023 •

edited

arcanis commented Dec 15, 2023 •

edited

elrrrrrrr commented Dec 15, 2023 •

edited

aladdin-add commented Feb 1, 2024

aduh95 Feb 12, 2024

aduh95 Feb 12, 2024

-          }
+          },
+          "npmRegistry": {
+            "type": "npm",
+            "package": "cnpm"
+          },

feat: add cnpm to corepack #333

Are you sure you want to change the base?

feat: add cnpm to corepack #333

Conversation

elrrrrrrr commented Dec 5, 2023 • edited by aduh95

aduh95 commented Dec 5, 2023

aduh95 left a comment

Choose a reason for hiding this comment

elrrrrrrr commented Dec 14, 2023

anonrig commented Dec 14, 2023

legendecas left a comment

Choose a reason for hiding this comment

joyeecheung commented Dec 14, 2023 • edited

arcanis commented Dec 15, 2023 • edited

elrrrrrrr commented Dec 15, 2023 • edited

aladdin-add commented Feb 1, 2024

aduh95 Feb 12, 2024

Choose a reason for hiding this comment

aduh95 Feb 12, 2024

Choose a reason for hiding this comment

elrrrrrrr commented Dec 5, 2023 •

edited by aduh95

joyeecheung commented Dec 14, 2023 •

edited

arcanis commented Dec 15, 2023 •

edited

elrrrrrrr commented Dec 15, 2023 •

edited