@gadgetinc/ggt 0.2.1 → 0.2.2

package/lib/commands/sync.js

@@ -5,7 +5,6 @@ import { _ as _define_property } from "@swc/helpers/_/_define_property";
 import { Args, Flags } from "@oclif/core";
 import assert from "assert";
 import chalkTemplate from "chalk-template";
-import { default as FSWatcher } from "watcher";
 import { format } from "date-fns";
 import { execa } from "execa";
 import fs from "fs-extra";
@@ -17,24 +16,17 @@ import PQueue from "p-queue";
 import path from "path";
 import pluralize from "pluralize";
 import { dedent } from "ts-dedent";
+import FSWatcher from "watcher";
 import which from "which";
 import { FileSyncEncoding } from "../__generated__/graphql.js";
-import { BaseCommand } from "../utils/base-command.js";
-import { Client } from "../utils/client.js";
-import { context } from "../utils/context.js";
-import { InvalidSyncAppFlagError, InvalidSyncFileError, YarnNotFoundError } from "../utils/errors.js";
-import { app } from "../utils/flags.js";
-import { FSIgnorer, ignoreEnoent, isEmptyDir, walkDir } from "../utils/fs-utils.js";
-import { PromiseSignal } from "../utils/promise.js";
+import { BaseCommand } from "../services/base-command.js";
+import { Client } from "../services/client.js";
+import { context } from "../services/context.js";
+import { InvalidSyncAppFlagError, InvalidSyncFileError, YarnNotFoundError } from "../services/errors.js";
+import { app } from "../services/flags.js";
+import { FSIgnorer, ignoreEnoent, isEmptyDir, walkDir } from "../services/fs-utils.js";
+import { PromiseSignal } from "../services/promise.js";
 class Sync extends BaseCommand {
-    static fileStats(path) {
-        try {
-            return fs.statSync(path);
-        } catch (error) {
-            ignoreEnoent(error);
-            return undefined;
-        }
-    }
     /**
    * Turns an absolute filepath into a relative one from {@linkcode dir}.
    */ relative(to) {
@@ -77,8 +69,8 @@ class Sync extends BaseCommand {
    * @param options.limit The maximum number of lines to print. Defaults to 10. If debug is enabled, this is ignored.
    */ logPaths(prefix, changed, deleted, { limit = 10 } = {}) {
         const lines = _.sortBy([
-            ...changed.map((normalizedPath)=>chalkTemplate`{green ${prefix}} ${normalizedPath} {gray (changed)}`),
-            ...deleted.map((normalizedPath)=>chalkTemplate`{red ${prefix}} ${normalizedPath} {gray (deleted)}`)
+            ..._.map(changed, (normalizedPath)=>chalkTemplate`{green ${prefix}} ${normalizedPath} {gray (changed)}`),
+            ..._.map(deleted, (normalizedPath)=>chalkTemplate`{red ${prefix}} ${normalizedPath} {gray (deleted)}`)
         ], (line)=>line.slice(line.indexOf(" ") + 1));
         let logged = 0;
         for (const line of lines){
@@ -100,16 +92,21 @@ class Sync extends BaseCommand {
    * - Prompts the user how to resolve conflicts if the local filesystem has changed since the last sync.
    */ async init() {
         await super.init();
-        assert(_.isString(this.args["directory"]));
-        this.dir = this.config.windows && this.args["directory"].startsWith("~/") ? path.join(this.config.home, this.args["directory"].slice(2)) : path.resolve(this.args["directory"]);
+        this.dir = this.config.windows && _.startsWith(this.args.directory, "~/") ? path.join(this.config.home, this.args.directory.slice(2)) : path.resolve(this.args.directory);
         const getApp = async ()=>{
-            if (this.flags.app) return this.flags.app;
-            if (this.state?.app) return this.state.app;
+            if (this.flags.app) {
+                return this.flags.app;
+            }
+            // this.state can be undefined if the user is running `ggt sync` for the first time
+            // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+            if (this.state?.app) {
+                return this.state.app;
+            }
             const selected = await inquirer.prompt({
                 type: "list",
                 name: "app",
                 message: "Please select the app to sync to.",
-                choices: await context.getAvailableApps().then((apps)=>apps.map((app)=>app.slug))
+                choices: await context.getAvailableApps().then((apps)=>_.map(apps, "slug"))
             });
             return selected.app;
         };
@@ -142,7 +139,6 @@ class Sync extends BaseCommand {
             ".gadget",
             ".git"
         ]);
-        this.debug("starting");
         if (!which.sync("yarn", {
             nothrow: true
         })) {
@@ -167,7 +163,7 @@ class Sync extends BaseCommand {
             files.delete("/");
             return files;
         };
-        const changedFiles = await getChangedFiles();
+        let changedFiles = await getChangedFiles();
         const hasLocalChanges = changedFiles.size > 0;
         if (hasLocalChanges) {
             this.log("Local files have changed since you last synced");
@@ -176,11 +172,16 @@ class Sync extends BaseCommand {
             });
             this.log();
         }
-        this.debug("init %O", {
-            metadata: this.state,
-            remoteFilesVersion,
-            hasRemoteChanges,
-            hasLocalChanges
+        context.addBreadcrumb({
+            category: "sync",
+            message: "Initializing",
+            data: {
+                state: this.state,
+                remoteFilesVersion,
+                hasRemoteChanges,
+                hasLocalChanges,
+                changed: Array.from(changedFiles.keys())
+            }
         });
         let action;
         if (hasLocalChanges) {
@@ -195,11 +196,20 @@ class Sync extends BaseCommand {
                 message: hasRemoteChanges ? "Remote files have also changed. How would you like to proceed?" : "How would you like to proceed?"
             }));
         }
+        // get all the changed files again in case more changed
+        changedFiles = await getChangedFiles();
         switch(action){
             case Action.MERGE:
                 {
-                    // get all the changed files again in case more changed
-                    const files = await getChangedFiles();
+                    context.addBreadcrumb({
+                        category: "sync",
+                        message: "Merging local changes",
+                        data: {
+                            state: this.state,
+                            remoteFilesVersion,
+                            changed: Array.from(changedFiles.keys())
+                        }
+                    });
                     // We purposefully don't set the returned remoteFilesVersion here because we haven't received the remote changes
                     // yet. This will cause us to receive the local files that we just published + the remote files that were
                     // changed since the last sync.
@@ -208,7 +218,7 @@ class Sync extends BaseCommand {
                         variables: {
                             input: {
                                 expectedRemoteFilesVersion: remoteFilesVersion,
-                                changed: await pMap(files, async ([normalizedPath, stats])=>{
+                                changed: await pMap(changedFiles, async ([normalizedPath, stats])=>{
                                     if (stats.mtime.getTime() > this.state.mtime) {
                                         this.state.mtime = stats.mtime.getTime();
                                     }
@@ -227,6 +237,15 @@ class Sync extends BaseCommand {
                 }
             case Action.RESET:
                 {
+                    context.addBreadcrumb({
+                        category: "sync",
+                        message: "Resetting local changes",
+                        data: {
+                            state: this.state,
+                            remoteFilesVersion,
+                            changed: Array.from(changedFiles.keys())
+                        }
+                    });
                     // delete all the local files that have changed since the last sync and set the files version to 0 so we receive
                     // all the remote files again, including any files that we just deleted that still exist
                     await pMap(changedFiles.keys(), (normalizedPath)=>this.softDelete(normalizedPath));
@@ -238,27 +257,32 @@ class Sync extends BaseCommand {
                     process.exit(0);
                 }
         }
-        this.debug("started");
+        context.addBreadcrumb({
+            category: "sync",
+            message: "Initialized",
+            data: {
+                state: this.state
+            }
+        });
     }
     /**
    * Runs the sync process until it is stopped or an error occurs.
    */ async run() {
         let error;
         const stopped = new PromiseSignal();
-        this.watcher = new FSWatcher(this.dir, {
-            ignore: (filepath)=>{
-                return this.ignorer.ignores(filepath);
-            },
-            // don't emit an event for every watched file on boot
-            ignoreInitial: true,
-            renameDetection: true,
-            recursive: true
-        });
         this.stop = async (e)=>{
             if (this.status != SyncStatus.RUNNING) return;
-            error = e;
-            this.debug("stopping");
             this.status = SyncStatus.STOPPING;
+            error = e;
+            context.addBreadcrumb({
+                category: "sync",
+                message: "Stopping",
+                level: error ? "error" : undefined,
+                data: {
+                    state: this.state,
+                    error
+                }
+            });
             try {
                 unsubscribe();
                 this.watcher.removeAllListeners();
@@ -270,9 +294,15 @@ class Sync extends BaseCommand {
                     this.watcher.close(),
                     this.client.dispose()
                 ]);
-                this.debug("stopped");
                 this.status = SyncStatus.STOPPED;
                 stopped.resolve();
+                context.addBreadcrumb({
+                    category: "sync",
+                    message: "Stopped",
+                    data: {
+                        state: this.state
+                    }
+                });
             }
         };
         for (const signal of [
@@ -301,22 +331,49 @@ class Sync extends BaseCommand {
         }, {
             error: (error)=>void this.stop(error),
             next: ({ remoteFileSyncEvents })=>{
+                context.addBreadcrumb({
+                    category: "sync",
+                    message: "Received file sync events",
+                    data: {
+                        state: this.state,
+                        remoteFilesVersion: remoteFileSyncEvents.remoteFilesVersion,
+                        changed: _.map(remoteFileSyncEvents.changed, "path"),
+                        deleted: _.map(remoteFileSyncEvents.deleted, "path")
+                    }
+                });
                 const remoteFilesVersion = remoteFileSyncEvents.remoteFilesVersion;
                 // we always ignore .gadget/ files so that we don't publish them (they're managed by gadget), but we still want to receive them
-                const filter = (event)=>event.path.startsWith(".gadget/") || !this.ignorer.ignores(event.path);
-                const changed = remoteFileSyncEvents.changed.filter(filter);
-                const deleted = remoteFileSyncEvents.deleted.filter(filter);
+                const filter = (event)=>_.startsWith(event.path, ".gadget/") || !this.ignorer.ignores(event.path);
+                const changed = _.filter(remoteFileSyncEvents.changed, filter);
+                const deleted = _.filter(remoteFileSyncEvents.deleted, filter);
                 this._enqueue(async ()=>{
+                    context.addBreadcrumb({
+                        category: "sync",
+                        message: "Processing received file sync events",
+                        data: {
+                            state: this.state,
+                            remoteFilesVersion: remoteFileSyncEvents.remoteFilesVersion,
+                            changed: _.map(remoteFileSyncEvents.changed, "path"),
+                            deleted: _.map(remoteFileSyncEvents.deleted, "path")
+                        }
+                    });
                     if (!changed.length && !deleted.length) {
                         if (BigInt(remoteFilesVersion) > this.state.filesVersion) {
                             // we still need to update filesVersion, otherwise our expectedFilesVersion will be behind the next time we publish
-                            this.debug("updated local files version from %s to %s", this.state.filesVersion, remoteFilesVersion);
                             this.state.filesVersion = remoteFilesVersion;
+                            context.addBreadcrumb({
+                                category: "sync",
+                                message: "Received empty file sync events",
+                                data: {
+                                    state: this.state,
+                                    remoteFilesVersion: remoteFileSyncEvents.remoteFilesVersion
+                                }
+                            });
                         }
                         return;
                     }
                     this.log(chalkTemplate`Received {gray ${format(new Date(), "pp")}}`);
-                    this.logPaths("←", changed.map((x)=>x.path), deleted.map((x)=>x.path));
+                    this.logPaths("←", _.map(changed, "path"), _.map(deleted, "path"));
                     // we need to processed deleted files first as we may delete an empty directory after a file has been put
                     // into it. if processed out of order the new file will be deleted as well
                     await pMap(deleted, async (file)=>{
@@ -326,14 +383,16 @@ class Sync extends BaseCommand {
                     await pMap(changed, async (file)=>{
                         this.recentRemoteChanges.add(file.path);
                         const absolutePath = this.absolute(file.path);
-                        if (file.path.endsWith("/")) {
+                        if (_.endsWith(file.path, "/")) {
                             await fs.ensureDir(absolutePath, {
                                 mode: 0o755
                             });
                             return;
                         }
-                        // we need to add the parent directory to recentRemoteChanges so that we don't try to publish it
-                        this.recentRemoteChanges.add(path.dirname(file.path) + "/");
+                        // we need to add all parent directories to recentRemoteChanges so that we don't re-publish them
+                        for (const dir of _.split(path.dirname(file.path), "/")){
+                            this.recentRemoteChanges.add(dir + "/");
+                        }
                         await fs.ensureDir(path.dirname(absolutePath), {
                             mode: 0o755
                         });
@@ -345,16 +404,22 @@ class Sync extends BaseCommand {
                                 "install"
                             ], {
                                 cwd: this.dir
-                            }).catch((err)=>{
-                                this.debug("yarn install failed");
-                                this.debug(err.message);
+                            }).catch((error)=>{
+                                context.addBreadcrumb({
+                                    category: "sync",
+                                    message: "Yarn install failed",
+                                    level: "error",
+                                    data: {
+                                        state: this.state,
+                                        error
+                                    }
+                                });
                             });
                         }
                         if (absolutePath == this.ignorer.filepath) {
                             this.ignorer.reload();
                         }
                     });
-                    this.debug("updated local files version from %s to %s", this.state.filesVersion, remoteFilesVersion);
                     this.state.filesVersion = remoteFilesVersion;
                     // always remove the root directory from recentRemoteChanges
                     this.recentRemoteChanges.delete("./");
@@ -364,6 +429,17 @@ class Sync extends BaseCommand {
                             this.recentRemoteChanges.delete(filepath);
                         }
                     }
+                    context.addBreadcrumb({
+                        category: "sync",
+                        message: "Processed received file sync events",
+                        data: {
+                            state: this.state,
+                            remoteFilesVersion: remoteFileSyncEvents.remoteFilesVersion,
+                            changed: _.map(remoteFileSyncEvents.changed, "path"),
+                            deleted: _.map(remoteFileSyncEvents.deleted, "path"),
+                            recentRemoteChanges: Array.from(this.recentRemoteChanges.keys())
+                        }
+                    });
                 });
             }
         });
@@ -372,6 +448,14 @@ class Sync extends BaseCommand {
             const localFiles = new Map(localFilesBuffer.entries());
             localFilesBuffer.clear();
             this._enqueue(async ()=>{
+                context.addBreadcrumb({
+                    category: "sync",
+                    message: "Publishing file sync events",
+                    data: {
+                        state: this.state,
+                        localFiles: Array.from(localFiles.keys())
+                    }
+                });
                 const changed = [];
                 const deleted = [];
                 await pMap(localFiles, async ([normalizedPath, file])=>{
@@ -381,16 +465,13 @@ class Sync extends BaseCommand {
                         });
                         return;
                     }
-                    const isRename = "oldPath" in file;
                     try {
                         changed.push({
                             path: normalizedPath,
+                            oldPath: "oldPath" in file ? file.oldPath : undefined,
                             mode: file.mode,
-                            content: file.isDirectory ? "" : await fs.readFile(this.absolute(normalizedPath), "base64"),
-                            encoding: FileSyncEncoding.Base64,
-                            ...isRename ? {
-                                oldPath: file.oldPath
-                            } : undefined
+                            content: file.isDirectory ? "" : await fs.readFile(this.absolute(normalizedPath), FileSyncEncoding.Base64),
+                            encoding: FileSyncEncoding.Base64
                         });
                     } catch (error) {
                         // A file could have been changed and then deleted before we process the change event, so the readFile
@@ -401,7 +482,7 @@ class Sync extends BaseCommand {
                 if (!changed.length && !deleted.length) {
                     return;
                 }
-                const data = await this.client.queryUnwrap({
+                const { publishFileSyncEvents } = await this.client.queryUnwrap({
                     query: PUBLISH_FILE_SYNC_EVENTS_MUTATION,
                     variables: {
                         input: {
@@ -411,32 +492,52 @@ class Sync extends BaseCommand {
                         }
                     }
                 });
-                this.log(chalkTemplate`Sent {gray ${format(new Date(), "pp")}}`);
-                this.logPaths("→", changed.map((x)=>x.path), deleted.map((x)=>x.path));
-                const { remoteFilesVersion } = data.publishFileSyncEvents;
-                this.debug("remote files version after publishing %s", remoteFilesVersion);
-                if (BigInt(remoteFilesVersion) > this.state.filesVersion) {
-                    this.debug("updated local files version from %s to %s", this.state.filesVersion, remoteFilesVersion);
-                    this.state.filesVersion = remoteFilesVersion;
+                context.addBreadcrumb({
+                    category: "sync",
+                    message: "Published file sync events",
+                    data: {
+                        state: this.state,
+                        remoteFilesVersion: publishFileSyncEvents.remoteFilesVersion,
+                        changed: _.map(changed, "path"),
+                        deleted: _.map(deleted, "path")
+                    }
+                });
+                if (BigInt(publishFileSyncEvents.remoteFilesVersion) > this.state.filesVersion) {
+                    this.state.filesVersion = publishFileSyncEvents.remoteFilesVersion;
                 }
+                this.log(chalkTemplate`Sent {gray ${format(new Date(), "pp")}}`);
+                this.logPaths("→", _.map(changed, "path"), _.map(deleted, "path"));
             });
         }, this.flags["file-push-delay"]);
-        this.on("error", (error)=>void this.stop(error)).on("all", (event, absolutePath, renamedPath)=>{
-            const filePath = event === "rename" || event === "renameDir" ? renamedPath : absolutePath;
+        this.watcher = new FSWatcher(this.dir, {
+            // paths that we never want to publish
+            ignore: /(\.gadget|\.git|node_modules)/,
+            // don't emit an event for every watched file on boot
+            ignoreInitial: true,
+            renameDetection: true,
+            recursive: true,
+            debounce: this.flags["file-watch-debounce"],
+            pollingInterval: this.flags["file-watch-poll-interval"],
+            pollingTimeout: this.flags["file-watch-poll-timeout"],
+            renameTimeout: this.flags["file-watch-rename-timeout"]
+        });
+        this.watcher.once("error", (error)=>void this.stop(error));
+        this.watcher.on("all", (event, absolutePath, renamedPath)=>{
+            const filepath = event === "rename" || event === "renameDir" ? renamedPath : absolutePath;
             const isDirectory = event === "renameDir" || event === "addDir" || event === "unlinkDir";
-            const normalizedPath = this.normalize(filePath, isDirectory);
-            const stats = Sync.fileStats(filePath);
-            // this shouldn't ever be the case using watcher since it doesn't support symlinks but we'll keep it here just in case we ever switch to another lib that does support it
-            if (stats?.isSymbolicLink?.()) {
-                this.debug("skipping event caused by symlink %s", normalizedPath);
-                return;
-            }
-            if (filePath == this.ignorer.filepath) {
+            const normalizedPath = this.normalize(filepath, isDirectory);
+            if (filepath == this.ignorer.filepath) {
                 this.ignorer.reload();
-            } else if (this.ignorer.ignores(filePath)) {
+            } else if (this.ignorer.ignores(filepath)) {
                 this.debug("skipping event caused by ignored file %s", normalizedPath);
                 return;
             }
+            let stats;
+            try {
+                stats = fs.statSync(filepath);
+            } catch (error) {
+                ignoreEnoent(error);
+            }
             // we only update the mtime if the file is not ignored, because if we restart and the mtime is set to an ignored
             // file, then it could be greater than the mtime of all non ignored files and we'll think that local files have
             // changed when only an ignored one has
@@ -447,7 +548,7 @@ class Sync extends BaseCommand {
                 this.debug("skipping event caused by recent write %s", normalizedPath);
                 return;
             }
-            this.debug("file changed %s", normalizedPath, event);
+            this.debug("%s %s", event, normalizedPath);
             switch(event){
                 case "add":
                 case "change":
@@ -515,10 +616,6 @@ class Sync extends BaseCommand {
             this.log("Goodbye!");
         }
     }
-    on(eventName, listener) {
-        this.watcher.on(eventName, listener);
-        return this;
-    }
     /**
    * Enqueues a function that handles file-sync events onto the {@linkcode queue}.
    *
@@ -612,6 +709,35 @@ _define_property(Sync, "flags", {
         helpValue: "ms",
         default: 100,
         hidden: true
+    }),
+    // The following flags are passed to FSWatcher (https://github.com/fabiospampinato/watcher)
+    "file-watch-debounce": Flags.integer({
+        summary: "Amount of milliseconds to debounce file changed events",
+        helpGroup: "file",
+        helpValue: "ms",
+        default: 300,
+        hidden: true
+    }),
+    "file-watch-poll-interval": Flags.integer({
+        summary: "Polling is used as a last resort measure when watching non-existent paths inside non-existent directories, this controls how often polling is performed, in milliseconds. You can set it to a lower value to make the app detect events much more quickly, but don't set it too low if you are watching many paths that require polling as polling is expensive.",
+        helpGroup: "file",
+        helpValue: "ms",
+        default: 3_000,
+        hidden: true
+    }),
+    "file-watch-poll-timeout": Flags.integer({
+        summary: "Sometimes polling will fail, for example if there are too many file descriptors currently open, usually eventually polling will succeed after a few tries though, this controls the amount of milliseconds the library should keep retrying for.",
+        helpGroup: "file",
+        helpValue: "ms",
+        default: 20_000,
+        hidden: true
+    }),
+    "file-watch-rename-timeout": Flags.integer({
+        summary: "Amount of milliseconds to wait for a potential rename/renameDir event to be detected. The higher this value is the more reliably renames will be detected, but don't set this too high, or the emission of some events could be delayed by that amount. The higher this value is the longer the library will take to emit add/addDir/unlink/unlinkDir events.",
+        helpGroup: "file",
+        helpValue: "ms",
+        default: 1_250,
+        hidden: true
     })
 });
 _define_property(Sync, "examples", [
@@ -700,6 +826,13 @@ var /**
    * @returns The SyncFile instance.
    */ static load(rootDir) {
         const state = fs.readJsonSync(path.join(rootDir, ".gadget/sync.json"));
+        context.addBreadcrumb({
+            category: "sync",
+            message: "Loaded sync state",
+            data: {
+                state
+            }
+        });
         assert(_.isString(state.app), "missing or invalid app");
         assert(_.isString(state.filesVersion), "missing or invalid filesVersion");
         assert(_.isNumber(state.mtime), "missing or invalid mtime");
@@ -714,6 +847,11 @@ var /**
    */ flush() {
         _class_private_field_get(this, _save).flush();
     }
+    /**
+   * @returns The JSON representation of this instance.
+   */ toJSON() {
+        return this._inner;
+    }
     constructor(_rootDir, inner){
         _define_property(this, "_rootDir", void 0);
         _define_property(this, "_inner", void 0);
@@ -726,6 +864,13 @@ var /**
             fs.outputJSONSync(path.join(this._rootDir, ".gadget/sync.json"), this._inner, {
                 spaces: 2
             });
+            context.addBreadcrumb({
+                category: "sync",
+                message: "Saved sync state",
+                data: {
+                    state: this._inner
+                }
+            });
         }, 100));
         this._inner = inner;
     }