project/lib/graph/graph.js

  1. import path from "node:path";
  2. import projectGraphBuilder from "./projectGraphBuilder.js";
  3. import ui5Framework from "./helpers/ui5Framework.js";
  4. import createWorkspace from "./helpers/createWorkspace.js";
  5. import {getLogger} from "@ui5/logger";
  6. const log = getLogger("generateProjectGraph");
  8. /**
  9.  * Helper module to create a [@ui5/project/graph/ProjectGraph]{@link @ui5/project/graph/ProjectGraph}
  10.  * from a directory
  11.  *
  12.  * @public
  13.  * @module @ui5/project/graph
  14.  */
  16. /**
  17.  * Generates a [@ui5/project/graph/ProjectGraph]{@link @ui5/project/graph/ProjectGraph} by resolving
  18.  * dependencies from package.json files and configuring projects from ui5.yaml files
  19.  *
  20.  * @public
  21.  * @static
  22.  * @param {object} [options]
  23.  * @param {string} [options.cwd=process.cwd()] Directory to start searching for the root module
  24.  * @param {object} [options.rootConfiguration]
  25.  *		Configuration object to use for the root module instead of reading from a configuration file
  26.  * @param {string} [options.rootConfigPath]
  27.  *		Configuration file to use for the root module instead the default ui5.yaml. Either a path relative to
  28.  *		<code>cwd</code> or an absolute path. In both case, platform-specific path segment separators must be used.
  29.  * @param {string} [options.versionOverride] Framework version to use instead of the one defined in the root project
  30.  * @param {string} [options.resolveFrameworkDependencies=true]
  31.  * 		Whether framework dependencies should be added to the graph
  32.  * @param {string} [options.workspaceName]
  33.  * 		Name of the workspace configuration that should be used if any is provided
  34.  * @param {module:@ui5/project/ui5Framework/maven/CacheMode} [options.cacheMode]
  35.  *      Cache mode to use when consuming SNAPSHOT versions of a framework
  36.  * @param {string} [options.workspaceConfigPath=ui5-workspace.yaml]
  37.  * 		Workspace configuration file to use if no object has been provided
  38.  * @param {@ui5/project/graph/Workspace~Configuration} [options.workspaceConfiguration]
  39.  * 		Workspace configuration object to use instead of reading from a configuration file.
  40.  * 		Parameter <code>workspaceName</code> can either be omitted or has to match with the given configuration name
  41.  * @returns {Promise<@ui5/project/graph/ProjectGraph>} Promise resolving to a Project Graph instance
  42.  */
  43. export async function graphFromPackageDependencies({
  44. 	cwd, rootConfiguration, rootConfigPath,
  45. 	versionOverride, cacheMode, resolveFrameworkDependencies = true,
  46. 	workspaceName /* TODO 4.0: default workspaceName to "default" ? */,
  47. 	workspaceConfiguration, workspaceConfigPath = "ui5-workspace.yaml"
  48. }) {
  49. 	log.verbose(`Creating project graph using npm provider...`);
  50. 	const {
  51. 		default: NpmProvider
  52. 	} = await import("./providers/NodePackageDependencies.js");
  54. 	cwd = cwd ? path.resolve(cwd) : process.cwd();
  55. 	rootConfigPath = utils.resolveConfigPath(cwd, rootConfigPath);
  57. 	let workspace;
  58. 	if (workspaceName || workspaceConfiguration) {
  59. 		workspace = await createWorkspace({
  60. 			cwd,
  61. 			name: workspaceName,
  62. 			configObject: workspaceConfiguration,
  63. 			configPath: workspaceConfigPath
  64. 		});
  65. 	}
  67. 	const provider = new NpmProvider({
  68. 		cwd,
  69. 		rootConfiguration,
  70. 		rootConfigPath
  71. 	});
  73. 	const projectGraph = await projectGraphBuilder(provider, workspace);
  75. 	if (resolveFrameworkDependencies) {
  76. 		await ui5Framework.enrichProjectGraph(projectGraph, {versionOverride, cacheMode, workspace});
  77. 	}
  79. 	return projectGraph;
  80. }
  82. /**
  83.  * Generates a [@ui5/project/graph/ProjectGraph]{@link @ui5/project/graph/ProjectGraph} from a
  84.  * YAML file following the structure of
  85.  * [@ui5/project/graph/providers/DependencyTree~TreeNode]{@link @ui5/project/graph/providers/DependencyTree~TreeNode}.
  86.  *
  87.  * Documentation:
  88.  * [Static Dependency Definition]{@link https://sap.github.io/ui5-tooling/stable/pages/Overview/#static-dependency-definition}
  89.  *
  90.  * @public
  91.  * @static
  92.  * @param {object} options
  93.  * @param {object} [options.filePath=projectDependencies.yaml] Path to the dependency configuration file
  94.  * @param {string} [options.cwd=process.cwd()] Directory to resolve relative paths to
  95.  * @param {object} [options.rootConfiguration]
  96.  *		Configuration object to use for the root module instead of reading from a configuration file
  97.  * @param {string} [options.rootConfigPath]
  98.  *		Configuration file to use for the root module instead the default ui5.yaml. Either a path relative to
  99.  *		<code>cwd</code> or an absolute path. In both case, platform-specific path segment separators must be used.
  100.  * @param {string} [options.versionOverride] Framework version to use instead of the one defined in the root project
  101.  * @param {module:@ui5/project/ui5Framework/maven/CacheMode} [options.cacheMode]
  102.  *      Cache mode to use when consuming SNAPSHOT versions of a framework
  103.  * @param {string} [options.resolveFrameworkDependencies=true]
  104.  *		Whether framework dependencies should be added to the graph
  105.  * @returns {Promise<@ui5/project/graph/ProjectGraph>} Promise resolving to a Project Graph instance
  106.  */
  107. export async function graphFromStaticFile({
  108. 	filePath = "projectDependencies.yaml", cwd,
  109. 	rootConfiguration, rootConfigPath,
  110. 	versionOverride, cacheMode, resolveFrameworkDependencies = true
  111. }) {
  112. 	log.verbose(`Creating project graph using static file...`);
  113. 	const {
  114. 		default: DependencyTreeProvider
  115. 	} = await import("./providers/DependencyTree.js");
  117. 	cwd = cwd ? path.resolve(cwd) : process.cwd();
  118. 	rootConfigPath = utils.resolveConfigPath(cwd, rootConfigPath);
  120. 	const dependencyTree = await utils.readDependencyConfigFile(cwd, filePath);
  122. 	const provider = new DependencyTreeProvider({
  123. 		dependencyTree,
  124. 		rootConfiguration,
  125. 		rootConfigPath
  126. 	});
  128. 	const projectGraph = await projectGraphBuilder(provider);
  130. 	if (resolveFrameworkDependencies) {
  131. 		await ui5Framework.enrichProjectGraph(projectGraph, {versionOverride, cacheMode});
  132. 	}
  134. 	return projectGraph;
  135. }
  137. /**
  138.  * Generates a [@ui5/project/graph/ProjectGraph]{@link @ui5/project/graph/ProjectGraph} from the
  139.  * given <code>dependencyTree</code> following the structure of
  140.  * [@ui5/project/graph/providers/DependencyTree~TreeNode]{@link @ui5/project/graph/providers/DependencyTree~TreeNode}
  141.  *
  142.  * @public
  143.  * @static
  144.  * @param {object} options
  145.  * @param {@ui5/project/graph/providers/DependencyTree~TreeNode} options.dependencyTree
  146.  * @param {string} [options.cwd=process.cwd()] Directory to resolve relative paths to
  147.  * @param {object} [options.rootConfiguration]
  148.  *		Configuration object to use for the root module instead of reading from a configuration file
  149.  * @param {string} [options.rootConfigPath]
  150.  *		Configuration file to use for the root module instead the default ui5.yaml. Either a path relative to
  151.  *		<code>cwd</code> or an absolute path. In both case, platform-specific path segment separators must be used.
  152.  * @param {string} [options.versionOverride] Framework version to use instead of the one defined in the root project
  153.  * @param {module:@ui5/project/ui5Framework/maven/CacheMode} [options.cacheMode]
  154.  *      Cache mode to use when consuming SNAPSHOT versions of a framework
  155.  * @param {string} [options.resolveFrameworkDependencies=true]
  156.  *		Whether framework dependencies should be added to the graph
  157.  * @returns {Promise<@ui5/project/graph/ProjectGraph>} Promise resolving to a Project Graph instance
  158. */
  159. export async function graphFromObject({
  160. 	dependencyTree, cwd,
  161. 	rootConfiguration, rootConfigPath,
  162. 	versionOverride, cacheMode, resolveFrameworkDependencies = true
  163. }) {
  164. 	log.verbose(`Creating project graph using object...`);
  165. 	const {
  166. 		default: DependencyTreeProvider
  167. 	} = await import("./providers/DependencyTree.js");
  169. 	cwd = cwd ? path.resolve(cwd) : process.cwd();
  170. 	rootConfigPath = utils.resolveConfigPath(cwd, rootConfigPath);
  172. 	const dependencyTreeProvider = new DependencyTreeProvider({
  173. 		dependencyTree,
  174. 		rootConfiguration,
  175. 		rootConfigPath
  176. 	});
  178. 	const projectGraph = await projectGraphBuilder(dependencyTreeProvider);
  180. 	if (resolveFrameworkDependencies) {
  181. 		await ui5Framework.enrichProjectGraph(projectGraph, {versionOverride, cacheMode});
  182. 	}
  184. 	return projectGraph;
  185. }
  187. const utils = {
  188. 	resolveConfigPath: function(cwd, configPath) {
  189. 		if (configPath && !path.isAbsolute(configPath)) {
  190. 			configPath = path.join(cwd, configPath);
  191. 		}
  192. 		return configPath;
  193. 	},
  194. 	readDependencyConfigFile: async function(cwd, filePath) {
  195. 		const {
  196. 			default: fs
  197. 		} = await import("graceful-fs");
  198. 		const {promisify} = await import("util");
  199. 		const readFile = promisify(fs.readFile);
  200. 		const parseYaml =(await import("js-yaml")).load;
  202. 		filePath = utils.resolveConfigPath(cwd, filePath);
  204. 		let dependencyTree;
  205. 		try {
  206. 			const contents = await readFile(filePath, {encoding: "utf-8"});
  207. 			dependencyTree = parseYaml(contents, {
  208. 				filename: filePath
  209. 			});
  210. 			utils.resolveProjectPaths(cwd, dependencyTree);
  211. 		} catch (err) {
  212. 			throw new Error(
  213. 				`Failed to load dependency tree configuration from path ${filePath}: ${err.message}`);
  214. 		}
  215. 		return dependencyTree;
  216. 	},
  218. 	resolveProjectPaths: function(cwd, project) {
  219. 		if (!project.path) {
  220. 			throw new Error(`Missing or empty attribute 'path' for project ${project.id}`);
  221. 		}
  222. 		project.path = path.resolve(cwd, project.path);
  224. 		if (!project.id) {
  225. 			throw new Error(`Missing or empty attribute 'id' for project with path ${project.path}`);
  226. 		}
  227. 		if (!project.version) {
  228. 			throw new Error(`Missing or empty attribute 'version' for project ${project.id}`);
  229. 		}
  231. 		if (project.dependencies) {
  232. 			project.dependencies.forEach((project) => utils.resolveProjectPaths(cwd, project));
  233. 		}
  234. 		return project;
  235. 	}
  236. };
  238. // Export function for testing only
  239. /* istanbul ignore else */
  240. if (process.env.NODE_ENV === "test") {
  241. 	graphFromStaticFile._utils = utils;
  242. }