From 38023ae743cd33926a9bd38c24630debe0711ad8 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Sun, 22 Dec 2024 11:41:11 +0100
Subject: [PATCH] cli: update alpha entry to support dynamic imports

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
---
 packages/cli/src/alpha.ts                 |  2 +-
 packages/cli/src/modules/config/alpha.ts  |  2 +-
 packages/cli/src/modules/config/index.ts  |  8 +++---
 packages/cli/src/wiring/CliInitializer.ts | 32 ++++++++++++++++++++---
 4 files changed, 35 insertions(+), 9 deletions(-)

diff --git a/packages/cli/src/alpha.ts b/packages/cli/src/alpha.ts
index 4b2cfa4842..f6cd2157ae 100644
--- a/packages/cli/src/alpha.ts
+++ b/packages/cli/src/alpha.ts
@@ -24,6 +24,6 @@ import chalk from 'chalk';
     ),
   );
   const initializer = new CliInitializer();
-  initializer.add(import('./modules/config/alpha').then(m => m.default));
+  initializer.add(import('./modules/config/alpha'));
   await initializer.run();
 })();
diff --git a/packages/cli/src/modules/config/alpha.ts b/packages/cli/src/modules/config/alpha.ts
index c32982086a..9ce6080a4a 100644
--- a/packages/cli/src/modules/config/alpha.ts
+++ b/packages/cli/src/modules/config/alpha.ts
@@ -32,7 +32,7 @@ export default createCliPlugin({
             'Only include the schema that applies to the given package',
           )
           .description('Browse the configuration reference documentation')
-          .action(lazy(() => import('./commands/docs').then(m => m.default)));
+          .action(lazy(() => import('./commands/docs'), 'default'));
 
         await defaultCommand.parseAsync(args, { from: 'user' });
       },
diff --git a/packages/cli/src/modules/config/index.ts b/packages/cli/src/modules/config/index.ts
index 0c6a79577d..a1436d0c21 100644
--- a/packages/cli/src/modules/config/index.ts
+++ b/packages/cli/src/modules/config/index.ts
@@ -32,7 +32,7 @@ export function registerCommands(program: Command) {
       'Only include the schema that applies to the given package',
     )
     .description('Browse the configuration reference documentation')
-    .action(lazy(() => import('./commands/docs').then(m => m.default)));
+    .action(lazy(() => import('./commands/docs'), 'default'));
 
   program
     .command('config:print')
@@ -49,7 +49,7 @@ export function registerCommands(program: Command) {
     )
     .option(...configOption)
     .description('Print the app configuration for the current package')
-    .action(lazy(() => import('./commands/print').then(m => m.default)));
+    .action(lazy(() => import('./commands/print'), 'default'));
 
   program
     .command('config:check')
@@ -68,7 +68,7 @@ export function registerCommands(program: Command) {
     .description(
       'Validate that the given configuration loads and matches schema',
     )
-    .action(lazy(() => import('./commands/validate').then(m => m.default)));
+    .action(lazy(() => import('./commands/validate'), 'default'));
 
   program
     .command('config:schema')
@@ -83,5 +83,5 @@ export function registerCommands(program: Command) {
     .option('--merge', 'Print the config schemas merged', true)
     .option('--no-merge', 'Print the config schemas not merged')
     .description('Print configuration schema')
-    .action(lazy(() => import('./commands/schema').then(m => m.default)));
+    .action(lazy(() => import('./commands/schema'), 'default'));
 }
diff --git a/packages/cli/src/wiring/CliInitializer.ts b/packages/cli/src/wiring/CliInitializer.ts
index 9fe8bb8084..5acb88151f 100644
--- a/packages/cli/src/wiring/CliInitializer.ts
+++ b/packages/cli/src/wiring/CliInitializer.ts
@@ -22,16 +22,23 @@ import { version } from '../lib/version';
 import chalk from 'chalk';
 import { exitWithError } from '../lib/errors';
 import { assertError } from '@backstage/errors';
+import { isPromise } from 'util/types';
 
-type UninitializedFeature = CliFeature | Promise<CliFeature>;
+type UninitializedFeature = CliFeature | Promise<{ default: CliFeature }>;
 
 export class CliInitializer {
   private graph = new CommandGraph();
   private commandRegistry = new CommandRegistry(this.graph);
   #uninitiazedFeatures: Promise<CliFeature>[] = [];
 
-  add(module: UninitializedFeature) {
-    this.#uninitiazedFeatures.push(Promise.resolve(module));
+  add(feature: UninitializedFeature) {
+    if (isPromise(feature)) {
+      this.#uninitiazedFeatures.push(
+        feature.then(f => unwrapFeature(f.default)),
+      );
+    } else {
+      this.#uninitiazedFeatures.push(Promise.resolve(feature));
+    }
   }
 
   async #register(feature: CliFeature) {
@@ -136,3 +143,22 @@ function isCliPlugin(feature: CliFeature): feature is InternalCliPlugin {
   // Backwards compatibility for v1 registrations that use duck typing
   return 'plugin' in internal;
 }
+
+/** @internal */
+export function unwrapFeature(
+  feature: CliFeature | { default: CliFeature },
+): CliFeature {
+  if ('$$type' in feature) {
+    return feature;
+  }
+
+  // This is a workaround where default exports get transpiled to `exports['default'] = ...`
+  // in CommonJS modules, which in turn results in a double `{ default: { default: ... } }` nesting
+  // when importing using a dynamic import.
+  // TODO: This is a broader issue than just this piece of code, and should move away from CommonJS.
+  if ('default' in feature) {
+    return feature.default;
+  }
+
+  return feature;
+}