nodejs / nodejs/node

import(cjs) and require(cjs) share a cache

Ouverte
#49,453 7 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
JavaScript
Étoiles
122k
Forks
37.3k
Merge moyen
4 j 2 h
PR mergées (30 j)
283

Description

Hiya! 👋

This might very well be on purpose, and if so feel free to close this issue.

For background, I'm currently working on ESM support in Jest. We implement our own resolution and module loading (including caching), so I'm writing some tests to try to make sure our semantics matches node's semantics.

I wrote the following test:

// stateful.cjs
'use strict';

let num = 0;

module.exports = function inc() {
  num++;
  return num;
};
// test.mjs
import * as assert from 'assert';
import {createRequire} from 'module';

async function main() {
  const require = createRequire(import.meta.url);

  const requiredStateful = require('./stateful.cjs');
  // delete require.cache[require.resolve('./stateful.cjs')];
  const {default: importedStateful} = await import('./stateful.cjs');

  assert.equal(importedStateful(), 1);
  assert.equal(importedStateful(), 2);
  assert.equal(requiredStateful(), 1);
  assert.equal(importedStateful(), 3);
  assert.equal(requiredStateful(), 2);
  assert.equal(requiredStateful(), 3);
}

main().catch(err => {
  process.exitCode = 1;

  console.error(err);
});

However, this test fails because the numbers are 1, 2, 3, 4, 5, 6, e.g. they share the same module rather than having their own.

I assumed that the module cache of require and import() would not be shared, based on

require.cache is not used by import. It has a separate cache.

From https://nodejs.org/api/esm.html#esm_no_require_cache

Note that if I swap the order from require then import to import then require (and uncomment the delete), the test behaves like I expect.

So doing import(cjs) populates require.cache which means require(cjs) loads the cached module, and require(cjs) populates the cache so import(cjs) reads it, but doing delete require.cache only affect require, not import.

If import populates and reads from require.cache, I'd expect it do respect deletions from that same property. What I would expect from reading the docs is that import would neither populate nor read from require.cache.

I ran these tests with no flags, using node v13.12.0.


Again, this might be expected behavior, and if so I'd be happy to provide a PR with a docs change specifying this. As a user I find it quite confusing, though

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la section de la documentation ESM consacrée au cache require.cache distinct et reproduisez les exemples test.mjs et stateful.cjs de l’issue avec une version actuelle de Node.js. Confirmez la relation observée entre import(), require() et require.cache, puis documentez le comportement attendu et la sémantique de suppression si ce comportement est bien celui attendu.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript, node.js
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
48/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.