carlin 1.19.8 → 1.19.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "carlin",
-  "version": "1.19.8",
+  "version": "1.19.9",
   "description": "",
   "license": "GPL-3.0",
   "author": "Pedro Arantes <arantespp@gmail.com> (https://twitter.com/arantespp)",
@@ -71,5 +71,5 @@
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
-  "gitHead": "5624791e118681b8ecbe2372bbc61806442df71b"
+  "gitHead": "c198401df0152f9dcfd6094b181996eb6fb08a09"
 }

package/dist/cli.js

@@ -1,232 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.options = void 0;
-const tslib_1 = require("tslib");
-/* eslint-disable no-param-reassign */
-const yargs = tslib_1.__importStar(require("yargs"));
-const config_1 = require("./config");
-const utils_1 = require("./utils");
-const change_case_1 = require("change-case");
-const command_1 = require("./deploy/command");
-const ecsTaskReportCommand_1 = require("./deploy/cicd/ecsTaskReportCommand");
-const generateEnvCommand_1 = require("./generateEnv/generateEnvCommand");
-const aws_sdk_1 = tslib_1.__importDefault(require("aws-sdk"));
-const deep_equal_1 = tslib_1.__importDefault(require("deep-equal"));
-const deepmerge_1 = tslib_1.__importDefault(require("deepmerge"));
-const find_up_1 = tslib_1.__importDefault(require("find-up"));
-const path_1 = tslib_1.__importDefault(require("path"));
-const coerceSetEnvVar = (env) => (value) => {
-    if (value) {
-        (0, utils_1.setEnvVar)(env, value);
-    }
-    return value;
-};
-exports.options = {
-    branch: {
-        coerce: coerceSetEnvVar('BRANCH'),
-        require: false,
-        type: 'string',
-    },
-    config: {
-        alias: 'c',
-        describe: 'Path to config file. You can create a config file and set all options there. Valid extensions: .js, .json, .ts, .yml, or .yaml.',
-        require: false,
-        type: 'string',
-    },
-    environment: {
-        alias: ['e', 'env'],
-        coerce: coerceSetEnvVar('ENVIRONMENT'),
-        type: 'string',
-    },
-    environments: {},
-    project: {
-        coerce: coerceSetEnvVar('PROJECT'),
-        require: false,
-        type: 'string',
-    },
-    region: {
-        alias: 'r',
-        // coerce: coerceSetEnvVar('REGION'),
-        default: config_1.AWS_DEFAULT_REGION,
-        describe: 'AWS region.',
-        type: 'string',
-    },
-};
-/**
- * You can also provide the options creating a property name `carlin`
- * inside your `package.json`. [See Yargs reference](https://yargs.js.org/docs/#api-reference-pkgconfkey-cwd).
- */
-const getPkgConfig = () => config_1.NAME;
-/**
- * All options can be passed as environment variables matching the prefix
- * `CARLIN`. See [Yargs reference](https://yargs.js.org/docs/#api-reference-envprefix).
- * Example, we may use `carlin deploy --stack-name StackName` or
- * `CARLIN_STACK_NAME=StackName carlin deploy`.
- */
-const getEnv = () => {
-    return (0, change_case_1.constantCase)(config_1.NAME);
-};
-/**
- * Transformed to method because finalConfig was failing the tests.
- */
-const cli = () => {
-    /**
-     * All config files merged.
-     */
-    let finalConfig;
-    /**
-     * If `--config` isn't provided, the algorithm will search for any of these
-     * files and use it to retrieve the options:
-     *
-     * - `carlin.js`
-     * - `carlin.ts`
-     * - `carlin.yaml`
-     * - `carlin.yml`
-     * - `carlin.json`
-     *
-     * The algorithm also make a find up path to search for other config files
-     * that may exist in parent directories. If find more than one file, they'll
-     * be merged, in such a way that the files nearest from `process.cwd()` will
-     * take the precedence at the merging.
-     *
-     * This is useful if you have a monorepo and have shared and specific
-     * configuration. For instance, you may have a config inside `packages/app/`
-     * folder with the config below:
-     *
-     * ```yaml
-     * stackName: MyMonorepoApp
-     * region: us-east-2
-     * ```
-     *
-     * And on the root of your monorepo:
-     *
-     * ```yaml
-     * awsAccountId: 123456789012
-     * region: us-east-1
-     * ```
-     *
-     * The result options that will be passed to the commands executed on
-     * `packages/app/` will be:
-     *
-     * ```yaml
-     * awsAccountId: 123456789012
-     * stackName: MyMonorepoApp
-     * region: us-east-2
-     * ```
-     */
-    const getConfig = () => {
-        const names = ['js', 'yml', 'yaml', 'json', 'ts'].map((ext) => `${config_1.NAME}.${ext}`);
-        const paths = [];
-        let currentPath = process.cwd();
-        let findUpPath;
-        do {
-            findUpPath = find_up_1.default.sync(names, { cwd: currentPath });
-            if (findUpPath) {
-                currentPath = path_1.default.resolve(findUpPath, '../..');
-                paths.push(findUpPath);
-            }
-        } while (findUpPath);
-        const configs = paths.map((p) => (0, utils_1.readObjectFile)({ path: p }) || {});
-        /**
-         * Using configs.reverser() to get the most far config first. This way the
-         * nearest configs will replace others.
-         */
-        finalConfig = deepmerge_1.default.all(configs.reverse());
-        return finalConfig;
-    };
-    return (yargs
-        /**
-         * It can't be full strict because options may overlap among carlin config
-         * files.
-         */
-        .strictCommands()
-        .scriptName(config_1.NAME)
-        .env(getEnv())
-        .options((0, utils_1.addGroupToOptions)(exports.options, 'Common Options'))
-        .middleware(((argv, { parsed }) => {
-        const { environment, environments } = argv;
-        /**
-         * Create final options with environment and environments.
-         */
-        if (environment &&
-            environments &&
-            environments[environment]) {
-            Object.entries(environments[environment]).forEach(([key, value]) => {
-                /**
-                 * The case where argv[key] must not have the environment value is
-                 * when such value is passed as option via CLI. For instance,
-                 *
-                 * $ carlin deploy --stack-name SomeName
-                 *
-                 * SomeName must be used as stack name independently of the
-                 * environment values https://github.com/ttoss/carlin/issues/13.
-                 *
-                 * Three cases set argv:
-                 *
-                 * 1. Default.
-                 * 2. Config file.
-                 * 3. CLI
-                 *
-                 * - Case 1 we determine if the parsed.defaulted is true.
-                 * - Case 2 we determine if `argv[key] === finalConfig[key]`.
-                 * - Case 3 if the two above are falsy.
-                 */
-                const isKeyFromCli = (() => {
-                    var _a;
-                    const paramCaseKey = (0, change_case_1.paramCase)(key);
-                    /**
-                     * Case 1.
-                     * Fixes #16 https://github.com/ttoss/carlin/issues/16
-                     */
-                    if ((_a = parsed === null || parsed === void 0 ? void 0 : parsed.defaulted) === null || _a === void 0 ? void 0 : _a[paramCaseKey]) {
-                        return false;
-                    }
-                    /**
-                     * Case 2.
-                     *
-                     * Fixes #13 https://github.com/ttoss/carlin/issues/13
-                     *
-                     * Deep equal because arg can be an array or object.
-                     */
-                    if ((0, deep_equal_1.default)(argv[key], finalConfig[key])) {
-                        return false;
-                    }
-                    return true;
-                })();
-                if (!isKeyFromCli) {
-                    argv[key] = value;
-                }
-            });
-        }
-    }))
-        /**
-         * Sometimes "environments" can be written as "environment" on config file.
-         */
-        .middleware(({ environment }) => {
-        if (!['string', 'undefined'].includes(typeof environment)) {
-            throw new Error(`environment type is invalid. The value: ${JSON.stringify(environment)}`);
-        }
-    })
-        /**
-         * Set AWS region.
-         */
-        .middleware(({ region }) => {
-        aws_sdk_1.default.config.region = region;
-        (0, utils_1.setEnvVar)('REGION', region);
-    })
-        .pkgConf(getPkgConfig())
-        .config(getConfig())
-        .config('config', (configPath) => (0, utils_1.readObjectFile)({ path: configPath }))
-        .command({
-        command: 'print-args',
-        describe: false,
-        // eslint-disable-next-line no-console
-        handler: (argv) => console.log(JSON.stringify(argv, null, 2)),
-    })
-        .command(command_1.deployCommand)
-        .command(ecsTaskReportCommand_1.ecsTaskReportCommand)
-        .command(generateEnvCommand_1.generateEnvCommand)
-        .epilogue('For more information, find our manual at https://carlin.ttoss.dev')
-        .help());
-};
-exports.default = cli;

