dxfl 0.1.5 → 0.1.7

package/README.md

@@ -36,8 +36,11 @@ dxfl deploy example.com _public
 git clone https://git.deuxfleurs.fr/Deuxfleurs/dxfl
 cd dxfl
 npm install
+# build and install the tool as the `dxfl` command
 npm link
 dxfl
+# alternatively, run the tool from the sources directly
+npx dxfl
 ```
 
 ## Release
@@ -49,6 +52,8 @@ Then to publish a release:
 
 ```bash
 vim package.json # update the version in this file
+vim index.ts # update the version in this file
+npm install # update the version in the package-lock.json
 git commit -a -m 'set version 0.1.5' # commit your change
 git push # send update
 git tag -m 'v0.1.5' v0.1.5 # create associated tag

package/dist/deploy.js

@@ -100,7 +100,22 @@ function getBucketFiles(client, Bucket) {
         return files;
     });
 }
-function uploadFile(client, Bucket, Key, Body, md5) {
+function formatBytes(bytes) {
+    if (bytes < 1000) {
+        return `${bytes}B`;
+    }
+    bytes /= 1000;
+    if (bytes < 1000) {
+        return `${bytes.toFixed(2)}KB`;
+    }
+    bytes /= 1000;
+    if (bytes < 1000) {
+        return `${bytes.toFixed(2)}MB`;
+    }
+    bytes /= 1000;
+    return `${bytes.toFixed(2)}GB`;
+}
+function uploadFile(client, Bucket, Key, Body, md5, display) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a;
         // use `path.posix` because `Key` is a path in a bucket that uses `/` as separator.
@@ -115,13 +130,29 @@ function uploadFile(client, Bucket, Key, Body, md5) {
         const params = { Bucket, Key, Body, ContentType, Metadata };
         const parallelUpload = new Upload({ client, params });
         parallelUpload.on("httpUploadProgress", progress => {
-            process.stdout.moveCursor(0, -1);
-            process.stdout.clearLine(1);
-            process.stdout.write(`Sending ${progress.Key}`);
-            if (!(progress.loaded == progress.total && progress.part == 1)) {
-                process.stdout.write(` (${progress.loaded}/${progress.total})`);
+            function writeLine() {
+                process.stdout.write(`Sending ${progress.Key}`);
+                if (progress.loaded && progress.total &&
+                    !(progress.loaded == progress.total && progress.part == 1)) {
+                    process.stdout.write(` (${formatBytes(progress.loaded)}/${formatBytes(progress.total)})`);
+                }
+                process.stdout.write("\n");
+            }
+            ;
+            if (progress.Key) {
+                if (display.lines.has(progress.Key)) {
+                    const offset = display.nblines - display.lines.get(progress.Key);
+                    process.stdout.moveCursor(0, -offset);
+                    process.stdout.clearLine(1);
+                    writeLine();
+                    process.stdout.moveCursor(0, offset - 1);
+                }
+                else {
+                    display.lines.set(progress.Key, display.nblines);
+                    display.nblines++;
+                    writeLine();
+                }
             }
-            process.stdout.write("\n");
         });
         yield parallelUpload.done();
     });
@@ -134,7 +165,7 @@ function deleteFiles(client, Bucket, files) {
         return yield client.send(new DeleteObjectsCommand({
             Bucket,
             Delete: {
-                Objects: files.map(f => { return { Key: f }; }),
+                Objects: files.map(f => { return { Key: f.name }; }),
             },
         }));
     });
@@ -167,11 +198,11 @@ function needsUpdate(client, localFile, localMd5, Bucket, Key, remoteSize) {
         return (localMd5 != remoteMd5);
     });
 }
