feat(filestore): added getInfo method

Author: saby1101

package.json

@@ -28,9 +28,9 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.800.0",
-    "@aws-sdk/credential-provider-node": "^3.799.0",
-    "@azure/identity": "^4.9.1",
+    "@aws-sdk/client-s3": "^3.817.0",
+    "@aws-sdk/credential-provider-node": "^3.817.0",
+    "@azure/identity": "^4.10.0",
     "@azure/service-bus": "^7.9.5",
     "@azure/storage-blob": "^12.27.0",
     "@google-cloud/pubsub": "^5.0.0",
@@ -46,14 +46,14 @@
   "devDependencies": {
     "@trivago/prettier-plugin-sort-imports": "^5.2.2",
     "@types/jest": "^29.5.14",
-    "@types/node": "^22.15.3",
+    "@types/node": "^22.15.21",
     "husky": "^9.1.7",
     "jest": "^29.7.0",
-    "lint-staged": "^15.5.1",
+    "lint-staged": "^16.0.0",
     "npm-run-all": "^4.1.5",
     "prettier": "^3.5.3",
     "rimraf": "^6.0.1",
-    "ts-jest": "^29.3.2",
+    "ts-jest": "^29.3.4",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3"
   }

src/file-store.ts

@@ -11,8 +11,16 @@ import { FastifyInstance, FastifyPluginAsync } from "fastify";
 import fp from "fastify-plugin";
 import { streamToBuffer } from "./utils";
 
+export interface FileInfo {
+  size: number;
+  contentType: string;
+  lastModified: Date;
+}
+
 export interface FileStore {
   exists(filepath: string): Promise<boolean>;
+  // return null if file does not exist
+  getInfo(filepath: string): Promise<FileInfo | null>;
   save(
     filepath: string,
     contentType: string,
@@ -56,6 +64,23 @@ class LocalFileStore implements FileStore {
     const p = path.join(this.dir, filepath);
     return !!(await fs.promises.stat(p));
   }
+  async getInfo(filepath: string): Promise<FileInfo | null> {
+    try {
+      const p = path.join(this.dir, filepath);
+      const stat = await fs.promises.stat(p);
+      return {
+        size: stat.size,
+        contentType: "application/octet-stream",
+        lastModified: stat.mtime,
+      };
+    } catch (err) {
+      if (err.code === "ENOENT") {
+        return null;
+      }
+      throw err;
+    }
+  }
+
   async save(
     filepath: string,
     _contentType: string,
@@ -179,6 +204,24 @@ class AzureFileStore implements FileStore {
       throw new Error(resp.errorCode);
     }
   }
+
+  async getInfo(filepath: string): Promise<FileInfo | null> {
+    try {
+      const blob = this.client.getBlobClient(filepath);
+      const properties = await blob.getProperties();
+
+      return {
+        size: properties.contentLength || 0,
+        contentType: properties.contentType || "application/octet-stream",
+        lastModified: properties.lastModified || new Date(),
+      };
+    } catch (err) {
+      if (err.statusCode === 404) {
+        return null;
+      }
+      throw err;
+    }
+  }
 }
 
 class GCPFileStore implements FileStore {
@@ -239,6 +282,29 @@ class GCPFileStore implements FileStore {
       }),
     );
   }
+
+  async getInfo(filepath: string): Promise<FileInfo | null> {
+    try {
+      const gcsfile = this.storage.bucket(this.bucket).file(filepath);
+      const [metadata] = await gcsfile.getMetadata();
+
+      return {
+        size:
+          typeof metadata.size === "number"
+            ? metadata.size
+            : parseInt(metadata.size ?? "0", 10) || 0,
+        contentType: metadata.contentType || "application/octet-stream",
+        lastModified: metadata.updated
+          ? new Date(metadata.updated)
+          : new Date(),
+      };
+    } catch (err) {
+      if (err.code === 404) {
+        return null;
+      }
+      throw err;
+    }
+  }
 }
 
 class S3FileStore implements FileStore {
@@ -334,6 +400,31 @@ class S3FileStore implements FileStore {
       }),
     );
   }
+
+  async getInfo(filepath: string): Promise<FileInfo | null> {
+    try {
+      const data = await this.client.send(
+        new S3.HeadObjectCommand({
+          Bucket: this.bucket,
+          Key: filepath,
+        }),
+      );
+
+      return {
+        size: data.ContentLength || 0,
+        contentType: data.ContentType || "application/octet-stream",
+        lastModified: data.LastModified || new Date(),
+      };
+    } catch (err) {
+      if (
+        err instanceof S3.NoSuchKey ||
+        err["$metadata"]?.httpStatusCode === 404
+      ) {
+        return null;
+      }
+      throw err;
+    }
+  }
 }
 
 async function ConfigureLocal(f: FastifyInstance) {