dxfl 0.1.10 → 0.2.0

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v0.2.0
+
+- hint towards new website names (XXX.web.deuxfleurs.fr), following an overhaul in website name handling in deuxfleurs
+- thorough error handling overhaul: dxfl now handles errors gracefully in most cases
+
+# v0.1.11
+
+- Lower files upload concurrency (from 50 to 20) to avoid IO issues
+
 # v0.1.10
 
 - new `logout` command: removes dxfl config folder containing the credentials

package/README.md

@@ -10,8 +10,6 @@ npm install -g dxfl
 
 ## Usage
 
-_Warning: software still in an experimental state_
-
 Start by logging in with your username, for example for `john`:
 
 ```

package/dist/auth.js

@@ -7,10 +7,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { Configuration, WebsiteApi } from "guichet-sdk-ts";
+import { Configuration } from "guichet-sdk-ts";
 import { read } from "read";
 import path from "node:path";
 import fs from "node:fs/promises";
+import { ErrorMsg } from "./error.js";
+import { GuichetApi } from "./guichet.js";
 import { confirmationPrompt } from "./utils.js";
 function configPath() {
     let path = ".dxfl/config.json";
@@ -80,17 +82,23 @@ export function openApiConf() {
                 yield moveOldConfig(); // Check for old config folder to rename
                 strConf = yield fs.readFile(configFile, { encoding: "utf8" });
             }
-            catch (err) {
-                console.error(err, `\n\nUnable to read ${configFile}, run 'dxfl login' first.`);
-                process.exit(1);
+            catch (e) {
+                let msg = `failed to read ${configFile}`;
+                if (e instanceof Error && "code" in e && e.code) {
+                    msg = msg + ` (${e.code})`;
+                }
+                throw new ErrorMsg(msg);
             }
         }
         try {
             dictConf = JSON.parse(strConf);
         }
-        catch (err) {
-            console.error(err, `\n\nUnable to parse ${configFile} as JSON, check your syntax. Did you manually edit this file?`);
-            process.exit(1);
+        catch (e) {
+            let msg = `Unable to parse ${configFile} as JSON. Did you manually edit this file?`;
+            if (e instanceof Error) {
+                msg = msg + ` (${e.message})`;
+            }
+            throw new ErrorMsg(msg);
         }
         // @FIXME: we do not validate that the dictConf object really contains a username or password field...
         return new Configuration({
@@ -111,14 +119,8 @@ export function login(username) {
             username: username,
             password: password,
         });
-        const web = new WebsiteApi(testConf);
-        try {
-            yield web.listWebsites();
-        }
-        catch (err) {
-            console.error(err, `\n\nLogin failed. Is your username and password correct?`);
-            process.exit(1);
-        }
+        const guichet = new GuichetApi(testConf);
+        yield guichet.listWebsites();
         // create config folder if needed
         const configFile = configPath();
         const parent = path.dirname(configFile);
@@ -128,7 +130,7 @@ export function login(username) {
         const serializedConfig = JSON.stringify(configData);
         yield fs.writeFile(configFile, serializedConfig, { mode: 0o600 });
         // @FIXME: we would like to avoid storing the password in clear text in the future.
-        console.log("ok");
+        console.log("Success.");
     });
 }
 export function logout(options) {
@@ -140,12 +142,11 @@ export function logout(options) {
             yield fs.access(configFile);
         }
         catch (err) {
-            console.error(err, `\n\nUnable to find ${configFile}. Are you logged on this device?`);
-            process.exit(1);
+            throw new ErrorMsg(`Unable to find ${configFile}. Are you logged on this device?`);
         }
         // If not --yes: ask for confirmation before proceeding
         if (!options.yes) {
-            process.stdout.write(`Are you sure to clean dxfl's config folder? (${parentFolder})\n`);
+            process.stdout.write(`This will clear dxfl's config folder. Proceed? (${parentFolder})\n`);
             const ok = yield confirmationPrompt(() => {
                 process.stdout.write("Details of planned operations:\n");
                 process.stdout.write(`  Delete file ${configFile}\n`);
@@ -162,8 +163,7 @@ export function logout(options) {
             process.stdout.write("You can now go outside, feel the sun and touch grass, you are free! ☀️\n");
         }
         catch (err) {
-            console.error(err, `\n\nUnable to cleanup config folder. Do you have the permission to delete ${parentFolder}?`);
-            process.exit(1);
+            throw new ErrorMsg(`Unable to cleanup config folder. Do you have the permission to delete ${parentFolder}?`);
         }
     });
 }

package/dist/bucket.js

@@ -9,21 +9,22 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import fs from "fs";
 import mime from "mime";