-export function deploy(vhost, localFolder) {
+export function deploy(vhost, localFolder, options) {
     return __awaiter(this, void 0, void 0, function* () {
         const conf = yield openApiConf();
         // Get paths of the local files to deploy
-        const localFiles = yield getLocalFiles(localFolder, "").catch(err => {
+        const localPaths = yield getLocalFiles(localFolder, "").catch(err => {
             if (err.errno = -2) {
                 console.error(`Error: directory '${localFolder}' does not exist`);
             }
@@ -180,6 +211,10 @@ export function deploy(vhost, localFolder) {
             }
             process.exit(1);
         });
+        // Compute local file sizes
+        const localFiles = yield Promise.all(localPaths.map((_a) => __awaiter(this, [_a], void 0, function* ({ localPath, s3Path }) {
+            return { localPath, s3Path, size: (yield fs.promises.stat(localPath)).size };
+        })));
         // Get website info from guichet (bucket name and keys)
         const api = new WebsiteApi(conf);
         let vhostInfo = yield api.getWebsite({ vhost }).catch(err => {
@@ -207,22 +242,40 @@ export function deploy(vhost, localFolder) {
         // Delete files that are present in the bucket but not locally.
         // Do this before sending the new files to avoid hitting the size quota
         // unnecessarily.
-        const resp = yield deleteFiles(s3client, Bucket, [...remoteFiles]
+        const filesToDelete = [...remoteFiles]
             .filter(([name, _]) => !localFiles.find(({ s3Path }) => s3Path == name))
-            .map(([name, _]) => name));
-        if (resp && resp.$metadata.httpStatusCode != 200) {
-            // TODO: better error handling?
-            console.error(resp);
-            process.exit(1);
+            .map(([name, { size }]) => ({ name, size }));
+        for (const file of filesToDelete) {
+            process.stdout.write(`Deleting ${file.name}\n`);
         }
-        // Uploads a local file unless the remote copy is the same
-        function processFile(localPath, s3Path) {
+        // If not in dry-run mode, send the delete command
+        if (!options.dryRun) {
+            const resp = yield deleteFiles(s3client, Bucket, filesToDelete);
+            if (resp && resp.$metadata.httpStatusCode != 200) {
+                // TODO: better error handling?
+                console.error(resp);
+                process.exit(1);
+            }
+        }
+        // Upload files.
+        let displaystate = {
+            lines: new Map(),
+            nblines: 0
+        };
+        let filesSent = [];
+        function processFile(f) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localMd5 = yield getFileMd5(localPath);
-                const remoteFile = remoteFiles.get(s3Path);
+                const remoteFile = remoteFiles.get(f.s3Path);
+                const localMd5 = yield getFileMd5(f.localPath);
                 if (!remoteFile ||
-                    (yield needsUpdate(s3client, localPath, localMd5, Bucket, s3Path, remoteFile.size))) {
-                    uploadFile(s3client, Bucket, s3Path, fs.createReadStream(localPath), localMd5);
+                    (yield needsUpdate(s3client, f.localPath, localMd5, Bucket, f.s3Path, remoteFile.size))) {
+                    filesSent.push({ s3Path: f.s3Path, size: f.size });
+                    if (options.dryRun) {
+                        process.stdout.write(`Sending ${f.s3Path}\n`);
+                    }
+                    else {
+                        yield uploadFile(s3client, Bucket, f.s3Path, fs.createReadStream(f.localPath), localMd5, displaystate);
+                    }
                 }
             });
         }
@@ -231,6 +284,27 @@ export function deploy(vhost, localFolder) {
         yield PromisePool
             .for(localFiles)
             .withConcurrency(6)
-            .process(({ localPath, s3Path }) => processFile(localPath, s3Path));
+            .process(processFile);
+        // Display a summary
+        function sum(a) { return a.reduce(((x, y) => x + y), 0); }
+        function formatFiles(n) {
+            if (n == 1) {
+                return `${n} file `;
+            }
+            else {
+                return `${n} files`;
+            }
+        }
+        const sizeSent = sum(filesSent.map((f) => f.size));
+        const sizeDeleted = sum(filesToDelete.map((f) => { var _a; return (_a = f.size) !== null && _a !== void 0 ? _a : 0; }));
+        let filesUnchanged = new Map(localFiles.map((f) => [f.s3Path, f.size]));
+        for (const f of filesSent) {
+            filesUnchanged.delete(f.s3Path);
+        }
+        const sizeUnchanged = sum([...filesUnchanged.values()]);
+        process.stdout.write("\nSummary:\n");
+        process.stdout.write(`${formatFiles(filesSent.length)} uploaded (${formatBytes(sizeSent)})\n`);
+        process.stdout.write(`${formatFiles(filesToDelete.length)} deleted (${formatBytes(sizeDeleted)})\n`);
+        process.stdout.write(`${formatFiles(filesUnchanged.size)} unchanged (${formatBytes(sizeUnchanged)})\n`);
     });
 }

package/dist/index.js

@@ -6,7 +6,7 @@ import { vhostsList } from "./vhosts.js";
 program
     .name('dxfl')
     .description('Deuxfleurs CLI tool')
-    .version('0.1.0');
+    .version('0.1.7');
 program.command('login')
     .description('Link your Deuxfleurs account with this tool.')
     .argument('<username>', 'your account username')
@@ -18,5 +18,6 @@ program.command('deploy')
     .description('Deploy your website')
     .argument('<vhost>', 'selected vhost')
     .argument('<local_folder>', 'your local folder')
+    .option('-n, --dry-run', 'do a trial run without making actual changes')
     .action(deploy);
 program.parse();

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "dxfl",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "",
   "license": "EUPL-1.2",
   "author": "Deuxfleurs Team <coucou@deuxfleurs.fr>",
   "type": "module",
   "main": "dist/main.js",
   "bin": {
-    "dxfl": "./dist/index.js"
+    "dxfl": "dist/index.js"
   },
   "scripts": {
     "prepare": "npx tsc"