package/dist/config.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CLOUDFRONT_REGION = exports.AWS_DEFAULT_REGION = exports.NAME = void 0;
-exports.NAME = 'carlin';
-exports.AWS_DEFAULT_REGION = 'us-east-1';
-/**
- * CloudFront triggers can be only in US East (N. Virginia) Region.
- * https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-requirements-limits.html#lambda-requirements-cloudfront-triggers
- */
-exports.CLOUDFRONT_REGION = 'us-east-1';

package/dist/deploy/addDefaults.cloudFormation.js

@@ -1,138 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addDefaults = void 0;
-const config_1 = require("../config");
-const utils_1 = require("../utils");
-const addDefaultsParametersAndTagsToParams = async (params) => {
-    const branchName = await (0, utils_1.getCurrentBranch)();
-    const environment = await (0, utils_1.getEnvironment)();
-    const packageName = await (0, utils_1.getPackageName)();
-    const packageVersion = await (0, utils_1.getPackageVersion)();
-    const projectName = await (0, utils_1.getProjectName)();
-    return {
-        ...params,
-        Parameters: [
-            ...(params.Parameters || []),
-            ...(environment
-                ? [{ ParameterKey: 'Environment', ParameterValue: environment }]
-                : []),
-            { ParameterKey: 'Project', ParameterValue: projectName },
-        ],
-        Tags: [
-            ...(params.Tags || []),
-            { Key: 'Branch', Value: branchName },
-            ...(environment ? [{ Key: 'Environment', Value: environment }] : []),
-            { Key: 'Package', Value: packageName },
-            { Key: 'Project', Value: projectName },
-            { Key: 'Version', Value: packageVersion },
-        ].filter(({ Value }) => !!Value),
-    };
-};
-const addDefaultParametersToTemplate = async (template) => {
-    const [environment, projectName] = await Promise.all([
-        (0, utils_1.getEnvironment)(),
-        (0, utils_1.getProjectName)(),
-    ]);
-    const newParameters = {
-        Project: { Default: projectName, Type: 'String' },
-    };
-    if (environment) {
-        newParameters.Environment = { Default: environment, Type: 'String' };
-    }
-    const newTemplate = {
-        ...template,
-        Parameters: { ...newParameters, ...template.Parameters },
-    };
-    return newTemplate;
-};
-const addLogGroupToResources = (template) => {
-    const { Resources } = template;
-    const resourcesEntries = Object.entries(Resources);
-    resourcesEntries.forEach(([key, resource]) => {
-        if (['AWS::Lambda::Function', 'AWS::Serverless::Function'].includes(resource.Type)) {
-            /**
-             * Check if exist a resource on template whose LogGroupName
-             * Properties includes the Lambda logical id.
-             */
-            const logGroup = resourcesEntries.find(([, resource2]) => {
-                var _a, _b;
-                const logGroupNameStr = JSON.stringify(((_b = (_a = resource2.Properties) === null || _a === void 0 ? void 0 : _a.LogGroupName) === null || _b === void 0 ? void 0 : _b['Fn::Join']) || '');
-                return logGroupNameStr.includes(key);
-            });
-            if (!logGroup) {
-                Resources[`${key}LogsLogGroup`] = {
-                    Type: 'AWS::Logs::LogGroup',
-                    DeletionPolicy: 'Delete',
-                    Properties: {
-                        LogGroupName: { 'Fn::Join': ['/', ['/aws/lambda', { Ref: key }]] },
-                    },
-                };
-            }
-        }
-    });
-    return template;
-};
-const addEnvironmentsToLambdaResources = async (template) => {
-    const environment = (0, utils_1.getEnvironment)();
-    const { Resources } = template;
-    const resourcesEntries = Object.entries(Resources);
-    resourcesEntries.forEach(([, resource]) => {
-        if (resource.Type === 'AWS::Lambda::Function') {
-            const { Properties } = resource;
-            /**
-             * Lambda@Edege does not support environment variables.
-             * https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-requirements-limits.html#lambda-requirements-lambda-function-configuration
-             * Then every function that has "Lambda@Edge" in its description will not
-             * have the variables passed to Environment.Variables.
-             */
-            if ((Properties.Description || '').includes('Lambda@Edge')) {
-                return;
-            }
-            if (!environment) {
-                return;
-            }
-            if (!Properties.Environment) {
-                Properties.Environment = {};
-            }
-            if (!Properties.Environment.Variables) {
-                Properties.Environment.Variables = {};
-            }
-            Properties.Environment.Variables.ENVIRONMENT = environment;
-        }
-    });
-    return template;
-};
-const addAppSyncApiOutputs = async (template) => {
-    const newTemplate = { ...template };
-    Object.entries(template.Resources).forEach(([key, resource]) => {
-        if (resource.Type === 'AWS::AppSync::GraphQLApi') {
-            newTemplate.Outputs = {
-                [key]: {
-                    Description: `Automatically added by ${config_1.NAME}`,
-                    Value: { 'Fn::GetAtt': [key, 'GraphQLUrl'] },
-                    Export: {
-                        Name: {
-                            'Fn::Join': [':', [{ Ref: 'AWS::StackName' }, 'GraphQLApiUrl']],
-                        },
-                    },
-                },
-                ...newTemplate.Outputs,
-            };
-        }
-    });
-    return newTemplate;
-};
-const addDefaults = async ({ params, template, }) => {
-    const newTemplate = await [
-        addDefaultParametersToTemplate,
-        addLogGroupToResources,
-        addEnvironmentsToLambdaResources,
-        addAppSyncApiOutputs,
-    ].reduce(async (acc, addFn) => addFn(await acc), Promise.resolve(template));
-    const response = {
-        params: await addDefaultsParametersAndTagsToParams(params),
-        template: newTemplate,
-    };
-    return response;
-};
-exports.addDefaults = addDefaults;

