dxfl 0.3.1 → 0.4.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# v0.4.0
+
+- `deploy`: allow to specify a custom config file with `--config-file` or `-c`
+
+# v0.3.2
+
+- update `@aws-sdk/client-s3` 3.983.0 → 3.1004.0
+- `deploy`: fix failed request not being retried
+- AWS\_\* environment variables now override guichet credentials
+
 # v0.3.1
 
 - fix `deuxfleurs.toml`: always pass the user-provided value of index_page to garage

package/README.md

@@ -40,6 +40,12 @@ Or only display the changes without applying them, with the `--dry-run` option:
 dxfl deploy example.com _public --dry-run
 ```
 
+You can also specify a custom TOML configuration file to use instead of the default `deuxfleurs.toml`, with the `--config-file` option:
+
+```
+dxfl deploy example.com _public --config-file custom.toml
+```
+
 Use the `empty` command to delete all files from a website (required before deleting it):
 
 ```
@@ -54,10 +60,10 @@ dxfl inspect example.com
 
 ## Website configuration
 
-`dxfl deploy` reads a `deuxfleurs.toml` configuration file (if it exists in the current directory).
+`dxfl deploy` reads a TOML configuration file, `deuxfleurs.toml` by default (if it exists in the current directory), or the one specified with the `--config-file` option.
 This file can be used to specify website configuration metadata such as redirections.
 
