Merge pull request #40 from RafalGoslawski/issue37

fix: fixed issues with serving index.html

Author: bogeychan

.prettierrc

@@ -1,5 +1,5 @@
 {
-	"useTabs": true,
+	"useTabs": false,
 	"tabWidth": 4,
 	"semi": false,
 	"singleQuote": true,

bun.lockb

@@ -89,7 +89,7 @@ export const staticPlugin = async <Prefix extends string = '/prefix'>(
          */
         staticLimit?: number
         /**
-         * @default false
+         * @default false unless `NODE_ENV` is 'production'
          *
          * Should file always be served statically
          */
@@ -210,31 +210,29 @@ export const staticPlugin = async <Prefix extends string = '/prefix'>(
         }
     })
 
+    const assetsDir = assets[0] === sep ? assets : resolve() + sep + assets
+
     if (
         alwaysStatic ||
         (process.env.ENV === 'production' && files.length <= staticLimit)
     )
-        for (let i = 0; i < files.length; i++) {
-            const filePath = files[i]
-            if (!filePath || shouldIgnore(filePath)) continue
-
-            let fileName = filePath
-                .replace(resolve(), '')
-                .replace(`${assets}${sep}`, '')
+        for (const absolutePath of files) {
+            if (!absolutePath || shouldIgnore(absolutePath)) continue
+            let relativePath = absolutePath.replace(assetsDir, '')
 
             if (noExtension) {
-                const temp = fileName.split('.')
+                const temp = relativePath.split('.')
                 temp.splice(-1)
 
-                fileName = temp.join('.')
+                relativePath = temp.join('.')
             }
 
-            const file = Bun.file(filePath)
+            const file = Bun.file(absolutePath)
             const etag = await generateETag(file)
 
             const pathName = isFSSepUnsafe
-                ? prefix + fileName.split(sep).join(URL_PATH_SEP)
-                : join(prefix, fileName)
+                ? prefix + relativePath.split(sep).join(URL_PATH_SEP)
+                : join(prefix, relativePath)
 
             app.get(
                 pathName,
@@ -243,7 +241,7 @@ export const staticPlugin = async <Prefix extends string = '/prefix'>(
                           headers
                       })
                     : async ({ headers: reqHeaders }) => {
-                          if (await isCached(reqHeaders, etag, filePath)) {
+                          if (await isCached(reqHeaders, etag, absolutePath)) {
                               return new Response(null, {
                                   status: 304,
                                   headers
@@ -263,7 +261,7 @@ export const staticPlugin = async <Prefix extends string = '/prefix'>(
 
             if (indexHTML && pathName.endsWith('/index.html'))
                 app.get(
-                    join(prefix, pathName.replace('/index.html', '')),
+                    pathName.replace('/index.html', ''),
                     noCache
                         ? new Response(file, {
                               headers
@@ -316,6 +314,9 @@ export const staticPlugin = async <Prefix extends string = '/prefix'>(
                             statCache.set(path, status)
                         }
 
+                        if (!indexHTML && status.isDirectory())
+                            throw new NotFoundError()
+
                         let file =
                             fileCache.get<ReturnType<(typeof Bun)['file']>>(
                                 path

src/index.ts

@@ -96,7 +96,7 @@ describe('Static Plugin', () => {
     })
 
     it('ignore string pattern', async () => {
-        const app = new Elysia({ forceErrorEncapsulation: true }).use(
+        const app = new Elysia().use(
             staticPlugin({
                 ignorePatterns: [`public${sep}takodachi.png`]
             })
@@ -141,7 +141,6 @@ describe('Static Plugin', () => {
         const app = new Elysia().use(
             staticPlugin({
                 alwaysStatic: true,
-                prefix: '',
                 assets: join(import.meta.dir, '../public')
             })
         )
@@ -390,48 +389,56 @@ describe('Static Plugin', () => {
     })
 
     it('serve index.html to default /', async () => {
-        let app = new Elysia().use(staticPlugin())
+        const app = new Elysia().use(staticPlugin())
         await app.modules
 
         let res = await app.handle(req('/public'))
         expect(res.status).toBe(404)
 
         res = await app.handle(req('/public/html'))
         expect(res.status).toBe(200)
+    })
 
-        app = new Elysia().use(
+    it('does not serve index.html to default / when not indexHTML', async () => {
+        const app = new Elysia().use(
             staticPlugin({
                 indexHTML: false
             })
         )
+        await app.modules
 
-        res = await app.handle(req('/public'))
+        let res = await app.handle(req('/public'))
         expect(res.status).toBe(404)
 
         res = await app.handle(req('/public/html'))
         expect(res.status).toBe(404)
+    })
 
-        // Not sure why this error but not in dev environment
-        // app = new Elysia().use(
-        //     staticPlugin({
-        //         alwaysStatic: true
-        //     })
-        // )
+    it('serves index.html to default / when alwaysStatic', async () => {
+        const app = new Elysia().use(
+            staticPlugin({
+                alwaysStatic: true
+            })
+        )
+        await app.modules
 
-        // res = await app.handle(req('/public'))
-        // expect(res.status).toBe(404)
+        let res = await app.handle(req('/public'))
+        expect(res.status).toBe(404)
 
-        // res = await app.handle(req('/public/html'))
-        // expect(res.status).toBe(200)
+        res = await app.handle(req('/public/html'))
+        expect(res.status).toBe(200)
+    })
 
-        app = new Elysia().use(
+    it('does not serve index.html to default / when alwaysStatic and not indexHTML', async () => {
+        const app = new Elysia().use(
             staticPlugin({
                 alwaysStatic: true,
                 indexHTML: false
             })
         )
+        await app.modules
 
-        res = await app.handle(req('/public'))
+        let res = await app.handle(req('/public'))
         expect(res.status).toBe(404)
 
         res = await app.handle(req('/public/html'))