-import { WebsiteApi } from "guichet-sdk-ts";
 import { DeleteObjectCommand, DeleteObjectsCommand, HeadObjectCommand, ListObjectsV2Command, PutObjectCommand, S3Client, } from "@aws-sdk/client-s3";
 import { PromisePool } from "@supercharge/promise-pool";
 import { apiConfExists, openApiConf } from "./auth.js";
+import { ErrorMsg, wrapS3Call } from "./error.js";
+import { GuichetApi } from "./guichet.js";
 import { parseEtag, toChunks, formatBytesHuman } from "./utils.js";
 export function getBucketCredentials(name) {
     return __awaiter(this, void 0, void 0, function* () {
         if (yield apiConfExists()) {
-            const api = new WebsiteApi(yield openApiConf());
-            return yield credentialsFromApi(api, name);
+            const guichet = new GuichetApi(yield openApiConf());
+            return yield credentialsFromApi(guichet, name);
         }
         else {
             const creds = credentialsFromEnv();
             if (creds === undefined) {
-                throw new Error("Failed to load credentials.\n" +
+                throw new ErrorMsg("Failed to load credentials.\n" +
                     "You need to run 'dxfl login', " +
                     "or define the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables.");
             }
@@ -42,19 +43,10 @@ function credentialsFromEnv() {
         return undefined;
     }
 }
-function credentialsFromApi(api, website) {
+function credentialsFromApi(guichet, website) {
     return __awaiter(this, void 0, void 0, function* () {
         // Get website info from guichet (bucket name and keys)
-        const bucket = yield api.getWebsite({ vhost: website }).catch(err => {
-            var _a;
-            if (((_a = err === null || err === void 0 ? void 0 : err.response) === null || _a === void 0 ? void 0 : _a.status) == 404) {
-                console.error(`Error: website '${website}' does not exist`);
-            }
-            else {
-                console.error(err);
-            }
-            throw new Error(err);
-        });
+        const bucket = yield guichet.getWebsite(website);
         return { key: bucket.accessKeyId, secret: bucket.secretAccessKey };
     });
 }
@@ -79,11 +71,7 @@ export function getBucketFiles(bucket) {
         let done = false;
         let cmd = new ListObjectsV2Command({ Bucket: bucket.name });
         while (!done) {
-            const resp = yield bucket.client.send(cmd);
-            if (resp.$metadata.httpStatusCode != 200) {
-                // TODO: better error handling?
-                throw resp;
-            }
+            const resp = yield wrapS3Call("list bucket files", [200], () => bucket.client.send(cmd));
             if (resp.Contents) {
                 for (const item of resp.Contents) {
                     const etag = item.ETag ? parseEtag(item.ETag) : undefined;
@@ -110,11 +98,7 @@ export function getBucketFilesDetails(bucket, files) {
         let res = new Map();
         function doFile(file) {
             return __awaiter(this, void 0, void 0, function* () {
-                const resp = yield bucket.client.send(new HeadObjectCommand({ Bucket: bucket.name, Key: file }));
-                if (resp.$metadata.httpStatusCode != 200) {
-                    // TODO: better error handling?
-                    throw resp;
-                }
+                const resp = yield wrapS3Call(`read metadata of file "${file}"`, [200], () => bucket.client.send(new HeadObjectCommand({ Bucket: bucket.name, Key: file })));
                 res.set(file, {
                     redirect: resp.WebsiteRedirectLocation,
                 });
@@ -131,14 +115,10 @@ export function getBucketFilesDetails(bucket, files) {
 }
 export function deleteBucketFile(bucket, name) {
     return __awaiter(this, void 0, void 0, function* () {
-        const resp = yield bucket.client.send(new DeleteObjectCommand({
+        yield wrapS3Call(`delete file "${name}"`, [204], () => bucket.client.send(new DeleteObjectCommand({
             Bucket: bucket.name,
             Key: name,
-        }));
-        if (resp && resp.$metadata.httpStatusCode != 204) {
-            // TODO: better error handling?
-            throw resp;
-        }
+        })));
     });
 }
 export function deleteBucketFiles(bucket, files) {
@@ -153,18 +133,14 @@ export function deleteBucketFiles(bucket, files) {
             for (const file of files) {
                 process.stdout.write(`  Delete ${file.name} (${file.size ? formatBytesHuman(file.size) : "?B"})\n`);
             }
-            const resp = yield bucket.client.send(new DeleteObjectsCommand({
+            yield wrapS3Call(`deleting ${files.length} files`, [200], () => bucket.client.send(new DeleteObjectsCommand({
                 Bucket: bucket.name,
                 Delete: {
                     Objects: files.map(f => {
                         return { Key: f.name };
                     }),
                 },
-            }));
-            if (resp && resp.$metadata.httpStatusCode != 200) {
-                // TODO: better error handling?
-                throw resp;
-            }
+            })));
         }));
     });
 }
@@ -179,10 +155,7 @@ export function uploadFile(bucket, s3Path, localPath) {
         }
         const Body = fs.createReadStream(localPath);
         const params = { Bucket: bucket.name, Key: s3Path, Body, ContentType };
-        const resp = yield bucket.client.send(new PutObjectCommand(params));
-        if (resp && resp.$metadata.httpStatusCode != 200) {
-            throw resp;
-        }
+        yield wrapS3Call(`upload "${s3Path}"`, [200], () => bucket.client.send(new PutObjectCommand(params)));
     });
 }
 // the 'source' object may or may not exist already in the bucket.
@@ -198,9 +171,6 @@ export function putEmptyObjectRedirect(bucket, source, target) {
             Body: "source of object redirect",
             WebsiteRedirectLocation: target,
         };
-        const resp = yield bucket.client.send(new PutObjectCommand(params));
-        if (resp && resp.$metadata.httpStatusCode != 200) {
-            throw resp;
-        }
+        yield wrapS3Call(`create redirection source object ${source}`, [200], () => bucket.client.send(new PutObjectCommand(params)));
     });
 }

package/dist/deploy.js

@@ -11,6 +11,7 @@ import fs from "fs";
 import path from "path";
 import { PromisePool } from "@supercharge/promise-pool";
 import { deleteBucketFile, deleteBucketFiles, getBucketCredentials, getBucket, getBucketFiles, putEmptyObjectRedirect, uploadFile, } from "./bucket.js";
+import { ErrorMsg } from "./error.js";
 import { confirmationPrompt, filterMap, formatBytesHuman, formatCount, getFileMd5, sum, } from "./utils.js";
 import { equalBucketRedirect, equalCorsRules, getBucketConfig, putBucketWebsiteConfig, putCorsRules, readConfigFile, } from "./website_config.js";
 // Walks through the local directory at path `dir`, and for each file it contains, returns :
@@ -39,10 +40,10 @@ function getLocalFilesWithInfo(localFolder) {
     return __awaiter(this, void 0, void 0, function* () {
         const localPaths = yield getLocalFiles(localFolder).catch(err => {
             if (err.errno == -2) {
-                throw `directory '${localFolder}' does not exist`;
+                throw new ErrorMsg(`directory '${localFolder}' does not exist`);
             }
             else {
-                throw err;
+                throw new ErrorMsg(`failed to read directory ${localFolder} (${err.message})`);
             }
         });
         return yield Promise.all(localPaths.map((_a) => __awaiter(this, [_a], void 0, function* ({ localPath, s3Path }) {
@@ -73,14 +74,15 @@ function computeDeployPlan(localFiles, remoteFiles, localCfg, remoteCfg) {
         return ret;
     });
     if (localRedirectSources.length > 0) {
-        console.error("Error: the following local files are also the source of a redirection:");
+        let msg = "the following local files are also the source of a redirection:\n";
         for (const [f, target] of localRedirectSources) {
             console.error(`  ${f.localPath} (redirect to: ${target})`);
         }
-        console.error("\nIt does not make sense for a local file to also be the source of a redirection,\n" +
-            "because its contents will never be read.");
-        console.error("Please delete these files or the corresponding redirections.");
-        process.exit(1);
+        msg +=
+            "It does not make sense for a local file to also be the source of a redirection,\n" +
+                "because its contents will never be read.\n" +
+                "Please delete these files or the corresponding redirections.";
+        throw new ErrorMsg(msg);
     }
     // Compute object redirects that need to be set because the redirection is new,
     // the target was changed, or because the source object changed.
@@ -165,8 +167,8 @@ function printPlan(plan, details) {
         const proto = r.protocol ? `${r.protocol}://` : "";
         const hostname = r.hostname ? `${r.hostname}/` : "";
         const status = r.status ? ` status=${r.status}` : "";
-        const force = r.force ? `  force=${r.force}` : "";
-        return `${proto}${hostname}${to}${status}${force}`;
+        const force = r.force ? ` force=${r.force}` : "";
+        return `${proto}${hostname}${to} ${status}${force}`;
     }
     function showBucketRedirect(r) {
         return `${r.prefix}* -> ${showBucketRedirectTarget(r)}`;
@@ -300,7 +302,7 @@ function applyDeployPlan(bucket, plan) {
         }));
         // Upload files
         yield PromisePool.for(plan.filesToUpload)
-            .withConcurrency(50)
+            .withConcurrency(20)
             .handleError(err => {
             throw err;
         })
@@ -316,17 +318,15 @@ function applyDeployPlan(bucket, plan) {
         }
     });
 }
-function deployMain(website, localFolder, options) {
+export function deploy(website, localFolder, options) {
     return __awaiter(this, void 0, void 0, function* () {
         if (options.dryRun && options.yes) {
-            throw "options --yes and --dry-run cannot be passed at the same time";
+            throw new ErrorMsg("options --yes and --dry-run cannot be passed at the same time");
         }
         // TODO: make this configurable
         const website_config_path = "deuxfleurs.toml";
         // Read and validate the local configuration file before doing anything else
-        const localWebsiteConfig = yield readConfigFile(website_config_path).catch(err => {
-            throw `while reading ${website_config_path}:\n${err}`;
-        });
+        const localWebsiteConfig = yield readConfigFile(website_config_path);
         process.stdout.write("Fetching the website configuration and metadata...\n");
         const [localFiles, [bucket, remoteFiles, remoteWebsiteConfig]] = yield Promise.all([
             // Get paths & size of the local files to deploy
@@ -373,19 +373,3 @@ function deployMain(website, localFolder, options) {
         }
     });
 }
-export function deploy(website, localFolder, options) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            yield deployMain(website, localFolder, options);
-        }
-        catch (err) {
-            if (typeof err == "string" || (err === null || err === void 0 ? void 0 : err.name) === "AbortError") {
-                console.error(`Error: ${err}`);
-            }
-            else {
-                console.error(err);
-            }
-            process.exit(1);
-        }
-    });
-}

package/dist/empty.js

@@ -8,11 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { getBucket, getBucketCredentials, getBucketFiles, deleteBucketFiles, } from "./bucket.js";
+import { ErrorMsg } from "./error.js";
 import { confirmationPrompt, formatBytesHuman, formatCount, sum, } from "./utils.js";
-function emptyMain(website, options) {
+export function empty(website, options) {
     return __awaiter(this, void 0, void 0, function* () {
         if (options.dryRun && options.yes) {
-            console.error("Error: options --yes and --dry-run cannot be passed at the same time");
+            throw new ErrorMsg("options --yes and --dry-run cannot be passed at the same time");
         }
         process.stdout.write("Fetching the website configuration and metadata...\n");
         const bucket = yield getBucket(website, yield getBucketCredentials(website));
@@ -50,20 +51,3 @@ function emptyMain(website, options) {
         yield deleteBucketFiles(bucket, filesToDelete);
     });
 }
-export function empty(website, options) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            yield emptyMain(website, options);
-        }
-        catch (err) {
-            if (typeof err == "string" || (err === null || err === void 0 ? void 0 : err.name) === "AbortError") {
-                console.error(`Error: ${err}`);
-            }
-            else {
-                console.error("Error:");
-                console.error(err);
-            }
-            process.exit(1);
-        }
-    });
-}

package/dist/error.js

@@ -0,0 +1,113 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { S3ServiceException } from "@aws-sdk/client-s3";
+export class ErrorCtx {
+    constructor(ctx, error) {
+        this.ctx = ctx;
+        this.error = error;
+    }
+}
+// Wraps any error returned by the function with some context.
+export function withErrorCtx(ctx, f) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            return yield f();
+        }
+        catch (e) {
+            throw new ErrorCtx(ctx, e);
+        }
+    });
+}
+export class ErrorMsg {
+    constructor(msg) {
+        this.msg = msg;
+    }
+}
+export function withErrorMsg(f, mapMsg) {
+    try {
+        return f();
+    }
+    catch (e) {
+        if (e instanceof ErrorMsg) {
+            throw new ErrorMsg(mapMsg(e.msg));
+        }
+        else {
+            throw e;
+        }
+    }
+}
+export class ErrorGuichet {
+    constructor(cause) {
+        this.cause = cause;
+    }
+}
+// Wraps a call to the S3 API, turning exceptions and unexpected error codes
+// into a formatted error message
+export function wrapS3Call(context, expectedCodes, f) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const ctx = `when sending a remote command to ${context}:\n  `;
+        try {
+            const resp = yield f();
+            if (!resp) {
+                throw new ErrorMsg(`${ctx}Empty response`);
+            }
+            if (!resp.$metadata.httpStatusCode) {
+                throw new ErrorMsg(`${ctx}Empty response code`);
+            }
+            if (!expectedCodes.includes(resp.$metadata.httpStatusCode)) {
+                throw new ErrorMsg(`${ctx}Unexpected response code: ${resp.$metadata.httpStatusCode}` +
+                    ` (expected: ${expectedCodes.join(", ")})`);
+            }
+            return resp;
+        }
+        catch (e) {
+            if (e instanceof S3ServiceException) {
+                throw new ErrorMsg(`${ctx}${e.message}`);
+            }
+            else {
+                throw e;
+            }
+        }
+    });
+}
+// Must only be used in the toplevel function that implements a command.
+// The entire program gets terminated if `e` is one of the errors above,
+// otherwise it is thrown as an exception.
+export function handleError(e) {
+    if (e instanceof ErrorMsg) {
+        console.error(`Error: ${e.msg}`);
+    }
+    else if (e instanceof ErrorGuichet) {
+        let msg = "Error: ";
+        if (e.cause.kind == "Unauthorized") {
+            msg +=
+                "failed to authenticate with Guichet. Is your password and login correct?";
+        }
+        else if (e.cause.kind == "WebsiteNotFound") {
+            msg += `website ${e.cause.website} does not exist`;
+        }
+        console.error(msg);
+    }
+    else {
+        console.error("Unexpected error:\n", e);
+    }
+    process.exit(1);
+}
+// Wraps a function and calls `handleError` should it return an exception.
+export function withHandleErrors(f) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            return yield f();
+        }
+        catch (e) {
+            return handleError(e);
+        }
+    });
+}

