metro-runtime 0.84.1 → 0.84.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metro-runtime",
-  "version": "0.84.1",
+  "version": "0.84.3",
   "description": "🚇 Module required for evaluating Metro bundles.",
   "exports": {
     "./package.json": "./package.json",

package/src/modules/HMRClient.js

@@ -1,6 +1,7 @@
 "use strict";
 
 const EventEmitter = require("./vendor/eventemitter3");
+const HEARTBEAT_INTERVAL_MS = 20_000;
 const inject = ({ module: [id, code], sourceURL }) => {
   if (global.globalEvalWithSourceUrl) {
     global.globalEvalWithSourceUrl(code, sourceURL);
@@ -17,11 +18,13 @@ class HMRClient extends EventEmitter {
   _pendingUpdate = null;
   _queue = [];
   _state = "opening";
+  _heartbeatTimer = null;
   constructor(url) {
     super();
     this._ws = new global.WebSocket(url);
     this._ws.onopen = () => {
       this._state = "open";
+      this._startHeartbeat();
       this.emit("open");
       this._flushQueue();
     };
@@ -30,11 +33,14 @@ class HMRClient extends EventEmitter {
     };
     this._ws.onclose = (closeEvent) => {
       this._state = "closed";
+      this._stopHeartbeat();
       this.emit("close", closeEvent);
     };
     this._ws.onmessage = (message) => {
       const data = JSON.parse(String(message.data));
       switch (data.type) {
+        case "heartbeat":
+          break;
         case "bundle-registered":
           this.emit("bundle-registered");
           break;
@@ -45,7 +51,7 @@ class HMRClient extends EventEmitter {
           this.emit("update", data.body);
           break;
         case "update-done":
-          this.emit("update-done");
+          this.emit("update-done", data.body);
           break;
         case "error":
           this.emit("error", data.body);
@@ -88,6 +94,20 @@ class HMRClient extends EventEmitter {
     this._queue.forEach((message) => this.send(message));
     this._queue.length = 0;
   }
+  _startHeartbeat() {
+    this._stopHeartbeat();
+    this._heartbeatTimer = setInterval(() => {
+      if (this._state === "open") {
+        this._ws.send('{"type":"heartbeat"}');
+      }
+    }, HEARTBEAT_INTERVAL_MS);
+  }
+  _stopHeartbeat() {
+    if (this._heartbeatTimer != null) {
+      clearInterval(this._heartbeatTimer);
+      this._heartbeatTimer = null;
+    }
+  }
   enable() {
     this._isEnabled = true;
     const update = this._pendingUpdate;

package/src/modules/HMRClient.js.flow

@@ -15,6 +15,8 @@ import type {HmrMessage, HmrUpdate} from './types';
 
 const EventEmitter = require('./vendor/eventemitter3');
 
+const HEARTBEAT_INTERVAL_MS = 20_000;
+
 type SocketState = 'opening' | 'open' | 'closed';
 
 const inject = ({module: [id, code], sourceURL}: HmrModule) => {
@@ -39,6 +41,7 @@ class HMRClient extends EventEmitter {
   _queue: Array<string> = [];
   _state: SocketState = 'opening';
   _ws: WebSocket;
+  _heartbeatTimer: ?IntervalID = null;
 
   constructor(url: string) {
     super();
@@ -48,6 +51,7 @@ class HMRClient extends EventEmitter {
     this._ws = new global.WebSocket(url);
     this._ws.onopen = () => {
       this._state = 'open';
+      this._startHeartbeat();
       this.emit('open');
       this._flushQueue();
     };
@@ -56,12 +60,17 @@ class HMRClient extends EventEmitter {
     };
     this._ws.onclose = closeEvent => {
       this._state = 'closed';
+      this._stopHeartbeat();
       this.emit('close', closeEvent);
     };
     this._ws.onmessage = message => {
       const data: HmrMessage = JSON.parse(String(message.data));
 
       switch (data.type) {
+        case 'heartbeat':
+          // Not exposed to consumers
+          break;
+
         case 'bundle-registered':
           this.emit('bundle-registered');
           break;
@@ -75,7 +84,7 @@ class HMRClient extends EventEmitter {
           break;
 
         case 'update-done':
-          this.emit('update-done');
+          this.emit('update-done', data.body);
           break;
 
         case 'error':
@@ -123,6 +132,22 @@ class HMRClient extends EventEmitter {
     this._queue.length = 0;
   }
 
+  _startHeartbeat(): void {
+    this._stopHeartbeat();
+    this._heartbeatTimer = setInterval(() => {
+      if (this._state === 'open') {
+        this._ws.send('{"type":"heartbeat"}');
+      }
+    }, HEARTBEAT_INTERVAL_MS);
+  }
+
+  _stopHeartbeat(): void {
+    if (this._heartbeatTimer != null) {
+      clearInterval(this._heartbeatTimer);
+      this._heartbeatTimer = null;
+    }
+  }
+
   enable() {
     this._isEnabled = true;
     const update = this._pendingUpdate;

package/src/modules/types.d.ts

@@ -0,0 +1,104 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<117ae8d35a498c8c16f22a36d6ee14ef>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-runtime/src/modules/types.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+export type ModuleMap = ReadonlyArray<[number, string]>;
+export type Bundle = {
+  readonly modules: ModuleMap;
+  readonly post: string;
+  readonly pre: string;
+};
+export type DeltaBundle = {
+  readonly added: ModuleMap;
+  readonly modified: ModuleMap;
+  readonly deleted: ReadonlyArray<number>;
+};
+export type BundleVariant =
+  | Readonly<
+      Omit<Bundle, keyof {base: true; revisionId: string}> & {
+        base: true;
+        revisionId: string;
+      }
+    >
+  | Readonly<
+      Omit<DeltaBundle, keyof {base: false; revisionId: string}> & {
+        base: false;
+        revisionId: string;
+      }
+    >;
+export type BundleMetadata = {
+  readonly pre: number;
+  readonly post: number;
+  readonly modules: ReadonlyArray<[number, number]>;
+};
+export type FormattedError = {
+  readonly type: string;
+  readonly message: string;
+  readonly errors: Array<{description: string}>;
+};
+export type HmrModule = {
+  readonly module: [number, string];
+  readonly sourceMappingURL: string;
+  readonly sourceURL: string;
+};
+export type HmrUpdate = {
+  readonly added: ReadonlyArray<HmrModule>;
+  readonly deleted: ReadonlyArray<number>;
+  readonly isInitialUpdate: boolean;
+  readonly modified: ReadonlyArray<HmrModule>;
+  readonly revisionId: string;
+};
+export type HmrUpdateMessage = {
+  readonly type: 'update';
+  readonly body: HmrUpdate;
+};
+export type HmrErrorMessage = {
+  readonly type: 'error';
+  readonly body: FormattedError;
+};
+export type HmrClientMessage =
+  | {
+      readonly type: 'register-entrypoints';
+      readonly entryPoints: Array<string>;
+    }
+  | {
+      readonly type: 'log';
+      readonly level:
+        | 'trace'
+        | 'info'
+        | 'warn'
+        | 'log'
+        | 'group'
+        | 'groupCollapsed'
+        | 'groupEnd'
+        | 'debug';
+      readonly data: Array<unknown>;
+    }
+  | {readonly type: 'log-opt-in'}
+  | {readonly type: 'heartbeat'};
+export type HmrMessage =
+  | {readonly type: 'bundle-registered'}
+  | {
+      readonly type: 'update-start';
+      readonly body: {readonly isInitialUpdate: boolean};
+    }
+  | {
+      readonly type: 'update-done';
+      readonly body?: {readonly changeId?: string};
+    }
+  | HmrUpdateMessage
+  | HmrErrorMessage
+  | {readonly type: 'heartbeat'};

package/src/modules/types.js.flow

@@ -83,6 +83,9 @@ export type HmrClientMessage =
     }
   | {
       +type: 'log-opt-in',
+    }
+  | {
+      +type: 'heartbeat',
     };
 
 export type HmrMessage =
@@ -97,6 +100,10 @@ export type HmrMessage =
     }
   | {
       +type: 'update-done',
+      +body?: {+changeId?: string},
     }
   | HmrUpdateMessage
-  | HmrErrorMessage;
+  | HmrErrorMessage
+  | {
+      +type: 'heartbeat',
+    };