alfresco-ng2-components/lib/cli/scripts/check-cs-env.ts

/*!
 * @license
 * Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { AlfrescoApi /*, NodesApi, UploadApi*/ } from '@alfresco/js-api';
import { argv, exit } from 'node:process';
import { parseArgs } from 'node:util';
import { logger } from './logger';

interface CheckCsEnvArgs {
    host?: string;
    username?: string;
    password?: string;
    time?: number;
    retry?: number;
}
const MAX_RETRY = 3;
const TIMEOUT = 20000;

let counter = 0;
let alfrescoJsApi: AlfrescoApi;

/**
 * Check CS environment command
 */
export default async function main() {
    if (argv.includes('-h') || argv.includes('--help')) {
        console.log(`
Usage: check-cs-env [options]

Check Content service is up

Options:
  -v, --version         Output the version number
  --host <host>         Remote environment host adf.lab.com
  -p, --password <pass> Password
  -u, --username <user> Username
  -t, --time <ms>       Time in milliseconds
  -r, --retry <num>     Retry count
  -h, --help            Display help for command
`);
        exit(0);
    }

    if (argv.includes('-v') || argv.includes('--version')) {
        console.log('0.1.0');
        exit(0);
    }

    const { values } = parseArgs({
        args: argv.slice(2),
        options: {
            host: {
                type: 'string'
            },
            password: {
                type: 'string',
                short: 'p'
            },
            username: {
                type: 'string',
                short: 'u'
            },
            time: {
                type: 'string',
                short: 't'
            },
            retry: {
                type: 'string',
                short: 'r'
            }
        },
        allowPositionals: true
    });

    const opts: CheckCsEnvArgs = {
        host: values.host as string | undefined,
        username: values.username as string | undefined,
        password: values.password as string | undefined,
        time: values.time ? parseInt(values.time as string, 10) : undefined,
        retry: values.retry ? parseInt(values.retry as string, 10) : undefined
    };

    await checkEnv(opts);
    // TODO: https://alfresco.atlassian.net/browse/ACS-5873
    // await checkDiskSpaceFullEnv();
}

/**
 * Check environment
 *
 * @param opts command options
 */
async function checkEnv(opts?: CheckCsEnvArgs) {
    try {
        alfrescoJsApi = new AlfrescoApi({
            provider: 'ECM',
            hostEcm: opts.host,
            contextRoot: 'alfresco'
        });

        await alfrescoJsApi.login(opts.username, opts.password);
    } catch (error) {
        if (error?.error?.code === 'ETIMEDOUT') {
            logger.error('The env is not reachable. Terminating');
            exit(1);
        }
        logger.error('Login error environment down or inaccessible');
        counter++;
        const retry = opts.retry || MAX_RETRY;
        const time = opts.time || TIMEOUT;
        if (retry === counter) {
            logger.error('Give up');
            exit(1);
        } else {
            logger.error(`Retry in 1 minute attempt N ${counter}`, error);
            sleep(time);
            await checkEnv();
        }
    }
}

// TODO: https://alfresco.atlassian.net/browse/ACS-5873
/*
async function checkDiskSpaceFullEnv() {
    logger.info(`Start Check disk full space`);

    try {
        const nodesApi = new NodesApi(alfrescoJsApi);
        const uploadApi = new UploadApi(alfrescoJsApi);

        const fileContent = 'x'.repeat(1024 * 1024);
        const file = Buffer.from(fileContent, 'utf8');

        const uploadedFile = await uploadApi.uploadFile(file, '', '-my-', null, {
            name: 'README.md',
            nodeType: 'cm:content',
            autoRename: true
        });

        await nodesApi.deleteNode(uploadedFile.entry.id, { permanent: true });
    } catch (error) {
        counter++;

        const retry = program.retry || MAX_RETRY;
        const time = program.time || TIMEOUT;
        if (retry === counter) {
            logger.info('=============================================================');
            logger.info('================ Not able to upload a file ==================');
            logger.info('================ Possible cause CS is full ==================');
            logger.info('=============================================================');
            exit(1);
        } else {
            logger.error(`Retry N ${counter}`);
            logger.error(JSON.stringify(error));
            sleep(time);
            await checkDiskSpaceFullEnv();
        }
    }
}
*/

/**
 * Perform a delay
 *
 * @param delay timeout in milliseconds
 */
function sleep(delay: number) {
    const start = new Date().getTime();
    while (new Date().getTime() < start + delay) {}
}