builder/lib/tasks/generateCachebusterInfo.js

  1. const crypto = require("crypto");
  2. const resourceFactory = require("@ui5/fs").resourceFactory;
  3. const log = require("@ui5/logger").getLogger("builder:tasks:generateCachebusterInfo");
  5. async function signByTime(resource) {
  6. 	return resource.getStatInfo().mtime.getTime();
  7. }
  9. async function signByHash(resource) {
  10. 	const hasher = crypto.createHash("sha1");
  11. 	const buffer = await resource.getBuffer();
  13. 	hasher.update(buffer.toString("binary"));
  14. 	return hasher.digest("hex");
  15. }
  17. function getSigner(type) {
  18. 	type = type || "time";
  20. 	switch (type) {
  21. 	case "time":
  22. 		return signByTime;
  23. 	case "hash":
  24. 		return signByHash;
  26. 	default:
  27. 		throw new Error(`Invalid signature type: '${type}'. Valid ones are: 'time' or 'hash'`);
  28. 	}
  29. }
  31. /**
  32.  * Task to generate the application cachebuster info file.
  33.  *
  34.  * @public
  35.  * @alias module:@ui5/builder.tasks.generateCachebusterInfo
  36.  * @param {object} parameters Parameters
  37.  * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
  38.  * @param {module:@ui5/fs.AbstractReader} parameters.dependencies Reader or Collection to read dependency files
  39.  * @param {object} parameters.options Options
  40.  * @param {string} parameters.options.namespace Namespace of the application
  41.  * @param {string} [parameters.options.signatureType='time'] Type of signature to be used ('time' or 'hash')
  42.  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  43.  */
  44. module.exports = function({workspace, dependencies, options: {namespace, signatureType}}) {
  45. 	const basePath = `/resources/${namespace}/`;
  46. 	return workspace.byGlob(`/resources/${namespace}/**/*`)
  47. 		.then(async (resources) => {
  48. 			const cachebusterInfo = {};
  49. 			const signer = getSigner(signatureType);
  51. 			await Promise.all(resources.map(async (resource) => {
  52. 				let resourcePath = resource.getPath();
  53. 				if (!resourcePath.startsWith(basePath)) {
  54. 					log.verbose(
  55. 						`Ignoring resource with path ${resourcePath} since it is not based on path ${basePath}`);
  56. 					return;
  57. 				}
  58. 				// Remove base path. Absolute paths are not allowed in cachebuster info
  59. 				resourcePath = resourcePath.replace(basePath, "");
  60. 				cachebusterInfo[resourcePath] = await signer(resource);
  61. 			}));
  62. 			const cachebusterInfoResource = resourceFactory.createResource({
  63. 				path: `/resources/${namespace}/sap-ui-cachebuster-info.json`,
  64. 				string: JSON.stringify(cachebusterInfo, null, 2)
  65. 			});
  66. 			return workspace.write(cachebusterInfoResource);
  67. 		});
  68. };