nx 22.7.11 → 22.7.12

package/dist/src/utils/consume-messages-from-socket.js

@@ -1,56 +1,290 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MESSAGE_END_SEQ = void 0;
+exports.MessageFramingError = exports.DEFAULT_MAX_MESSAGE_SIZE = exports.MESSAGE_HEADER_PREFIX = void 0;
+exports.getMaxMessageSize = getMaxMessageSize;
+exports.frameHeader = frameHeader;
+exports.writeMessage = writeMessage;
 exports.consumeMessagesFromSocket = consumeMessagesFromSocket;
 exports.isJsonMessage = isJsonMessage;
+exports.describeMessage = describeMessage;
 exports.parseMessage = parseMessage;
-const string_decoder_1 = require("string_decoder");
 const v8_1 = require("v8");
-const VERY_END_CODE = 4;
-exports.MESSAGE_END_SEQ = 'NX_MSG_END' + String.fromCharCode(VERY_END_CODE);
-function consumeMessagesFromSocket(callback) {
-    let message = '';
-    const decoder = new string_decoder_1.StringDecoder('utf8');
-    return (data) => {
-        const chunk = decoder.write(data);
-        message += chunk;
-        // Check if accumulated message ends with MESSAGE_END_SEQ (not just the chunk)
-        // This handles TCP packet fragmentation where MESSAGE_END_SEQ may be split across packets
-        if (chunk.codePointAt(chunk.length - 1) === VERY_END_CODE &&
-            message.endsWith(exports.MESSAGE_END_SEQ)) {
-            // Remove the trailing MESSAGE_END_SEQ
-            const fullMessage = message.substring(0, message.length - exports.MESSAGE_END_SEQ.length);
-            // Server may send multiple messages in one chunk, so splitting by MESSAGE_END_SEQ
-            const messages = fullMessage.split(exports.MESSAGE_END_SEQ);
-            for (const splitMessage of messages) {
-                if (splitMessage) {
-                    callback(splitMessage);
+exports.MESSAGE_HEADER_PREFIX = 'NX_MSG_';
+const MESSAGE_HEADER_TERMINATOR = ':'.charCodeAt(0);
+const MESSAGE_HEADER_PREFIX_BYTES = Buffer.from(exports.MESSAGE_HEADER_PREFIX, 'ascii');
+// `Number.MAX_SAFE_INTEGER` is 16 digits, so a longer run of digits than that
+// is a desynchronized stream rather than a very large message.
+const MAX_HEADER_LENGTH = exports.MESSAGE_HEADER_PREFIX.length + 16 + 1;
+/**
+ * Ceiling on a single message, in bytes. Payloads are buffered outside the V8
+ * heap, so `--max-old-space-size` does not bound them and a peer that declares
+ * a huge length would otherwise be allowed to stream until the machine gives
+ * out. The default is four times the ~0.5GiB string ceiling that used to cap
+ * every message, so it clears any payload that previously worked or was meant
+ * to. Set `NX_MAX_MESSAGE_SIZE` to another byte count to change it, or to 0 to
+ * remove the ceiling. The daemon reads it from the env it was spawned with —
+ * clients do not reflect it (see DAEMON_ENV_VARS_EXCLUSIONS) — so changing it
+ * needs a daemon restart (`nx reset`).
+ */
+exports.DEFAULT_MAX_MESSAGE_SIZE = 2 * 1024 * 1024 * 1024;
+function getMaxMessageSize() {
+    const configured = process.env.NX_MAX_MESSAGE_SIZE;
+    if (configured === undefined || configured === '') {
+        return exports.DEFAULT_MAX_MESSAGE_SIZE;
+    }
+    const parsed = Number(configured);
+    if (!Number.isFinite(parsed) || parsed < 0) {
+        console.warn(`NX_MAX_MESSAGE_SIZE must be a non-negative number of bytes, but was "${configured}". Using the default of ${exports.DEFAULT_MAX_MESSAGE_SIZE}.`);
+        return exports.DEFAULT_MAX_MESSAGE_SIZE;
+    }
+    return parsed;
+}
+/**
+ * `nx reset` only helps while a daemon is enabled: it and its plugin workers keep the
+ * limit they were spawned with. Every other reader re-reads the env per invocation.
+ * Required lazily because the daemon client imports this module.
+ */
+function daemonHoldsItsOwnLimit() {
+    try {
+        return require('../daemon/client/client').daemonClient.enabled();
+    }
+    catch {
+        return true;
+    }
+}
+const ZERO = '0'.charCodeAt(0);
+const NINE = '9'.charCodeAt(0);
+function frameHeader(payloadLength) {
+    return Buffer.from(`${exports.MESSAGE_HEADER_PREFIX}${payloadLength}:`, 'ascii');
+}
+/**
+ * Writes a length-prefixed message. The header and payload are written
+ * separately so a large payload is never copied to prepend its header.
+ */
+function writeMessage(socket, payload, callback) {
+    socket.write(frameHeader(payload.length));
+    socket.write(payload, callback);
+}
+class MessageFramingError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'MessageFramingError';
+        Object.setPrototypeOf(this, MessageFramingError.prototype);
+    }
+}
+exports.MessageFramingError = MessageFramingError;
+function consumeMessagesFromSocket(callback, onError = (error) => {
+    console.error(error.message);
+}) {
+    let chunks = [];
+    let buffered = 0;
+    let expectedPayloadLength = null;
+    let broken = false;
+    // Read once per socket so a test or a caller can change it between
+    // connections without paying the lookup on every frame.
+    const maxMessageSize = getMaxMessageSize();
+    const fail = (message) => {
+        broken = true;
+        chunks = [];
+        buffered = 0;
+        expectedPayloadLength = null;
+        onError(new MessageFramingError(message));
+    };
+    // Copies at most `length` leading bytes without collapsing the chunk list.
+    const peek = (length) => {
+        const size = Math.min(length, buffered);
+        if (chunks.length === 1) {
+            return chunks[0].subarray(0, size);
+        }
+        const out = Buffer.allocUnsafe(size);
+        let offset = 0;
+        for (const chunk of chunks) {
+            if (offset >= size)
+                break;
+            offset += chunk.copy(out, offset, 0, Math.min(chunk.length, size - offset));
+        }
+        return out;
+    };
+    const take = (length) => {
+        if (length === 0) {
+            return Buffer.alloc(0);
+        }
+        // A socket chunk usually carries several whole messages, so slice the
+        // leading one out in place rather than allocating and copying for each.
+        // The payload is parsed by the callback before the next read, so sharing
+        // the chunk's memory does not retain it.
+        if (chunks[0].length === length) {
+            buffered -= length;
+            return chunks.shift();
+        }
+        if (chunks[0].length > length) {
+            const out = chunks[0].subarray(0, length);
+            chunks[0] = chunks[0].subarray(length);
+            buffered -= length;
+            return out;
+        }
+        const out = Buffer.allocUnsafe(length);
+        let offset = 0;
+        while (offset < length) {
+            const chunk = chunks[0];
+            const needed = length - offset;
+            if (chunk.length <= needed) {
+                chunk.copy(out, offset);
+                offset += chunk.length;
+                chunks.shift();
+            }
+            else {
+                chunk.copy(out, offset, 0, needed);
+                chunks[0] = chunk.subarray(needed);
+                offset = length;
+            }
+        }
+        buffered -= length;
+        return out;
+    };
+    const discard = (length) => {
+        let remaining = length;
+        while (remaining > 0) {
+            const chunk = chunks[0];
+            if (chunk.length <= remaining) {
+                remaining -= chunk.length;
+                chunks.shift();
+            }
+            else {
+                chunks[0] = chunk.subarray(remaining);
+                remaining = 0;
+            }
+        }
+        buffered -= length;
+    };
+    // Returns the payload length, or null when the header is still incomplete.
+    const readHeader = () => {
+        const head = peek(MAX_HEADER_LENGTH);
+        for (let i = 0; i < MESSAGE_HEADER_PREFIX_BYTES.length; i++) {
+            if (i >= head.length)
+                return null;
+            if (head[i] !== MESSAGE_HEADER_PREFIX_BYTES[i]) {
+                fail(`Expected a message to begin with '${exports.MESSAGE_HEADER_PREFIX}' but received ` +
+                    `${JSON.stringify(head.toString('utf8', 0, 32))}. The stream is out of sync.`);
+                return null;
+            }
+        }
+        let digits = 0;
+        let value = 0;
+        for (let i = MESSAGE_HEADER_PREFIX_BYTES.length; i < head.length; i++) {
+            const byte = head[i];
+            if (byte === MESSAGE_HEADER_TERMINATOR) {
+                if (digits === 0) {
+                    fail(`Message header carried no length.`);
+                    return null;
+                }
+                if (maxMessageSize > 0 && value > maxMessageSize) {
+                    fail(`Message of ${value} bytes exceeds the ${maxMessageSize} byte limit. ` +
+                        `Set NX_MAX_MESSAGE_SIZE to raise it, or to 0 to remove it.` +
+                        (daemonHoldsItsOwnLimit()
+                            ? ` Then run \`nx reset\`, since a running daemon and the plugin workers it spawns keep the limit they started with.`
+                            : ''));
+                    return null;
                 }
+                discard(i + 1);
+                return value;
             }
-            message = '';
+            if (byte < ZERO || byte > NINE) {
+                fail(`Message header contained a non-digit length. The stream is out of sync.`);
+                return null;
+            }
+            value = value * 10 + (byte - ZERO);
+            digits++;
+        }
+        if (head.length >= MAX_HEADER_LENGTH) {
+            fail(`Message header exceeded ${MAX_HEADER_LENGTH} bytes without a ':'.`);
+        }
+        return null;
+    };
+    return (data) => {
+        if (broken) {
+            return;
+        }
+        chunks.push(data);
+        buffered += data.length;
+        while (!broken) {
+            if (expectedPayloadLength === null) {
+                const length = readHeader();
+                if (length === null)
+                    break;
+                expectedPayloadLength = length;
+            }
+            if (expectedPayloadLength === 0) {
+                fail('Message header declared a zero-length payload.');
+                break;
+            }
+            if (buffered < expectedPayloadLength)
+                break;
+            const payload = take(expectedPayloadLength);
+            expectedPayloadLength = null;
+            callback(payload);
         }
-        // If message doesn't end with MESSAGE_END_SEQ, keep accumulating chunks
     };
 }
+/**
+ * v8-serialized payloads always begin with the 0xFF version header, which no
+ * JSON document can start with.
+ */
 function isJsonMessage(message) {
-    return (
-    // json objects
-    ['[', '{'].some((prefix) => message.startsWith(prefix)) ||
-        // booleans
-        message === 'true' ||
-        message === 'false' ||
-        // strings
-        (message.startsWith('"') && message.endsWith('"')) ||
-        // numbers
-        /^[0-9]+(\.?[0-9]+)?$/.test(message));
+    return message.length === 0 || message[0] !== 0xff;
+}
+/**
+ * Widest slice of `window` that holds only whole utf8 characters. Cutting at an
+ * arbitrary byte leaves a partial sequence, and a partial sequence decodes to
+ * U+FFFD, which is the corruption `describeMessage` exists to avoid. A slice
+ * taken from the end can also begin mid-character, so both edges are trimmed.
+ */
+function trimToCharBoundary(window, from) {
+    const isContinuation = (byte) => (byte & 0xc0) === 0x80;
+    if (from === 'end') {
+        let offset = 0;
+        while (offset < window.length && isContinuation(window[offset])) {
+            offset++;
+        }
+        return window.subarray(offset);
+    }
+    let lead = window.length - 1;
+    while (lead >= 0 && isContinuation(window[lead])) {
+        lead--;
+    }
+    if (lead < 0) {
+        return window.subarray(0, 0);
+    }
+    const byte = window[lead];
+    const width = byte >= 0xf0 ? 4 : byte >= 0xe0 ? 3 : byte >= 0xc0 ? 2 : 1;
+    // Keep the trailing sequence only when the cut did not land inside it.
+    return lead + width <= window.length ? window : window.subarray(0, lead);
+}
+/**
+ * Render part of a message for an error message. A v8 payload is binary rather
+ * than utf8 text — its 0xFF header alone can never decode — so it is rendered
+ * as hex instead of as U+FFFD-riddled mojibake.
+ */
+function describeMessage(message, { maxBytes = 300, from = 'start' } = {}) {
+    const json = isJsonMessage(message);
+    const window = from === 'end'
+        ? message.subarray(Math.max(0, message.length - maxBytes))
+        : message.subarray(0, maxBytes);
+    const slice = json ? trimToCharBoundary(window, from) : window;
+    const elided = message.length - slice.length;
+    return [
+        `${json ? 'json' : 'v8'}, ${message.length} bytes` +
+            (elided > 0
+                ? `, ${from === 'end' ? 'last' : 'first'} ${slice.length} shown`
+                : ''),
+        json ? slice.toString('utf8') : slice.toString('hex'),
+    ].join('\n');
 }
 /**
- * Parse a message that was produced by `serialize()` in
- * `daemon/socket-utils.ts`. Auto-detects JSON vs. v8-serialized payloads using
- * `isJsonMessage()` and decodes the binary path via `v8.deserialize`.
+ * Parse a message produced by `serialize()` in `daemon/socket-utils.ts`.
  */
 function parseMessage(message) {
     return isJsonMessage(message)
-        ? JSON.parse(message)
-        : (0, v8_1.deserialize)(Buffer.from(message, 'binary'));
+        ? JSON.parse(message.toString('utf8'))
+        : (0, v8_1.deserialize)(message);
 }

package/dist/src/utils/params.js

@@ -443,7 +443,7 @@ function applyVerbosity(options, schema, isVerbose) {
 }
 function combineOptionsForExecutor(commandLineOpts, config, target, schema, defaultProjectName, relativeCwd, isVerbose = false) {
     const r = convertAliases(coerceTypesInOptions(convertToCamelCase(commandLineOpts, schema), schema), schema, false);
-    let combined = target.options || {};
+    let combined = { ...target.options };
     if (config && target.configurations && target.configurations[config]) {
         Object.assign(combined, target.configurations[config]);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nx",
-  "version": "22.7.11",
+  "version": "22.7.12",
   "private": false,
   "type": "commonjs",
   "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
@@ -175,16 +175,16 @@
     }
   },
   "optionalDependencies": {
-    "@nx/nx-darwin-arm64": "22.7.11",
-    "@nx/nx-darwin-x64": "22.7.11",
-    "@nx/nx-freebsd-x64": "22.7.11",
-    "@nx/nx-linux-arm-gnueabihf": "22.7.11",
-    "@nx/nx-linux-arm64-gnu": "22.7.11",
-    "@nx/nx-linux-arm64-musl": "22.7.11",
-    "@nx/nx-linux-x64-gnu": "22.7.11",
-    "@nx/nx-linux-x64-musl": "22.7.11",
-    "@nx/nx-win32-arm64-msvc": "22.7.11",
-    "@nx/nx-win32-x64-msvc": "22.7.11"
+    "@nx/nx-darwin-arm64": "22.7.12",
+    "@nx/nx-darwin-x64": "22.7.12",
+    "@nx/nx-freebsd-x64": "22.7.12",
+    "@nx/nx-linux-arm-gnueabihf": "22.7.12",
+    "@nx/nx-linux-arm64-gnu": "22.7.12",
+    "@nx/nx-linux-arm64-musl": "22.7.12",
+    "@nx/nx-linux-x64-gnu": "22.7.12",
+    "@nx/nx-linux-x64-musl": "22.7.12",
+    "@nx/nx-win32-arm64-msvc": "22.7.12",
+    "@nx/nx-win32-x64-msvc": "22.7.12"
   },
   "nx-migrations": {
     "migrations": "./migrations.json",