dxfl 0.6.2 → 0.7.0

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v0.7.0
+
+- Improve behavior of redirections whose source path is a directory (path ending
+  with a `/`). They are now interpreted as redirecting from the index page of
+  that directory. For example, a redirect with `from = "foo/"` is now
+  interpreted as `from = "foo/index.html"` (assuming `index_page` in
+  `deuxfleurs.toml` is not defined to a custom value; otherwise `index.html` is
+  replaced by the value of `index_page`).
+
 # v0.6.2
 
 - `deploy`: Re-enable CORS configuration (disabled on v0.4.2)

package/deuxfleurs.toml

@@ -0,0 +1,23 @@
+error_page = "error.html"
+index_page = "myindex.html"
+
+# [[redirects]]
+# from = "TinyCorePure64-15.0.iso"
+# to = "/bbc"
+
+[[redirects]]
+from = "/a"
+to = "/def"
+
+[[redirects]]
+from = "/a/"
+to = "/ghi"
+
+[[cors]]
+allowed_origins = "foo"
+
+[[headers]]
+for = ["**/*.txt"]
+compress = "gzip"
+[headers.values]
+Cache-Control = "hello44"

package/deuxfleurs.toml~

@@ -0,0 +1,18 @@
+error_page = "error.html"
+
+# [[redirects]]
+# from = "TinyCorePure64-15.0.iso"
+# to = "/bbc"
+
+[[redirects]]
+from = "/a"
+to = "/def"
+
+[[cors]]
+allowed_origins = "foo"
+
+[[headers]]
+for = ["**/*.txt"]
+compress = "gzip"
+[headers.values]
+Cache-Control = "hello44"

package/dist/deploy_websiteconfig.js

@@ -0,0 +1,108 @@
+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 { PromisePool } from "@supercharge/promise-pool";
+import { GetBucketWebsiteCommand, HeadObjectCommand, } from "@aws-sdk/client-s3";
+export function getBucketWebsite(client, Bucket) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b;
+        const cmd = new GetBucketWebsiteCommand({ Bucket });
+        const response = yield client.send(cmd);
+        if (response.RedirectAllRequestsTo) {
+            // NB: garage does not currently support RedirectAllRequestsTo so this should never happen
+            throw `remote website configuration: RedirectAllRequestsTo is specified; \
+               this is currently unsupported by dxfl`;
+        }
+        const index_page = (_a = response.ErrorDocument) === null || _a === void 0 ? void 0 : _a.Key;
+        const error_page = (_b = response.IndexDocument) === null || _b === void 0 ? void 0 : _b.Suffix;
+        let redirects = [];
+        if (response.RoutingRules) {
+            for (const rule of response.RoutingRules) {
+                // 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 (rule.Condition) {
+                    if (rule.Condition.HttpErrorCodeReturnedEquals) {
+                        if (rule.Condition.HttpErrorCodeReturnedEquals == "404") {
+                            if_error = 404;
+                        }
+                        else {
+                            // currently not supported by garage
+                            throw `remote website configuration: 'if_error' specified with a different \
+                               code than 404; this is currently unsupported by dxfl`;
+                        }
+                    }
+                    if (rule.Condition.KeyPrefixEquals) {
+                        prefix = rule.Condition.KeyPrefixEquals;
+                    }
+                }
+                const hostname = rule.Redirect.HostName;
+                const code = rule.Redirect.HttpRedirectCode
+                    ? parseInt(rule.Redirect.HttpRedirectCode)
+                    : undefined;
+                let protocol = undefined;
+                if (rule.Redirect.Protocol) {
+                    if (rule.Redirect.Protocol == "http" ||
+                        rule.Redirect.Protocol == "https") {
+                        protocol = rule.Redirect.Protocol;
+                    }
+                    else {
+                        // currently not supported by garage
+                        throw `remote website configuration: 'protocol' is neither http or https; \
+                           this is currently unsupported by dxfl`;
+                    }
+                }
+                let to;
+                if (rule.Redirect.ReplaceKeyPrefixWith) {
+                    to = {
+                        kind: "replace_prefix",
+                        prefix: rule.Redirect.ReplaceKeyPrefixWith,
+                    };
+                }
+                else if (rule.Redirect.ReplaceKeyWith) {
+                    to = { kind: "replace", target: rule.Redirect.ReplaceKeyWith };
+                }
+                else {
+                    // not completely sure whether this is the correct behavior, but it should
+                    // match garage's implementation
+                    to = { kind: "replace", target: "" };
+                }
+                redirects.push({
+                    kind: "bucket",
+                    r: { prefix, if_error, hostname, code, protocol, to },
+                });
+            }
+        }
+        return { index_page, error_page, redirects };
+    });
+}
+// XXX
+const MD5METAFIELD = "dfl-md5sum";
+export function getBucketFilesDetails(client, Bucket, files) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let res = new Map();
+        function doFile(file) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a;
+                const resp = yield client.send(new HeadObjectCommand({ Bucket, Key: file }));
+                if (resp.$metadata.httpStatusCode != 200) {
+                    // TODO: better error handling?
+                    throw resp;
+                }
+                res.set(file, {
+                    md5: (_a = resp.Metadata) === null || _a === void 0 ? void 0 : _a[MD5METAFIELD],
+                    redirect: resp.WebsiteRedirectLocation,
+                });
+            });
+        }
+        yield PromisePool.for(files).withConcurrency(50).process(doFile);
+        return res;
+    });
+}

