rollup: replace problematic bitcoin dependency readable-stream

readable-stream has circular dependencies which cause inheriting a class which is still
undefined at that moment, resulting in a runtime error.

readable-stream is imported by @ledgerhq/hw-app-btc/src/hashPublicKey > ripemd160 > hash-base.
To fix the build, we replace it by stream which gets polyfilled by rollup-plugin-node-polyfills.
Note that stream and readable-stream are largely compatible and effectively the same code.
However, the stream polyfill used by rollup-plugin-node-polyfills is an older version which has
less problems with circular dependencies. The circular dependencies are currently being resolved
in readable-stream though and once merged (see nodejs/readable-stream#348)
the replacement should be removed or even turned around. Note that without the replacement, the
stream polyfill and readable-stream are both bundled, which is not desirable.

Note that the stream polyfill / older readable-stream version also has circular dependencies but
is able to run.

Other options tried to resolve this issue which didn't help were:
- Update readable-stream: the circular dependencies are still present in the current version of
  readable-stream. See nodejs/readable-stream#348 for progress on that
  issue getting resolved.
- Update rollup-plugin-node-polyfills dependencies and polyfills: While the plugin is not being
  updated and maintained anymore, there has been a recent pull request with updates:
  ionic-team/rollup-plugin-node-polyfills#14. This didn't help though.

Other options which have not been tried:
- Using @rollup/plugin-commonjs option dynamicRequireTargets: replicates the logic for dynamic
  requires and might fix problems with circular dynamic requires.
- rewrite imports as in rollup/rollup#1507 (comment):
  This is in the end similar to what we did.

Note that also re-ordering of the plugin order mitigated the issue of builds that fail to run,
however, still readable-stream has more circular dependencies than the stream polyfill and
therefore we keep this fix for now.
The re-ordering of plugins will be re-visited in a later change / commit.

Author: danimoh

rollup.config.js

@@ -43,6 +43,25 @@ function fixedEslint(options) {
     };
 }
 
+// function debugModuleDependencies(module) {
+//     return {
+//         name: 'debug-module-dependencies',
+//         writeBundle() {
+//             console.log(`\n\nDebug module dependencies for ${module}.`);
+//             const moduleIds = [...this.getModuleIds()].filter((id) => id.includes(module));
+//             console.log('Matched bundled module ids:', moduleIds);
+//             for (const moduleId of moduleIds) {
+//                 const moduleInfo = this.getModuleInfo(moduleId);
+//                 console.log('\n', {
+//                     id: moduleInfo.id,
+//                     importers: moduleInfo.importers,
+//                     dynamicImporters: moduleInfo.dynamicImporters,
+//                 });
+//             }
+//         },
+//     };
+// }
+
 // Hoist dependency imports for dynamic imports similar to rollup's dependency hoisting for regular imports
 // (see https://rollupjs.org/guide/en/#why-do-additional-imports-turn-up-in-my-entry-chunks-when-code-splitting) for
 // quicker loading of the dependencies. Note that rollup does not do this by default, as the execution order is not
@@ -126,6 +145,19 @@ export default (commandLineArgs) => {
         })),
         preserveEntrySignatures: 'allow-extension', // avoid rollup's additional facade chunk
         plugins: [
+            alias({
+                entries: {
+                    // replace readable-stream imported by @ledgerhq/hw-app-btc/src/hashPublicKey > ripemd160 >
+                    // hash-base by stream which gets polyfilled by rollup-plugin-node-polyfills. Note that stream and
+                    // readable-stream are largely compatible and effectively the same code. However, the stream
+                    // polyfill used by rollup-plugin-node-polyfills is an older version which has less problems with
+                    // circular dependencies. The circular dependencies are currently being resolved in readable-stream
+                    // though and once merged (see https://github.com/nodejs/readable-stream/issues/348), this alias
+                    // should be removed or even turned around. Note that without the replacement, the stream polyfill
+                    // and readable-stream are both bundled, which is not desirable.
+                    'readable-stream': 'stream',
+                },
+            }),
             fixedEslint({
                 throwOnError: isProduction,
             }),
@@ -153,6 +185,7 @@ export default (commandLineArgs) => {
                 ],
             }),
             hoistDynamicImportDependencies(),
+            // debugModuleDependencies('stream'),
         ],
         watch: {
             clearScreen: false,
@@ -200,20 +233,20 @@ export default (commandLineArgs) => {
             sourcemapPathTransform,
         },
         plugins: [
-            fixedEslint({
-                throwOnError: isProduction,
-            }),
-            typescript({
-                include: ['src/demo/**', 'src/lib/**'],
-                noEmitOnError: isProduction,
-            }),
             // typescript needs the import as specified to find the .d.ts file but for actual import we need .es.js file
             alias({
                 entries: {
                     '../../dist/low-level-api/low-level-api': '../low-level-api/low-level-api.es.js',
                     '../../dist/high-level-api/ledger-api': '../high-level-api/ledger-api.es.js',
                 },
             }),
+            fixedEslint({
+                throwOnError: isProduction,
+            }),
+            typescript({
+                include: ['src/demo/**', 'src/lib/**'],
+                noEmitOnError: isProduction,
+            }),
             resolve({
                 preferBuiltins: true, // don't touch imports of node builtins as these will be handled by nodePolyfills
             }),