@nu-art/commando/core/CommandoPool.js

Shell command execution framework with interactive sessions, CLI parameter resolution, and plugin system for building and executing shell scripts programmatically

/*
 * commando provides shell command execution framework with interactive sessions and plugin system
 *
 * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
 *
 * 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 { CommandoInteractive } from '../interactive/CommandoInteractive.js';
import { Commando_Basic } from '../plugins/basic.js';
/** Internal pool of allocated commando instances */
const commandoPool = [];
/**
 * Pool manager for Commando instances with lifecycle management.
 *
 * Tracks all allocated Commando instances and provides a way to kill
 * all of them at once. Useful for cleanup in long-running processes
 * or test teardown.
 *
 * **Behavior**:
 * - All allocated commandos are stored in an internal pool
 * - `allocateCommando()` always includes Commando_Basic plugin
 * - `killAll()` terminates all tracked commandos asynchronously
 *
 * **Use Case**: Managing multiple interactive commandos that need
 * to be cleaned up together (e.g., test suites, long-running scripts).
 */
export const CommandoPool = {
    /**
     * Allocates a new Commando instance and adds it to the pool.
     *
     * Creates a CommandoInteractive instance with the provided plugins
     * plus Commando_Basic (always included). The instance is tracked
     * in the pool for later cleanup.
     *
     * @template T - Array of plugin constructor types
     * @param uid - Unique identifier for this commando instance
     * @param plugins - Plugin classes to merge with the commando
     * @returns Merged commando instance with all plugins
     */
    allocateCommando: (uid, ...plugins) => {
        const commando = CommandoInteractive.create(...plugins, Commando_Basic);
        commando.setUID(uid);
        commandoPool.push(commando);
        return commando;
    },
    /**
     * Kills all allocated commando instances.
     *
     * Calls `kill()` on all commandos in the pool asynchronously.
     * Useful for cleanup in test teardown or application shutdown.
     */
    killAll: async () => {
        await Promise.all(commandoPool.map(c => c.kill()));
    }
};