nx
Version:
271 lines (270 loc) • 12.5 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ProcessTasks = void 0;
exports.createTaskGraph = createTaskGraph;
exports.mapTargetDefaultsToDependencies = mapTargetDefaultsToDependencies;
exports.filterDummyTasks = filterDummyTasks;
exports.getNonDummyDeps = getNonDummyDeps;
const utils_1 = require("./utils");
const project_graph_utils_1 = require("../utils/project-graph-utils");
const output_1 = require("../utils/output");
const task_graph_utils_1 = require("./task-graph-utils");
const DUMMY_TASK_TARGET = '__nx_dummy_task__';
class ProcessTasks {
constructor(extraTargetDependencies, projectGraph) {
this.extraTargetDependencies = extraTargetDependencies;
this.projectGraph = projectGraph;
this.seen = new Set();
this.tasks = {};
this.dependencies = {};
const allTargetNames = new Set();
for (const projectName in projectGraph.nodes) {
const project = projectGraph.nodes[projectName];
for (const targetName in project.data.targets ?? {}) {
allTargetNames.add(targetName);
}
}
this.allTargetNames = Array.from(allTargetNames);
}
processTasks(projectNames, targets, configuration, overrides, excludeTaskDependencies) {
for (const projectName of projectNames) {
for (const target of targets) {
const project = this.projectGraph.nodes[projectName];
if (targets.length === 1 || project.data.targets[target]) {
const resolvedConfiguration = this.resolveConfiguration(project, target, configuration);
const id = this.getId(projectName, target, resolvedConfiguration);
const task = this.createTask(id, project, target, resolvedConfiguration, overrides);
this.tasks[task.id] = task;
this.dependencies[task.id] = [];
}
}
}
// used when excluding tasks
const initialTasks = { ...this.tasks };
for (const taskId of Object.keys(this.tasks)) {
const task = this.tasks[taskId];
this.processTask(task, task.target.project, configuration, overrides);
}
if (excludeTaskDependencies) {
for (let t of Object.keys(this.tasks)) {
if (!initialTasks[t]) {
delete this.tasks[t];
delete this.dependencies[t];
}
}
for (let d of Object.keys(this.dependencies)) {
this.dependencies[d] = this.dependencies[d].filter((dd) => !!initialTasks[dd]);
}
}
filterDummyTasks(this.dependencies);
for (const taskId of Object.keys(this.dependencies)) {
if (this.dependencies[taskId].length > 0) {
this.dependencies[taskId] = [
...new Set(this.dependencies[taskId].filter((d) => d !== taskId)).values(),
];
}
}
return Object.keys(this.dependencies).filter((d) => this.dependencies[d].length === 0);
}
processTask(task, projectUsedToDeriveDependencies, configuration, overrides) {
const seenKey = `${task.id}-${projectUsedToDeriveDependencies}`;
if (this.seen.has(seenKey)) {
return;
}
this.seen.add(seenKey);
const dependencyConfigs = (0, utils_1.getDependencyConfigs)({ project: task.target.project, target: task.target.target }, this.extraTargetDependencies, this.projectGraph, this.allTargetNames);
for (const dependencyConfig of dependencyConfigs) {
const taskOverrides = dependencyConfig.params === 'forward'
? overrides
: { __overrides_unparsed__: [] };
if (dependencyConfig.projects) {
this.processTasksForMultipleProjects(dependencyConfig, configuration, task, taskOverrides, overrides);
}
else if (dependencyConfig.dependencies) {
this.processTasksForDependencies(projectUsedToDeriveDependencies, dependencyConfig, configuration, task, taskOverrides, overrides);
}
else {
this.processTasksForSingleProject(task, task.target.project, dependencyConfig, configuration, taskOverrides, overrides);
}
}
}
processTasksForMultipleProjects(dependencyConfig, configuration, task, taskOverrides, overrides) {
if (dependencyConfig.projects.length === 0) {
output_1.output.warn({
title: `\`dependsOn\` is misconfigured for ${task.target.project}:${task.target.target}`,
bodyLines: [
`Project patterns "${dependencyConfig.projects}" does not match any projects.`,
],
});
}
for (const projectName of dependencyConfig.projects) {
this.processTasksForSingleProject(task, projectName, dependencyConfig, configuration, taskOverrides, overrides);
}
}
processTasksForSingleProject(task, projectName, dependencyConfig, configuration, taskOverrides, overrides) {
const selfProject = this.projectGraph.nodes[projectName];
if ((0, project_graph_utils_1.projectHasTarget)(selfProject, dependencyConfig.target)) {
const resolvedConfiguration = this.resolveConfiguration(selfProject, dependencyConfig.target, configuration);
const selfTaskId = this.getId(selfProject.name, dependencyConfig.target, resolvedConfiguration);
if (task.id !== selfTaskId) {
this.dependencies[task.id].push(selfTaskId);
}
if (!this.tasks[selfTaskId]) {
const newTask = this.createTask(selfTaskId, selfProject, dependencyConfig.target, resolvedConfiguration, taskOverrides);
this.tasks[selfTaskId] = newTask;
this.dependencies[selfTaskId] = [];
this.processTask(newTask, newTask.target.project, configuration, overrides);
}
}
}
processTasksForDependencies(projectUsedToDeriveDependencies, dependencyConfig, configuration, task, taskOverrides, overrides) {
if (!this.projectGraph.dependencies.hasOwnProperty(projectUsedToDeriveDependencies)) {
return;
}
for (const dep of this.projectGraph.dependencies[projectUsedToDeriveDependencies]) {
const depProject = this.projectGraph.nodes[dep.target];
// this is to handle external dependencies
if (!depProject)
continue;
if ((0, project_graph_utils_1.projectHasTarget)(depProject, dependencyConfig.target)) {
const resolvedConfiguration = this.resolveConfiguration(depProject, dependencyConfig.target, configuration);
const depTargetId = this.getId(depProject.name, dependencyConfig.target, resolvedConfiguration);
if (task.id !== depTargetId) {
this.dependencies[task.id].push(depTargetId);
}
if (!this.tasks[depTargetId]) {
const newTask = this.createTask(depTargetId, depProject, dependencyConfig.target, resolvedConfiguration, taskOverrides);
this.tasks[depTargetId] = newTask;
this.dependencies[depTargetId] = [];
this.processTask(newTask, newTask.target.project, configuration, overrides);
}
}
else {
// Create a dummy task for task.target.project... which simulates if depProject had dependencyConfig.target
const dummyId = this.getId(depProject.name, task.target.project +
'__' +
dependencyConfig.target +
DUMMY_TASK_TARGET, undefined);
this.dependencies[task.id].push(dummyId);
this.dependencies[dummyId] ??= [];
const noopTask = this.createDummyTask(dummyId, task);
this.processTask(noopTask, depProject.name, configuration, overrides);
}
}
}
createDummyTask(id, task) {
return {
...task,
id,
};
}
createTask(id, project, target, resolvedConfiguration, overrides) {
if (!project.data.targets[target]) {
throw new Error(`Cannot find configuration for task ${project.name}:${target}`);
}
if (!project.data.targets[target].executor) {
throw new Error(`Target "${project.name}:${target}" does not have an executor configured`);
}
const qualifiedTarget = {
project: project.name,
target,
configuration: resolvedConfiguration,
};
const interpolatedOverrides = interpolateOverrides(overrides, project.name, project.data);
return {
id,
target: qualifiedTarget,
projectRoot: project.data.root,
overrides: interpolatedOverrides,
outputs: (0, utils_1.getOutputs)(this.projectGraph.nodes, qualifiedTarget, interpolatedOverrides),
cache: project.data.targets[target].cache,
parallelism: project.data.targets[target].parallelism ?? true,
};
}
resolveConfiguration(project, target, configuration) {
const defaultConfiguration = project.data.targets?.[target]?.defaultConfiguration;
configuration ??= defaultConfiguration;
return (0, project_graph_utils_1.projectHasTargetAndConfiguration)(project, target, configuration)
? configuration
: defaultConfiguration;
}
getId(project, target, configuration) {
let id = `${project}:${target}`;
if (configuration) {
id += `:${configuration}`;
}
return id;
}
}
exports.ProcessTasks = ProcessTasks;
function createTaskGraph(projectGraph, extraTargetDependencies, projectNames, targets, configuration, overrides, excludeTaskDependencies = false) {
const p = new ProcessTasks(extraTargetDependencies, projectGraph);
const roots = p.processTasks(projectNames, targets, configuration, overrides, excludeTaskDependencies);
return {
roots,
tasks: p.tasks,
dependencies: p.dependencies,
};
}
function mapTargetDefaultsToDependencies(defaults) {
const res = {};
Object.keys(defaults ?? {}).forEach((k) => {
res[k] = defaults[k].dependsOn;
});
return res;
}
function interpolateOverrides(args, projectName, project) {
const interpolatedArgs = { ...args };
Object.entries(interpolatedArgs).forEach(([name, value]) => {
interpolatedArgs[name] =
typeof value === 'string'
? (0, utils_1.interpolate)(value, {
workspaceRoot: '',
projectRoot: project.root,
projectName: project.name,
project: { ...project, name: projectName }, // this is legacy
})
: value;
});
return interpolatedArgs;
}
/**
* This function is used to filter out the dummy tasks from the dependencies
* It will manipulate the dependencies object in place
*/
function filterDummyTasks(dependencies) {
const cycles = (0, task_graph_utils_1.findCycles)({ dependencies });
for (const [key, deps] of Object.entries(dependencies)) {
if (!key.endsWith(DUMMY_TASK_TARGET)) {
const normalizedDeps = [];
for (const dep of deps) {
normalizedDeps.push(...getNonDummyDeps(dep, dependencies, cycles, new Set([key])));
}
dependencies[key] = normalizedDeps;
}
}
for (const key of Object.keys(dependencies)) {
if (key.endsWith(DUMMY_TASK_TARGET)) {
delete dependencies[key];
}
}
}
/**
* this function is used to get the non dummy dependencies of a task recursively
*/
function getNonDummyDeps(currentTask, dependencies, cycles, seen = new Set()) {
if (seen.has(currentTask)) {
return [];
}
seen.add(currentTask);
if (currentTask.endsWith(DUMMY_TASK_TARGET)) {
if (cycles?.has(currentTask)) {
return [];
}
// if not a cycle, recursively get the non dummy dependencies
return (dependencies[currentTask]?.flatMap((dep) => getNonDummyDeps(dep, dependencies, cycles, seen)) ?? []);
}
else {
return [currentTask];
}
}