@static-suite/static-suite-data-server 1.0.5 → 1.0.6

package/dist/lib/store/dump/dumpIndexHelper.d.ts

@@ -7,6 +7,7 @@ export declare const dumpIndexHelper: {
     loadDumpIndex: () => void;
     hasEntry: (relativeFilePath: string) => boolean;
     getEntry: (relativeFilePath: string) => IndexEntry | undefined;
+    getKeys: () => MapIterator<string>;
     addEntry: (relativeFilePath: string, entry: IndexEntry) => void;
     removeEntry: (relativeFilePath: string) => void;
 };

package/dist/lib/store/dump/dumpIndexHelper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dumpIndexHelper.d.ts","sourceRoot":"","sources":["../../../../src/lib/store/dump/dumpIndexHelper.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAiC1C,eAAO,MAAM,eAAe;4BACJ,OAAO;8BAYL,OAAO;yBAEZ,IAAI;2BASF,IAAI;yBAgCN,IAAI;iCAqBM,MAAM,KAAG,OAAO;iCAEhB,MAAM,KAAG,UAAU,GAAG,SAAS;iCAG/B,MAAM,SAAS,UAAU,KAAG,IAAI;oCAK7B,MAAM,KAAG,IAAI;CAI9C,CAAC"}
+{"version":3,"file":"dumpIndexHelper.d.ts","sourceRoot":"","sources":["../../../../src/lib/store/dump/dumpIndexHelper.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAiC1C,eAAO,MAAM,eAAe;4BACJ,OAAO;8BAYL,OAAO;yBAEZ,IAAI;2BASF,IAAI;yBAgCN,IAAI;iCAqBM,MAAM,KAAG,OAAO;iCAEhB,MAAM,KAAG,UAAU,GAAG,SAAS;;iCAK/B,MAAM,SAAS,UAAU,KAAG,IAAI;oCAK7B,MAAM,KAAG,IAAI;CAI9C,CAAC"}

package/dist/lib/store/dump/dumpIndexHelper.js

@@ -100,6 +100,7 @@ exports.dumpIndexHelper = {
     },
     hasEntry: (relativeFilePath) => index.has(relativeFilePath),
     getEntry: (relativeFilePath) => index.get(relativeFilePath),
+    getKeys: () => index.keys(),
     addEntry: (relativeFilePath, entry) => {
         setIsStale(true);
         index.set(relativeFilePath, entry);

package/dist/lib/store/dump/dumpManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dumpManager.d.ts","sourceRoot":"","sources":["../../../../src/lib/store/dump/dumpManager.ts"],"names":[],"mappings":"AASA,OAAO,EAAQ,WAAW,EAAE,MAAM,cAAc,CAAC;AA6GjD,eAAO,MAAM,WAAW,EAAE,WA4EzB,CAAC"}
+{"version":3,"file":"dumpManager.d.ts","sourceRoot":"","sources":["../../../../src/lib/store/dump/dumpManager.ts"],"names":[],"mappings":"AASA,OAAO,EAAQ,WAAW,EAAE,MAAM,cAAc,CAAC;AAqKjD,eAAO,MAAM,WAAW,EAAE,WA+EzB,CAAC"}

package/dist/lib/store/dump/dumpManager.js

@@ -99,6 +99,48 @@ const removeDeletedFiles = (diff, dump, filesDumpDir) => {
         }
     });
 };
