@faable/faable 1.1.1 → 1.2.1

package/README.md

@@ -0,0 +1,24 @@
+<p align="center">
+  <a href="https://faable.com">
+    <img src="https://www.faable.com/logo/Emblem.png" height="96">
+    <h3 align="center">Faable</h3>
+  </a>
+</p>
+
+<p align="center">
+  Your React, Node.js or Python apps, up to the cloud in seconds.
+</p>
+
+## Faable
+
+Faable is the best platform to build modern architectures that scale precisely to meet demand. We handle the hard stuff so you can focus on building cloud ready apps. Make your business cloud driven and join those awesome companies.
+
+To install the latest version of Faable CLI:
+
+```bash
+npm i -g @faable/faable
+```
+
+## Documentation
+
+For details on how to use Faable CLI, check out our [documentation](https://docs.faable.com/).

package/bin/faable.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import "../dist/index.js";

package/dist/commands/deploy/build_docker.js

@@ -0,0 +1,14 @@
+import { log } from '../../log.js';
+import { cmd } from './cmd.js';
+
+const build_docker = async (props) => {
+    const { app_name, workdir } = props;
+    //log.info("Building...");
+    await cmd("/bin/bash", [
+        "-c",
+        `docker build -t app ${workdir} -f .faable/Dockerfile`,
+    ]);
+    log.info(`✅ Build ${app_name} successful`);
+};
+
+export { build_docker };

package/dist/commands/deploy/cmd.js

@@ -0,0 +1,11 @@
+import { spawn } from 'promisify-child-process';
+
+const cmd = async (cmd, args) => {
+    const { stdout, stderr } = await spawn(cmd, args, {
+        encoding: "utf8",
+        stdio: "inherit",
+    });
+    return stdout;
+};
+
+export { cmd };

package/dist/commands/deploy/deploy.js

@@ -0,0 +1,42 @@
+import { log } from '../../log.js';
+import { build_docker } from './build_docker.js';
+import { prepare } from './prepare.js';
+import { upload_tag } from './upload_tag.js';
+import fs from 'fs-extra';
+
+const deploy = {
+    command: "deploy [app_name]",
+    describe: "Deploy a faable app",
+    builder: (yargs) => {
+        return yargs
+            .positional("app_name", {
+            type: "string",
+            description: "App name to build for",
+            default: (s) => {
+                const { name } = fs.readJSONSync("./package.json");
+                return name;
+            },
+        })
+            .option("workdir", {
+            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");
+        }
+        log.info(`Building ${app_name}`);
+        await prepare({ from_image: "node:18.12.0", workdir });
+        await build_docker({ app_name, workdir });
+        // TODO: get this data from Faable API
+        //faablecloud#${ctx.faable_user}+deployment
+        await upload_tag({ app_name, user: "", password: "" });
+    },
+};
+
+export { deploy };

package/dist/commands/deploy/prepare.js

@@ -0,0 +1,33 @@
+import fs from 'fs-extra';
+import Handlebars from 'handlebars';
+import * as path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const templates_dir = path.join(__dirname, "../../../templates");
+const dockerfile = fs.readFileSync(`${templates_dir}/Dockerfile`).toString();
+// Docker template file
+const docker_template = Handlebars.compile(dockerfile);
+const prepare = async (props) => {
+    const { from_image, build_script = "build", start_script = "start", workdir, } = props;
+    await fs.remove(path.join(workdir, ".faable"));
+    await fs.mkdirp(path.join(workdir, ".faable"));
+    //log.info(`Preparing Dockerfile`);
+    // Compose template with data and write to path
+    const composed_file_data = docker_template({
+        from_image,
+        build_script,
+        start_script,
+    });
+    // Create Dockerfile
+    let out = path.join(workdir, ".faable", "Dockerfile");
+    await fs.writeFile(out, composed_file_data);
+    //log.info(`Created ${out}`);
+    // Copy entrypoint file
+    let out2 = path.join(workdir, ".faable", "entrypoint.sh");
+    await fs.copyFile(path.join(templates_dir, "entrypoint.sh"), out2);
+    //log.info(`Created ${out2}`);
+};
+
+export { prepare };

package/dist/commands/deploy/upload_tag.js

@@ -0,0 +1,21 @@
+import { log } from '../../log.js';
+import { cmd } from './cmd.js';
+
+const upload_tag = async (props) => {
+    const { hostname = "harbor.app.faable.com", user, password, app_name, } = props;
+    const tag = `${hostname}/${user}/${app_name}`;
+    // Registry login
+    await cmd("/bin/bash", [
+        "-c",
+        `echo "${password}" | docker login --username ${user} --password-stdin ${hostname}`,
+    ]);
+    log.info(`Logged in ${user}`);
+    // Tag image for production
+    await cmd("docker", ["tag", "app", tag]);
+    log.info(`Tagged image ${tag}`);
+    // Upload the image to faable registry
+    await cmd("docker", ["push", tag]);
+    log.info(`Uploaded ${tag}`);
+};
+
+export { upload_tag };

package/dist/index.js

@@ -0,0 +1,9 @@
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { deploy } from './commands/deploy/deploy.js';
+
+yargs(hideBin(process.argv))
+    .scriptName("faable")
+    .command(deploy)
+    .demandCommand(1)
+    .parse();

package/dist/log.js

@@ -0,0 +1,10 @@
+import * as core from '@actions/core';
+
+const log = {
+    error: core.error,
+    info: core.info,
+    warning: core.warning,
+    debug: core.debug,
+};
+
+export { log };

package/package.json

@@ -1,29 +1,26 @@
 {
   "name": "@faable/faable",
-  "version": "1.1.1",
-  "main": "dist/faable.js",
-  "license": "MIT",
-  "author": "Marc Pomar <marc@faable.com>",
-  "types": "dist/index.d.ts",
-  "bugs": {
-    "url": "https://github.com/faablecloud/faable/issues"
-  },
-  "homepage": "https://github.com/faablecloud/faable#readme",
-  "bin": {
-    "faable": "bin/faable"
-  },
+  "main": "dist/index.js",
   "dependencies": {
     "@actions/core": "^1.10.0",
     "fs-extra": "^11.1.0",
     "handlebars": "^4.7.7",
     "promisify-child-process": "^4.1.1",
-    "yargs": "^17.6.2",
-    "tslib": "^2.4.1"
+    "yargs": "^17.6.2"
   },
-  "engines": {
-    "node": ">=16"
+  "bin": {
+    "faable": "bin/faable.js"
+  },
+  "type": "module",
+  "license": "MIT",
+  "author": "Marc Pomar <marc@faable.com>",
+  "types": "./dist/index.d.ts",
+  "bugs": {
+    "url": "https://github.com/faablecloud/faable/issues"
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "homepage": "https://github.com/faablecloud/faable#readme",
+  "version": "1.2.1"
 }

package/templates/Dockerfile

@@ -0,0 +1,21 @@
+FROM {{from_image}}
+LABEL com.faable.cloud="FaableCloud"
+LABEL description="Faablecloud automatic deployment"
+
+WORKDIR /faable/app
+
+# Environment variables for runtime
+ENV PORT=80
+ENV NODE_ENV=production
+
+# Copy Usercode
+COPY ../ /faable/app
+
+# Build the project if requested
+{{#if build_script}}
+RUN echo "Running build command: {{build_script}}"
+RUN yarn run {{build_script}}
+{{/if}}
+
+
+ENTRYPOINT ["/bin/sh", "/faable/app/entrypoint.sh","{{start_script}}"]  

package/templates/entrypoint.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+NPM_RUN_COMMAND=$1
+
+NODE_VERSION=$(node --version)
+NPM_VERSION=$(npm --version)
+YARN_VERSION=$(yarn --version)
+echo "FaableCloud · Node:$NODE_VERSION NPM:$NPM_VERSION Yarn:$YARN_VERSION"
+echo "Running npm script -> $NPM_RUN_COMMAND"
+
+
+yarn run $NPM_RUN_COMMAND

package/bin/faable

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-
-require("../dist/faable");

package/dist/commands/deploy/build_docker.d.ts

@@ -1,6 +0,0 @@
-interface BuildConfig {
-    app_name: string;
-    workdir: string;
-}
-export declare const build_docker: (props: BuildConfig) => Promise<void>;
-export {};

package/dist/commands/deploy/cmd.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="node" />
-export declare const cmd: (cmd: string, args?: string[]) => Promise<string | Buffer>;

package/dist/commands/deploy/index.d.ts

@@ -1,7 +0,0 @@
-import { CommandModule } from "yargs";
-declare type Options = {
-    app_name: string;
-    workdir: string;
-};
-export declare const deploy: CommandModule<{}, Options>;
-export {};

package/dist/commands/deploy/prepare.d.ts

@@ -1,8 +0,0 @@
-interface PrepareBuild {
-    from_image: string;
-    build_script?: string;
-    start_script?: string;
-    workdir: string;
-}
-export declare const prepare: (props: PrepareBuild) => Promise<void>;
-export {};

package/dist/commands/deploy/upload_tag.d.ts

@@ -1,8 +0,0 @@
-interface RegistryUploadConfig {
-    app_name: string;
-    hostname?: string;
-    user: string;
-    password: string;
-}
-export declare const upload_tag: (props: RegistryUploadConfig) => Promise<void>;
-export {};

package/dist/faable.js

@@ -1,12 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const yargs_1 = (0, tslib_1.__importDefault)(require("yargs"));
-const helpers_1 = require("yargs/helpers");
-const deploy_1 = require("./commands/deploy");
-(0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
-    .scriptName("faable")
-    .command(deploy_1.deploy)
-    .demandCommand(1)
-    .parse();

package/dist/index.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/log.d.ts

@@ -1,7 +0,0 @@
-import * as core from "@actions/core";
-export declare const log: {
-    error: typeof core.error;
-    info: typeof core.info;
-    warning: typeof core.warning;
-    debug: typeof core.debug;
-};