package/dist/deploy/baseStack/command.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deployBaseStackCommand = void 0;
-const deployBaseStack_1 = require("./deployBaseStack");
-exports.deployBaseStackCommand = {
-    command: 'base-stack',
-    describe: 'Create base resources.',
-    handler: deployBaseStack_1.deployBaseStack,
-};

package/dist/deploy/baseStack/config.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BASE_STACK_VPC_PUBLIC_SUBNET_2_EXPORTED_NAME = exports.BASE_STACK_VPC_PUBLIC_SUBNET_1_EXPORTED_NAME = exports.BASE_STACK_VPC_PUBLIC_SUBNET_0_EXPORTED_NAME = exports.BASE_STACK_VPC_DEFAULT_SECURITY_GROUP_EXPORTED_NAME = exports.BASE_STACK_VPC_ID_EXPORTED_NAME = exports.BASE_STACK_LAMBDA_LAYER_BUILDER_LOGICAL_NAME = exports.BASE_STACK_LAMBDA_IMAGE_BUILDER_EXPORTED_NAME = exports.BASE_STACK_LAMBDA_IMAGE_BUILDER_LOGICAL_NAME = exports.BASE_STACK_BUCKET_NAME_EXPORTED_NAME = exports.BASE_STACK_BUCKET_LOGICAL_NAME = exports.BASE_STACK_BUCKET_TEMPLATES_FOLDER = exports.BASE_STACK_NAME = void 0;
-const change_case_1 = require("change-case");
-const config_1 = require("../../config");
-const pascalCaseName = (0, change_case_1.pascalCase)(config_1.NAME);
-exports.BASE_STACK_NAME = `${pascalCaseName}BaseStack`;
-exports.BASE_STACK_BUCKET_TEMPLATES_FOLDER = 'cloudformation-templates';
-/**
- * S3 Bucket.
- */
-exports.BASE_STACK_BUCKET_LOGICAL_NAME = `${pascalCaseName}Bucket`;
-exports.BASE_STACK_BUCKET_NAME_EXPORTED_NAME = `${pascalCaseName}BucketNameExportedName`;
-/**
- * Lambda image builder.
- */
-exports.BASE_STACK_LAMBDA_IMAGE_BUILDER_LOGICAL_NAME = `${pascalCaseName}LambdaImageBuilder`;
-exports.BASE_STACK_LAMBDA_IMAGE_BUILDER_EXPORTED_NAME = `${pascalCaseName}LambdaImageBuilderExportedName`;
-/**
- * Lambda layer builder.
- */
-exports.BASE_STACK_LAMBDA_LAYER_BUILDER_LOGICAL_NAME = `${pascalCaseName}LambdaLayerBuilder`;
-/**
- * VPC
- */
-exports.BASE_STACK_VPC_ID_EXPORTED_NAME = `${pascalCaseName}VPCIDExportedName`;
-exports.BASE_STACK_VPC_DEFAULT_SECURITY_GROUP_EXPORTED_NAME = `${pascalCaseName}DefaultSecurityGroupExportedName`;
-exports.BASE_STACK_VPC_PUBLIC_SUBNET_0_EXPORTED_NAME = `${pascalCaseName}VPCPublicSubnet0ExportedName`;
-exports.BASE_STACK_VPC_PUBLIC_SUBNET_1_EXPORTED_NAME = `${pascalCaseName}VPCPublicSubnet1ExportedName`;
-exports.BASE_STACK_VPC_PUBLIC_SUBNET_2_EXPORTED_NAME = `${pascalCaseName}VPCPublicSubnet2ExportedName`;

