builder/lib/tasks/generateCachebusterInfo.js

  1. import crypto from "node:crypto";
  2. import {createResource} from "@ui5/fs/resourceFactory";
  3. import {getLogger} from "@ui5/logger";
  4. const log = getLogger("builder:tasks:generateCachebusterInfo");
  6. /**
  7.  * @public
  8.  * @module @ui5/builder/tasks/generateCachebusterInfo
  9.  */
  11. async function signByTime(resource) {
  12. 	return resource.getStatInfo().mtime.getTime();
  13. }
  15. async function signByHash(resource) {
  16. 	const hasher = crypto.createHash("sha1");
  17. 	const buffer = await resource.getBuffer();
  19. 	hasher.update(buffer.toString("binary"));
  20. 	return hasher.digest("hex");
  21. }
  23. function getSigner(type) {
  24. 	type = type || "time";
  26. 	switch (type) {
  27. 	case "time":
  28. 		return signByTime;
  29. 	case "hash":
  30. 		return signByHash;
  32. 	default:
  33. 		throw new Error(`Invalid signature type: '${type}'. Valid ones are: 'time' or 'hash'`);
  34. 	}
  35. }
  37. /* eslint "jsdoc/check-param-names": ["error", {"disableExtraPropertyReporting":true}] */
  38. /**
  39.  * Task to generate the application cachebuster info file.
  40.  *
  41.  * @public
  42.  * @function default
  43.  * @static
  44.  *
  45.  * @param {object} parameters Parameters
  46.  * @param {@ui5/fs/DuplexCollection} parameters.workspace DuplexCollection to read and write files
  47.  * @param {object} parameters.options Options
  48.  * @param {string} parameters.options.projectNamespace Namespace of the application
  49.  * @param {string} [parameters.options.signatureType='time'] Type of signature to be used ('time' or 'hash')
  50.  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  51.  */
  52. export default function({workspace, options}) {
  53. 	const {signatureType} = options;
  54. 	// Backward compatibility: "namespace" option got renamed to "projectNamespace"
  55. 	const namespace = options.projectNamespace || options.namespace;
  57. 	const basePath = `/resources/${namespace}/`;
  58. 	return workspace.byGlob(`/resources/${namespace}/**/*`)
  59. 		.then(async (resources) => {
  60. 			const cachebusterInfo = Object.create(null);
  61. 			const signer = getSigner(signatureType);
  63. 			await Promise.all(resources.map(async (resource) => {
  64. 				let resourcePath = resource.getPath();
  65. 				if (!resourcePath.startsWith(basePath)) {
  66. 					log.verbose(
  67. 						`Ignoring resource with path ${resourcePath} since it is not based on path ${basePath}`);
  68. 					return;
  69. 				}
  70. 				// Remove base path. Absolute paths are not allowed in cachebuster info
  71. 				resourcePath = resourcePath.replace(basePath, "");
  72. 				cachebusterInfo[resourcePath] = await signer(resource);
  73. 			}));
  74. 			const cachebusterInfoResource = createResource({
  75. 				path: `/resources/${namespace}/sap-ui-cachebuster-info.json`,
  76. 				string: JSON.stringify(cachebusterInfo, null, 2)
  77. 			});
  78. 			return workspace.write(cachebusterInfoResource);
  79. 		});
  80. }