@teambit/builder 1.0.108 → 1.0.109

package/pipeline.ts

@@ -1,104 +0,0 @@
-import { BuildTask } from '@teambit/builder';
-import { EnvContext, EnvHandler } from '@teambit/envs';
-import { clone, findIndex } from 'lodash';
-import { Task } from './task';
-
-export type TaskHandler = {
-  handler: EnvHandler<Task>;
-  name: string;
-};
-
-/**
- * create and maintain build pipelines for component
- * dev environments.
- */
-export class Pipeline {
-  constructor(private _tasks: TaskHandler[]) {}
-
-  /**
-   * list all tasks in the build pipeline.
-   */
-  get tasks() {
-    return this._tasks;
-  }
-
-  private initiateTasks(tasks: TaskHandler[], context: EnvContext, envId: string) {
-    const _tasks = tasks.map((task) => {
-      return task.handler(context);
-    });
-
-    const buildTasks: BuildTask[] = _tasks.map((task) => {
-      // @ts-ignore
-      const aspectId = task.aspectId || envId;
-      const buildTask: BuildTask = Object.assign(clone(task), { aspectId });
-      return buildTask;
-    });
-
-    return buildTasks;
-  }
-
-  /**
-   * add a build task to the pipeline.
-   */
-  add(tasks: TaskHandler[]) {
-    this._tasks = this._tasks.concat(tasks);
-    return this;
-  }
-
-  /**
-   * remove a build task from the pipeline.
-   */
-  remove(taskNames: string[]) {
-    this._tasks = this._tasks.filter((task) => {
-      return !taskNames.includes(task.name);
-    });
-    return this;
-  }
-
-  /**
-   * replace a build task in the pipeline.
-   */
-  replace(tasks: TaskHandler[]) {
-    tasks.forEach((task) => {
-      // Find task index using _.findIndex
-      const matchIndex = findIndex(this._tasks, (origTask) => {
-        return origTask.name === task.name;
-      });
-      if (matchIndex !== -1) {
-        // Replace task at index using native splice
-        this._tasks.splice(matchIndex, 1, task);
-      } else {
-        // Add task if there's no existing task to replace
-        this._tasks.push(task);
-      }
-    });
-    return this;
-  }
-
-  /**
-   * return a new pipeline with the tasks from the pipeline args added.
-   * @param pipeline
-   * @returns
-   */
-  concat(pipeline: Pipeline) {
-    return new Pipeline(this._tasks.concat(pipeline.tasks));
-  }
-
-  /**
-   * compute the pipeline.
-   */
-  compute(context: EnvContext): BuildTask[] {
-    const buildTasks = this.initiateTasks(this._tasks, context, context.envId.toString());
-    return buildTasks;
-  }
-
-  static from(tasks: TaskHandler[]) {
-    return new Pipeline(tasks);
-  }
-
-  // static concat(...pipelines: EnvHandler<Pipeline>[]) {
-  //   return reduceServiceHandlersFactories(pipelines, (acc, pipeline) => {
-  //     return acc.concat(pipeline);
-  //   });
-  // }
-}

package/task-results-list.ts

@@ -1,68 +0,0 @@
-import chalk from 'chalk';
-import { BitError } from '@teambit/bit-error';
-import { BuildTaskHelper } from './build-task';
-import { TasksQueue } from './tasks-queue';
-import { TaskResults } from './build-pipe';
-import { ComponentResult } from './types';
-
-export class TaskResultsList {
-  constructor(
-    public tasksQueue: TasksQueue,
-    /**
-     * results of all tasks executed in the build pipeline.
-     */
-    public tasksResults: TaskResults[],
-
-    public capsuleRootDir: string
-  ) {}
-
-  hasErrors(): boolean {
-    return this.tasksResults.some((taskResult) => taskResult.componentsResults.find((c) => c.errors?.length));
-  }
-
-  throwErrorsIfExist() {
-    const errorMessage = this.getErrorMessageFormatted();
-    if (errorMessage) {
-      throw new BitError(errorMessage);
-    }
-  }
-
-  /**
-   * group errors from all tasks and show them nicely to the user
-   */
-  public getErrorMessageFormatted(): string | null {
-    const tasksErrors: string[] = [];
-    let totalErrors = 0;
-    this.tasksResults.forEach((taskResult) => {
-      const compsWithErrors = taskResult.componentsResults.filter((c) => c.errors?.length);
-      if (!compsWithErrors.length) return;
-      const title = chalk.bold(
-        `Failed task ${tasksErrors.length + 1}: "${BuildTaskHelper.serializeId(taskResult.task)}" of env "${
-          taskResult.env.id
-        }"\n`
-      );
-      const errorsStr = compsWithErrors
-        .map((compWithErrors) => this.aggregateTaskErrorsToOneString(compWithErrors))
-        .join('\n\n');
-      const taskErrors = compsWithErrors.reduce((acc, current) => acc + (current.errors || []).length, 0);
-      const summery = `\n\nFound ${taskErrors} errors in ${compsWithErrors.length} components`;
-      totalErrors += taskErrors;
-      tasksErrors.push(title + errorsStr + summery);
-    });
-    if (!tasksErrors.length) return null;
-    const title = `\nThe following errors were found while running the build pipeline\n`;
-    const errorsStr = tasksErrors.join('\n\n');
-    const totalTasks = this.tasksQueue.length;
-    const totalFailed = tasksErrors.length;
-    const totalSucceed = this.tasksResults.length - totalFailed;
-    const totalSkipped = totalTasks - this.tasksResults.length;
-    const summery = `\n\n\n✖ Total ${totalTasks} tasks. ${totalSucceed} succeeded. ${totalFailed} failed. ${totalSkipped} skipped. Total errors: ${totalErrors}.`;
-    return title + errorsStr + summery;
-  }
-
-  private aggregateTaskErrorsToOneString(componentResult: ComponentResult) {
-    const rawErrors = componentResult.errors || [];
-    const errors = rawErrors.map((e) => (typeof e === 'string' ? e : e.toString()));
-    return `component: ${componentResult.component.id.toString()}\n${errors.join('\n')}`;
-  }
-}