package/dist/deploy/baseStack/deployBaseStack.js

@@ -1,59 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deployBaseStack = exports.baseStackTemplate = void 0;
-const tslib_1 = require("tslib");
-const config_1 = require("./config");
-const cloudFormation_core_1 = require("../cloudFormation.core");
-const getBucket_template_1 = require("./getBucket.template");
-const getLambdaImageBuilder_template_1 = require("./getLambdaImageBuilder.template");
-const getLambdaLayerBuilder_template_1 = require("./getLambdaLayerBuilder.template");
-const getVpc_template_1 = require("./getVpc.template");
-const utils_1 = require("../utils");
-const deepmerge_1 = tslib_1.__importDefault(require("deepmerge"));
-const logPrefix = 'base-stack';
-exports.baseStackTemplate = deepmerge_1.default.all([
-    (0, getBucket_template_1.getBucketTemplate)(),
-    (0, getLambdaImageBuilder_template_1.getLambdaImageBuilderTemplate)(),
-    (0, getLambdaLayerBuilder_template_1.getLambdaLayerBuilderTemplate)(),
-    (0, getVpc_template_1.getVpcTemplate)(),
-]);
-/**
- * Base Stack is a set of auxiliary resources that will be used to help at the
- * deployment time. The resources that will be created are listed below.
- *
- * - **S3 bucket**. Deployment may need an auxiliary bucket to succeed. For
- * instance, to deploy resources that contain a
- * [Lambda](https://carlin.ttoss.dev/docs/commands/deploy#lambda), we need a S3
- * bucket to upload the zipped code. Or if the CloudFormation template has a
- * size greater than [the limit](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html),
- * we need to upload the template to a S3 bucket in order to create/update the
- * stack.
- *
- * - **Lambda Layer builder**. This resource is a CodeBuild project that is
- * used to create Lambda Layers when [--lambda-externals](/docs/api-reference/deploy#lambda-externals)
- * has values.
- *
- * - **Lambda Image builder**. This resource is a CodeBuild project that builds
- * Docker Images if Lambda is going to use them.
- *
- * - **VPC**. This resource is used when some network infrastructure is
- * required. For example, CICD needs a VPC to execute the [Fargate](https://aws.amazon.com/fargate/)
- * operations.
- */
-const deployBaseStack = async () => {
-    try {
-        const { stackName } = await (0, utils_1.handleDeployInitialization)({
-            logPrefix,
-            stackName: config_1.BASE_STACK_NAME,
-        });
-        await (0, cloudFormation_core_1.deploy)({
-            template: exports.baseStackTemplate,
-            params: { StackName: stackName },
-            terminationProtection: true,
-        });
-    }
-    catch (error) {
-        (0, utils_1.handleDeployError)({ error, logPrefix });
-    }
-};
-exports.deployBaseStack = deployBaseStack;

