@ohos-ports/nx 23.2.0-beta.0 → 23.2.1-beta.0

package/dist/src/daemon/server/watcher.js

@@ -1,126 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.watchWorkspace = watchWorkspace;
-exports.flushPendingWorkspaceChanges = flushPendingWorkspaceChanges;
-exports.watchOutputFiles = watchOutputFiles;
-exports.convertChangeEventsToLogMessage = convertChangeEventsToLogMessage;
-const workspace_root_1 = require("../../utils/workspace-root");
-const path_1 = require("path");
-const shutdown_utils_1 = require("./shutdown-utils");
-const path_2 = require("../../utils/path");
-const cache_1 = require("../cache");
-const server_1 = require("./server");
-const handle_import_1 = require("../../utils/handle-import");
-// Captured by watchWorkspace so flushPendingWorkspaceChanges can route
-// force-flushed events through the same handling as the async callback.
-// Definite-assignment: dispatchWorkspaceChanges only runs after
-// watchWorkspace has set both, so reading them as non-nullable is safe.
-let activeServer;
-let workspaceChangesCallback;
-function dispatchWorkspaceChanges(events) {
-    for (const event of events) {
-        if (event.path.endsWith('.gitignore') || event.path === '.nxignore') {
-            // If the ignore files themselves have changed we need to dynamically
-            // update our cached ignoreGlobs
-            (0, shutdown_utils_1.handleServerProcessTermination)({
-                server: activeServer,
-                reason: 'Stopping the daemon the set of ignored files changed (native)',
-                sockets: server_1.openSockets,
-            });
-        }
-    }
-    return workspaceChangesCallback(null, events);
-}
-async function watchWorkspace(server, cb) {
-    const { Watcher } = await (0, handle_import_1.handleImport)('../../native/index.js', __dirname);
-    activeServer = server;
-    workspaceChangesCallback = cb;
-    const watcher = new Watcher(workspace_root_1.workspaceRoot);
-    watcher.watch((err, events) => {
-        if (err) {
-            return cb(err, null);
-        }
-        dispatchWorkspaceChanges(events);
-    });
-    return watcher;
-}
-/**
- * Synchronously drain anything the workspace watcher has buffered and feed
- * it through the normal change-handling pipeline. Call this before serving
- * a cached project graph so we never return data that the watcher has
- * already seen invalidated but hasn't flushed yet.
- */
-async function flushPendingWorkspaceChanges() {
-    const watcher = (0, shutdown_utils_1.getWatcherInstance)();
-    if (!watcher)
-        return;
-    const events = watcher.forceFlushPending();
-    if (events.length === 0)
-        return;
-    await dispatchWorkspaceChanges(events);
-}
-async function watchOutputFiles(server, cb) {
-    const { Watcher } = await (0, handle_import_1.handleImport)('../../native/index.js', __dirname);
-    const relativeServerProcess = (0, path_2.normalizePath)((0, path_1.relative)(workspace_root_1.workspaceRoot, cache_1.serverProcessJsonPath));
-    const watcher = new Watcher(workspace_root_1.workspaceRoot, [`!${relativeServerProcess}`], false);
-    watcher.watch((err, events) => {
-        if (err) {
-            return cb(err, null);
-        }
-        for (const event of events) {
-            if (event.path == relativeServerProcess &&
-                (0, cache_1.getDaemonProcessIdSync)() !== process.pid) {
-                return (0, shutdown_utils_1.handleServerProcessTermination)({
-                    server,
-                    reason: 'this process is no longer the current daemon (native)',
-                    sockets: server_1.openSockets,
-                });
-            }
-        }
-        if (events.length !== 0) {
-            cb(null, events);
-        }
-    });
-    return watcher;
-}
-/**
- * NOTE: An event type of "create" will also apply to the case where the user has restored
- * an original version of a file after modifying/deleting it by using git, so we adjust
- * our log language accordingly.
- */
-function convertChangeEventsToLogMessage(changeEvents) {
-    // If only a single file was changed, show the information inline
-    if (changeEvents.length === 1) {
-        const { path, type } = changeEvents[0];
-        let typeLog = 'updated';
-        switch (type) {
-            case 'create':
-                typeLog = 'created or restored';
-                break;
-            case 'update':
-                typeLog = 'modified';
-                break;
-            case 'delete':
-                typeLog = 'deleted';
-                break;
-        }
-        return `${path} was ${typeLog}`;
-    }
-    let numCreatedOrRestoredFiles = 0;
-    let numModifiedFiles = 0;
-    let numDeletedFiles = 0;
-    for (const event of changeEvents) {
-        switch (event.type) {
-            case 'create':
-                numCreatedOrRestoredFiles++;
-                break;
-            case 'update':
-                numModifiedFiles++;
-                break;
-            case 'delete':
-                numDeletedFiles++;
-                break;
-        }
-    }
-    return `${numCreatedOrRestoredFiles} file(s) created or restored, ${numModifiedFiles} file(s) modified, ${numDeletedFiles} file(s) deleted`;
-}

