hypercore-fetch 8.6.2-0 → 9.0.0

package/.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
     continue-on-error: true
     strategy:
       matrix:
-        node: [ '16' ]
+        node: [ '18' ]
         os: [ubuntu-latest, windows-latest, macOS-latest]
     runs-on: ${{ matrix.os }}
     name: Node ${{ matrix.node }}-${{matrix.os}} tests

package/index.js

@@ -317,8 +317,7 @@ export default async function makeHyperFetch ({
         )
       }
 
-      // TODO: Use 201 with location in response headers
-      return { status: 200 }
+      return { status: 201, headers: { Location: request.url } }
     })
     router.delete('hyper://*/**', async function putFiles (request) {
       const { hostname, pathname } = new URL(request.url)
@@ -409,7 +408,8 @@ export default async function makeHyperFetch ({
         }
       }
     }
-    const entry = await drive.entry(pathname)
+
+    const { entry, path } = await resolvePath(drive, pathname, noResolve)
 
     if (!entry) {
       return { status: 404, body: 'Not Found' }
@@ -417,7 +417,7 @@ export default async function makeHyperFetch ({
 
     resHeaders.ETag = `${entry.seq}`
 
-    const contentType = getMimeType(pathname)
+    const contentType = getMimeType(path)
     resHeaders['Content-Type'] = contentType
 
     if (entry.metadata?.mtime) {
@@ -486,7 +486,7 @@ export default async function makeHyperFetch ({
       }
 
       if (accept.includes('text/html')) {
-        const body = renderIndex(url, entries, fetch)
+        const body = await renderIndex(url, entries, fetch)
         return {
           status: 200,
           body,
@@ -506,13 +506,14 @@ export default async function makeHyperFetch ({
         }
       }
     }
-    const entry = await drive.entry(pathname)
+
+    const { entry, path } = await resolvePath(drive, pathname, noResolve)
 
     if (!entry) {
       return { status: 404, body: 'Not Found' }
     }
 
-    return serveFile(request.headers, drive, pathname)
+    return serveFile(request.headers, drive, path)
   })
 
   return fetch
@@ -568,6 +569,31 @@ async function serveFile (headers, drive, pathname) {
   }
 }
 
+function makeToTry (pathname) {
+  return [
+    pathname,
+    pathname + '.html',
+    pathname + '.md'
+  ]
+}
+
+async function resolvePath (drive, pathname, noResolve) {
+  if (noResolve) {
+    const entry = drive.entry(pathname)
+
+    return { entry, path: pathname }
+  }
+
+  for (const path of makeToTry(pathname)) {
+    const entry = await drive.entry(path)
+    if (entry) {
+      return { entry, path }
+    }
+  }
+
+  return { entry: null, path: null }
+}
+
 async function listEntries (drive, pathname = '/') {
   const entries = []
   for await (const path of drive.readdir(pathname)) {

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "hypercore-fetch",
-  "version": "8.6.2-0",
+  "version": "9.0.0",
   "description": "Implementation of Fetch that uses the Dat SDK for loading p2p content",
   "type": "module",
+  "main": "index.js",
   "scripts": {
     "test": "node test",
     "lint": "standard --fix"
@@ -31,7 +32,7 @@
   },
   "devDependencies": {
     "@rangermauve/fetch-event-source": "^1.0.3",
-    "hyper-sdk": "^4.1.0",
+    "hyper-sdk": "^4.1.1",
     "standard": "^17.0.0",
     "tape": "^5.2.2"
   }

package/test.js

@@ -93,11 +93,11 @@ test('PUT file', async (t) => {
     body: SAMPLE_CONTENT
   })
 
-  await checkResponse(uploadResponse, t)
+  await checkResponse(uploadResponse, t, 'upload successful')
 
   const uploadedContentResponse = await fetch(uploadLocation)
 
-  await checkResponse(uploadedContentResponse, t)
+  await checkResponse(uploadedContentResponse, t, 'able to load content')
 
   const content = await uploadedContentResponse.text()
   const contentType = uploadedContentResponse.headers.get('Content-Type')
@@ -272,8 +272,54 @@ test('Ignore index.html with noResolve', async (t) => {
   const entries = await listDirRequest.json()
   t.deepEqual(entries, ['index.html'], 'able to list index.html')
 })
-test.skip('Read directory as HTML', async (t) => {
+test('Read directory as HTML', async (t) => {
+  const created = await nextURL(t)
+
+  const formData = new FormData()
+  formData.append('file', new Blob([SAMPLE_CONTENT]), 'example.txt')
+  formData.append('file', new Blob([SAMPLE_CONTENT]), 'example2.txt')
+
+  const uploadedResponse = await fetch(created, {
+    method: 'put',
+    body: formData
+  })
+  await checkResponse(uploadedResponse, t)
+
+  const listDirRequest = await fetch(created, {
+    headers: {
+      Accept: 'text/html'
+    }
+  })
+  await checkResponse(listDirRequest, t, 'Able to list HTML')
+
+  const html = await listDirRequest.text()
+
+  t.equal(listDirRequest.headers.get('Content-Type'), 'text/html; charset=utf-8', 'Returned HTML in mime type')
+  t.ok(html.includes('<title'), 'Listing has title')
+  t.ok(html.includes('./example.txt'), 'Listing has link to file')
+})
+test('Resolve pretty markdown URLs', async (t) => {
+  const created = await nextURL(t)
+
+  const uploadLocation = new URL('./example.md', created)
+
+  const uploadResponse = await fetch(uploadLocation, {
+    method: 'put',
+    body: SAMPLE_CONTENT
+  })
+  await checkResponse(uploadResponse, t)
+
+  const resolvedLocation = new URL('/example', created)
+
+  const uploadedContentResponse = await fetch(resolvedLocation)
+
+  await checkResponse(uploadedContentResponse, t, 'able to load content')
+
+  const content = await uploadedContentResponse.text()
+  const contentType = uploadedContentResponse.headers.get('Content-Type')
 
+  t.equal(content, SAMPLE_CONTENT, 'Got original content out')
+  t.equal(contentType, 'text/markdown; charset=utf-8', 'Got markdown mime type')
 })
 
 test('EventSource extension messages', async (t) => {