package/dist/guichet.js

@@ -0,0 +1,64 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { WebsiteApi, } from "guichet-sdk-ts";
+import { ErrorGuichet } from "./error.js";
+// The GuichetApi class wraps WebsiteApi (from the guichet sdk). It catches
+// errors that can happen in normal use, and it turn them into a dedicated error type
+// (ErrorGuichet) that we know how to display nicely.
+export class GuichetApi {
+    constructor(cfg) {
+        this.api = new WebsiteApi(cfg);
+    }
+    // NOTE: using `err instanceof ResponseError` will not work here
+    // because ResponseError extends Error and the following issue:
+    // https://github.com/Microsoft/TypeScript/wiki/FAQ#why-doesnt-extending-built-ins-like-error-array-and-map-work
+    listWebsites() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield this.api.listWebsites();
+            }
+            catch (err) {
+                if ((err === null || err === void 0 ? void 0 : err.name) == "ResponseError" && err.response.status == 401) {
+                    throw new ErrorGuichet({ kind: "Unauthorized" });
+                }
+                else {
+                    throw err;
+                }
+            }
+        });
+    }
+    getWebsite(vhost) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const websiteInfo = yield this.api.getWebsite({ vhost });
+                if (websiteInfo.vhost == `${vhost}.web.deuxfleurs.fr`) {
+                    // This means that `vhost` is a website name from before
+                    // the migration of websites *.web.deuxfleurs.fr to bucket
+                    // names with the full domain name.
+                    // We just warn that this is a working but deprecated name.
+                    console.log(`Warning: the name "${vhost}" is now deprecated for this website,` +
+                        ` you should use "${vhost}.web.deuxfleurs.fr" instead.`);
+                }
+                return websiteInfo;
+            }
+            catch (err) {
+                if ((err === null || err === void 0 ? void 0 : err.name) == "ResponseError" && err.response.status == 401) {
+                    throw new ErrorGuichet({ kind: "Unauthorized" });
+                }
+                else if ((err === null || err === void 0 ? void 0 : err.name) == "ResponseError" && err.response.status == 404) {
+                    throw new ErrorGuichet({ kind: "WebsiteNotFound", website: vhost });
+                }
+                else {
+                    throw err;
+                }
+            }
+        });
+    }
+}