package/dist/src/daemon/socket-utils.d.ts

@@ -1,43 +0,0 @@
-import type { Socket } from 'net';
-export declare const isWindows: boolean;
-/**
- * For IPC with the daemon server we use unix sockets or windows named pipes, depending on the user's operating system.
- *
- * See https://nodejs.org/dist/latest-v14.x/docs/api/net.html#net_identifying_paths_for_ipc_connections for a full breakdown
- * of OS differences between Unix domain sockets and named pipes.
- */
-export declare const getFullOsSocketPath: () => string;
-export declare const getForkedProcessOsSocketPath: (id: string) => string;
-export declare const getPluginOsSocketPath: (id: string) => string;
-export declare function getPluginSocketFileName(id: string): string;
-export declare function killSocketOrPath(): void;
-export declare function serializeResult(error: Error | null, serializedProjectGraph: string | null, serializedSourceMaps: string | null): string | null;
-/**
- * Serialize using `preferred`, falling back to the other format when it throws.
- * Neither format subsumes the other: JSON cannot represent a BigInt and hits the
- * max string length far sooner, while v8 cannot clone a function.
- *
- * @param data Data to serialize
- * @param preferred Format to attempt first
- * @returns Serialized data as bytes ready to be framed onto a socket
- */
-export declare function serializeWithFallback(data: any, preferred: 'v8' | 'json'): Buffer;
-/**
- * Serialize data for IPC using the format the user configured.
- *
- * @param data Data to serialize
- * @param force Use this format without falling back. For callers whose data is
- *              known to be unrepresentable in the other format, where a fallback
- *              would only swap one failure for a less obvious one.
- * @returns Serialized data as bytes ready to be framed onto a socket
- */
-export declare function serialize(data: any, force?: 'v8' | 'json'): Buffer;
-/**
- * Serialize `data` and write it as one framed message.
- *
- * Lives here rather than in `writeMessage` so the framing stays a byte-level
- * primitive: `utils/consume-messages-from-socket` is shared by callers that
- * already hold bytes, and having it reach back into the daemon's serializer
- * would invert the dependency.
- */
-export declare function sendMessage(socket: Socket, data: any, force?: 'v8' | 'json', callback?: (err?: Error) => void): void;

package/dist/src/daemon/socket-utils.js