+const removeStaleFiles = (diff, dump, filesDumpDir) => {
+    const iterator = dumpIndexHelper_1.dumpIndexHelper.getKeys();
+    for (const relativeFilepath of iterator) {
+        const absoluteFilepath = `${filesDumpDir}/${relativeFilepath}`;
+        if (!store_1.store.data.has(relativeFilepath) && fs_1.default.existsSync(absoluteFilepath)) {
+            logger_1.logger.info(`Dump: removing stale file: ${relativeFilepath}`);
+            try {
+                // Get old public URLs before they change on disk.
+                const dumpStaleFileString = fs_1.default
+                    .readFileSync(absoluteFilepath)
+                    .toString();
+                const isJson = (0, fs_2.isJsonFile)(relativeFilepath);
+                const dumpStaleFileContentData = isJson
+                    ? JSON.parse(dumpStaleFileString)
+                    : dumpStaleFileString;
+                let oldPublicUrl = dumpStaleFileContentData.data?.content?.url?.path || null;
+                // An stale file can be a manually copied file.
+                // In that case, that stale file would have an oldPublicUrl from a valid file,
+                // which would lead to deleting a valid URL.
+                // To solve that case, check that oldPublicUrl is not a valid URL.
+                if (oldPublicUrl && store_1.store.index.url.has(oldPublicUrl)) {
+                    logger_1.logger.info(`Dump: skipping valid url from stale file: ${oldPublicUrl}`);
+                    oldPublicUrl = null;
+                }
+                // Delete it.
+                fs_1.default.unlinkSync(absoluteFilepath);
+                // Delete any empty directory.
+                (0, fs_2.removeEmptyDirsUpwards)(path_1.default.dirname(absoluteFilepath));
+                // Delete it from index.
+                dumpIndexHelper_1.dumpIndexHelper.removeEntry(relativeFilepath);
+                // Mark it as deleted.
+                dump.deleted.set(relativeFilepath, {
+                    oldPublicUrl,
+                    newPublicUrl: null,
+                });
+            }
+            catch (e) {
+                logger_1.logger.error(`Dump: error deleting stale file "${absoluteFilepath}": ${e}`);
+            }
+        }
+    }
+};
 exports.dumpManager = {
     dump(options = { incremental: true }) {
         const startDate = microtime_1.default.now();
@@ -120,6 +162,8 @@ exports.dumpManager = {
                 storeUpdatedFiles(diff, dump, filesDumpDir);
                 // Remove deleted files.
                 removeDeletedFiles(diff, dump, filesDumpDir);
+                // Remove stale files.
+                removeStaleFiles(diff, dump, filesDumpDir);
                 // Save dump index
                 dumpIndexHelper_1.dumpIndexHelper.saveDumpIndex();
                 // Invoke "onDumpCreate" hook.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@static-suite/static-suite-data-server",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "A flexible, fast and developer friendly Data Server for Static Suite",
   "main": "./dist/lib/index.js",
   "typings": "./dist/lib/index.d.ts",
@@ -84,5 +84,6 @@
       "src/__tests__/fixtures/*",
       "src/__tests__/mocks/*"
     ]
-  }
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

package/src/lib/store/dump/dumpIndexHelper.ts

@@ -120,6 +120,8 @@ export const dumpIndexHelper = {
   getEntry: (relativeFilePath: string): IndexEntry | undefined =>
     index.get(relativeFilePath),
 
+  getKeys: () => index.keys(),
+
   addEntry: (relativeFilePath: string, entry: IndexEntry): void => {
     setIsStale(true);
     index.set(relativeFilePath, entry);

package/src/lib/store/dump/dumpManager.ts

@@ -116,6 +116,62 @@ const removeDeletedFiles = (
   });
 };
 
+const removeStaleFiles = (
+  diff: Diff,
+  dump: Dump,
+  filesDumpDir: string,
+): void => {
+  const iterator = dumpIndexHelper.getKeys();
+  for (const relativeFilepath of iterator) {
+    const absoluteFilepath = `${filesDumpDir}/${relativeFilepath}`;
+    if (!store.data.has(relativeFilepath) && fs.existsSync(absoluteFilepath)) {
+      logger.info(`Dump: removing stale file: ${relativeFilepath}`);
+      try {
+        // Get old public URLs before they change on disk.
+        const dumpStaleFileString = fs
+          .readFileSync(absoluteFilepath)
+          .toString();
+        const isJson = isJsonFile(relativeFilepath);
+        const dumpStaleFileContentData = isJson
+          ? JSON.parse(dumpStaleFileString)
+          : dumpStaleFileString;
+        let oldPublicUrl: string | null =
+          dumpStaleFileContentData.data?.content?.url?.path || null;
+
+        // An stale file can be a manually copied file.
+        // In that case, that stale file would have an oldPublicUrl from a valid file,
+        // which would lead to deleting a valid URL.
+        // To solve that case, check that oldPublicUrl is not a valid URL.
+        if (oldPublicUrl && store.index.url.has(oldPublicUrl)) {
+          logger.info(
+            `Dump: skipping valid url from stale file: ${oldPublicUrl}`,
+          );
+          oldPublicUrl = null;
+        }
+
+        // Delete it.
+        fs.unlinkSync(absoluteFilepath);
+
+        // Delete any empty directory.
+        removeEmptyDirsUpwards(path.dirname(absoluteFilepath));
+
+        // Delete it from index.
+        dumpIndexHelper.removeEntry(relativeFilepath);
+
+        // Mark it as deleted.
+        dump.deleted.set(relativeFilepath, {
+          oldPublicUrl,
+          newPublicUrl: null,
+        });
+      } catch (e) {
+        logger.error(
+          `Dump: error deleting stale file "${absoluteFilepath}": ${e}`,
+        );
+      }
+    }
+  }
+};
+
 export const dumpManager: DumpManager = {
   dump(options = { incremental: true }): Dump {
     const startDate = microtime.now();
@@ -143,6 +199,9 @@ export const dumpManager: DumpManager = {
         // Remove deleted files.
         removeDeletedFiles(diff, dump, filesDumpDir);
 
+        // Remove stale files.
+        removeStaleFiles(diff, dump, filesDumpDir);
+
         // Save dump index
         dumpIndexHelper.saveDumpIndex();