@gadgetinc/ggt 0.1.17 → 0.1.18

package/README.md

@@ -129,7 +129,7 @@ EXAMPLES
   Goodbye!
 ```
 
-_See code: [src/commands/sync.ts](https://github.com/gadget-inc/ggt/blob/v0.1.17/src/commands/sync.ts)_
+_See code: [src/commands/sync.ts](https://github.com/gadget-inc/ggt/blob/v0.1.18/src/commands/sync.ts)_
 
 ### `ggt help [COMMAND]`
 
@@ -143,7 +143,7 @@ ARGUMENTS
   COMMAND  The command to show help for.
 ```
 
-_See code: [src/commands/help.ts](https://github.com/gadget-inc/ggt/blob/v0.1.17/src/commands/help.ts)_
+_See code: [src/commands/help.ts](https://github.com/gadget-inc/ggt/blob/v0.1.18/src/commands/help.ts)_
 
 ### `ggt list`
 
@@ -170,7 +170,7 @@ EXAMPLES
   $ ggt list --sort=slug
 ```
 
-_See code: [src/commands/list.ts](https://github.com/gadget-inc/ggt/blob/v0.1.17/src/commands/list.ts)_
+_See code: [src/commands/list.ts](https://github.com/gadget-inc/ggt/blob/v0.1.18/src/commands/list.ts)_
 
 ### `ggt login`
 
@@ -189,7 +189,7 @@ EXAMPLES
   Hello, Jane Doe (jane@example.com)
 ```
 
-_See code: [src/commands/login.ts](https://github.com/gadget-inc/ggt/blob/v0.1.17/src/commands/login.ts)_
+_See code: [src/commands/login.ts](https://github.com/gadget-inc/ggt/blob/v0.1.18/src/commands/login.ts)_
 
 ### `ggt logout`
 
@@ -204,7 +204,7 @@ EXAMPLES
   Goodbye
 ```
 
-_See code: [src/commands/logout.ts](https://github.com/gadget-inc/ggt/blob/v0.1.17/src/commands/logout.ts)_
+_See code: [src/commands/logout.ts](https://github.com/gadget-inc/ggt/blob/v0.1.18/src/commands/logout.ts)_
 
 ### `ggt whoami`
 
@@ -219,7 +219,7 @@ EXAMPLES
   You are logged in as Jane Doe (jane@example.com)
 ```
 
-_See code: [src/commands/whoami.ts](https://github.com/gadget-inc/ggt/blob/v0.1.17/src/commands/whoami.ts)_
+_See code: [src/commands/whoami.ts](https://github.com/gadget-inc/ggt/blob/v0.1.18/src/commands/whoami.ts)_
 
 <!-- commandsstop -->
 

package/lib/commands/sync.d.ts

@@ -35,7 +35,7 @@ export default class Sync extends BaseCommand<typeof Sync> {
      * A list of filepaths that have changed because of a remote file-sync event. This is used to avoid sending files that
      * we recently received from a remote file-sync event.
      */
-    recentRemoteChanges: Set<unknown>;
+    recentRemoteChanges: Set<string>;
     /**
      * A FIFO async callback queue that ensures we process file-sync events in the order they occurred.
      */
@@ -91,19 +91,20 @@ export default class Sync extends BaseCommand<typeof Sync> {
     absolute(...pathSegments: string[]): string;
     /**
      * Similar to {@linkcode relative} in that it turns a filepath into a relative one from {@linkcode dir}. However, it
-     * also changes any slashes to be posix/unix-like forward slashes, condenses repeat slashes into a single slash.
+     * also changes any slashes to be posix/unix-like forward slashes, condenses repeated slashes into a single slash, and
+     * adds a trailing slash if the filepath is a directory.
      *
      * This is used when sending file-sync events to Gadget to ensure that the paths are consistent across platforms.
      *
      * @see https://www.npmjs.com/package/normalize-path
      */
-    normalize(filepath: string, isDirectory?: boolean): string;
+    normalize(filepath: string, isDirectory: boolean): string;
     /**
      * Pretty-prints changed and deleted filepaths to the console.
      *
      * @param prefix The prefix to print before each line.
-     * @param changed The filepaths that have changed.
-     * @param deleted The filepaths that have been deleted.
+     * @param changed The normalized paths that have changed.
+     * @param deleted The normalized paths that have been deleted.
      * @param options.limit The maximum number of lines to print. Defaults to 10. If debug is enabled, this is ignored.
      */
     logPaths(prefix: string, changed: string[], deleted: string[], { limit }?: {
@@ -122,6 +123,12 @@ export default class Sync extends BaseCommand<typeof Sync> {
      * Runs the sync process until it is stopped or an error occurs.
      */
     run(): Promise<void>;
+    /**
+     * Enqueues a function that handles file-sync events onto the {@linkcode queue}.
+     *
+     * @param fn The function to enqueue.
+     */
+    private _enqueue;
 }
 export declare enum SyncStatus {
     STARTING = 0,

package/lib/commands/sync.js

@@ -159,27 +159,28 @@ class Sync extends base_command_1.BaseCommand {
     }
     /**
      * Similar to {@linkcode relative} in that it turns a filepath into a relative one from {@linkcode dir}. However, it
-     * also changes any slashes to be posix/unix-like forward slashes, condenses repeat slashes into a single slash.
+     * also changes any slashes to be posix/unix-like forward slashes, condenses repeated slashes into a single slash, and
+     * adds a trailing slash if the filepath is a directory.
      *
      * This is used when sending file-sync events to Gadget to ensure that the paths are consistent across platforms.
      *
      * @see https://www.npmjs.com/package/normalize-path
      */
-    normalize(filepath, isDirectory = false) {
+    normalize(filepath, isDirectory) {
         return (0, normalize_path_1.default)(path_1.default.isAbsolute(filepath) ? this.relative(filepath) : filepath) + (isDirectory ? "/" : "");
     }
     /**
      * Pretty-prints changed and deleted filepaths to the console.
      *
      * @param prefix The prefix to print before each line.
-     * @param changed The filepaths that have changed.
-     * @param deleted The filepaths that have been deleted.
+     * @param changed The normalized paths that have changed.
+     * @param deleted The normalized paths that have been deleted.
      * @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 = (0, lodash_1.sortBy)([
-            ...changed.map((filepath) => (0, chalk_1.default) `{green ${prefix}} ${this.normalize(filepath)} {gray (changed)}`),
-            ...deleted.map((filepath) => (0, chalk_1.default) `{red ${prefix}} ${this.normalize(filepath)} {gray (deleted)}`),
+            ...changed.map((normalizedPath) => (0, chalk_1.default) `{green ${prefix}} ${normalizedPath} {gray (changed)}`),
+            ...deleted.map((normalizedPath) => (0, chalk_1.default) `{red ${prefix}} ${normalizedPath} {gray (deleted)}`),
         ], (line) => line.slice(line.indexOf(" ") + 1));
         let logged = 0;
         for (const line of lines) {
@@ -262,14 +263,14 @@ class Sync extends base_command_1.BaseCommand {
         const hasRemoteChanges = BigInt(remoteFilesVersion) > BigInt(this.metadata.filesVersion);
         const getChangedFiles = async () => {
             const files = new Map();
-            for await (const filepath of (0, fs_utils_1.walkDir)(this.dir, { ignorer: this.ignorer })) {
-                const stats = await fs_extra_1.default.stat(filepath);
+            for await (const absolutePath of (0, fs_utils_1.walkDir)(this.dir, { ignorer: this.ignorer })) {
+                const stats = await fs_extra_1.default.stat(absolutePath);
                 if (stats.mtime.getTime() > this.metadata.mtime) {
-                    files.set(this.absolute(filepath), stats);
+                    files.set(this.normalize(absolutePath, stats.isDirectory()), stats);
                 }
             }
             // never include the root directory
-            files.delete(this.dir);
+            files.delete("/");
             return files;
         };
         const changedFiles = await getChangedFiles();
@@ -301,15 +302,14 @@ class Sync extends base_command_1.BaseCommand {
                     variables: {
                         input: {
                             expectedRemoteFilesVersion: remoteFilesVersion,
-                            changed: await (0, p_map_1.default)(files, async ([filepath, stats]) => {
+                            changed: await (0, p_map_1.default)(files, async ([normalizedPath, stats]) => {
                                 if (stats.mtime.getTime() > this.metadata.mtime) {
                                     this.metadata.mtime = stats.mtime.getTime();
                                 }
-                                const isDirectory = stats.isDirectory();
                                 return {
-                                    path: this.normalize(filepath, isDirectory),
+                                    path: normalizedPath,
                                     mode: stats.mode,
-                                    content: isDirectory ? "" : await fs_extra_1.default.readFile(filepath, "base64"),
+                                    content: stats.isDirectory() ? "" : await fs_extra_1.default.readFile(this.absolute(normalizedPath), "base64"),
                                     encoding: graphql_1.FileSyncEncoding.Base64,
                                 };
                             }),
@@ -322,7 +322,7 @@ class Sync extends base_command_1.BaseCommand {
             case Action.RESET: {
                 // 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 (0, p_map_1.default)(changedFiles, ([filepath]) => fs_extra_1.default.remove(filepath));
+                await (0, p_map_1.default)(changedFiles.keys(), (normalizedPath) => fs_extra_1.default.remove(this.absolute(normalizedPath)));
                 this.metadata.filesVersion = "0";
                 break;
             }
@@ -379,13 +379,14 @@ class Sync extends base_command_1.BaseCommand {
             variables: () => ({ localFilesVersion: this.metadata.filesVersion }),
         }, {
             error: (error) => void this.stop(error),
-            next: ({ remoteFileSyncEvents: { remoteFilesVersion, changed, deleted } }) => {
-                const remoteFiles = new Map([...deleted, ...changed]
-                    .filter((event) => event.path.startsWith(".gadget/") || !this.ignorer.ignores(event.path))
-                    .map((e) => [e.path, e]));
-                void this.queue
-                    .add(async () => {
-                    if (!remoteFiles.size) {
+            next: ({ remoteFileSyncEvents }) => {
+                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);
+                this._enqueue(async () => {
+                    if (!changed.length && !deleted.length) {
                         if (BigInt(remoteFilesVersion) > BigInt(this.metadata.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.metadata.filesVersion, remoteFilesVersion);
@@ -394,106 +395,104 @@ class Sync extends base_command_1.BaseCommand {
                         return;
                     }
                     this.log((0, chalk_1.default) `Received {gray ${(0, format_1.default)(new Date(), "pp")}}`);
-                    this.logPaths("←", changed.map((x) => x.path).filter((x) => remoteFiles.has(x)), deleted.map((x) => x.path).filter((x) => remoteFiles.has(x)));
-                    const handleFiles = async (files) => await (0, p_map_1.default)(files, async (file) => {
-                        if (!remoteFiles.has(file.path)) {
+                    this.logPaths("←", changed.map((x) => x.path), deleted.map((x) => x.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 is deleted as well
+                    await (0, p_map_1.default)(deleted, async (file) => {
+                        this.recentRemoteChanges.add(file.path);
+                        await fs_extra_1.default.remove(this.absolute(file.path));
+                    });
+                    await (0, p_map_1.default)(changed, async (file) => {
+                        this.recentRemoteChanges.add(file.path);
+                        const absolutePath = this.absolute(file.path);
+                        if (file.path.endsWith("/")) {
+                            await fs_extra_1.default.ensureDir(absolutePath, { mode: 0o755 });
                             return;
                         }
-                        const filepath = this.absolute(file.path);
-                        this.recentRemoteChanges.add(filepath);
-                        if ("content" in file) {
-                            if (!file.path.endsWith("/")) {
-                                this.recentRemoteChanges.add(path_1.default.dirname(filepath));
-                                await fs_extra_1.default.ensureDir(path_1.default.dirname(filepath), { mode: 0o755 });
-                                await fs_extra_1.default.writeFile(filepath, Buffer.from(file.content, file.encoding ?? graphql_1.FileSyncEncoding.Utf8), {
-                                    mode: file.mode,
-                                });
-                            }
-                            else {
-                                await fs_extra_1.default.ensureDir(filepath, { mode: 0o755 });
-                            }
-                            if (filepath == this.absolute("yarn.lock")) {
-                                await (0, execa_1.default)("yarn", ["install"], { cwd: this.dir }).catch((err) => {
-                                    this.debug("yarn install failed");
-                                    this.debug(err.message);
-                                });
-                            }
-                        }
-                        else {
-                            await fs_extra_1.default.remove(filepath);
+                        // we need to add the parent directory to recentRemoteChanges so that we don't try to publish it
+                        this.recentRemoteChanges.add(path_1.default.dirname(file.path) + "/");
+                        await fs_extra_1.default.ensureDir(path_1.default.dirname(absolutePath), { mode: 0o755 });
+                        await fs_extra_1.default.writeFile(absolutePath, Buffer.from(file.content, file.encoding), { mode: file.mode });
+                        if (absolutePath == this.absolute("yarn.lock")) {
+                            await (0, execa_1.default)("yarn", ["install"], { cwd: this.dir }).catch((err) => {
+                                this.debug("yarn install failed");
+                                this.debug(err.message);
+                            });
                         }
-                        if (filepath == this.ignorer.filepath) {
+                        if (absolutePath == this.ignorer.filepath) {
                             this.ignorer.reload();
                         }
-                    }, { stopOnError: false });
-                    // we need to processed deleted files first as we may delete an empty directory once a file has been put into it. if processed out of order the new file is deleted as well
-                    await handleFiles(deleted);
-                    await handleFiles(changed);
+                    });
                     this.debug("updated local files version from %s to %s", this.metadata.filesVersion, remoteFilesVersion);
                     this.metadata.filesVersion = remoteFilesVersion;
-                })
-                    .catch(this.stop);
+                    // always remove the root directory from recentRemoteChanges
+                    this.recentRemoteChanges.delete("./");
+                    // remove any files in recentRemoteChanges that are ignored (e.g. .gadget/ files)
+                    for (const filepath of this.recentRemoteChanges) {
+                        if (this.ignorer.ignores(filepath)) {
+                            this.recentRemoteChanges.delete(filepath);
+                        }
+                    }
+                });
             },
         });
         const localFilesBuffer = new Map();
         this.publish = (0, lodash_2.debounce)(() => {
             const localFiles = new Map(localFilesBuffer.entries());
             localFilesBuffer.clear();
-            void this.queue
-                .add(async () => {
+            this._enqueue(async () => {
                 const changed = [];
                 const deleted = [];
-                await (0, p_map_1.default)(localFiles, async ([filepath, file]) => {
+                await (0, p_map_1.default)(localFiles, async ([normalizedPath, file]) => {
                     if ("isDeleted" in file) {
-                        deleted.push({ path: this.normalize(filepath, file.isDirectory) });
+                        deleted.push({ path: normalizedPath });
+                        return;
                     }
-                    else {
-                        try {
-                            changed.push({
-                                path: this.normalize(filepath, file.isDirectory),
-                                mode: file.mode,
-                                content: file.isDirectory ? "" : await fs_extra_1.default.readFile(filepath, "base64"),
-                                encoding: graphql_1.FileSyncEncoding.Base64,
-                            });
-                        }
-                        catch (error) {
-                            // A file could have been changed and then deleted before we process the change event, so the readFile
-                            // above will raise an ENOENT. This is normal operation, so just ignore this event.
-                            (0, fs_utils_1.ignoreEnoent)(error);
-                        }
+                    try {
+                        changed.push({
+                            path: normalizedPath,
+                            mode: file.mode,
+                            content: file.isDirectory ? "" : await fs_extra_1.default.readFile(this.absolute(normalizedPath), "base64"),
+                            encoding: graphql_1.FileSyncEncoding.Base64,
+                        });
                     }
-                }, { stopOnError: false });
-                if (changed.length > 0 || deleted.length > 0) {
-                    const data = await this.client.queryUnwrap({
-                        query: exports.PUBLISH_FILE_SYNC_EVENTS_MUTATION,
-                        variables: { input: { expectedRemoteFilesVersion: this.metadata.filesVersion, changed, deleted } },
-                    });
-                    this.log((0, chalk_1.default) `Sent {gray ${(0, format_1.default)(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) > BigInt(this.metadata.filesVersion)) {
-                        this.debug("updated local files version from %s to %s", this.metadata.filesVersion, remoteFilesVersion);
-                        this.metadata.filesVersion = remoteFilesVersion;
+                    catch (error) {
+                        // A file could have been changed and then deleted before we process the change event, so the readFile
+                        // above will raise an ENOENT. This is normal operation, so just ignore this event.
+                        (0, fs_utils_1.ignoreEnoent)(error);
                     }
+                });
+                if (!changed.length && !deleted.length) {
+                    return;
+                }
+                const data = await this.client.queryUnwrap({
+                    query: exports.PUBLISH_FILE_SYNC_EVENTS_MUTATION,
+                    variables: { input: { expectedRemoteFilesVersion: this.metadata.filesVersion, changed, deleted } },
+                });
+                this.log((0, chalk_1.default) `Sent {gray ${(0, format_1.default)(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) > BigInt(this.metadata.filesVersion)) {
+                    this.debug("updated local files version from %s to %s", this.metadata.filesVersion, remoteFilesVersion);
+                    this.metadata.filesVersion = remoteFilesVersion;
                 }
-            })
-                .catch(this.stop);
+            });
         }, this.flags["file-push-delay"]);
         this.watcher
             .add(`${this.dir}/**/*`)
             .on("error", (error) => void this.stop(error))
-            .on("all", (event, filepath, stats) => {
-            const relativePath = this.relative(filepath);
+            .on("all", (event, absolutePath, stats) => {
+            const normalizedPath = this.normalize(absolutePath, event == "addDir" || event == "unlinkDir");
             if (stats?.isSymbolicLink?.()) {
-                this.debug("skipping event caused by symlink %s", relativePath);
+                this.debug("skipping event caused by symlink %s", normalizedPath);
                 return;
             }
-            if (filepath == this.ignorer.filepath) {
+            if (absolutePath == this.ignorer.filepath) {
                 this.ignorer.reload();
             }
-            else if (this.ignorer.ignores(filepath)) {
-                this.debug("skipping event caused by ignored file %s", relativePath);
+            else if (this.ignorer.ignores(absolutePath)) {
+                this.debug("skipping event caused by ignored file %s", normalizedPath);
                 return;
             }
             // we only update the mtime if the file is not ignored, because if we restart and the mtime is set to an ignored
@@ -502,24 +501,24 @@ class Sync extends base_command_1.BaseCommand {
             if (stats && stats.mtime.getTime() > this.metadata.mtime) {
                 this.metadata.mtime = stats.mtime.getTime();
             }
-            if (this.recentRemoteChanges.delete(filepath)) {
-                this.debug("skipping event caused by recent write %s", relativePath);
+            if (this.recentRemoteChanges.delete(normalizedPath)) {
+                this.debug("skipping event caused by recent write %s", normalizedPath);
                 return;
             }
-            this.debug("file changed %s", relativePath, event);
+            this.debug("file changed %s", normalizedPath, event);
             switch (event) {
                 case "add":
                 case "change":
                     (0, assert_1.default)(stats, "missing stats on add/change event");
-                    localFilesBuffer.set(filepath, { mode: stats.mode, mtime: stats.mtime.getTime(), isDirectory: false });
+                    localFilesBuffer.set(normalizedPath, { mode: stats.mode, isDirectory: false });
                     break;
                 case "addDir":
                     (0, assert_1.default)(stats, "missing stats on addDir event");
-                    localFilesBuffer.set(filepath, { mode: stats.mode, mtime: stats.mtime.getTime(), isDirectory: true });
+                    localFilesBuffer.set(normalizedPath, { mode: stats.mode, isDirectory: true });
                     break;
                 case "unlinkDir":
                 case "unlink":
-                    localFilesBuffer.set(filepath, { isDeleted: true, isDirectory: event === "unlinkDir" });
+                    localFilesBuffer.set(normalizedPath, { isDeleted: true, isDirectory: event === "unlinkDir" });
                     break;
             }
             this.publish();
@@ -555,6 +554,14 @@ class Sync extends base_command_1.BaseCommand {
             this.log("Goodbye!");
         }
     }
+    /**
+     * Enqueues a function that handles file-sync events onto the {@linkcode queue}.
+     *
+     * @param fn The function to enqueue.
+     */
+    _enqueue(fn) {
+        void this.queue.add(fn).catch(this.stop);
+    }
 }
 Object.defineProperty(Sync, "priority", {
     enumerable: true,