@faable/faable 1.2.7 → 1.2.8

package/dist/api/FaableApi.js

@@ -1,26 +1,35 @@
+import { __decorate } from 'tslib';
 import { prepare_client } from './client.js';
 
-const wrap_error = async (prom) => {
-    try {
-        const res = await prom;
-        return res.data;
-    }
-    catch (error) {
-        const e = error;
-        if (e.isAxiosError) {
-            const res = e.response;
-            if (res) {
-                throw new Error(`API Error ${res.status}: ${res?.data.message}`);
+function handleError(message) {
+    return function (target, propertyKey, descriptor) {
+        const method = descriptor.value;
+        descriptor.value = async function (...args) {
+            try {
+                return await method.bind(this).apply(target, args);
             }
-            else {
-                throw new Error(`API Error:${e.message}`);
+            catch (error) {
+                const e = error;
+                if (e.isAxiosError) {
+                    const res = e.response;
+                    if (res) {
+                        throw new Error(`FaableApi ${e.config.url} ${res.status}: ${res?.data.message}`);
+                    }
+                    else {
+                        throw new Error(`FaableApi ${e.message}`);
+                    }
+                }
+                throw error;
             }
-        }
-        throw error;
-    }
+        };
+    };
+}
+const paginate = async (res) => {
+    const items = (await res).results;
+    return items;
 };
-const paginate = async (data) => {
-    const items = (await data).results;
+const data = async (res) => {
+    const items = (await res).data;
     return items;
 };
 class FaableApi {
@@ -32,14 +41,23 @@ class FaableApi {
         return new FaableApi(config);
     }
     async list() {
-        return paginate(wrap_error(this.client.get(`/app`)));
+        return paginate(data(this.client.get(`/app`)));
     }
     async getBySlug(slug) {
-        return wrap_error(this.client.get(`/app/slug/${slug}`));
+        return data(this.client.get(`/app/slug/${slug}`));
     }
     async getRegistry(app_id) {
-        return wrap_error(this.client.get(`/app/${app_id}/registry`));
+        return data(this.client.get(`/app/${app_id}/registry`));
     }
 }
+__decorate([
+    handleError()
+], FaableApi.prototype, "list", null);
+__decorate([
+    handleError()
+], FaableApi.prototype, "getBySlug", null);
+__decorate([
+    handleError()
+], FaableApi.prototype, "getRegistry", null);
 
 export { FaableApi };

package/dist/api/context.js

@@ -1,11 +1,10 @@
 import { FaableApi } from './FaableApi.js';
-import { authenticateOAuthApp } from './authenticateOAuthApp.js';
+import { apikey } from './strategies/apikey.js';
 
 const context = async () => {
-    const authStrategy = authenticateOAuthApp;
     const { config } = await import('./userdir_config.js');
     return {
-        api: FaableApi.create({ authStrategy, auth: config }),
+        api: FaableApi.create({ authStrategy: apikey, auth: config }),
     };
 };
 

package/dist/api/strategies/apikey.js

@@ -0,0 +1,15 @@
+const apikey = (config) => {
+    const { apikey } = config;
+    if (!apikey) {
+        throw new Error("Missing apikey.");
+    }
+    return {
+        headers: async () => {
+            return {
+                Authorization: `Basic ${Buffer.from(`${apikey}:`).toString("base64")}`,
+            };
+        },
+    };
+};
+
+export { apikey };

package/dist/api/userdir_config.js

@@ -11,10 +11,10 @@ if (fs.existsSync(credentials_path)) {
     // console.log(creds);
     config.clientId = creds.clientId;
     config.clientSecret = creds.clientSecret;
+    config.apikey = creds.apikey;
 }
-if (process.env.FAABLE_CLIENT_ID && process.env.FAABLE_CLIENT_SECRET) {
-    config.clientId = process.env.FAABLE_CLIENT_ID;
-    config.clientSecret = process.env.FAABLE_CLIENT_SECRET;
-}
+config.clientId = process.env.FAABLE_CLIENT_ID || config.clientId;
+config.clientSecret = process.env.FAABLE_CLIENT_SECRET || config.clientSecret;
+config.apikey = process.env.FAABLE_APIKEY || config.apikey;
 
 export { config };

package/dist/commands/configure/index.js

@@ -27,13 +27,8 @@ const configure = {
         const response = await prompts([
             {
                 type: "text",
-                name: "clientId",
-                message: "What is your Faable clientId?",
-            },
-            {
-                type: "text",
-                name: "clientSecret",
-                message: "What is your Faable clientSecret?",
+                name: "apikey",
+                message: "What is your Faable ApiKey?",
             },
         ]);
         await fs.ensureDir(faable_home);

package/dist/commands/deploy/analyze_package.js

@@ -2,7 +2,8 @@ import fs from 'fs-extra';
 import path__default from 'path';
 import { log } from '../../log.js';
 
-const analyze_package = async ({ workdir }) => {
+const analyze_package = async (params) => {
+    const workdir = params.workdir;
     const package_file = path__default.join(path__default.resolve(workdir), "package.json");
     log.info(`Loading config from package.json...`);
     const pkg = await fs.readJSON(package_file);
@@ -11,16 +12,13 @@ const analyze_package = async ({ workdir }) => {
         throw new Error("Missing start script");
     }
     // Check if build is required to run
-    let hasBuild = false;
-    if (pkg?.scripts?.build) {
-        log.info(`Build step: ${pkg?.scripts?.build}`);
-        hasBuild = true;
-    }
-    else {
+    const build_script = params.build_script || "build";
+    let build = pkg?.scripts[build_script];
+    if (!build) {
         log.info(`No build script found`);
     }
     return {
-        hasBuild,
+        build_script,
     };
 };
 

package/dist/commands/deploy/build_project.js

@@ -0,0 +1,17 @@
+import { log } from '../../log.js';
+import { cmd } from './cmd.js';
+
+const build_project = async (args) => {
+    const cwd = args?.cwd || process.cwd();
+    const build_script = args?.build_script || "build";
+    args.app;
+    log.info(`⚡️ Running build script [${build_script}]...`);
+    const timeout = 1000 * 60 * 10; // 10 minute timeout
+    await cmd("yarn", ["run", build_script], {
+        timeout,
+        cwd,
+        enableOutput: true,
+    });
+};
+
+export { build_project };

package/dist/commands/deploy/{build_docker.js → bundle_docker.js}

@@ -1,3 +1,4 @@
+import { log } from '../../log.js';
 import { cmd } from './cmd.js';
 import fs from 'fs-extra';
 import Handlebars from 'handlebars';
@@ -22,15 +23,26 @@ Handlebars.registerHelper("escape", function (variable) {
 // Docker template file
 const docker_template = Handlebars.compile(dockerfile);
 const entrypoint_template = Handlebars.compile(entrypoint);
-const build_docker = async (props) => {
-    const { app_name, workdir, template_context } = props;
+const bundle_docker = async (props) => {
+    const { app, workdir, template_context } = props;
     const entrypoint_custom = entrypoint_template(template_context);
     const dockerfile = docker_template({
         ...template_context,
         entry_script: entrypoint_custom,
     });
-    // console.log(dockerfile);
-    await cmd("/bin/bash", ["-c", `docker build -t app ${workdir} -f-<<EOF\n${dockerfile}\nEOF`], { enableOutput: true });
+    log.info(`📦 Packaging inside a docker image`);
+    const tagname = app.id;
+    const timeout = 10 * 60 * 1000; // 10 minute timeout
+    const command = [
+        "-c",
+        `docker build -t ${tagname} ${workdir} -f -<<EOF\n${dockerfile}\nEOF`,
+    ];
+    console.log(command.join(" "));
+    await cmd("/bin/bash", command, { timeout, enableOutput: true });
+    log.info(`⚙️  Image ready [tag:${tagname}]`);
+    return {
+        tagname,
+    };
 };
 
-export { build_docker };
+export { bundle_docker };

package/dist/commands/deploy/cmd.js

@@ -1,10 +1,15 @@
 import { spawn } from 'promisify-child-process';
 
-const cmd = async (cmd, args, params = { enableOutput: false }) => {
-    const { enableOutput } = params;
+const cmd = async (cmd, args, params) => {
+    // Defaults
+    const enableOutput = params?.enableOutput || false;
+    const timeout = params?.timeout;
+    const cwd = params?.cwd;
     const child = spawn(cmd, args, {
         encoding: "utf8",
         stdio: enableOutput ? "inherit" : "pipe",
+        timeout,
+        cwd,
     });
     const out_data = [];
     child.stderr?.on("data", (data) => {

package/dist/commands/deploy/deploy_command.js

@@ -0,0 +1,39 @@
+import { log } from '../../log.js';
+import { bundle_docker } from './bundle_docker.js';
+import { upload_tag } from './upload_tag.js';
+import { check_environment } from './check_environment.js';
+import { analyze_package } from './analyze_package.js';
+import { context } from '../../api/context.js';
+import { build_project } from './build_project.js';
+
+const deploy_command = async (args) => {
+    const app_slug = args.app_slug;
+    const workdir = args.workdir || process.cwd();
+    if (!app_slug) {
+        throw new Error("Missing app name");
+    }
+    // Check if we can build docker images
+    await check_environment();
+    // Get registry data from api.faable.com
+    const { api } = await context();
+    const app = await api.getBySlug(app_slug);
+    log.info(`🚀 Preparing to build ${app.name} [${app.id}]`);
+    // Analyze package.json to check if build is needed
+    const { build_script } = await analyze_package({ workdir });
+    if (build_script) {
+        await build_project({ app, build_script });
+    }
+    // Bundle project inside a docker image
+    const { tagname } = await bundle_docker({
+        app,
+        workdir,
+        template_context: {
+            from: "node:18.12.0-slim",
+            start_script: "start",
+        },
+    });
+    // Upload to Faable registry
+    await upload_tag({ app, api, tagname });
+};
+
+export { deploy_command };

package/dist/commands/deploy/index.js

@@ -1,10 +1,5 @@
-import { log } from '../../log.js';
-import { build_docker } from './build_docker.js';
-import { upload_tag } from './upload_tag.js';
 import fs from 'fs-extra';
-import { check_environment } from './check_environment.js';
-import { analyze_package } from './analyze_package.js';
-import { context } from '../../api/context.js';
+import { deploy_command } from './deploy_command.js';
 
 const deploy = {
     command: "deploy [app_name]",
@@ -23,39 +18,10 @@ const deploy = {
             alias: "w",
             type: "string",
             description: "Working directory",
-            default: process.cwd(),
         })
             .showHelpOnFail(false);
     },
-    handler: async (args) => {
-        const { app_name, workdir } = args;
-        if (!app_name) {
-            throw new Error("Missing app_name");
-        }
-        // Check environment is ready
-        await check_environment();
-        // Get registry data from api.faable.com
-        const { api } = await context();
-        const app = await api.getBySlug(app_name);
-        log.info(`⚡️ Building app "${app.name}"`);
-        // Analyze package.json
-        const { hasBuild } = await analyze_package({ workdir });
-        // Build docker image
-        await build_docker({
-            app_name,
-            workdir,
-            template_context: {
-                from: "node:18.12.0-slim",
-                build_script: hasBuild && "build",
-                start_script: "start",
-            },
-        });
-        log.info(`⚙️ Image ready. Uploading...`);
-        // Upload using api.faable.com data
-        const registry = await api.getRegistry(app.id);
-        await upload_tag({ registry });
-        log.info(`✅ Upload completed.`);
-    },
+    handler: async (args) => deploy_command(args),
 };
 
 export { deploy };

package/dist/commands/deploy/upload_tag.js

@@ -1,16 +1,20 @@
+import { log } from '../../log.js';
 import { cmd } from './cmd.js';
 
-const upload_tag = async (props) => {
-    //faablecloud#${ctx.faable_user}+deployment
-    const { user, password, hostname, image } = props.registry;
+const upload_tag = async (args) => {
+    const { api, app, tagname } = args;
+    log.info(`Uploading ${tagname}`);
+    const registry = await api.getRegistry(app.id);
     // Registry login
+    const { user, password, hostname, image } = registry;
     const docker_login_cmd = `echo "${password}" | docker login --username ${user} --password-stdin ${hostname}`;
     await cmd("/bin/bash", ["-c", docker_login_cmd]);
     // Tag image for production
     const image_tag = `${hostname}/${image}`;
-    await cmd("docker", ["tag", "app", image_tag]);
+    await cmd("docker", ["tag", tagname, image_tag]);
     // Upload the image to faable registry
     await cmd("docker", ["push", image_tag]);
+    log.info(`✅ Upload completed.`);
 };
 
 export { upload_tag };

package/package.json

@@ -9,6 +9,7 @@
     "pino-pretty": "^9.4.0",
     "promisify-child-process": "^4.1.1",
     "prompts": "^2.4.2",
+    "tslib": "^2.4.1",
     "yargs": "^17.6.2"
   },
   "bin": {
@@ -25,5 +26,5 @@
     "access": "public"
   },
   "homepage": "https://github.com/faablecloud/faable#readme",
-  "version": "1.2.7"
+  "version": "1.2.8"
 }

package/templates/Dockerfile

@@ -7,17 +7,9 @@ WORKDIR /faable/app
 # Environment variables for runtime
 ENV PORT=80
 ENV NODE_ENV=production
+ENV START_SCRIPT=start
 
 # Copy Usercode
-COPY ./ /faable/app
+COPY . .
 
-RUN echo '{{{escape entry_script}}}' >> entrypoint.sh
-
-# Build the project if requested
-{{#if build_script}}
-RUN echo "Running build command: {{build_script}}"
-RUN yarn run {{build_script}}
-{{/if}}
-
-
-CMD ["/bin/sh", "/faable/app/entrypoint.sh","{{start_script}}"]  
+CMD ["/bin/sh", "./entrypoint.sh"]  

package/templates/entrypoint.sh

@@ -5,4 +5,4 @@ NPM_VERSION=$(npm --version)
 YARN_VERSION=$(yarn --version)
 
 echo "Faable Cloud · [node $NODE_VERSION] [npm $NPM_VERSION] [yarn $YARN_VERSION]"
-yarn run {{start_script}}
+npm run $START_SCRIPT

package/dist/api/authenticateOAuthApp.js

@@ -1,35 +0,0 @@
-import axios from 'axios';
-
-const authenticateOAuthApp = (creds) => {
-    const { clientId, clientSecret } = creds;
-    if (!clientId || !clientSecret) {
-        throw new Error("Missing credentials. Run faable configure first.");
-    }
-    const client = axios.create({ baseURL: "https://api-auth.app.faable.com" });
-    let cache_token;
-    const fetch_token = async () => {
-        // Send client credentials in POST body. Can also be sent as basic auth header.
-        const res = await client.post("/oauth/token", {
-            client_id: clientId,
-            client_secret: clientSecret,
-            grant_type: "client_credentials",
-        });
-        //console.log(`Fetched Token!`);
-        // Cache the token
-        cache_token = res.data;
-        return cache_token;
-    };
-    return {
-        headers: async () => {
-            // TODO: Check token is not expired
-            const { token_type, access_token } = cache_token
-                ? cache_token
-                : await fetch_token();
-            return {
-                Authorization: `${token_type} ${access_token}`,
-            };
-        },
-    };
-};
-
-export { authenticateOAuthApp };