feat: adb reverse interaction & run adb reverse by default (#824)

* feat: ivnert the reverse port CLI option * feat: run adb reverse by default * refactor: log adb reverse only in debug, more verbose logging * feat: add adb reverse interaction * fix: run adb reverse on watchRun when using rspack * test: align setupInteractions tests * refactor: use lowercase adb * chore: add changeset * refactor: run when bundling for Android * refactor: undo cli flag changes
callstack · Dec 16, 2024 · 8cf7cc3 · 8cf7cc3
1 parent 312108e
commit 8cf7cc3
Show file tree

Hide file tree

Showing 7 changed files with 96 additions and 22 deletions.
diff --git a/.changeset/smart-carrots-sneeze.md b/.changeset/smart-carrots-sneeze.md
@@ -0,0 +1,5 @@
+---
+"@callstack/repack": minor
+---
+
+Added `adb reverse` interaction & `adb reverse` command is now run by default when bundling for Android
diff --git a/packages/repack/src/commands/common/__tests__/setupInteractions.test.ts b/packages/repack/src/commands/common/__tests__/setupInteractions.test.ts
@@ -239,6 +239,7 @@ describe('setupInteractions', () => {
             onOpenDevTools: debuggerSupport ? jest.fn() : undefined,
             onOpenDevMenu() {},
             onReload() {},
+            onAdbReverse() {},
           },
           {
             logger: mockLogger,
@@ -261,6 +262,10 @@ describe('setupInteractions', () => {
         );
         expect(mockProcess.stdout.write).toHaveBeenNthCalledWith(
           4,
+          ' a: Run adb reverse\n'
+        );
+        expect(mockProcess.stdout.write).toHaveBeenNthCalledWith(
+          5,
           '\nPress Ctrl+c or Ctrl+z to quit the dev server\n\n'
         );
       });

diff --git a/packages/repack/src/commands/common/runAdbReverse.ts b/packages/repack/src/commands/common/runAdbReverse.ts
@@ -1,18 +1,35 @@
 import execa from 'execa';
 import type { Logger } from '../../types';
 
-export async function runAdbReverse(port: number, logger: Logger = console) {
+interface RunAdbReverseParams {
+  port: number;
+  verbose?: boolean;
+  logger?: Logger;
+}
+
+export async function runAdbReverse({
+  port,
+  verbose = false,
+  logger = console,
+}: RunAdbReverseParams) {
   const adbPath = process.env.ANDROID_HOME
     ? `${process.env.ANDROID_HOME}/platform-tools/adb`
     : 'adb';
   const command = `${adbPath} reverse tcp:${port} tcp:${port}`;
+  const info = JSON.stringify({ port, adbPath, command });
+
   try {
     await execa.command(command);
-    logger.info(`Successfully run: ${command}`);
+    if (verbose) {
+      logger.info('adb reverse success');
+    }
+    logger.debug(`adb reverse success: ${info}`);
   } catch (error) {
-    // Get just the error message
     const message =
       (error as Error).message.split('error:')[1] || (error as Error).message;
-    logger.warn(`Failed to run: ${command} - ${message.trim()}`);
+    if (verbose) {
+      logger.warn(`adb reverse failed: "${message.trim()}"`);
+    }
+    logger.debug(`adb reverse failed: "${message.trim()}" ${info}`);
   }
 }
diff --git a/packages/repack/src/commands/common/setupInteractions.ts b/packages/repack/src/commands/common/setupInteractions.ts
@@ -21,6 +21,7 @@ export function setupInteractions(
     onReload?: () => void;
     onOpenDevMenu?: () => void;
     onOpenDevTools?: () => void;
+    onAdbReverse?: () => void;
   },
   options?: {
     logger?: Logger;
@@ -92,6 +93,11 @@ export function setupInteractions(
       postPerformMessage: 'Opening debugger',
       helpName: 'Open debugger',
     },
+    a: {
+      action: handlers.onAdbReverse,
+      postPerformMessage: 'Running adb reverse',
+      helpName: 'Run adb reverse',
+    },
   };
 
   // use process.stdout for sync output at startup

diff --git a/packages/repack/src/commands/rspack/Compiler.ts b/packages/repack/src/commands/rspack/Compiler.ts
@@ -10,7 +10,12 @@ import type {
 import memfs from 'memfs';
 import type { Reporter } from '../../logging';
 import type { HMRMessageBody } from '../../types';
-import { adaptFilenameToPlatform, getEnvOptions, loadConfig } from '../common';
+import {
+  adaptFilenameToPlatform,
+  getEnvOptions,
+  loadConfig,
+  runAdbReverse,
+} from '../common';
 import { DEV_SERVER_ASSET_TYPES } from '../consts';
 import type { StartCliOptions } from '../types';
 import type { CompilerAsset, MultiWatching } from './types';
@@ -73,6 +78,12 @@ export class Compiler {
     this.compiler.hooks.watchRun.tap('repack:watch', () => {
       this.isCompilationInProgress = true;
       this.platforms.forEach((platform) => {
+        if (platform === 'android') {
+          void runAdbReverse({
+            port: this.cliOptions.arguments.start.port!,
+            logger: this.devServerContext.log,
+          });
+        }
         this.devServerContext.notifyBuildStart(platform);
       });
     });

diff --git a/packages/repack/src/commands/rspack/start.ts b/packages/repack/src/commands/rspack/start.ts
@@ -42,6 +42,13 @@ export async function start(
     args.config ?? args.webpackConfig
   );
   const { reversePort, ...restArgs } = args;
+
+  const serverProtocol = args.https ? 'https' : 'http';
+  const serverHost = args.host || DEFAULT_HOSTNAME;
+  const serverPort = args.port ?? DEFAULT_PORT;
+  const serverURL = `${serverProtocol}://${serverHost}:${serverPort}`;
+  const showHttpRequests = args.verbose || args.logRequests;
+
   const cliOptions: StartCliOptions = {
     config: {
       root: cliConfig.root,
@@ -50,7 +57,9 @@ export async function start(
       reactNativePath: cliConfig.reactNativePath,
     },
     command: 'start',
-    arguments: { start: { ...restArgs } },
+    arguments: {
+      start: { ...restArgs, host: serverHost, port: serverPort },
+    },
   };
 
   if (args.platform && !cliOptions.config.platforms.includes(args.platform)) {
@@ -76,11 +85,6 @@ export async function start(
   // @ts-ignore
   const compiler = new Compiler(cliOptions, reporter);
 
-  const serverHost = args.host || DEFAULT_HOSTNAME;
-  const serverPort = args.port ?? DEFAULT_PORT;
-  const serverURL = `${args.https === true ? 'https' : 'http'}://${serverHost}:${serverPort}`;
-  const showHttpRequests = args.verbose || args.logRequests;
-
   const { createServer } = await import('@callstack/repack-dev-server');
   const { start, stop } = await createServer({
     options: {
@@ -110,13 +114,24 @@ export async function start(
                 method: 'POST',
               });
             },
+            onAdbReverse() {
+              void runAdbReverse({
+                port: serverPort,
+                logger: ctx.log,
+                verbose: true,
+              });
+            },
           },
           { logger: ctx.log }
         );
       }
 
-      if (reversePort && args.port) {
-        void runAdbReverse(args.port, ctx.log);
+      if (
+        reversePort ||
+        args.platform === undefined ||
+        args.platform === 'android'
+      ) {
+        void runAdbReverse({ port: serverPort, logger: ctx.log });
       }
 
       compiler.setDevServerContext(ctx);

diff --git a/packages/repack/src/commands/webpack/start.ts b/packages/repack/src/commands/webpack/start.ts
@@ -41,6 +41,13 @@ export async function start(_: string[], config: Config, args: StartArguments) {
     args.config ?? args.webpackConfig
   );
   const { reversePort, ...restArgs } = args;
+
+  const serverProtocol = args.https ? 'https' : 'http';
+  const serverHost = args.host || DEFAULT_HOSTNAME;
+  const serverPort = args.port ?? DEFAULT_PORT;
+  const serverURL = `${serverProtocol}://${serverHost}:${serverPort}`;
+  const showHttpRequests = args.verbose || args.logRequests;
+
   const cliOptions: StartCliOptions = {
     config: {
       root: config.root,
@@ -49,7 +56,9 @@ export async function start(_: string[], config: Config, args: StartArguments) {
       reactNativePath: config.reactNativePath,
     },
     command: 'start',
-    arguments: { start: { ...restArgs } },
+    arguments: {
+      start: { ...restArgs, host: serverHost, port: serverPort },
+    },
   };
 
   if (args.platform && !cliOptions.config.platforms.includes(args.platform)) {
@@ -74,11 +83,6 @@ export async function start(_: string[], config: Config, args: StartArguments) {
 
   const compiler = new Compiler(cliOptions, reporter);
 
-  const serverHost = args.host || DEFAULT_HOSTNAME;
-  const serverPort = args.port ?? DEFAULT_PORT;
-  const serverURL = `${args.https === true ? 'https' : 'http'}://${serverHost}:${serverPort}`;
-  const showHttpRequests = args.verbose || args.logRequests;
-
   const { createServer } = await import('@callstack/repack-dev-server');
   const { start, stop } = await createServer({
     options: {
@@ -108,21 +112,32 @@ export async function start(_: string[], config: Config, args: StartArguments) {
                 method: 'POST',
               });
             },
+            onAdbReverse() {
+              void runAdbReverse({
+                port: serverPort,
+                logger: ctx.log,
+                verbose: true,
+              });
+            },
           },
           { logger: ctx.log }
         );
       }
 
-      if (reversePort && args.port) {
-        void runAdbReverse(args.port, ctx.log);
+      if (
+        reversePort ||
+        args.platform === undefined ||
+        args.platform === 'android'
+      ) {
+        void runAdbReverse({ port: serverPort, logger: ctx.log });
       }
 
       const lastStats: Record<string, webpack.StatsCompilation> = {};
 
       compiler.on('watchRun', ({ platform }) => {
         ctx.notifyBuildStart(platform);
         if (platform === 'android') {
-          void runAdbReverse(args.port ?? DEFAULT_PORT, ctx.log);
+          void runAdbReverse({ port: serverPort, logger: ctx.log });
         }
       });