package/dist/deploy/baseStack/getBaseStackResource.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBaseStackResource = exports.getBaseStackOutput = void 0;
-const cloudFormation_core_1 = require("../cloudFormation.core");
-const config_1 = require("./config");
-const getBaseStackOutput = async (outputKey) => {
-    const output = await (0, cloudFormation_core_1.getStackOutput)({
-        stackName: config_1.BASE_STACK_NAME,
-        outputKey,
-    });
-    return output.OutputValue;
-};
-exports.getBaseStackOutput = getBaseStackOutput;
-const resourcesKeys = {
-    BASE_STACK_BUCKET_LOGICAL_NAME: config_1.BASE_STACK_BUCKET_LOGICAL_NAME,
-    BASE_STACK_LAMBDA_IMAGE_BUILDER_LOGICAL_NAME: config_1.BASE_STACK_LAMBDA_IMAGE_BUILDER_LOGICAL_NAME,
-    BASE_STACK_LAMBDA_LAYER_BUILDER_LOGICAL_NAME: config_1.BASE_STACK_LAMBDA_LAYER_BUILDER_LOGICAL_NAME,
-};
-const resources = {};
-const getBaseStackResource = async (resource) => {
-    if (!resources[resource]) {
-        resources[resource] = await (0, exports.getBaseStackOutput)(resourcesKeys[resource]);
-    }
-    return resources[resource];
-};
-exports.getBaseStackResource = getBaseStackResource;