package/dist/errors.js

@@ -0,0 +1,7 @@
+import { err } from "neverthrow";
+export function errMsg(msg) {
+    return err({ kind: "msg", msg });
+}
+export function errS3(resp) {
+    return err({ kind: "s3", resp: resp.$metadata });
+}

package/dist/index.js

@@ -6,7 +6,7 @@ import { deploy } from "./deploy.js";
 import { empty } from "./empty.js";
 import { list } from "./vhosts.js";
 import { inspect } from "./inspect.js";
-program.name("dxfl").description("Deuxfleurs CLI tool").version("0.6.2");
+program.name("dxfl").description("Deuxfleurs CLI tool").version("0.7.0");
 program
     .command("login")
     .description("Link your Deuxfleurs account with this tool.")

package/dist/website_config.js

@@ -179,7 +179,7 @@ function unescape(s) {
 }
 function interpConfig(rawcfg) {
     var _a, _b, _c, _d, _e, _f, _g, _h;
-    function interpRedirect(r) {
+    function interpRedirect(r, index_page) {
         var _a, _b;
         const rfrom = withErrorMsg(() => unescape(r.from), msg => `from: ${msg}`);
         const rto = withErrorMsg(() => unescape(r.to), msg => `to: ${msg}`);
@@ -273,6 +273,14 @@ function interpConfig(rawcfg) {
             if (from.startsWith("/")) {
                 from = from.substring(1);
             }
+            // if 'from' ends with a /, consider that the user meant to refer to the index
+            // page of that directory, and add it for them. A redirection source that is a
+            // directory would otherwise be non-functional: a URL query to "foo/" will first
+            // turn it into a request to "foo/index.html", at which point the redirection would
+            // not apply.
+            if (from.endsWith("/")) {
+                from = from.concat(index_page);
+            }
             // 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;
@@ -312,7 +320,7 @@ function interpConfig(rawcfg) {
     };
     for (const [i, raw] of ((_b = rawcfg.redirects) !== null && _b !== void 0 ? _b : []).entries()) {
         // `i+1` is only used for display: start counting redirects from 1 instead of 0
-        const r = withErrorMsg(() => interpRedirect(raw), msg => `Redirect ${i + 1}: ${msg}`);
+        const r = withErrorMsg(() => interpRedirect(raw, index_page), msg => `Redirect ${i + 1}: ${msg}`);
         if (r.kind == "bucket") {
             cfg.bucket_redirects.push(r.r);
         }

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "dxfl",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "dxfl",
-      "version": "0.6.2",
+      "version": "0.7.0",
       "license": "EUPL-1.2",
       "dependencies": {
         "@aws-sdk/client-s3": "^3.1014.0",
@@ -865,13 +865,14 @@
       }
     },
     "node_modules/@aws-sdk/xml-builder": {
-      "version": "3.972.15",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/xml-builder/-/xml-builder-3.972.15.tgz",
-      "integrity": "sha512-PxMRlCFNiQnke9YR29vjFQwz4jq+6Q04rOVFeTDR2K7Qpv9h9FOWOxG+zJjageimYbWqE3bTuLjmryWHAWbvaA==",
+      "version": "3.972.21",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/xml-builder/-/xml-builder-3.972.21.tgz",
+      "integrity": "sha512-qxNiHUtlrsjTeSlrPWiFkWps7uD6YB4eKzg7eLAFH8jbiHTlt0ePNlo2Xu+WlftP38JIcMaIX4jTUjOlE2ySWw==",
       "license": "Apache-2.0",
       "dependencies": {
-        "@smithy/types": "^4.13.1",
-        "fast-xml-parser": "5.5.8",
+        "@nodable/entities": "2.1.0",
+        "@smithy/types": "^4.14.1",
+        "fast-xml-parser": "5.7.2",
         "tslib": "^2.6.2"
       },
       "engines": {
@@ -910,6 +911,18 @@
         "commander": "~14.0.0"
       }
     },
+    "node_modules/@nodable/entities": {
+      "version": "2.1.0",
+      "resolved": "https://registry.npmjs.org/@nodable/entities/-/entities-2.1.0.tgz",
+      "integrity": "sha512-nyT7T3nbMyBI/lvr6L5TyWbFJAI9FTgVRakNoBqCD+PmID8DzFrrNdLLtHMwMszOtqZa8PAOV24ZqDnQrhQINA==",
+      "funding": [
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/nodable"
+        }
+      ],
+      "license": "MIT"
+    },
     "node_modules/@smithy/abort-controller": {
       "version": "4.2.12",
       "resolved": "https://registry.npmjs.org/@smithy/abort-controller/-/abort-controller-4.2.12.tgz",
@@ -1399,9 +1412,9 @@
       }
     },
     "node_modules/@smithy/types": {
-      "version": "4.13.1",
-      "resolved": "https://registry.npmjs.org/@smithy/types/-/types-4.13.1.tgz",
-      "integrity": "sha512-787F3yzE2UiJIQ+wYW1CVg2odHjmaWLGksnKQHUrK/lYZSEcy1msuLVvxaR/sI2/aDe9U+TBuLsXnr3vod1g0g==",
+      "version": "4.14.1",
+      "resolved": "https://registry.npmjs.org/@smithy/types/-/types-4.14.1.tgz",
+      "integrity": "sha512-59b5HtSVrVR/eYNei3BUj3DCPKD/G7EtDDe7OEJE7i7FtQFugYo6MxbotS8mVJkLNVf8gYaAlEBwwtJ9HzhWSg==",
       "license": "Apache-2.0",
       "dependencies": {
         "tslib": "^2.6.2"
@@ -1799,9 +1812,9 @@
       "license": "BSD-3-Clause"
     },
     "node_modules/fast-xml-builder": {
-      "version": "1.1.4",
-      "resolved": "https://registry.npmjs.org/fast-xml-builder/-/fast-xml-builder-1.1.4.tgz",
-      "integrity": "sha512-f2jhpN4Eccy0/Uz9csxh3Nu6q4ErKxf0XIsasomfOihuSUa3/xw6w8dnOtCDgEItQFJG8KyXPzQXzcODDrrbOg==",
+      "version": "1.1.5",
+      "resolved": "https://registry.npmjs.org/fast-xml-builder/-/fast-xml-builder-1.1.5.tgz",
+      "integrity": "sha512-4TJn/8FKLeslLAH3dnohXqE3QSoxkhvaMzepOIZytwJXZO69Bfz0HBdDHzOTOon6G59Zrk6VQ2bEiv1t61rfkA==",
       "funding": [
         {
           "type": "github",
@@ -1814,9 +1827,9 @@
       }
     },
     "node_modules/fast-xml-parser": {
-      "version": "5.5.8",
-      "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-5.5.8.tgz",
-      "integrity": "sha512-Z7Fh2nVQSb2d+poDViM063ix2ZGt9jmY1nWhPfHBOK2Hgnb/OW3P4Et3P/81SEej0J7QbWtJqxO05h8QYfK7LQ==",
+      "version": "5.7.2",
+      "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-5.7.2.tgz",
+      "integrity": "sha512-P7oW7tLbYnhOLQk/Gv7cZgzgMPP/XN03K02/Jy6Y/NHzyIAIpxuZIM/YqAkfiXFPxA2CTm7NtCijK9EDu09u2w==",
       "funding": [
         {
           "type": "github",
@@ -1825,9 +1838,10 @@
       ],
       "license": "MIT",
       "dependencies": {
-        "fast-xml-builder": "^1.1.4",
-        "path-expression-matcher": "^1.2.0",
-        "strnum": "^2.2.0"
+        "@nodable/entities": "^2.1.0",
+        "fast-xml-builder": "^1.1.5",
+        "path-expression-matcher": "^1.5.0",
+        "strnum": "^2.2.3"
       },
       "bin": {
         "fxparser": "src/cli/cli.js"
@@ -1996,9 +2010,9 @@
       }
     },
     "node_modules/path-expression-matcher": {
-      "version": "1.2.0",
-      "resolved": "https://registry.npmjs.org/path-expression-matcher/-/path-expression-matcher-1.2.0.tgz",
-      "integrity": "sha512-DwmPWeFn+tq7TiyJ2CxezCAirXjFxvaiD03npak3cRjlP9+OjTmSy1EpIrEbh+l6JgUundniloMLDQ/6VTdhLQ==",
+      "version": "1.5.0",
+      "resolved": "https://registry.npmjs.org/path-expression-matcher/-/path-expression-matcher-1.5.0.tgz",
+      "integrity": "sha512-cbrerZV+6rvdQrrD+iGMcZFEiiSrbv9Tfdkvnusy6y0x0GKBXREFg/Y65GhIfm0tnLntThhzCnfKwp1WRjeCyQ==",
       "funding": [
         {
           "type": "github",
@@ -2122,9 +2136,9 @@
       }
     },
     "node_modules/strnum": {
-      "version": "2.2.1",
-      "resolved": "https://registry.npmjs.org/strnum/-/strnum-2.2.1.tgz",
-      "integrity": "sha512-BwRvNd5/QoAtyW1na1y1LsJGQNvRlkde6Q/ipqqEaivoMdV+B1OMOTVdwR+N/cwVUcIt9PYyHmV8HyexCZSupg==",
+      "version": "2.2.3",
+      "resolved": "https://registry.npmjs.org/strnum/-/strnum-2.2.3.tgz",
+      "integrity": "sha512-oKx6RUCuHfT3oyVjtnrmn19H1SiCqgJSg+54XqURKp5aCMbrXrhLjRN9TjuwMjiYstZ0MzDrHqkGZ5dFTKd+zg==",
       "funding": [
         {
           "type": "github",

package/package.json

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

package/public/TinyCorePure64-15.0.iso

@@ -0,0 +1 @@
+toto

package/public/d/b

@@ -0,0 +1,2 @@
+b
+foo

package/public/d/c

@@ -0,0 +1,2 @@
+c
+foo

package/public/d/dd/bla

@@ -0,0 +1 @@
+bla

package/public/d/dd/foo.txt

@@ -0,0 +1 @@
+test

package/public/def

@@ -0,0 +1,2 @@
+abc
+abc

package/public/error.html

@@ -0,0 +1 @@
+oops, 404 error!

package/public/index.html

@@ -0,0 +1 @@
+hello there! 花見 toto312

package/public/index.html~

@@ -0,0 +1 @@
+hello there! 花見 toto2

package/public/slt

@@ -0,0 +1 @@
+abc

package/public/toto.txt

@@ -0,0 +1 @@
+abc defuieu

package/public/toto2.txt

@@ -0,0 +1 @@
+abc

package/dist/_empty.js

@@ -1,64 +0,0 @@
-// // TODO: Refacto the codebase global before integrate this feature
-export {};
-// export async function empty(
-// 	vhost: string,
-// 	options: { dryRun: boolean | undefined },
-// ) {
-// 	const conf = await openApiConf();
-// 	// Get website info from guichet (bucket name and keys)
-// 	const api = new WebsiteApi(conf);
-// 	let vhostInfo = await api.getWebsite({ vhost }).catch(err => {
-// 		if (err.response.status == 404) {
-// 			console.error(`Error: website '${vhost}' does not exist`);
-// 		} else {
-// 			console.error(err);
-// 		}
-// 		process.exit(1);
-// 	});
-// 	// List the files currently stored in the bucket
-// 	// @FIXME this info could be returned by the guichet API
-// 	const s3client = new S3Client({
-// 		endpoint: "https://garage.deuxfleurs.fr",
-// 		region: "garage",
-// 		forcePathStyle: true,
-// 		credentials: {
-// 			accessKeyId: vhostInfo.accessKeyId!,
-// 			secretAccessKey: vhostInfo.secretAccessKey!,
-// 		},
-// 	});
-// 	const Bucket = vhostInfo.vhost!.name!;
-// 	const filesToDelete = [...(await getBucketFiles(s3client, Bucket))].map(
-// 		([name, { size }]) => ({
-// 			name,
-// 			size,
-// 		}),
-// 	);
-// 	for (const file of filesToDelete) {
-// 		process.stdout.write(`Deleting ${file.name}\n`);
-// 	}
-// 	// If not in dry-run mode, send the delete command
-// 	if (!options.dryRun) {
-// 		const resp = await deleteFiles(s3client, Bucket, filesToDelete);
-// 		if (resp && resp!.$metadata.httpStatusCode != 200) {
-// 			// TODO: better error handling?
-// 			console.error(resp);
-// 			process.exit(1);
-// 		}
-// 	}
-// 	// Display a summary
-// 	function sum(a: number[]) {
-// 		return a.reduce((x, y) => x + y, 0);
-// 	}
-// 	function formatFiles(n: number) {
-// 		if (n == 1) {
-// 			return `${n} file `;
-// 		} else {
-// 			return `${n} files`;
-// 		}
-// 	}
-// 	const sizeDeleted = sum(filesToDelete.map(f => f.size ?? 0));
-// 	process.stdout.write("\nSummary:\n");
-// 	process.stdout.write(
-// 		`${formatFiles(filesToDelete.length)} deleted (${formatBytes(sizeDeleted)})\n`,
-// 	);
-// }

package/dist/tsconfig.tsbuildinfo

@@ -1 +0,0 @@
-{"root":["../auth.ts","../bucket.ts","../deploy.ts","../empty.ts","../error.ts","../guichet.ts","../headers.ts","../index.ts","../inspect.ts","../utils.ts","../vhosts.ts","../website_config.ts"],"version":"5.9.3"}