packages/community-cli-plugin/src/dev-server/loadCommunityMiddleware.js - main - githubmirror/react-native

packages/community-cli-plugin/src/dev-server/loadCommunityMiddleware.js

82 строки3 KB

Alex Hunt

Drop legacy cli-server-api reference in dev server (#57653)

25 июл 2026, 20:32

25 июл 2026, 20:3214c3bd8

/**
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @flow strict-local
 * @format
 */

import type {Server} from 'connect';
import type {TerminalReportableEvent} from 'metro';

type DevServerMiddlewareFactory = (params: {
  host?: string,
  port: number,
  watchFolders: ReadonlyArray<string>,
}) => {
  middleware: Server,
  websocketEndpoints: {[path: string]: ws$WebSocketServer},
  messageSocketEndpoint: {
    server: ws$WebSocketServer,
    broadcast: (
      method: string,
      params?: Record<string, unknown> | null,
    ) => void,
  },
  eventsSocketEndpoint: {
    server: ws$WebSocketServer,
    reportEvent: (event: TerminalReportableEvent) => void,
  },
  ...
};

// $FlowFixMe[incompatible-type]
const unusedStubWSServer: ws$WebSocketServer = {};
// $FlowFixMe[incompatible-type]
const unusedMiddlewareStub: Server = {};

// FIXME: Several features will break without community middleware
// (@react-native-community/cli-server-api) and should be migrated into core.
// e.g. used by packages/react-native/Libraries/Core/Devtools/:
// - /open-stack-frame
// - /open-url
// - /symbolicate
// e.g. used by ./isDevServerRunning.js:
// - /status
const communityMiddlewareFallback: DevServerMiddlewareFactory = () => ({
  middleware: unusedMiddlewareStub,
  websocketEndpoints: {},
  messageSocketEndpoint: {
    server: unusedStubWSServer,
    broadcast: (
      method: string,
      _params?: Record<string, unknown> | null,
    ): void => {},
  },
  eventsSocketEndpoint: {
    server: unusedStubWSServer,
    reportEvent: (event: TerminalReportableEvent) => {},
  },
});

/**
 * Attempt to load the `createDevServerMiddleware` factory from
 * `@react-native-community/cli` (an optional peer dependency). If it cannot be
 * found, return a factory that produces stub middleware instead.
 */
export default function loadCommunityMiddleware(): DevServerMiddlewareFactory {
  try {
    // `@react-native-community/cli` is an optional peer dependency of this
    // package, and should be a dev dependency of the host project (via the
    // community template's package.json).
    // $FlowFixMe[prop-missing]
    // $FlowFixMe[untyped-import]
    return require('@react-native-community/cli').createDevServerMiddleware;
  } catch {
    console.warn(`⚠️ Unable to find @react-native-community/cli.
Starting dev server without community middleware endpoints - some functionality may be broken.`);
    return communityMiddlewareFallback;
  }
}