Potential fix for range request beyond end of file (#23)

Author: cmdcolin

eslint.config.mjs

@@ -6,7 +6,14 @@ import tseslint from 'typescript-eslint'
 
 export default defineConfig(
   {
-    ignores: ['esm/**/*', 'dist/**/*', '*.js', '*.mjs', 'example/*'],
+    ignores: [
+      'esm/**/*',
+      'dist/**/*',
+      '*.js',
+      '*.mjs',
+      'example/*',
+      'test/browser.test.ts',
+    ],
   },
   {
     languageOptions: {

package.json

@@ -41,18 +41,19 @@
   "author": "Matt Morgan",
   "repository": "GMOD/trix-js",
   "devDependencies": {
-    "@types/node": "^25.0.9",
-    "@typescript-eslint/eslint-plugin": "^8.53.0",
-    "@typescript-eslint/parser": "^8.53.0",
+    "@types/node": "^25.0.10",
+    "puppeteer": "^24.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.53.1",
+    "@typescript-eslint/parser": "^8.53.1",
     "eslint": "^9.0.0",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-unicorn": "^62.0.0",
     "generic-filehandle2": "^2.0.18",
-    "prettier": "^3.8.0",
+    "prettier": "^3.8.1",
     "rimraf": "^6.0.1",
     "typescript": "^5.7.0",
-    "typescript-eslint": "^8.53.0",
-    "vitest": "^4.0.17"
+    "typescript-eslint": "^8.53.1",
+    "vitest": "^4.0.18"
   },
   "publishConfig": {
     "access": "public"

src/index.ts

@@ -12,13 +12,28 @@ const ADDRESS_SIZE = 10
 export default class Trix {
   private decoder = new TextDecoder('utf8')
   private indexCache?: readonly (readonly [string, number])[]
+  private ixFileSize?: number
 
   constructor(
     public ixxFile: GenericFilehandle,
     public ixFile: GenericFilehandle,
     public maxResults = 20,
   ) {}
 
+  private async getIxFileSize(opts?: { signal?: AbortSignal }) {
+    if (this.ixFileSize !== undefined) {
+      return this.ixFileSize
+    }
+    try {
+      // @ts-expect-error
+      const stat = await this.ixFile.stat(opts)
+      this.ixFileSize = stat.size
+      return this.ixFileSize
+    } catch {
+      return undefined
+    }
+  }
+
   async search(searchString: string, opts?: { signal?: AbortSignal }) {
     let resultArr = [] as [string, string][]
     const searchWords = searchString.split(' ')
@@ -30,6 +45,7 @@ export default class Trix {
       const res = await this.getBuffer(searchWord, opts)
 
       let { end, buffer } = res
+      const { fileSize } = res
       let done = false
       // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
       while (!done) {
@@ -68,13 +84,22 @@ export default class Trix {
           break
         }
 
-        // fetch more data
-        const res2 = await this.ixFile.read(CHUNK_SIZE, end, opts)
+        // avoid reading past end of file
+        if (fileSize !== undefined && end >= fileSize) {
+          break
+        }
+
+        // fetch more data, clamping to file size if known
+        let bytesToRead = CHUNK_SIZE
+        if (fileSize !== undefined) {
+          bytesToRead = Math.min(CHUNK_SIZE, fileSize - end)
+        }
+        const res2 = await this.ixFile.read(bytesToRead, end, opts)
         if (res2.length === 0) {
           break
         }
         buffer = concatUint8Array([buffer, res2])
-        end += CHUNK_SIZE
+        end += res2.length
       }
     }
 
@@ -116,7 +141,12 @@ export default class Trix {
       }
     }
 
+    const fileSize = await this.getIxFileSize(opts)
+    if (fileSize !== undefined) {
+      end = Math.min(end, fileSize)
+    }
+
     const buffer = await this.ixFile.read(end - start, start, opts)
-    return { buffer, end }
+    return { buffer, end, fileSize }
   }
 }

test/__snapshots__/browser.test.ts.snap

@@ -0,0 +1,35 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Browser tests with Puppeteer > handles EOF correctly with CORS enabled server 1`] = `
+[
+  [
+    "this",
+    "id1",
+  ],
+  [
+    "this",
+    "id2",
+  ],
+  [
+    "this",
+    "id3",
+  ],
+]
+`;
+
+exports[`Browser tests with Puppeteer > searches via HTTP with CORS enabled server 1`] = `
+[
+  [
+    "for",
+    "id1",
+  ],
+  [
+    "for",
+    "id2",
+  ],
+  [
+    "for",
+    "id3",
+  ],
+]
+`;

test/__snapshots__/http-server.test.ts.snap

@@ -0,0 +1,69 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`HTTP server tests with CORS > handles search near end of file without reading past EOF with CORS 1`] = `
+[
+  [
+    "this",
+    "id1",
+  ],
+  [
+    "this",
+    "id2",
+  ],
+  [
+    "this",
+    "id3",
+  ],
+]
+`;
+
+exports[`HTTP server tests with CORS > searches via HTTP with CORS 1`] = `
+[
+  [
+    "for",
+    "id1",
+  ],
+  [
+    "for",
+    "id2",
+  ],
+  [
+    "for",
+    "id3",
+  ],
+]
+`;
+
+exports[`HTTP server tests without CORS > handles search near end of file without reading past EOF 1`] = `
+[
+  [
+    "this",
+    "id1",
+  ],
+  [
+    "this",
+    "id2",
+  ],
+  [
+    "this",
+    "id3",
+  ],
+]
+`;
+
+exports[`HTTP server tests without CORS > searches via HTTP without CORS 1`] = `
+[
+  [
+    "for",
+    "id1",
+  ],
+  [
+    "for",
+    "id2",
+  ],
+  [
+    "for",
+    "id3",
+  ],
+]
+`;