package/dist/index.js

@@ -1,19 +1,20 @@
 #!/usr/bin/env node
 import { program } from "@commander-js/extra-typings";
+import { withHandleErrors } from "./error.js";
 import { login, logout } from "./auth.js";
 import { deploy } from "./deploy.js";
 import { empty } from "./empty.js";
 import { vhostsList } from "./vhosts.js";
-program.name("dxfl").description("Deuxfleurs CLI tool").version("0.1.10");
+program.name("dxfl").description("Deuxfleurs CLI tool").version("0.2.0");
 program
     .command("login")
     .description("Link your Deuxfleurs account with this tool.")
     .argument("<username>", "your account username")
-    .action(login);
+    .action(username => withHandleErrors(() => login(username)));
 program
     .command("list")
     .description("List all your websites")
-    .action(vhostsList);
+    .action(() => withHandleErrors(vhostsList));
 program
     .command("deploy")
     .description("Deploy your website")
@@ -21,17 +22,17 @@ program
     .argument("<local_folder>", "your local folder")
     .option("-n, --dry-run", "do a trial run without making actual changes")
     .option("-y, --yes", "apply the changes without asking for confirmation")
-    .action(deploy);
+    .action((website, localFolder, options) => withHandleErrors(() => deploy(website, localFolder, options)));
 program
     .command("empty")
     .description("Empty your website from its contents")
     .argument("<website>", "selected website")
     .option("-n, --dry-run", "do a trial run without making actual changes")
     .option("-y, --yes", "apply the changes without asking for confirmation")