-Your `deuxfleurs.toml` should follow the following structure:
+Your configuration file should follow the following structure:
 
 ```toml
 # Filename added after URLs that point to directories.

package/dist/auth.js

@@ -109,6 +109,11 @@ export function openApiConf() {
 }
 export function login(username) {
     return __awaiter(this, void 0, void 0, function* () {
+        if (username == undefined) {
+            username = yield read({
+                prompt: "username: ",
+            });
+        }
         const password = yield read({
             prompt: "password: ",
             silent: true,

package/dist/bucket.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import fs from "fs";
+import fs from "fs/promises";
 import mime from "mime";
 import { DeleteObjectCommand, DeleteObjectsCommand, HeadObjectCommand, ListObjectsV2Command, PutObjectCommand, S3Client, } from "@aws-sdk/client-s3";
 import { PromisePool } from "@supercharge/promise-pool";
@@ -17,19 +17,18 @@ import { GuichetApi } from "./guichet.js";
 import { parseEtag, toChunks, formatBytesHuman } from "./utils.js";
 export function getBucketCredentials(name) {
     return __awaiter(this, void 0, void 0, function* () {
+        const creds = credentialsFromEnv();
+        if (creds !== undefined) {
+            process.stdout.write("Using credentials from environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY\n");
+            return creds;
+        }
         if (yield apiConfExists()) {
             const guichet = new GuichetApi(yield openApiConf());
             return yield credentialsFromApi(guichet, name);
         }
-        else {
-            const creds = credentialsFromEnv();
-            if (creds === undefined) {
-                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.");
-            }
-            return creds;
-        }
+        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.");
     });
 }
 function credentialsFromEnv() {
@@ -153,7 +152,12 @@ export function uploadFile(bucket, s3Path, localPath) {
         if (ContentType && ContentType.startsWith("text/")) {
             ContentType = ContentType + "; charset=utf-8";
         }
-        const Body = fs.createReadStream(localPath);
+        // NB: we read the entire file into memory instead of creating a stream from
+        // the file (which would allow streaming the data). Indeed, using a stream
+        // results in transcient network errors being throwned instead of being
+        // retried by the AWS SDK: https://github.com/aws/aws-sdk-js-v3/issues/6770
+        // which we want to avoid...
+        const Body = yield fs.readFile(localPath);
         const params = { Bucket: bucket.name, Key: s3Path, Body, ContentType };
         yield wrapS3Call(`upload "${s3Path}"`, [200], () => bucket.client.send(new PutObjectCommand(params)));
     });

package/dist/deploy.js

@@ -323,10 +323,8 @@ export function deploy(website, localFolder, options) {
         if (options.dryRun && options.yes) {
             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);
+        const localWebsiteConfig = yield readConfigFile(options.configFile);
         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

package/dist/index.js

@@ -6,11 +6,11 @@ import { deploy } from "./deploy.js";
 import { empty } from "./empty.js";
 import { vhostsList } from "./vhosts.js";
 import { inspect } from "./inspect.js";
-program.name("dxfl").description("Deuxfleurs CLI tool").version("0.3.1");
+program.name("dxfl").description("Deuxfleurs CLI tool").version("0.4.0");
 program
     .command("login")
     .description("Link your Deuxfleurs account with this tool.")
-    .argument("<username>", "your account username")
+    .argument("[username]", "your account username")
     .action(username => withHandleErrors(() => login(username)));
 program
     .command("list")
@@ -29,6 +29,7 @@ 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")
+    .option("-c, --config-file <path>", "apply a custom TOML config file")
     .action((website, localFolder, options) => withHandleErrors(() => deploy(website, localFolder, options)));
 program
     .command("empty")

package/dist/website_config.js

@@ -54,7 +54,15 @@ export function equalCorsRules(c1, c2) {
 // Parsing: TOML -> untyped object
 function readConfigFileObject(filename) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!fs.existsSync(filename)) {
+        if (filename != undefined) {
+            if (!fs.existsSync(filename)) {
+                throw new ErrorMsg(`${filename} configuration file not found`);
+            }
+        }
+        else if (fs.existsSync("deuxfleurs.toml")) {
+            filename = "deuxfleurs.toml";
+        }
+        else {
             return {};
         }
         let strConf;
@@ -485,7 +493,7 @@ export function putCorsRules(bucket, cors_rules) {
                 ExposeHeaders: rule.expose_headers,
             });
         }
-        yield wrapS3Call(`when writing the bucket CORS config`, [200], () => bucket.client.send(new PutBucketCorsCommand({
+        yield wrapS3Call(`write the bucket CORS config`, [200], () => bucket.client.send(new PutBucketCorsCommand({
             Bucket: bucket.name,
             CORSConfiguration: { CORSRules },
         })));

package/doc/workflows/gh-actions.yml

@@ -3,7 +3,7 @@ name: Deploy with GitHub Actions
 # You will need to:
 # 1. Get (from Guichet web interface):
 #    - Your access keys (ID and secret): in the "S3" tab of your website
-#    - The website id: your sub-domain (the part before .web.deuxfleurs.fr) or your full custom domain (e.g. your-domain.com)
+#    - The website id: your sub-domain (e.g. something.deuxfleurs.eu|page) or your full custom domain (e.g. your-domain.com)
 # 2. Setup the access keys as secrets in GitHub web interface (https://docs.github.com/en/actions/how-tos/writing-workflows/choosing-what-your-workflow-does/using-secrets-in-github-actions), named in this example key_id and key_secret
 # 3. If you use a deuxfleurs.toml config, be sure the dxfl deploy command is launch in the current directory its in.
 

package/doc/workflows/woodpecker.yml

@@ -3,7 +3,7 @@
 # You will need to:
 # 1. Get (from Guichet web interface):
 #    - Your access keys (ID and secret): in the "S3" tab of your website
-#    - The website id: your sub-domain (the part before .web.deuxfleurs.fr) or your full custom domain (e.g. your-domain.com)
+#    - The website id: your sub-domain (e.g. something.deuxfleurs.eu|page) or your full custom domain (e.g. your-domain.com)
 # 2. Setup the access keys as secrets in Woodpecker web interface (https://woodpecker-ci.org/docs/usage/secrets), named in this example key_id and key_secret
 # 3. If you use a deuxfleurs.toml config, be sure the dxfl deploy command is launch in the current directory its in.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dxfl",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "",
   "license": "EUPL-1.2",
   "author": "Deuxfleurs Team <coucou@deuxfleurs.fr>",
@@ -20,18 +20,18 @@
     "prettier-check": "npx prettier . --check"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.750.0",
-    "@commander-js/extra-typings": "^13.1.0",
+    "@aws-sdk/client-s3": "^3.1004.0",
+    "@commander-js/extra-typings": "^14.0.0",
     "@supercharge/promise-pool": "^3.2.0",
-    "@types/node": "^22.13.5",
+    "@types/node": "^25.2.1",
     "cli-color": "^2.0.4",
-    "commander": "^13.1.0",
-    "fast-uri": "^3.0.6",
+    "commander": "^14.0.3",
+    "fast-uri": "^3.1.0",
     "guichet-sdk-ts": "^0.1.0",
-    "mime": "^4.0.6",
-    "read": "^4.1.0",
-    "smol-toml": "^1.3.4",
-    "typescript": "^5.7.3",
+    "mime": "^4.1.0",
+    "read": "^5.0.1",
+    "smol-toml": "^1.6.0",
+    "typescript": "^5.9.3",
     "zod": "^3.24.4",
     "zod-validation-error": "^3.4.1"
   },