refactor: ipfs-gateway.js -> ipfs-gateway.ts (#669)

* chore: npm run test:all tests everything easily

* refactor: ipfs-gateway.js -> ipfs-gateway.ts

* chore: ensure start:hosted script uses correct ipfs-gateway.js path

* chore: fix path to ipfs-gateway.js in playwright config

* chore: some cleanup

* chore: more cleanup

Author: SgtPooki

package.json

@@ -17,10 +17,13 @@
     "build:esbuild": "node build.js",
     "start": "node build.js --watch --serve",
     "start:cloudflare": "npm run build && npx wrangler pages dev dist",
-    "start:hosted": "concurrently --kill-others -c 'auto' -n 'app,gateway,proxy' \"npm run start\" \"wait-on 'http://localhost:8345' && cross-env PROXY_PORT=3334 GATEWAY_PORT=8088 POLL_INTERVAL=1000 node test-e2e/ipfs-gateway.js\" \"cross-env BACKEND_PORT=8345 PROXY_PORT=3333 node test-e2e/reverse-proxy.js\"",
+    "prestart:hosted": "run-s build:tsc",
+    "start:hosted": "concurrently --kill-others -c 'auto' -n 'app,gateway,proxy' \"npm run start\" \"wait-on 'http://localhost:8345' && cross-env PROXY_PORT=3334 GATEWAY_PORT=8088 POLL_INTERVAL=1000 node dist-tsc/test-e2e/ipfs-gateway.js\" \"cross-env BACKEND_PORT=8345 PROXY_PORT=3333 node dist-tsc/test-e2e/reverse-proxy.js\"",
     "test": "run-s test:iso 'test:node -- -b false'",
+    "pretest:all": "run-s build",
+    "test:all": "cross-env SHOULD_BUILD=false run-s 'test:iso -- -b false' 'test:node -- -b false' test:browsers",
     "test:iso": "aegir test -f dist-tsc/test/**/*.spec.js",
-    "test:browsers": "playwright test -c playwright.config.js",
+    "test:browsers": "playwright test -c playwright.config.js --project chromium firefox no-service-worker",
     "test:chrome": "playwright test -c playwright.config.js --project chromium",
     "test:no-sw": "playwright test -c playwright.config.js --project no-service-worker",
     "test:firefox": "playwright test -c playwright.config.js --project firefox --project no-service-worker",

playwright.config.js

@@ -92,7 +92,7 @@ export default defineConfig({
       stderr: process.env.CI ? undefined : 'pipe'
     },
     {
-      command: 'npx wait-on "http://localhost:3000" && node test-e2e/ipfs-gateway.js',
+      command: 'npx wait-on "http://localhost:3000" && node dist-tsc/test-e2e/ipfs-gateway.js',
       timeout: 15 * 1000,
       env: {
         PROXY_PORT: '3334',
@@ -103,7 +103,7 @@ export default defineConfig({
     },
     {
       // need to use built assets due to service worker loading issue.
-      command: 'npm run build && npx http-server --silent -p 3000 dist',
+      command: process.env.SHOULD_BUILD !== 'false' ? 'npm run build && npx http-server --silent -p 3000 dist' : 'npx http-server --silent -p 3000 dist',
       port: 3000,
       timeout: 15 * 1000,
       reuseExistingServer: !process.env.CI,

test-e2e/ipfs-gateway.js renamed to test-e2e/ipfs-gateway.ts

@@ -15,6 +15,7 @@ import { createReverseProxy } from './reverse-proxy.js'
 const log = logger('ipfs-host.local')
 const daemonLog = logger('ipfs-host.local:kubo')
 const proxyLog = logger('ipfs-host.local:proxy')
+// eslint-disable-next-line @typescript-eslint/naming-convention
 const __dirname = dirname(fileURLToPath(import.meta.url))
 const tempDir = tmpdir()
 const IPFS_PATH = `${tempDir}/.ipfs/${Date.now()}`
@@ -50,8 +51,8 @@ log('using IPFS_PATH: ', IPFS_PATH)
 const kuboRedirects = await readFile(join(cwd(), './dist/_kubo_redirects'), 'utf-8')
 
 await writeFile(join(cwd(), './dist/_redirects'), kuboRedirects)
-
-const { stdout: cid } = await $(execaOptions)`${kuboBin} add -r -Q ${relative(cwd(), '../dist')} --cid-version 1`
+const distPath = relative(cwd(), '../../dist')
+const { stdout: cid } = await $(execaOptions)`${kuboBin} add -r -Q ${distPath} --cid-version 1`
 
 log('sw-gateway dist CID: ', cid.trim())
 const { stdout: pinStdout } = await $(execaOptions)`${kuboBin} pin add -r /ipfs/${cid.trim()}`
@@ -77,7 +78,7 @@ log('starting kubo')
 // need to stand up kubo daemon to serve the dist folder
 const daemon = execa(kuboBin, ['daemon', '--offline'], execaOptions)
 
-if (daemon == null || (daemon.stdout == null || daemon.stderr == null)) {
+if (daemon.stdout == null || daemon.stderr == null) {
   throw new Error('failed to start kubo daemon')
 }
 daemon.stdout.on('data', (data) => {
@@ -89,7 +90,7 @@ daemon.stderr.on('data', (data) => {
 
 // check for "daemon is ready" message
 await new Promise((resolve, reject) => {
-  daemon.stdout?.on('data', (data) => {
+  daemon.stdout?.on('data', (data: string) => {
     if (data.includes('Daemon is ready')) {
       // @ts-expect-error - nothing needed here.
       resolve()