@defer/redwood/esm/function/tasks.js

Setup Defer in RedwoodJS

import path from "path";
import { Listr } from "listr2";
import fs from "fs-extra";
import { getPaths, writeFile } from "@redwoodjs/cli-helpers";
import humanize from "humanize-string";
export const tasks = (options) => {
    const PACKAGE_JSON_PATH = path.join(getPaths().api.base, "package.json");
    const SRC_DEFER_PATH = path.join(getPaths().api.src, "jobs", "defer");
    const SRC_DEFER_CLIENT_PATH_FILE = path.join(getPaths().api.src, "jobs", "clients", "defer.ts");
    const commandPaths = {
        PACKAGE_JSON_PATH,
        SRC_DEFER_PATH,
        SRC_DEFER_CLIENT_PATH_FILE,
    };
    const existingFiles = options.force ? "OVERWRITE" : "FAIL";
    return new Listr([
        {
            title: "Check Defer is properly configured ...",
            task: () => {
                const pkg = JSON.parse(fs.readFileSync(PACKAGE_JSON_PATH, "utf-8"));
                if (!Object.keys(pkg.dependencies || {}).includes("@defer/client") ||
                    !fs.existsSync(SRC_DEFER_CLIENT_PATH_FILE)) {
                    throw new Error("Please setup Defer before creating a background function.");
                }
            },
        },
        {
            title: `Create ${humanize(options.name)} background function ...`,
            task: () => {
                createBackgroundFunctionTask({
                    commandPaths,
                    existingFiles,
                    name: options.name,
                });
            },
        },
    ], { rendererOptions: {} });
};
export const createBackgroundFunctionTask = ({ commandPaths, existingFiles, name, }) => {
    fs.ensureDirSync(commandPaths["SRC_DEFER_PATH"]);
    const deferHelloWorldTemplate = fs.readFileSync(path.resolve(__dirname, "..", "..", "templates", "function", "helloWorld.ts.template"), "utf-8");
    return writeFile(path.join(commandPaths["SRC_DEFER_PATH"], `${humanize(name)}.ts`), deferHelloWorldTemplate.replace(/helloWorld/g, humanize(name)), {
        existingFiles,
    });
};