@@ -1,131 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPluginOsSocketPath = exports.getForkedProcessOsSocketPath = exports.getFullOsSocketPath = exports.isWindows = void 0;
-exports.getPluginSocketFileName = getPluginSocketFileName;
-exports.killSocketOrPath = killSocketOrPath;
-exports.serializeResult = serializeResult;
-exports.serializeWithFallback = serializeWithFallback;
-exports.serialize = serialize;
-exports.sendMessage = sendMessage;
-const fs_1 = require("fs");
-const os_1 = require("os");
-const path_1 = require("path");
-const tmp_dir_1 = require("./tmp-dir");
-const serializable_error_1 = require("../utils/serializable-error");
-const is_v8_serializer_enabled_1 = require("./is-v8-serializer-enabled");
-const v8_1 = require("v8");
-const consume_messages_from_socket_1 = require("../utils/consume-messages-from-socket");
-exports.isWindows = (0, os_1.platform)() === 'win32';
-/**
- * For IPC with the daemon server we use unix sockets or windows named pipes, depending on the user's operating system.
- *
- * See https://nodejs.org/dist/latest-v14.x/docs/api/net.html#net_identifying_paths_for_ipc_connections for a full breakdown
- * of OS differences between Unix domain sockets and named pipes.
- */
-const getFullOsSocketPath = () => {
-    const path = (0, path_1.resolve)((0, tmp_dir_1.getDaemonSocketDir)());
-    assertValidSocketPath(path);
-    return exports.isWindows ? '\\\\.\\pipe\\nx\\' + path : path;
-};
-exports.getFullOsSocketPath = getFullOsSocketPath;
-const getForkedProcessOsSocketPath = (id) => {
-    let path = (0, path_1.resolve)((0, path_1.join)((0, tmp_dir_1.getSocketDir)(), 'fp' + id + '.sock'));
-    assertValidSocketPath(path);
-    return exports.isWindows ? '\\\\.\\pipe\\nx\\' + path : path;
-};
-exports.getForkedProcessOsSocketPath = getForkedProcessOsSocketPath;
-const getPluginOsSocketPath = (id) => {
-    let path = (0, path_1.resolve)((0, path_1.join)((0, tmp_dir_1.getPluginSocketDir)(), getPluginSocketFileName(id)));
-    assertValidSocketPath(path);
-    return exports.isWindows ? '\\\\.\\pipe\\nx\\' + path : path;
-};
-exports.getPluginOsSocketPath = getPluginOsSocketPath;
-function getPluginSocketFileName(id) {
-    return `p${id}.sock`;
-}
-function assertValidSocketPath(path) {
-    if (path.length > 95) {
-        const fallbackCause = (0, tmp_dir_1.getSocketDirFallbackCause)();
-        const refusedConfiguredSocketDir = (0, tmp_dir_1.getRefusedConfiguredSocketDir)();
-        throw new Error([
-            'Attempted to open socket that exceeds the maximum socket length.',
-            ...(fallbackCause === undefined
-                ? []
-                : [
-                    `Nx fell back to ${(0, path_1.dirname)(path)} because the default socket directory could not be used.`,
-                    'Run the command with --verbose to see why the default directory was rejected.',
-                ]),
-            '',
-            ...(refusedConfiguredSocketDir === undefined
-                ? [
-                    `Set NX_SOCKET_DIR to a shorter path (e.g. ${exports.isWindows ? '%TMP%/nx-tmp' : '/tmp/nx-tmp'}) to avoid this issue.`,
-                ]
-                : [
-                    // Saying "set a shorter path" here would be advice they already
-                    // followed: they set one, and it was refused for another reason.
-                    `The directory set in NX_SOCKET_DIR (${refusedConfiguredSocketDir}) could not be used — see the warning above — so Nx fell back to a longer path.`,
-                    'Point NX_SOCKET_DIR at a short directory your user owns.',
-                ]),
-        ].join('\n'), fallbackCause === undefined ? undefined : { cause: fallbackCause });
-    }
-}
-function killSocketOrPath() {
-    try {
-        (0, fs_1.unlinkSync)((0, exports.getFullOsSocketPath)());
-    }
-    catch { }
-}
-// Prepare a serialized project graph result for sending over IPC from the server to the client
-function serializeResult(error, serializedProjectGraph, serializedSourceMaps) {
-    // We do not want to repeat work `JSON.stringify`ing an object containing the potentially large project graph so merge as strings
-    return `{ "error": ${JSON.stringify(error ? (0, serializable_error_1.createSerializableError)(error) : error)}, "projectGraph": ${serializedProjectGraph}, "sourceMaps": ${serializedSourceMaps} }`;
-}
-function serializeAs(data, format) {
-    return format === 'v8'
-        ? (0, v8_1.serialize)(data)
-        : Buffer.from(JSON.stringify(data), 'utf8');
-}
-/**
- * Serialize using `preferred`, falling back to the other format when it throws.
- * Neither format subsumes the other: JSON cannot represent a BigInt and hits the
- * max string length far sooner, while v8 cannot clone a function.
- *
- * @param data Data to serialize
- * @param preferred Format to attempt first
- * @returns Serialized data as bytes ready to be framed onto a socket
- */
-function serializeWithFallback(data, preferred) {
-    try {
-        return serializeAs(data, preferred);
-    }
-    catch (e) {
-        const fallback = preferred === 'v8' ? 'json' : 'v8';
-        console.warn(`Data could not be serialized using ${preferred} serialization: ${e}. Falling back to ${fallback} serialization.`);
-        return serializeAs(data, fallback);
-    }
-}
-/**
- * Serialize data for IPC using the format the user configured.
- *
- * @param data Data to serialize
- * @param force Use this format without falling back. For callers whose data is
- *              known to be unrepresentable in the other format, where a fallback
- *              would only swap one failure for a less obvious one.
- * @returns Serialized data as bytes ready to be framed onto a socket
- */
-function serialize(data, force) {
-    return force
-        ? serializeAs(data, force)
-        : serializeWithFallback(data, (0, is_v8_serializer_enabled_1.isV8SerializerEnabled)() ? 'v8' : 'json');
-}
-/**
- * Serialize `data` and write it as one framed message.
- *
- * Lives here rather than in `writeMessage` so the framing stays a byte-level
- * primitive: `utils/consume-messages-from-socket` is shared by callers that
- * already hold bytes, and having it reach back into the daemon's serializer
- * would invert the dependency.
- */
-function sendMessage(socket, data, force, callback) {
-    (0, consume_messages_from_socket_1.writeMessage)(socket, serialize(data, force), callback);
-}

