@jam-comments/server-utilities 4.3.1 → 4.3.2

package/dist/cjs/markupFetcher.js

@@ -91,7 +91,12 @@ exports.makeMarkupRequest = makeMarkupRequest;
 function markupFetcher(platform, fetchImplementation = fetch) {
     return async ({ tz = undefined, path, domain, apiKey, schema, baseUrl = "https://go.jamcomments.com", environment = (0, utils_1.getEnvironment)(), }) => {
         path = path || "/";
-        const savedFile = (0, utils_1.readFile)(path);
+        const savedFile = (() => {
+            if (!(0, utils_1.tempDirectoryExists)()) {
+                return null;
+            }
+            return (0, utils_1.readFile)(path) || (0, utils_1.getEmptyMarkup)();
+        })();
         const markup = savedFile
             ? savedFile
             : await fetchFreshMarkup({ tz, path, domain, apiKey, baseUrl, environment }, fetchImplementation, platform);

package/dist/cjs/markupFetcher.test.js

@@ -353,6 +353,76 @@ const { markupFetcher, batchMarkupFetcher } = fetcherExports;
             apiKey: "123abc",
         })).rejects.toThrowError(/request failed! Status code: 500/);
     });
+    (0, vitest_1.describe)("using saved markup", () => {
+        (0, vitest_1.it)("makes fresh request when temp directory does not exist", async () => {
+            const tempDirectoryExistsSpy = vitest_1.vi
+                .spyOn(utilsExports, "tempDirectoryExists")
+                .mockReturnValue(false);
+            const readFileSpy = vitest_1.vi.spyOn(utilsExports, "readFile");
+            const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+                return {
+                    status: 200,
+                    ok: true,
+                    text: () => "results!",
+                };
+            });
+            const fetcher = markupFetcher("test", fetchMock);
+            const result = await fetcher({
+                path: "/test",
+                domain: "test.com",
+                apiKey: "123abc",
+                environment: "production",
+            });
+            (0, vitest_1.expect)(tempDirectoryExistsSpy).toHaveBeenCalledOnce();
+            (0, vitest_1.expect)(readFileSpy).not.toHaveBeenCalled();
+            (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Ftest", vitest_1.expect.anything());
+            (0, vitest_1.expect)(result).toEqual("results!");
+        });
+        (0, vitest_1.it)("uses saved markup when it exists", async () => {
+            const tempDirectoryExistsSpy = vitest_1.vi
+                .spyOn(utilsExports, "tempDirectoryExists")
+                .mockReturnValue(true);
+            const readFileSpy = vitest_1.vi
+                .spyOn(utilsExports, "readFile")
+                .mockReturnValue("saved markup");
+            const fetchMock = vitest_1.vi.fn();
+            const fetcher = markupFetcher("test", fetchMock);
+            const result = await fetcher({
+                path: "/test",
+                domain: "test.com",
+                apiKey: "123abc",
+                environment: "production",
+            });
+            (0, vitest_1.expect)(tempDirectoryExistsSpy).toHaveBeenCalledOnce();
+            (0, vitest_1.expect)(readFileSpy).toHaveBeenCalledOnce();
+            (0, vitest_1.expect)(fetchMock).not.toHaveBeenCalled();
+            (0, vitest_1.expect)(result).toEqual("saved markup");
+        });
+        (0, vitest_1.it)("uses the EMPTY template when there's no saved file for a post", async () => {
+            const tempDirectoryExistsSpy = vitest_1.vi
+                .spyOn(utilsExports, "tempDirectoryExists")
+                .mockReturnValue(true);
+            const readFileSpy = vitest_1.vi
+                .spyOn(utilsExports, "readFile")
+                .mockReturnValue(null);
+            const getEmptyMarkupSpy = vitest_1.vi
+                .spyOn(utilsExports, "getEmptyMarkup")
+                .mockReturnValue("<!-- EMPTY -->");
+            const fetchMock = vitest_1.vi.fn();
+            const fetcher = markupFetcher("test", fetchMock);
+            const result = await fetcher({
+                path: "/test",
+                domain: "test.com",
+                apiKey: "123abc",
+                environment: "production",
+            });
+            (0, vitest_1.expect)(tempDirectoryExistsSpy).toHaveBeenCalledOnce();
+            (0, vitest_1.expect)(readFileSpy).toHaveBeenCalledOnce();
+            (0, vitest_1.expect)(getEmptyMarkupSpy).toHaveBeenCalledOnce();
+            (0, vitest_1.expect)(fetchMock).not.toHaveBeenCalled();
+            (0, vitest_1.expect)(result).toEqual("<!-- EMPTY -->");
+        });
+    });
     (0, vitest_1.describe)("timezone validation", () => {
         (0, vitest_1.it)("throws error when invalid timezone is provided", async () => {
             const fetchImplMock = vitest_1.vi.fn();

package/dist/cjs/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.saveFile = exports.readFile = exports.toSavedFileName = exports.createTempDirectory = exports.deleteTempDirectory = exports.unescapeHTML = exports.parseJson = exports.reAppendMarkup = exports.getEnvironment = exports.isValidTimezone = void 0;
+exports.saveFile = exports.tempDirectoryExists = exports.getEmptyMarkup = exports.readFile = exports.toSavedFileName = exports.createTempDirectory = exports.deleteTempDirectory = exports.unescapeHTML = exports.parseJson = exports.reAppendMarkup = exports.getEnvironment = exports.isValidTimezone = void 0;
 const fs_1 = require("fs");
 const _1 = require(".");
 function isValidTimezone(tz) {
@@ -78,7 +78,7 @@ function deleteTempDirectory() {
 }
 exports.deleteTempDirectory = deleteTempDirectory;
 function createTempDirectory(mkdirSyncImpl = fs_1.mkdirSync, existsSyncImpl = fs_1.existsSync) {
-    if (!existsSyncImpl(_1.TEMP_DIRECTORY)) {
+    if (!tempDirectoryExists(existsSyncImpl)) {
         mkdirSyncImpl(_1.TEMP_DIRECTORY);
     }
 }
@@ -97,6 +97,14 @@ function readFile(name, readFileSyncImpl = fs_1.readFileSync) {
     }
 }
 exports.readFile = readFile;
+function getEmptyMarkup() {
+    return readFile("EMPTY");
+}
+exports.getEmptyMarkup = getEmptyMarkup;
+function tempDirectoryExists(existsSyncImpl = fs_1.existsSync) {
+    return existsSyncImpl(_1.TEMP_DIRECTORY);
+}
+exports.tempDirectoryExists = tempDirectoryExists;
 function saveFile(name, data, writeFileImpl = fs_1.writeFile) {
     const fileName = toSavedFileName(name);
     return new Promise((resolve) => {

package/dist/esm/markupFetcher.js

@@ -1,5 +1,5 @@
 import { injectSchema } from "./injectSchema";
-import { createTempDirectory, deleteTempDirectory, getEnvironment, isValidTimezone, parseJson, readFile, saveFile, } from "./utils";
+import { createTempDirectory, deleteTempDirectory, getEmptyMarkup, getEnvironment, isValidTimezone, parseJson, readFile, saveFile, tempDirectoryExists, } from "./utils";
 export async function fetchAll({ tz = undefined, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = getEnvironment(), }, platform, fetchImplementation = fetch, batchMarkupFetcherImpl = batchMarkupFetcher) {
     const fetchBatchMarkup = batchMarkupFetcherImpl(platform, fetchImplementation);
     createTempDirectory();
@@ -84,7 +84,12 @@ export async function makeMarkupRequest({ tz = undefined, path = undefined, doma
 export function markupFetcher(platform, fetchImplementation = fetch) {
     return async ({ tz = undefined, path, domain, apiKey, schema, baseUrl = "https://go.jamcomments.com", environment = getEnvironment(), }) => {
         path = path || "/";
-        const savedFile = readFile(path);
+        const savedFile = (() => {
+            if (!tempDirectoryExists()) {
+                return null;
+            }
+            return readFile(path) || getEmptyMarkup();
+        })();
         const markup = savedFile
             ? savedFile
             : await fetchFreshMarkup({ tz, path, domain, apiKey, baseUrl, environment }, fetchImplementation, platform);

package/dist/esm/markupFetcher.test.js

@@ -328,6 +328,76 @@ describe("markupFetcher", () => {
             apiKey: "123abc",
         })).rejects.toThrowError(/request failed! Status code: 500/);
     });
+    describe("using saved markup", () => {
+        it("makes fresh request when temp directory does not exist", async () => {
+            const tempDirectoryExistsSpy = vi
+                .spyOn(utilsExports, "tempDirectoryExists")
+                .mockReturnValue(false);
+            const readFileSpy = vi.spyOn(utilsExports, "readFile");
+            const fetchMock = vi.fn().mockImplementation(() => {
+                return {
+                    status: 200,
+                    ok: true,
+                    text: () => "results!",
+                };
+            });
+            const fetcher = markupFetcher("test", fetchMock);
+            const result = await fetcher({
+                path: "/test",
+                domain: "test.com",
+                apiKey: "123abc",
+                environment: "production",
+            });
+            expect(tempDirectoryExistsSpy).toHaveBeenCalledOnce();
+            expect(readFileSpy).not.toHaveBeenCalled();
+            expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Ftest", expect.anything());
+            expect(result).toEqual("results!");
+        });
+        it("uses saved markup when it exists", async () => {
+            const tempDirectoryExistsSpy = vi
+                .spyOn(utilsExports, "tempDirectoryExists")
+                .mockReturnValue(true);
+            const readFileSpy = vi
+                .spyOn(utilsExports, "readFile")
+                .mockReturnValue("saved markup");
+            const fetchMock = vi.fn();
+            const fetcher = markupFetcher("test", fetchMock);
+            const result = await fetcher({
+                path: "/test",
+                domain: "test.com",
+                apiKey: "123abc",
+                environment: "production",
+            });
+            expect(tempDirectoryExistsSpy).toHaveBeenCalledOnce();
+            expect(readFileSpy).toHaveBeenCalledOnce();
+            expect(fetchMock).not.toHaveBeenCalled();
+            expect(result).toEqual("saved markup");
+        });
+        it("uses the EMPTY template when there's no saved file for a post", async () => {
+            const tempDirectoryExistsSpy = vi
+                .spyOn(utilsExports, "tempDirectoryExists")
+                .mockReturnValue(true);
+            const readFileSpy = vi
+                .spyOn(utilsExports, "readFile")
+                .mockReturnValue(null);
+            const getEmptyMarkupSpy = vi
+                .spyOn(utilsExports, "getEmptyMarkup")
+                .mockReturnValue("<!-- EMPTY -->");
+            const fetchMock = vi.fn();
+            const fetcher = markupFetcher("test", fetchMock);
+            const result = await fetcher({
+                path: "/test",
+                domain: "test.com",
+                apiKey: "123abc",
+                environment: "production",
+            });
+            expect(tempDirectoryExistsSpy).toHaveBeenCalledOnce();
+            expect(readFileSpy).toHaveBeenCalledOnce();
+            expect(getEmptyMarkupSpy).toHaveBeenCalledOnce();
+            expect(fetchMock).not.toHaveBeenCalled();
+            expect(result).toEqual("<!-- EMPTY -->");
+        });
+    });
     describe("timezone validation", () => {
         it("throws error when invalid timezone is provided", async () => {
             const fetchImplMock = vi.fn();

package/dist/esm/utils.js

@@ -69,7 +69,7 @@ export function deleteTempDirectory() {
     }
 }
 export function createTempDirectory(mkdirSyncImpl = mkdirSync, existsSyncImpl = existsSync) {
-    if (!existsSyncImpl(TEMP_DIRECTORY)) {
+    if (!tempDirectoryExists(existsSyncImpl)) {
         mkdirSyncImpl(TEMP_DIRECTORY);
     }
 }
@@ -85,6 +85,12 @@ export function readFile(name, readFileSyncImpl = readFileSync) {
         return null;
     }
 }
+export function getEmptyMarkup() {
+    return readFile("EMPTY");
+}
+export function tempDirectoryExists(existsSyncImpl = existsSync) {
+    return existsSyncImpl(TEMP_DIRECTORY);
+}
 export function saveFile(name, data, writeFileImpl = writeFile) {
     const fileName = toSavedFileName(name);
     return new Promise((resolve) => {

package/dist/types/utils.d.ts

@@ -9,4 +9,6 @@ export declare function deleteTempDirectory(): void;
 export declare function createTempDirectory(mkdirSyncImpl?: typeof mkdirSync, existsSyncImpl?: typeof existsSync): void;
 export declare function toSavedFileName(name: string): string;
 export declare function readFile(name: any, readFileSyncImpl?: typeof readFileSync): string;
+export declare function getEmptyMarkup(): string;
+export declare function tempDirectoryExists(existsSyncImpl?: typeof existsSync): boolean;
 export declare function saveFile(name: string, data: string, writeFileImpl?: any): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jam-comments/server-utilities",
-  "version": "4.3.1",
+  "version": "4.3.2",
   "description": "Various JavaScript utilities for JamComments.",
   "main": "dist/cjs/index.js",
   "types": "dist/types/index.d.ts",
@@ -21,7 +21,7 @@
   "homepage": "https://jamcomments.com",
   "license": "GPL-2.0",
   "devDependencies": {
-    "@types/node": "^20.12.11",
+    "@types/node": "^20.12.12",
     "prettier": "^3.2.5",
     "typescript": "^5.4.5",
     "vite": "^5.2.11",