@alwaysmeticulous/downloading-helpers 2.42.0 → 2.43.0

package/dist/file-downloads/local-data.utils.d.ts

@@ -15,6 +15,7 @@ export interface LoadOrDownloadJsonFileOptions<T> {
  * Handles concurrent processes trying to download to the same file at the same time.
  */
 export declare const getOrDownloadJsonFile: <T>({ filePath, downloadJson, dataDescription, }: LoadOrDownloadJsonFileOptions<T>) => Promise<T | null>;
+export declare const waitToAcquireLockOnFile: (filePath: string) => Promise<ReleaseLock>;
 export declare const fileExists: (filePath: string) => Promise<boolean>;
 export declare const waitToAcquireLockOnDirectory: (directoryPath: string) => Promise<ReleaseLock>;
 export {};

package/dist/file-downloads/local-data.utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.waitToAcquireLockOnDirectory = exports.fileExists = exports.getOrDownloadJsonFile = exports.sanitizeFilename = void 0;
+exports.waitToAcquireLockOnDirectory = exports.fileExists = exports.waitToAcquireLockOnFile = exports.getOrDownloadJsonFile = exports.sanitizeFilename = void 0;
 const promises_1 = require("fs/promises");
 const path_1 = require("path");
 const common_1 = require("@alwaysmeticulous/common");
@@ -27,7 +27,7 @@ const getOrDownloadJsonFile = async ({ filePath, downloadJson, dataDescription,
     // time they don't interfere with each other. The second process to run will
     // wait for the first process to complete, and then return straight away because
     // it'll notice the file already exists.
-    const releaseLock = await waitToAcquireLockOnFile(filePath);
+    const releaseLock = await (0, exports.waitToAcquireLockOnFile)(filePath);
     try {
         const existingData = await (0, promises_1.readFile)(filePath)
             .then((data) => JSON.parse(data.toString("utf-8")))
@@ -68,6 +68,7 @@ const waitToAcquireLockOnFile = async (filePath) => {
         await releaseLock();
     };
 };
+exports.waitToAcquireLockOnFile = waitToAcquireLockOnFile;
 const fileExists = (filePath) => (0, promises_1.access)(filePath)
     .then(() => true)
     .catch(() => false);

package/dist/scripts/replay-assets.js

@@ -10,32 +10,43 @@ const common_1 = require("@alwaysmeticulous/common");
 const axios_1 = __importDefault(require("axios"));
 const loglevel_1 = __importDefault(require("loglevel"));
 const snippets_1 = require("../config/snippets");
+const local_data_utils_1 = require("../file-downloads/local-data.utils");
 const ASSETS_FOLDER_NAME = "assets";
 const ASSET_METADATA_FILE_NAME = "assets.json";
 const fetchAsset = async (path) => {
     const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
     const fetchUrl = new URL(path, (0, snippets_1.getSnippetsBaseUrl)()).href;
     const assetFileName = `${(0, path_1.basename)(new URL(fetchUrl).pathname, ".js")}.cjs`;
-    const assetMetadata = await loadAssetMetadata();
-    const etag = (await axios_1.default.head(fetchUrl)).headers["etag"] || "";
-    const entry = assetMetadata.assets.find((item) => item.fileName === assetFileName);
-    const filePath = (0, path_1.join)(await getOrCreateAssetsDir(), assetFileName);
-    if (entry && etag !== "" && etag === entry.etag) {
-        logger.debug(`${fetchUrl} already present`);
+    const releaseLock = await (0, local_data_utils_1.waitToAcquireLockOnFile)(await getAssetsFilePath());
+    try {
+        const assetMetadata = await loadAssetMetadata();
+        const etag = (await axios_1.default.head(fetchUrl)).headers["etag"] || "";
+        const entry = assetMetadata.assets.find((item) => item.fileName === assetFileName);
+        const filePath = (0, path_1.join)(await getOrCreateAssetsDir(), assetFileName);
+        if (entry && etag !== "" && etag === entry.etag) {
+            logger.debug(`${fetchUrl} already present`);
+            releaseLock();
+            return filePath;
+        }
+        const contents = (await axios_1.default.get(fetchUrl)).data;
+        await (0, promises_1.writeFile)(filePath, contents);
+        if (entry) {
+            logger.debug(`${fetchUrl} updated`);
+            entry.etag = etag;
+        }
+        else {
+            logger.debug(`${fetchUrl} downloaded`);
+            assetMetadata.assets.push({ fileName: assetFileName, etag, fetchUrl });
+        }
+        await saveAssetMetadata(assetMetadata);
+        releaseLock();
         return filePath;
     }
-    const contents = (await axios_1.default.get(fetchUrl)).data;
-    await (0, promises_1.writeFile)(filePath, contents);
-    if (entry) {
-        logger.debug(`${fetchUrl} updated`);
-        entry.etag = etag;
+    catch (err) {
+        releaseLock();
+        logger.error(`Error fetching asset from ${fetchUrl}`);
+        throw err;
     }
-    else {
-        logger.debug(`${fetchUrl} downloaded`);
-        assetMetadata.assets.push({ fileName: assetFileName, etag, fetchUrl });
-    }
-    await saveAssetMetadata(assetMetadata);
-    return filePath;
 };
 exports.fetchAsset = fetchAsset;
 const getOrCreateAssetsDir = async () => {
@@ -44,7 +55,7 @@ const getOrCreateAssetsDir = async () => {
     return assetsDir;
 };
 const loadAssetMetadata = async () => {
-    const assetsFile = (0, path_1.join)(await getOrCreateAssetsDir(), ASSET_METADATA_FILE_NAME);
+    const assetsFile = await getAssetsFilePath();
     const existingMetadata = await (0, promises_1.readFile)(assetsFile)
         .then((data) => JSON.parse(data.toString("utf-8")))
         .catch(() => null);
@@ -57,3 +68,7 @@ const saveAssetMetadata = async (assetMetadata) => {
     const assetsFile = (0, path_1.join)(await getOrCreateAssetsDir(), ASSET_METADATA_FILE_NAME);
     await (0, promises_1.writeFile)(assetsFile, JSON.stringify(assetMetadata, null, 2));
 };
+const getAssetsFilePath = async () => {
+    const assetsDir = await getOrCreateAssetsDir();
+    return (0, path_1.join)(assetsDir, ASSET_METADATA_FILE_NAME);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/downloading-helpers",
-  "version": "2.42.0",
+  "version": "2.43.0",
   "description": "Helper utilities for downloading files & scripts required to execute replays",
   "license": "ISC",
   "main": "dist/index.js",
@@ -50,5 +50,5 @@
   "bugs": {
     "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
   },
-  "gitHead": "65e2410a784642674ea6c8203d5b9f8a303c33ea"
+  "gitHead": "7664f4dfeed3b08e5523c0acb4d98d11eee4c9ff"
 }