package/task.ts

@@ -1,50 +0,0 @@
-import { BuildContext, BuiltTaskResult } from './build-task';
-import { TaskResultsList } from './task-results-list';
-
-/**
- * this is the external interface for task. please make
- * sure to use only this interface outside of this builder
- * aspect.
- */
-export interface Task {
-  /**
-   * names ideally with dashes 'typescript'
-   */
-  name: string;
-
-  /**
-   * description of what the task does.
-   */
-  description?: string;
-
-  /**
-   * execute a task in a build context
-   */
-  execute(context: BuildContext): Promise<BuiltTaskResult>;
-
-  /**
-   * run before the build pipeline has started. this is useful when some preparation are needed to
-   * be done on all envs before the build starts.
-   * e.g. typescript compiler needs to write the tsconfig file. doing it during the task, will
-   * cause dependencies from other envs to get this tsconfig written.
-   */
-  preBuild?(context: BuildContext): Promise<void>;
-
-  /**
-   * run after the build pipeline completed for all envs. useful for doing some cleanup on the
-   * capsules before the deployment starts.
-   */
-  postBuild?(context: BuildContext, tasksResults: TaskResultsList): Promise<void>;
-
-  /**
-   * needed if you want the task to be running only after the dependencies were completed
-   * for *all* envs.
-   * normally this is not needed because the build-pipeline runs the tasks in the same order
-   * they're located in the `getBuildPipe()` array and according to the task.location.
-   * the case where this is useful is when a task not only needs to be after another task, but also
-   * after all environments were running that task.
-   * a dependency is task.aspectId. if an aspect has multiple tasks, to be more specific, use
-   * "aspectId:name", e.g. "teambit.compilation/compiler:TypescriptCompiler".
-   */
-  dependencies?: string[];
-}

package/tasks-queue.ts

@@ -1,40 +0,0 @@
-import { EnvDefinition } from '@teambit/envs';
-import { BuildTask, BuildTaskHelper } from './build-task';
-import { InvalidTask } from './exceptions';
-
-type EnvTask = { env: EnvDefinition; task: BuildTask };
-
-export class TasksQueue extends Array<EnvTask> {
-  toString() {
-    return this.map(({ env, task }) => `env ${env.id}, task ${BuildTaskHelper.serializeId(task)}`).join('\n');
-  }
-  /**
-   * make sure tasks names are valid and there are no duplications
-   */
-  validate() {
-    this.forEach(({ task }) => {
-      this.validateTaskName(task);
-    });
-    this.validateDuplications();
-  }
-
-  private validateTaskName(task: BuildTask) {
-    if (!task.name) throw new InvalidTask(task.aspectId, 'name is missing');
-    const regexWord = /^\w+$/; // match any word: a-zA-Z0-9 and underscore.
-    const isValid = regexWord.test(task.name);
-    if (!isValid)
-      throw new InvalidTask(task.aspectId, `name "${task.name}" is invalid, only alphanumeric characters are allowed`);
-  }
-
-  private validateDuplications() {
-    const uniqueTasks = this.map(({ env, task }) => `${env.id} ${task.aspectId}:${task.name}`);
-    uniqueTasks.forEach((uniqTask) => {
-      if (uniqueTasks.filter((u) => u === uniqTask).length > 1) {
-        throw new InvalidTask(
-          uniqTask,
-          'there are two or more tasks with the same name and aspectId in the same environment'
-        );
-      }
-    });
-  }
-}

package/types.ts

@@ -1,37 +0,0 @@
-import { Component } from '@teambit/component';
-
-export type TaskMetadata = { [key: string]: any };
-
-export type ComponentResult = {
-  /**
-   * instance of the component
-   */
-  component: Component;
-
-  /**
-   * metadata generated during component build.
-   * this eventually gets saved into `aspectsData` prop of the builder aspect data.
-   * it can be retrieved later on by `builder.getDataByAspect()` method.
-   */
-  metadata?: TaskMetadata;
-
-  /**
-   * returning errors from build tasks will cause a pipeline failure and logs all returned errors.
-   */
-  errors?: Array<Error | string>;
-
-  /**
-   * warnings generated throughout the build task.
-   */
-  warnings?: string[];
-
-  /**
-   * timestamp in milliseconds when the task started
-   */
-  startTime?: number;
-
-  /**
-   * timestamp in milliseconds when the task ended
-   */
-  endTime?: number;
-};