assertNoDuplicates throw with more context

[hjdivad]

Q	A
Fixed Issues?	Fixes #9778
Patch: Bug Fix?	No
Major: Breaking Change?	No
Minor: New Feature?	Yes
Tests Added + Pass?	Yes
Documentation PR Link	N/A
Any Dependency Changes?	No
License	MIT

When users see errors like

Duplicate plugin/preset detected.
If you'd like to use two separate instances of a plugin,
they need separate names, e.g.

  plugins: [
    ['some-plugin', {}],
    ['some-plugin', {}, 'some unique name'],
  ]

It can be difficult to determine the source of the conflict, especially
in a larger build system.

This commit outputs what is known about the plugins that actually
conflict, which can be helpful for users to determine the root cause of
the conflict.

New example output on conflict:

Duplicate plugin/preset detected.
If you'd like to use two separate instances of a plugin,
they need separate names, e.g.

  plugins: [
    ['some-plugin', {}],
    ['some-plugin', {}, 'some unique name'],
  ]

Duplicates detected are:
[
      "root": "/Users/dhamilto/src/linkedin/ember-cli-pemberly-m3",
      "name": "ember-m3"
    },
    "dirname": "/Users/dhamilto/src/linkedin/ember-cli-pemberly-m3",
    "ownPass": false,
    "file": {
      "request": "/Users/dhamilto/src/linkedin/ember-cli-pemberly-m3/node_modules/ember-compatibilit
y-helpers/comparision-plugin.js",
      "resolved": "/Users/dhamilto/src/linkedin/ember-cli-pemberly-m3/node_modules/ember-compatibili
ty-helpers/comparision-plugin.js"
    }
  },
  {
    "alias": "/Users/dhamilto/src/linkedin/ember-cli-pemberly-m3/node_modules/ember-compatibility-he
y-helpers/comparision-plugin.js",
      "resolved": "/Users/dhamilto/src/linkedin/ember-cli-pemberly-m3/node_modules/ember-compatibili
ty-helpers/comparision-plugin.js"
    }
  }
]

Partially addresses #9778

[hjdivad]

Note that this commit only outputs the conflicts that triggered a particular assertion.

It could in principle output all conflicts, but I'd be concerned about the output getting too large.

[rwjblue]

Thanks for working on this @hjdivad! Debugging these errors is quite hard (since it contains no context on which plugins/presets were causing the issue), with these changes we can have a bit more of a fighting chance....

[babel-bot]

Build successful! You can test your changes in the REPL here: https://babeljs.io/repl/build/11526/

[babel-bot]

Build successful! You can test your changes in the REPL here: https://babeljs.io/repl/build/11526/

[nicolo-ribaudo]

What does it throw if you don't specify the my-plugin name here?

[hjdivad]

@nicolo-ribaudo the example output in the pr is a case where no name is specified. Because I'm serializing it with JSON.stringify you don't see the name key in the output at all.

The output for this test is:

      Duplicate plugin/preset detected.
      If you'd like to use two separate instances of a plugin,
      they need separate names, e.g.

        plugins: [
          ['some-plugin', {}],
          ['some-plugin', {}, 'some unique name'],
        ]

      Duplicates detected are:
      [
        {
          "name": "my-plugin",
          "alias": "base$0",
          "dirname": "/Users/dhamilto/src/babel/babel/packages/babel-core/test",
          "ownPass": false
        },
        {
          "name": "my-plugin",
          "alias": "base$1",
          "dirname": "/Users/dhamilto/src/babel/babel/packages/babel-core/test",
          "ownPass": false
        }
      ]

With the name omitted, the output becomes:

      Duplicate plugin/preset detected.
      If you'd like to use two separate instances of a plugin,
      they need separate names, e.g.

        plugins: [
          ['some-plugin', {}],
          ['some-plugin', {}, 'some unique name'],
        ]

      Duplicates detected are:
      [
        {
          "alias": "base$0",
          "dirname": "/Users/dhamilto/src/babel/babel/packages/babel-core/test",
          "ownPass": false
        },
        {
          "alias": "base$1",
          "dirname": "/Users/dhamilto/src/babel/babel/packages/babel-core/test",
          "ownPass": false
        }
      ]

[rwjblue]

Any thoughts on this one? Not sure what the process itself is to move forward here...

[rwjblue]

@nicolo-ribaudo - 👋 I'd love some progress here, we are often times getting bug reports for the current error that require us to manually throw a console.log into node_modules/@babel/core/lib/config/config-descriptors.js to see any useful information.

[hzoo]

This is great and sorely needed! thanks @hjdivad and @rwjblue - we just merged a something one regarding filenames #10511