package/dist/deploy/baseStack/getBucket.template.js

@@ -1,44 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBucketTemplate = void 0;
-const config_1 = require("./config");
-const getBucketTemplate = () => ({
-    AWSTemplateFormatVersion: '2010-09-09',
-    Resources: {
-        [config_1.BASE_STACK_BUCKET_LOGICAL_NAME]: {
-            Type: 'AWS::S3::Bucket',
-            DeletionPolicy: 'Retain',
-            Properties: {
-                LifecycleConfiguration: {
-                    Rules: [
-                        {
-                            ExpirationInDays: 1,
-                            Prefix: config_1.BASE_STACK_BUCKET_TEMPLATES_FOLDER,
-                            Status: 'Enabled',
-                        },
-                        {
-                            NoncurrentVersionExpirationInDays: 3,
-                            Status: 'Enabled',
-                        },
-                    ],
-                },
-                /**
-                 * This is necessary because if we update Lambda code without change
-                 * CloudFormation template, the Lambda will not be updated.
-                 */
-                VersioningConfiguration: {
-                    Status: 'Enabled',
-                },
-            },
-        },
-    },
-    Outputs: {
-        [config_1.BASE_STACK_BUCKET_LOGICAL_NAME]: {
-            Value: { Ref: config_1.BASE_STACK_BUCKET_LOGICAL_NAME },
-            Export: {
-                Name: config_1.BASE_STACK_BUCKET_NAME_EXPORTED_NAME,
-            },
-        },
-    },
-});
-exports.getBucketTemplate = getBucketTemplate;