@graphql-codegen/cli 3.3.0-rc-20230402134456-aa606b215 → 3.3.1-alpha-20230404030315-638d98dae

package/cjs/utils/watcher.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createWatcher = void 0;
 const tslib_1 = require("tslib");
+const promises_1 = require("node:fs/promises");
 const path_1 = require("path");
 const plugin_helpers_1 = require("@graphql-codegen/plugin-helpers");
 const utils_1 = require("@graphql-tools/utils");
@@ -18,8 +19,8 @@ function log(msg) {
     // double spaces to inline the message with Listr
     (0, logger_js_1.getLogger)().info(`  ${msg}`);
 }
-function emitWatching() {
-    log(`${log_symbols_1.default.info} Watching for changes...`);
+function emitWatching(watchDir) {
+    log(`${log_symbols_1.default.info} Watching for changes in ${watchDir}...`);
 }
 const createWatcher = (initalContext, onNext) => {
     (0, debugging_js_1.debugLog)(`[Watcher] Starting watcher...`);
@@ -55,6 +56,7 @@ const createWatcher = (initalContext, onNext) => {
     let watcherSubscription;
     const runWatcher = async () => {
         var _a;
+        const watchDirectory = await findHighestCommonDirectory(files);
         const parcelWatcher = await Promise.resolve().then(() => tslib_1.__importStar(require('@parcel/watcher')));
         (0, debugging_js_1.debugLog)(`[Watcher] Parcel watcher loaded...`);
         let isShutdown = false;
@@ -62,10 +64,10 @@ const createWatcher = (initalContext, onNext) => {
             if (!isShutdown) {
                 (0, codegen_js_1.executeCodegen)(initalContext)
                     .then(onNext, () => Promise.resolve())
-                    .then(() => emitWatching());
+                    .then(() => emitWatching(watchDirectory));
             }
         }, 100);
-        emitWatching();
+        emitWatching(watchDirectory);
         const ignored = [];
         for (const entry of Object.keys(config.generates).map(filename => ({
             filename,
@@ -81,7 +83,7 @@ const createWatcher = (initalContext, onNext) => {
                 ignored.push(entry.filename);
             }
         }
-        watcherSubscription = await parcelWatcher.subscribe(process.cwd(), async (_, events) => {
+        watcherSubscription = await parcelWatcher.subscribe(watchDirectory, async (_, events) => {
             // it doesn't matter what has changed, need to run whole process anyway
             await Promise.all(events.map(async ({ type: eventName, path }) => {
                 /**
@@ -92,7 +94,7 @@ const createWatcher = (initalContext, onNext) => {
                     return;
                 (0, hooks_js_1.lifecycleHooks)(config.hooks).onWatchTriggered(eventName, path);
                 (0, debugging_js_1.debugLog)(`[Watcher] triggered due to a file ${eventName} event: ${path}`);
-                const fullPath = (0, path_1.join)(process.cwd(), path);
+                const fullPath = (0, path_1.join)(watchDirectory, path);
                 // In ESM require is not defined
                 try {
                     delete require.cache[fullPath];
@@ -135,3 +137,56 @@ const createWatcher = (initalContext, onNext) => {
     });
 };
 exports.createWatcher = createWatcher;
+/**
+ * Given a list of file paths (each of which may be absolute, or relative to
+ * `process.cwd()`), find absolute path of the "highest" common directory,
+ * i.e. the directory that contains all the files in the list.
+ *
+ * @param files List of relative and/or absolute file paths (or micromatch patterns)
+ */
+const findHighestCommonDirectory = async (files) => {
+    // Map files to a list of basePaths, where "base" is the result of mm.scan(pathOrPattern)
+    // e.g. mm.scan("/**/foo/bar").base -> "/" ; mm.scan("/foo/bar/**/fizz/*.graphql") -> /foo/bar
+    const dirPaths = files
+        .map(filePath => ((0, path_1.isAbsolute)(filePath) ? filePath : (0, path_1.resolve)(filePath)))
+        .map(patterned => micromatch_1.default.scan(patterned).base);
+    // Return longest common prefix if it's accessible, otherwise process.cwd()
+    return (async (maybeValidPath) => {
+        (0, debugging_js_1.debugLog)(`[Watcher] Longest common prefix of all files: ${maybeValidPath}...`);
+        try {
+            await (0, promises_1.access)(maybeValidPath);
+            return maybeValidPath;
+        }
+        catch (_a) {
+            log(`[Watcher] Longest common prefix (${maybeValidPath}) is not accessible`);
+            log(`[Watcher] Watching current working directory (${process.cwd()}) instead`);
+            return process.cwd();
+        }
+    })(longestCommonPrefix(dirPaths.map(path => path.split(path_1.sep))).join(path_1.sep));
+};
+/**
+ * Find the longest common prefix of an array of paths, where each item in
+ * the array an array of path segments which comprise an absolute path when
+ * joined together by a path separator
+ *
+ * Adapted from:
+ * https://duncan-mcardle.medium.com/leetcode-problem-14-longest-common-prefix-javascript-3bc6a2f777c4
+ *
+ * @param splitPaths An array of arrays, where each item is a path split by its separator
+ * @returns An array of path segments representing the longest common prefix of splitPaths
+ */
+const longestCommonPrefix = (splitPaths) => {
+    // Return early on empty input
+    if (!splitPaths.length) {
+        return [];
+    }
+    // Loop through the segments of the first path
+    for (let i = 0; i <= splitPaths[0].length; i++) {
+        // Check if this path segment is present in the same position of every path
+        if (!splitPaths.every(string => string[i] === splitPaths[0][i])) {
+            // If not, return the path segments up to and including the previous segment
+            return splitPaths[0].slice(0, i);
+        }
+    }
+    return splitPaths[0];
+};

package/esm/utils/watcher.js

@@ -1,4 +1,5 @@
-import { join } from 'path';
+import { access } from 'node:fs/promises';
+import { join, isAbsolute, resolve, sep } from 'path';
 import { normalizeInstanceOrArray, normalizeOutputParam } from '@graphql-codegen/plugin-helpers';
 import { isValidPath } from '@graphql-tools/utils';
 import debounce from 'debounce';
@@ -14,8 +15,8 @@ function log(msg) {
     // double spaces to inline the message with Listr
     getLogger().info(`  ${msg}`);
 }
-function emitWatching() {
-    log(`${logSymbols.info} Watching for changes...`);
+function emitWatching(watchDir) {
+    log(`${logSymbols.info} Watching for changes in ${watchDir}...`);
 }
 export const createWatcher = (initalContext, onNext) => {
     debugLog(`[Watcher] Starting watcher...`);
@@ -51,6 +52,7 @@ export const createWatcher = (initalContext, onNext) => {
     let watcherSubscription;
     const runWatcher = async () => {
         var _a;
+        const watchDirectory = await findHighestCommonDirectory(files);
         const parcelWatcher = await import('@parcel/watcher');
         debugLog(`[Watcher] Parcel watcher loaded...`);
         let isShutdown = false;
@@ -58,10 +60,10 @@ export const createWatcher = (initalContext, onNext) => {
             if (!isShutdown) {
                 executeCodegen(initalContext)
                     .then(onNext, () => Promise.resolve())
-                    .then(() => emitWatching());
+                    .then(() => emitWatching(watchDirectory));
             }
         }, 100);
-        emitWatching();
+        emitWatching(watchDirectory);
         const ignored = [];
         for (const entry of Object.keys(config.generates).map(filename => ({
             filename,
@@ -77,7 +79,7 @@ export const createWatcher = (initalContext, onNext) => {
                 ignored.push(entry.filename);
             }
         }
-        watcherSubscription = await parcelWatcher.subscribe(process.cwd(), async (_, events) => {
+        watcherSubscription = await parcelWatcher.subscribe(watchDirectory, async (_, events) => {
             // it doesn't matter what has changed, need to run whole process anyway
             await Promise.all(events.map(async ({ type: eventName, path }) => {
                 /**
@@ -88,7 +90,7 @@ export const createWatcher = (initalContext, onNext) => {
                     return;
                 lifecycleHooks(config.hooks).onWatchTriggered(eventName, path);
                 debugLog(`[Watcher] triggered due to a file ${eventName} event: ${path}`);
-                const fullPath = join(process.cwd(), path);
+                const fullPath = join(watchDirectory, path);
                 // In ESM require is not defined
                 try {
                     delete require.cache[fullPath];
@@ -130,3 +132,56 @@ export const createWatcher = (initalContext, onNext) => {
         });
     });
 };
+/**
+ * Given a list of file paths (each of which may be absolute, or relative to
+ * `process.cwd()`), find absolute path of the "highest" common directory,
+ * i.e. the directory that contains all the files in the list.
+ *
+ * @param files List of relative and/or absolute file paths (or micromatch patterns)
+ */
+const findHighestCommonDirectory = async (files) => {
+    // Map files to a list of basePaths, where "base" is the result of mm.scan(pathOrPattern)
+    // e.g. mm.scan("/**/foo/bar").base -> "/" ; mm.scan("/foo/bar/**/fizz/*.graphql") -> /foo/bar
+    const dirPaths = files
+        .map(filePath => (isAbsolute(filePath) ? filePath : resolve(filePath)))
+        .map(patterned => mm.scan(patterned).base);
+    // Return longest common prefix if it's accessible, otherwise process.cwd()
+    return (async (maybeValidPath) => {
+        debugLog(`[Watcher] Longest common prefix of all files: ${maybeValidPath}...`);
+        try {
+            await access(maybeValidPath);
+            return maybeValidPath;
+        }
+        catch (_a) {
+            log(`[Watcher] Longest common prefix (${maybeValidPath}) is not accessible`);
+            log(`[Watcher] Watching current working directory (${process.cwd()}) instead`);
+            return process.cwd();
+        }
+    })(longestCommonPrefix(dirPaths.map(path => path.split(sep))).join(sep));
+};
+/**
+ * Find the longest common prefix of an array of paths, where each item in
+ * the array an array of path segments which comprise an absolute path when
+ * joined together by a path separator
+ *
+ * Adapted from:
+ * https://duncan-mcardle.medium.com/leetcode-problem-14-longest-common-prefix-javascript-3bc6a2f777c4
+ *
+ * @param splitPaths An array of arrays, where each item is a path split by its separator
+ * @returns An array of path segments representing the longest common prefix of splitPaths
+ */
+const longestCommonPrefix = (splitPaths) => {
+    // Return early on empty input
+    if (!splitPaths.length) {
+        return [];
+    }
+    // Loop through the segments of the first path
+    for (let i = 0; i <= splitPaths[0].length; i++) {
+        // Check if this path segment is present in the same position of every path
+        if (!splitPaths.every(string => string[i] === splitPaths[0][i])) {
+            // If not, return the path segments up to and including the previous segment
+            return splitPaths[0].slice(0, i);
+        }
+    }
+    return splitPaths[0];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-codegen/cli",
-  "version": "3.3.0-rc-20230402134456-aa606b215",
+  "version": "3.3.1-alpha-20230404030315-638d98dae",
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
   },
@@ -9,7 +9,7 @@
     "@babel/template": "^7.18.10",
     "@babel/types": "^7.18.13",
     "@graphql-codegen/core": "^3.1.0",
-    "@graphql-codegen/plugin-helpers": "4.2.0-rc-20230402134456-aa606b215",
+    "@graphql-codegen/plugin-helpers": "^4.2.0",
     "@graphql-tools/apollo-engine-loader": "^7.3.6",
     "@graphql-tools/code-file-loader": "^7.3.17",
     "@graphql-tools/git-loader": "^7.2.13",