-    .action(empty);
+    .action((website, options) => withHandleErrors(() => empty(website, options)));
 program
     .command("logout")
     .description("Cleanup dxfl config containing your credentials")
     .option("-y, --yes", "clean without asking for confirmation")
-    .action(logout);
+    .action(options => withHandleErrors(() => logout(options)));
 program.parse();

package/dist/utils.js

@@ -18,6 +18,7 @@ import fs from "fs";
 import crypto from "crypto";
 import { stdin, stdout } from "process";
 import readline from "readline/promises";
+import { ErrorMsg } from "./error.js";
 export function getFileMd5(file) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a, e_1, _b, _c;
@@ -85,24 +86,34 @@ export function parseEtag(s) {
 }
 export function confirmationPrompt(details) {
     return __awaiter(this, void 0, void 0, function* () {
-        const rl = readline.createInterface({ input: stdin, output: stdout });
-        let ok = true;
-        while (true) {
-            const a = yield rl.question(`Proceed? y (yes), n (no), d (details): `);
-            if (a == "y" || a == "yes") {
-                break;
+        try {
+            const rl = readline.createInterface({ input: stdin, output: stdout });
+            let ok = true;
+            while (true) {
+                const a = yield rl.question(`Proceed? y (yes), n (no), d (details): `);
+                if (a == "y" || a == "yes") {
+                    break;
+                }
+                else if (a == "n" || a == "no") {
+                    ok = false;
+                    break;
+                }
+                else if (a == "d" || a == "details") {
+                    details();
+                    process.stdout.write("\n");
+                }
             }
-            else if (a == "n" || a == "no") {
-                ok = false;
-                break;
+            rl.close();
+            return ok;
+        }
+        catch (e) {
+            if (e.code == "ABORT_ERR") {
+                throw new ErrorMsg("Aborted with Ctrl+C");
             }
-            else if (a == "d" || a == "details") {
-                details();
-                process.stdout.write("\n");
+            else {
+                throw e;
             }
         }
-        rl.close();
-        return ok;
     });
 }
 export function filterMap(a, f) {

package/dist/website_config.js

@@ -13,6 +13,7 @@ import URI from "fast-uri";
 import { z as zod } from "zod";
 import { fromError as zodError } from "zod-validation-error";
 import { GetBucketCorsCommand, GetBucketWebsiteCommand, PutBucketWebsiteCommand, PutBucketCorsCommand, } from "@aws-sdk/client-s3";
+import { ErrorMsg, withErrorMsg, wrapS3Call } from "./error.js";
 import { getBucketFilesDetails } from "./bucket.js";
 ////////////// Utilities
 export function equalBucketRedirect(b1, b2) {
@@ -61,16 +62,22 @@ function readConfigFileObject(filename) {
         try {
             strConf = yield fs.promises.readFile(filename, { encoding: "utf8" });
         }
-        catch (err) {
-            console.error(err, `\n\nUnable to read ${filename}`);
-            process.exit(1);
+        catch (e) {
+            let msg = `failed to read ${filename}`;
+            if (e instanceof Error && "code" in e && e.code) {
+                msg += ` (${e.code})`;
+            }
+            throw new ErrorMsg(msg);
         }
         try {
             dictConf = TOML.parse(strConf);
         }
-        catch (err) {
-            console.error(err, `\n\nUnable to parse ${filename} as TOML, please check it for syntax errors.`);
-            process.exit(1);
+        catch (e) {
+            let msg = `Unable to parse ${filename} as TOML`;
+            if (e instanceof Error) {
+                msg += `:\n${e.message}`;
+            }
+            return new ErrorMsg(msg);
         }
         return dictConf;
     });
@@ -100,7 +107,7 @@ function interpRawConfig(cfg) {
     }
     catch (err) {
         const validationError = zodError(err);
-        throw validationError.toString();
+        throw new ErrorMsg(validationError.toString());
     }
 }
 // Parsing: RawConfig -> WebsiteConfig
@@ -127,7 +134,7 @@ function unescape(s) {
                 out += "*";
             }
             else {
-                throw `a single '*' is only allowed at the end for wildcards; please use '**' instead`;
+                throw new ErrorMsg(`a single '*' is only allowed at the end for wildcards; please use '**' instead`);
             }
         }
         else {
@@ -137,36 +144,28 @@ function unescape(s) {
 }
 function interpConfig(rawcfg) {
     var _a, _b, _c, _d, _e;
-    function interpPath(name, str) {
-        try {
-            return unescape(str);
-        }
-        catch (err) {
-            throw `${name}: ${err}`;
-        }
-    }
     function interpRedirect(i, r) {
         var _a, _b;
-        const rfrom = interpPath(`Redirect ${i}, from`, r.from);
-        const rto = interpPath(`Redirect ${i}, to`, r.to);
+        const rfrom = withErrorMsg(() => unescape(r.from), msg => `from: ${msg}`);
+        const rto = withErrorMsg(() => unescape(r.to), msg => `to: ${msg}`);
         let redirect;
         if (rfrom.is_prefix) {
             // This is a bucket redirect
             const toURI = URI.parse(rto.s);
             if (toURI.error) {
-                throw `Redirect ${i}, 'to': ${toURI.error}`;
+                throw new ErrorMsg(`'to': ${toURI.error}`);
             }
             if (toURI.scheme && toURI.scheme != "http" && toURI.scheme != "https") {
-                throw `Redirect ${i}, 'to': unsupported URI scheme ${toURI.scheme}; http or https required`;
+                throw new ErrorMsg(`'to': unsupported URI scheme ${toURI.scheme}; http or https required`);
             }
             if (toURI.port) {
-                throw `Redirect ${i}, 'to': specifying a port is not supported`;
+                throw new ErrorMsg(`'to': specifying a port is not supported`);
             }
             if (toURI.query) {
-                throw `Redirect ${i}, 'to': specifying a query is not supported`;
+                throw new ErrorMsg(`'to': specifying a query is not supported`);
             }
             if (toURI.fragment) {
-                throw `Redirect ${i}, 'to': specifying a fragment is not supported`;
+                throw new ErrorMsg(`'to': specifying a fragment is not supported`);
             }
             let path = (_a = toURI.path) !== null && _a !== void 0 ? _a : "";
             // - In case of an absolute URL e.g. `https://foo.net/abc`, toURI.path will
@@ -208,12 +207,13 @@ function interpConfig(rawcfg) {
                 }
                 else if ([200, 404].includes(r.status)) {
                     if (toURI.host || toURI.scheme) {
-                        throw `Redirect ${i}: a status of 200 or 404 is not accepted while specifying a protocol and hostname in the destination`;
+                        throw new ErrorMsg(`a status of 200 or 404 is not accepted while specifying` +
+                            ` a protocol and hostname in the destination`);
                     }
                     bredirect.status = r.status;
                 }
                 else {
-                    throw `Redirect ${i}: unsupported status code ${r.status}`;
+                    throw new ErrorMsg(`unsupported status code ${r.status}`);
                 }
             }
             redirect = { kind: "bucket", r: bredirect };
@@ -221,15 +221,15 @@ function interpConfig(rawcfg) {
         else {
             // This is an object redirect
             if (r.force) {
-                throw (`Redirect ${i}: 'force' is not supported for single redirections.\n` +
+                throw new ErrorMsg(`'force' is not supported for single redirections.\n` +
                     "The source of the redirection must not exist already as a file.");
             }
             if (r.status) {
-                throw (`Redirect ${i}: 'status' is not supported for single redirections.\n` +
+                throw new ErrorMsg(`'status' is not supported for single redirections.\n` +
                     "All single redirections have status code 301.");
             }
             if (rto.is_prefix) {
-                throw `Redirect ${i}: cannot use a prefix target in 'to' when 'from' is a single address`;
+                throw new ErrorMsg(`cannot use a prefix target in 'to' when 'from' is a single address`);
             }
             // if 'from' starts with a /, consider that the user meant to refer to an object
             // at the root of the bucket and not an object with "/" in its name. Thus we should
@@ -263,24 +263,26 @@ function interpConfig(rawcfg) {
         }
         return s !== null && s !== void 0 ? s : def;
     };
+    // use index.html as default index page
+    const index_page = withDefault(rawcfg.index_page, "index.html");
+    // use error.html as default error page
+    const error_page = withDefault(rawcfg.error_page, "error.html");
     let cfg = {
-        // use index.html as default index if not specified explicitly
-        index_page: withDefault(rawcfg.index_page, "index.html"),
-        // use error.html as default error page
-        error_page: withDefault(rawcfg.error_page, "error.html"),
+        index_page,
+        error_page,
         bucket_redirects: [],
         object_redirects: new Map(),
         cors_rules: [],
     };
     for (const [i, raw] of ((_a = rawcfg.redirects) !== null && _a !== void 0 ? _a : []).entries()) {
         // `i+1` is only used for display: start counting redirects from 1 instead of 0
-        const r = interpRedirect(i + 1, raw);
+        const r = withErrorMsg(() => interpRedirect(i + 1, raw), msg => `Redirect ${i + 1}: ${msg}`);
         if (r.kind == "bucket") {
             cfg.bucket_redirects.push(r.r);
         }
         else {
             if (cfg.object_redirects.has(r.from)) {
-                throw `Cannot have two redirects from the same path ${r.from}`;
+                throw new ErrorMsg(`Cannot have two redirects from the same path ${r.from}`);
             }
             cfg.object_redirects.set(r.from, r.to);
         }
@@ -300,7 +302,9 @@ function interpConfig(rawcfg) {
 }
 export function readConfigFile(filename) {
     return __awaiter(this, void 0, void 0, function* () {
-        return interpConfig(interpRawConfig(yield readConfigFileObject(filename)));
+        const obj = yield readConfigFileObject(filename);
+        const raw = withErrorMsg(() => interpRawConfig(obj), msg => `Failed to parse ${filename}:\n${msg}`);
+        return interpConfig(raw);
     });
 }
 ////////////// Reading from a S3 bucket
@@ -314,22 +318,12 @@ export function getBucketConfig(bucket, files) {
         //    but I don't know of a better way.)
         var _a, _b, _c, _d, _e, _f;
         const [website, cors, details] = yield Promise.all([
-            bucket.client.send(new GetBucketWebsiteCommand({ Bucket: bucket.name })),
-            bucket.client.send(new GetBucketCorsCommand({ Bucket: bucket.name })),
+            // 204 "No Content" is returned when there is no existing website config
+            wrapS3Call(`read the bucket website config`, [200, 204], () => bucket.client.send(new GetBucketWebsiteCommand({ Bucket: bucket.name }))),
+            // 204 "No Content" is returned when there are no existing CORS rules
+            wrapS3Call(`read the bucket CORS config`, [200, 204], () => bucket.client.send(new GetBucketCorsCommand({ Bucket: bucket.name }))),
             getBucketFilesDetails(bucket, files),
         ]);
-        if (website && website.$metadata.httpStatusCode != 200) {
-            throw `Error sending GetBucketWebsite: ${JSON.stringify(website)}`;
-        }
-        if (!cors ||
-            (cors.$metadata.httpStatusCode != 200 &&
-                cors.$metadata.httpStatusCode != 204)) {
-            throw `Error sending GetBucketCors: ${JSON.stringify(cors)}`;
-        }
-        // 204 "No Content" is returned when there are no existing CORS rules
-        if (cors.$metadata.httpStatusCode == 204) {
-            cors.CORSRules = [];
-        }
         // Collect object redirects
         const object_redirects = new Map();
         for (const [file, { redirect }] of details) {
@@ -340,7 +334,7 @@ export function getBucketConfig(bucket, files) {
         // Interpret bucket redirects
         if (website.RedirectAllRequestsTo) {
             // NB: garage does not currently support RedirectAllRequestsTo so this should never happen
-            throw (`remote website configuration: RedirectAllRequestsTo is specified; ` +
+            throw new ErrorMsg(`remote website configuration: RedirectAllRequestsTo is specified; ` +
                 `this is currently unsupported by dxfl`);
         }
         const index_page = (_a = website.IndexDocument) === null || _a === void 0 ? void 0 : _a.Suffix;
@@ -361,7 +355,8 @@ export function getBucketConfig(bucket, files) {
                         }
                         else {
                             // not supported by garage
-                            throw `remote website configuration: unexpected value for 'HttpErrorCodeReturnedEquals': ${rule.Condition.HttpErrorCodeReturnedEquals}`;
+                            throw new ErrorMsg(`remote website configuration: unexpected value for` +
+                                ` 'HttpErrorCodeReturnedEquals': ${rule.Condition.HttpErrorCodeReturnedEquals}`);
                         }
                     }
                     if (rule.Condition.KeyPrefixEquals) {
@@ -380,7 +375,7 @@ export function getBucketConfig(bucket, files) {
                     }
                     else {
                         // currently not supported by garage
-                        throw (`remote website configuration: 'protocol' is neither http or https; ` +
+                        throw new ErrorMsg(`remote website configuration: 'protocol' is neither http or https; ` +
                             `this is currently unsupported by dxfl`);
                     }
                 }
@@ -472,13 +467,10 @@ export function putBucketWebsiteConfig(bucket, index_page, error_page, bucket_re
                 WebsiteConfiguration.RoutingRules.push(rule);
             }
         }
-        const resp = yield bucket.client.send(new PutBucketWebsiteCommand({
+        yield wrapS3Call(`write the bucket website config`, [200], () => bucket.client.send(new PutBucketWebsiteCommand({
             Bucket: bucket.name,
             WebsiteConfiguration,
-        }));
-        if (resp && resp.$metadata.httpStatusCode != 200) {
-            throw resp;
-        }
+        })));
     });
 }
 // applies CORS rules
@@ -493,12 +485,9 @@ export function putCorsRules(bucket, cors_rules) {
                 ExposeHeaders: rule.expose_headers,
             });
         }
-        const resp = yield bucket.client.send(new PutBucketCorsCommand({
+        yield wrapS3Call(`when writing the bucket CORS config`, [200], () => bucket.client.send(new PutBucketCorsCommand({
             Bucket: bucket.name,
             CORSConfiguration: { CORSRules },
-        }));
-        if (resp && resp.$metadata.httpStatusCode != 200) {
-            throw resp;
-        }
+        })));
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dxfl",
-  "version": "0.1.10",
+  "version": "0.2.0",
   "description": "",
   "license": "EUPL-1.2",
   "author": "Deuxfleurs Team <coucou@deuxfleurs.fr>",