dxfl 0.1.8 → 0.1.9

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.1.9
+
+- `deuxfleurs.toml`: rename redirection property `if_error = 404` to `force = true`, to simplify and improve comprehension.
+
+# v0.1.8
+
 - `deploy`: add support for redirects, configured from a new `deuxfleurs.toml` file.
   - supports S3 "object redirects" (redirects from a path in the website)
   - supports global "bucket redirects" (redirects from any path in the website

package/README.md

@@ -10,7 +10,7 @@ npm install -g dxfl
 
 ## Usage
 
-_Not ready_
+_Warning: software still in an experimental state_
 
 Start by login with your username, for example for `john`:
 
@@ -30,13 +30,19 @@ And then to deploy your `_public` folder on `example.com`:
 dxfl deploy example.com _public
 ```
 
-Or potentially preview the upcoming changes with the `--dry-run` option:
+To deploy without confirmation, use the `--yes` option:
+
+```
+dxfl deploy example.com _public --yes
+```
+
+Or only display the changes without applying them, with the `--dry-run` option:
 
 ```
 dxfl deploy example.com _public --dry-run
 ```
 
-If you need to empty a website from its contents:
+Use the `empty` command to delete all files from a website (required before deleting it):
 
 ```
 dxfl empty example.com
@@ -45,7 +51,7 @@ dxfl empty example.com
 ## Website configuration
 
 `dxfl deploy` reads a `deuxfleurs.toml` configuration file (if it exists in the current directory).
-This file can be used to specify website configuration metadata, such as redirections.
+This file can be used to specify website configuration metadata such as redirections.
 
 Your `deuxfleurs.toml` should follow the following structure:
 
@@ -53,8 +59,8 @@ Your `deuxfleurs.toml` should follow the following structure:
 # Filename added after URLs that point to directories.
 # Default value: "index.html"
 index_page = "index.html"
-# Path to the file to serve in case of 404 error
-# Default value: none.
+# Path to the file to serve in case of 404 error.
+# Default value: none
 error_page = "404.html"
 
 # A redirect entry. There can be as many as desired.
@@ -75,9 +81,15 @@ from = "foobar/*"
 # single path.
 to = "baz/*"
 # Optional: custom HTTP status code for the redirection.
-status = 302
-# Optional: only redirect if the original request triggered a 404 error
-if_error = 404
+# Default value: 302
+status = 301
+# Optional: always apply the redirect.
+# By default, redirections that match multiple paths do not apply
+# if a file that matches the requested path could be served instead.
+# Setting this option to true overrides this behavior and always
+# applies the redirection.
+# Default value: false
+force = true
 ```
 
 ## Development
@@ -113,6 +125,7 @@ Do not forget also to run `npm login` to bind your account with the CLI.
 Then to publish a release:
 
 ```bash
+vim CHANGELOG.md # update the version and its content in this file
 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

package/dist/deploy.js

@@ -163,8 +163,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 if_error = r.if_error ? `  if_error=${r.if_error}` : "";
-        return `${proto}${hostname}${to}${status}${if_error}`;
+        const force = r.force ? `  force=${r.force}` : "";
+        return `${proto}${hostname}${to}${status}${force}`;
     }
     function showBucketRedirect(r) {
         return `${r.prefix}* -> ${showBucketRedirectTarget(r)}`;

package/dist/index.js

@@ -4,7 +4,7 @@ import { login } 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.8");
+program.name("dxfl").description("Deuxfleurs CLI tool").version("0.1.9");
 program
     .command("login")
     .description("Link your Deuxfleurs account with this tool.")

package/dist/website_config.js

@@ -28,7 +28,7 @@ export function equalBucketRedirect(b1, b2) {
         }
     }
     return (b1.prefix === b2.prefix &&
-        b1.if_error === b2.if_error &&
+        b1.force === b2.force &&
         b1.hostname === b2.hostname &&
         b1.status === b2.status &&
         b1.protocol === b2.protocol &&
@@ -64,7 +64,7 @@ function readConfigFileObject(filename) {
 const RawRedirectSchema = zod.object({
     from: zod.string(),
     to: zod.string(),
-    if_error: zod.number().int().optional(),
+    force: zod.boolean().optional(),
     status: zod.number().int().positive().optional(),
 });
 const RawConfigSchema = zod.object({
@@ -124,7 +124,7 @@ function interpConfig(rawcfg) {
         }
     }
     function interpRedirect(i, r) {
-        var _a;
+        var _a, _b;
         const rfrom = interpPath(`Redirect ${i}, from`, r.from);
         const rto = interpPath(`Redirect ${i}, to`, r.to);
         let redirect;
@@ -167,7 +167,7 @@ function interpConfig(rawcfg) {
             }
             let bredirect = {
                 prefix,
-                if_error: undefined,
+                force: (_b = r.force) !== null && _b !== void 0 ? _b : false,
                 hostname: toURI.host,
                 protocol: toURI.scheme,
                 // Unless specified, set the status to 302.
@@ -180,12 +180,6 @@ function interpConfig(rawcfg) {
                     ? { kind: "replace_prefix", prefix: path }
                     : { kind: "replace", target: path },
             };
-            if (r.if_error) {
-                if (r.if_error != 404) {
-                    throw `Redirect ${i}: the only currently supported value for 'if_error' is 404`;
-                }
-                bredirect.if_error = 404;
-            }
             if (r.status) {
                 if ([301, 302, 303, 307, 308].includes(r.status)) {
                     bredirect.status = r.status;
@@ -204,8 +198,9 @@ function interpConfig(rawcfg) {
         }
         else {
             // This is an object redirect
-            if (r.if_error) {
-                throw `Redirect ${i}: 'if_error' is not supported for single redirections`;
+            if (r.force) {
+                throw (`Redirect ${i}: '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` +
@@ -221,7 +216,7 @@ function interpConfig(rawcfg) {
             if (from.startsWith("/")) {
                 from = from.substring(1);
             }
-            // for the 'to' field, garage expects a target that starts with 'http://', 'https://'
+            // for the 'to' field, garage expects the target to start with 'http://', 'https://'
             // or '/'. So if the 'to' field does not start with '/', add one...
             let to = rto.s;
             if (!(to.startsWith("http://") ||
@@ -297,16 +292,17 @@ export function getBucketConfig(bucket, files) {
                 // If no Condition is specified, then the redirect always applies, which is equivalent
                 // to matching on an empty prefix
                 let prefix = "";
-                let if_error = undefined;
+                // If no HttpErrorCodeReturnedEquals is specified, then the redirection always
+                // applies, which is equivalent to force=true
+                let force = true;
                 if (rule.Condition) {
                     if (rule.Condition.HttpErrorCodeReturnedEquals) {
                         if (rule.Condition.HttpErrorCodeReturnedEquals == "404") {
-                            if_error = 404;
+                            force = false;
                         }
                         else {
-                            // currently not supported by garage
-                            throw (`remote website configuration: 'if_error' specified with a different ` +
-                                `status code than 404; this is currently unsupported by dxfl`);
+                            // not supported by garage
+                            throw `remote website configuration: unexpected value for 'HttpErrorCodeReturnedEquals': ${rule.Condition.HttpErrorCodeReturnedEquals}`;
                         }
                     }
                     if (rule.Condition.KeyPrefixEquals) {
@@ -346,7 +342,7 @@ export function getBucketConfig(bucket, files) {
                 }
                 bucket_redirects.push({
                     prefix,
-                    if_error,
+                    force,
                     hostname,
                     status,
                     protocol,
@@ -378,8 +374,8 @@ export function putBucketWebsiteConfig(bucket, index_page, error_page, bucket_re
                     },
                     Redirect: {},
                 };
-                if (r.if_error) {
-                    rule.Condition.HttpErrorCodeReturnedEquals = r.if_error.toString();
+                if (!r.force) {
+                    rule.Condition.HttpErrorCodeReturnedEquals = "404";
                 }
                 if (r.hostname) {
                     rule.Redirect.HostName = r.hostname;

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "dxfl",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "",
   "license": "EUPL-1.2",
   "author": "Deuxfleurs Team <coucou@deuxfleurs.fr>",
+  "keywords": [
+    "cli",
+    "deuxfleurs"
+  ],
   "type": "module",
   "main": "dist/main.js",
   "bin": {