package/dist/src/daemon/tmp-dir.d.ts

@@ -1,62 +0,0 @@
-/**
- * Why a directory was refused. Named rather than a boolean so a table entry
- * reads as its own reason: picking the wrong one tells a user their private
- * directory is a code-execution risk, which is the one claim here that most
- * needs to be true.
- */
-export type SocketDirRefusal = 'shared-with-other-users' | 'nx-managed' | 'os-temp-root';
-/**
- * Thrown when the socket dir resolves to a directory Nx will not accept.
- * Invalid configuration, not a recoverable failure.
- *
- * Three reasons, and they are not interchangeable. A directory other users can
- * reach is a security problem; the OS temp root is the user's own but holds
- * everything else that uses it, and Nx deletes the socket directory
- * recursively; an Nx container or cache root is refused because Nx manages what
- * lives there. Telling someone their own `0700` directory lets a local attacker
- * execute code would be false, which is why the reason is derived from the
- * directory rather than the platform.
- */
-export declare class InvalidSocketDirConfigured extends Error {
-    readonly dir: string;
-    readonly reason: SocketDirRefusal;
-    constructor(dir: string, reason: SocketDirRefusal);
-}
-export declare const DAEMON_DIR_FOR_CURRENT_WORKSPACE: string;
-export declare const DAEMON_OUTPUT_LOG_FILE: string;
-export declare const getDaemonSocketDir: () => string;
-export declare function writeDaemonLogs(error?: string): string;
-export declare function markDaemonAsDisabled(reason: string): void;
-/**
- * Turns the daemon off for this process only, leaving no marker behind.
- *
- * For a cause that belongs to the environment rather than to the workspace: a
- * sandbox refusing the socket says nothing about the next run from an ordinary
- * terminal, and the marker `markDaemonAsDisabled` writes would follow the
- * checkout there. It would also survive the user doing exactly what Nx told
- * them to do, since nothing clears it but `nx reset`.
- */
-export declare function disableDaemonForThisProcess(reason: string): void;
-export declare function isDaemonDisabled(): boolean;
-export declare function getSocketDir(): string;
-/**
- * Plugin worker sockets get their own workspace-scoped directory rather than
- * sitting in the shared system temp dir, which cannot be locked down.
- */
-export declare function getPluginSocketDir(): string;
-/**
- * Exported for tests: both fallback warnings fire once per process, so a suite
- * that stages either fallback more than once has to clear the latches between
- * cases.
- */
-export declare function resetSocketDirWarningsForTesting(): void;
-export declare function getSocketDirFallbackCause(): unknown;
-/**
- * The NX_SOCKET_DIR that was refused, if that is why we are in the fallback.
- * Reflects the most recent resolution only — both accessors are cleared at the
- * top of every `createOwnerOnlySocketDir` call, and the daemon and plugin socket
- * paths each drive one. Read it immediately after the call that produced the
- * path, which is what `assertValidSocketPath` does.
- */
-export declare function getRefusedConfiguredSocketDir(): string | undefined;
-export declare function removeSocketDir(): void;