@atomist/sdm/src/lib/core/log/rolarAndDashboardLogFactory.ts

Atomist Software Delivery Machine SDK

/*
 * Copyright © 2020 Atomist, Inc.
 *
 * 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 { Configuration } from "@atomist/automation-client/lib/configuration";
import { createEphemeralProgressLog } from "../../api-helper/log/EphemeralProgressLog";
import { firstAvailableProgressLog } from "../../api-helper/log/firstAvailableProgressLog";
import { LoggingProgressLog } from "../../api-helper/log/LoggingProgressLog";
import { WriteToAllProgressLog } from "../../api-helper/log/WriteToAllProgressLog";
import { ProgressLogFactory } from "../../spi/log/ProgressLog";
import { DashboardDisplayProgressLog } from "./DashboardDisplayProgressLog";

/**
 * Create a progress log that will use Rolar logging service if available,
 * otherwise falling back to logging.
 */
export function rolarAndDashboardLogFactory(configuration: Configuration): ProgressLogFactory {
    const persistentLogFactory = (context, sdmGoal, fallback) => {
        return firstAvailableProgressLog(
            new DashboardDisplayProgressLog(
                configuration,
                context,
                sdmGoal),
            fallback,
        );
    };
    return async (context, sdmGoal) => {
        const name = sdmGoal.name;
        const persistentLog = await persistentLogFactory(context, sdmGoal, new LoggingProgressLog(name, "info"));
        return new WriteToAllProgressLog(name, await createEphemeralProgressLog(context, sdmGoal), persistentLog);
    };
}