Fix regression in file storage

Fixes #53

Author: mjackson

packages/file-storage/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This is the changelog for [`file-storage`](https://github.com/mjackson/remix-the-web/tree/main/packages/file-storage). It follows [semantic versioning](https://semver.org/).
 
+## HEAD
+
+- Fix regression when using `LocalFileStorage` together with `form-data-parser` (see #53)
+
 ## v0.6.0 (2025-02-04)
 
 - BREAKING CHANGE: `LocalFileStorage` now uses 2 characters for shard directory names instead of 8.

packages/file-storage/package.json

@@ -79,6 +79,7 @@
     "@mjackson/lazy-file": "workspace:^"
   },
   "devDependencies": {
+    "@mjackson/form-data-parser": "workspace:^",
     "@types/node": "^20.14.10",
     "tsup": "^8.3.5"
   },

packages/file-storage/src/lib/local-file-storage.test.ts

@@ -2,6 +2,7 @@ import * as assert from 'node:assert/strict';
 import { afterEach, describe, it } from 'node:test';
 import * as fs from 'node:fs';
 import * as path from 'node:path';
+import { parseFormData } from '@mjackson/form-data-parser';
 
 import { LocalFileStorage } from './local-file-storage.ts';
 
@@ -136,4 +137,41 @@ describe('LocalFileStorage', () => {
     assert.ok(retrieved2);
     assert.equal(await retrieved2.text(), 'Hello, universe!');
   });
+
+  describe('integration with form-data-parser', () => {
+    it('stores and lists file uploads', async () => {
+      let storage = new LocalFileStorage(directory);
+
+      let boundary = '----WebKitFormBoundary7MA4YWxkTrZu0gW';
+      let request = new Request('http://example.com', {
+        method: 'POST',
+        headers: {
+          'Content-Type': `multipart/form-data; boundary=${boundary}`,
+        },
+        body: [
+          `--${boundary}`,
+          'Content-Disposition: form-data; name="hello"; filename="hello.txt"',
+          'Content-Type: text/plain',
+          '',
+          'Hello, world!',
+          `--${boundary}--`,
+        ].join('\r\n'),
+      });
+
+      await parseFormData(request, async (file) => {
+        await storage.set('hello', file);
+      });
+
+      assert.ok(await storage.has('hello'));
+
+      let { files } = await storage.list({ includeMetadata: true });
+
+      assert.equal(files.length, 1);
+      assert.equal(files[0].key, 'hello');
+      assert.equal(files[0].name, 'hello.txt');
+      assert.equal(files[0].size, 13);
+      assert.equal(files[0].type, 'text/plain');
+      assert.ok(files[0].lastModified);
+    });
+  });
 });

packages/file-storage/src/lib/local-file-storage.ts

@@ -3,12 +3,7 @@ import * as fsp from 'node:fs/promises';
 import * as path from 'node:path';
 import { openFile, writeFile } from '@mjackson/lazy-file/fs';
 
-import {
-  type FileStorage,
-  type FileMetadata,
-  type ListOptions,
-  type ListResult,
-} from './file-storage.ts';
+import type { FileStorage, FileMetadata, ListOptions, ListResult } from './file-storage.ts';
 
 /**
  * A `FileStorage` that is backed by a directory on the local filesystem.
@@ -105,7 +100,8 @@ export class LocalFileStorage implements FileStorage {
           }
 
           if (includeMetadata) {
-            files.push(meta);
+            let size = (await fsp.stat(path.join(this.#dirname, subdir.name, `${hash}.dat`))).size;
+            files.push({ ...meta, size });
           } else {
             files.push({ key: meta.key });
           }
@@ -151,11 +147,10 @@ export class LocalFileStorage implements FileStorage {
 
     await writeFile(filePath, file);
 
-    let meta: FileMetadata = {
+    let meta: Omit<FileMetadata, 'size'> = {
       key,
       lastModified: file.lastModified,
       name: file.name,
-      size: file.size,
       type: file.type,
     };
     await fsp.writeFile(metaPath, JSON.stringify(meta));

packages/file-storage/src/lib/memory-file-storage.test.ts

@@ -1,5 +1,6 @@
 import * as assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
+import { parseFormData } from '@mjackson/form-data-parser';
 
 import { MemoryFileStorage } from './memory-file-storage.ts';
 
@@ -97,4 +98,41 @@ describe('MemoryFileStorage', () => {
     files.forEach((f) => assert.ok('size' in f));
     files.forEach((f) => assert.ok('type' in f));
   });
+
+  describe('integration with form-data-parser', () => {
+    it('stores and lists file uploads', async () => {
+      let storage = new MemoryFileStorage();
+
+      let boundary = '----WebKitFormBoundaryzv5f5B8XUeVl7e0A';
+      let request = new Request('http://example.com', {
+        method: 'POST',
+        headers: {
+          'Content-Type': `multipart/form-data; boundary=${boundary}`,
+        },
+        body: [
+          `--${boundary}`,
+          'Content-Disposition: form-data; name="a"; filename="hello.txt"',
+          'Content-Type: text/plain',
+          '',
+          'Hello, world!',
+          `--${boundary}--`,
+        ].join('\r\n'),
+      });
+
+      await parseFormData(request, async (file) => {
+        await storage.put('hello', file);
+      });
+
+      assert.ok(storage.has('hello'));
+
+      let { files } = storage.list({ includeMetadata: true });
+
+      assert.equal(files.length, 1);
+      assert.equal(files[0].key, 'hello');
+      assert.equal(files[0].name, 'hello.txt');
+      assert.equal(files[0].size, 13);
+      assert.equal(files[0].type, 'text/plain');
+      assert.ok(files[0].lastModified);
+    });
+  });
 });

packages/file-storage/src/lib/memory-file-storage.ts

@@ -1,4 +1,4 @@
-import { type FileStorage, type ListOptions, type ListResult } from './file-storage.ts';
+import type { FileStorage, ListOptions, ListResult } from './file-storage.ts';
 
 /**
  * A simple, in-memory implementation of the `FileStorage` interface.