cleanup

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    open-pull-requests-limit: 2
+    versioning-strategy: lockfile-only
+    schedule:
+      interval: "weekly"

.gitignore

@@ -1,3 +1,6 @@
 dist
 node_modules
 coverage
+
+# config for `asdf` version manager.
+.tool-versions

.npmrc

@@ -0,0 +1 @@
+@dbl-works:registry=https://npm.pkg.github.com

README.md

@@ -2,53 +2,52 @@
 
 Easily manage routing using Cloudflare Workers
 
-
-
 ## Usage
 
-```typescript
-import { startWorker } from '@dbl-works/cloudflare-router'
-
-startWorker({
-  routes: {
-    'example.com': 's3://eu-central-1.assets.example.com',
+```toml
+# wrangler.toml
+name = "my-worker"
+routes = [
+  {
+    pattern = "*example.com/*",
+    zone_id = "5d7a8c0f96213b4e1a57b0c2f9478ec3"
   },
-  edgeCacheTtl: 360 // seconds, Edge Cache TTL (Time to Live) specifies how long to cache a resource in the Cloudflare edge network
-})
+]
 ```
 
-
-
-## Match rules
-
-- Starting with `/` does a path only match
-- Any other start will assume matching against `[domain][path]` as the value
-
-
-
-## Basic Authentication
-
-You can protect a deployment by defining basic auth in the config.
-
 ```typescript
 startWorker({
   deployments: [
     {
-      accountId: '12345',
-      zoneId: 'abcdef',
       routes: [
         '*example.com/*',
       ],
-      auth: [
+      auth: [ // optional
         {
           type: 'basic',
           username: 'test',
-          password: 'letmein',
+          password: 'lemmein',
         },
+        {
+
+        }
       ],
     },
   ],
-  routes: {
+  routes: { // define proxy routes
+    'production-example.com': 's3://eu-central-1.assets.example.com',
   },
+  edgeCacheTtl: 360 // optional: Edge Cache TTL (Time to Live) specifies how long (in secs) to cache a resource in the Cloudflare edge network
 })
 ```
+
+## Match rules
+
+- Starting with `/` does a path only match
+- Any other start will assume matching against `[domain][path]` as the value
+
+## Releases
+
+- [Make sure you're logged in to npm.](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token)
+- Switch to a branch named `chore/release/X.X.X` and make sure the changelog is up to date.
+- In order to cut a release invoke `yarn release`. This will bump the version, update the changelog and push a new tag to the repo. The release will be automatically published to npm.

package.json

@@ -1,20 +1,59 @@
 {
-  "name": "cloudflare-router",
-  "version": "0.2.0",
+  "name": "@dbl-works/cloudflare-router",
+  "author": "dbl-works",
+  "version": "0.3.0",
+  "license": "MIT",
   "main": "dist/index.js",
+  "description": "Cloudflare Router",
+  "homepage": "https://github.com/dbl-works/cloudflare-router#readme",
+  "bugs": {
+    "url": "https://github.com/dbl-works/cloudflare-router/issues"
+  },
+  "repository": "git+https://github.com/dbl-works/cloudflare-router.git",
   "scripts": {
     "build": "rm -rf dist && tsc",
-    "test": "yarn build && jest test/*.test.ts test/**/*.test.ts --coverage"
+    "test": "yarn build && jest test/*.test.ts test/**/*.test.ts --coverage",
+    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
+    "release": "release-it"
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "typescript",
+      "prettier"
+    ],
+    "parserOptions": {
+      "ecmaVersion": 8,
+      "sourceType": "module"
+    },
+    "env": {
+      "node": true,
+      "es6": true
+    }
+  },
+  "release-it": {
+    "github": {
+      "release": true
+    }
   },
   "devDependencies": {
     "@cloudflare/workers-types": "^3.0.0",
-    "@types/jest": "^27.0.2",
+    "@types/jest": "^29.5.5",
     "@types/node-fetch": "^3.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.32.0",
+    "@typescript-eslint/parser": "^5.32.0",
+    "eslint": "^8.50.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-typescript": "^3.0.0",
     "jest": "^27.5.1",
     "jest-environment-miniflare": "^2.14.1",
     "jest-fetch-mock": "^3.0.3",
+    "release-it": "^16.2.1",
     "ts-jest": "^27.0.7",
     "ts-loader": "^9.2.6",
     "typescript": "^4.4.4"
+  },
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com"
   }
 }

src/cloudflare-router.ts

@@ -4,9 +4,10 @@ import normalizeRequest from './utils/normalize-request'
 import { withAuth } from './utils/with-auth'
 
 export const startWorker = (config: Config) => {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   addEventListener('fetch', (event: any) => {
     withAuth(event, config, async () => {
-      const { request, cache }= normalizeRequest(event.request, config.routes)
+      const { request, cache } = normalizeRequest(event.request, config.routes)
       const edgeCacheTtl = cache && config.edgeCacheTtl ? config.edgeCacheTtl : 0
       return handleRequest(request, edgeCacheTtl)
     })

src/config.ts

@@ -1,10 +1,3 @@
-interface Route {
-  remote: string
-  spa?: boolean
-}
-
-type RouteHandler = (request: Request) => Response
-
 export type BasicAuthMethod = {
   type: 'basic'
   username: string
@@ -24,8 +17,8 @@ export interface Routes {
 }
 
 export interface Deployment {
-  accountId: string
-  zoneId: string
+  accountId?: string
+  zoneId?: string
   routes: string[]
   auth?: AuthMethods[]
 }

src/utils/deployment-for-request.ts

@@ -2,7 +2,8 @@ import { Config, Deployment } from '../config'
 
 export const deploymentForRequest = (request: Request, config: Config): Deployment | undefined => {
   return config.deployments.find(deployment => {
-    return deployment.routes.find(route => {
+    return deployment.routes.some(route => {
+        // eslint-disable-next-line no-useless-escape
       const sanitizedRoute = route.replace(/[^a-zA-Z0-9*\.\-\/]/g, '') // We only really want to allow the pattern *.example.com/*
       const regexedRoute = sanitizedRoute.replace(/\./g, '\\.').replace(/\*/g, '(.*)')
       const normalizedUrl = request.url.replace(/https?:\/\//, '')

src/utils/handle-request.ts

@@ -1,29 +1,25 @@
-export default async function handleRequest(request: Request, edgeCacheTtl: number) {
+export default async function handleRequest(request: Request, edgeCacheTtl: number): Promise<Response> {
+  // https://developers.cloudflare.com/workers/runtime-apis/request/#requestinitcfproperties
   const cfOptions = edgeCacheTtl > 0 ? {
-    // Requests proxied through Cloudflare are cached even without Workers according to a zone’s default
-    // or configured behavior. Setting Cloudflare cache rules to further customised the behavior
     cf: {
-      // NOTE: cf is Enterprise only feature
-      // This is equivalent to setting two Page Rules:
-      // - Edge Cache TTL and
-      // - Cache Level (to Cache Everything).
-      // Edge Cache TTL (Time to Live) specifies how long to cache a resource in the Cloudflare edge network
-      // The value must be zero or a positive number.
-      // A value of 0 indicates that the cache asset expires immediately.
-      // This option applies to GET and HEAD request methods only.
       cacheTtlByStatus: { '200-299': edgeCacheTtl, '404': 1, '500-599': 0 },
-      // The Cloudflare CDN does not cache HTML by default without setting cacheEverything to true.
       cacheEverything: true,
       cacheKey: request.url
     }
   } : {}
 
-  //@ts-ignore
-  let response = await fetch(request, cfOptions);
+  const fetchResponse = await fetch(request, cfOptions as RequestInit);
+  const responseBodyBlob = await fetchResponse.blob();
 
-  // Reconstruct the Response object to make its headers mutable.
-  response = new Response(response.body, response);
-  response.headers.set('edge-cache-ttl', `${edgeCacheTtl}`)
+  const response = new Response(responseBodyBlob, {
+    status: fetchResponse.status,
+    statusText: fetchResponse.statusText,
+    headers: fetchResponse.headers,
+  });
+
+  if (edgeCacheTtl > 0) { // Only set the header if edgeCacheTtl is set
+    response.headers.set('edge-cache-ttl', `${edgeCacheTtl}`);
+  }
+
   return response;
 }
-

src/utils/normalize-request.ts

@@ -1,47 +1,52 @@
-import { Config } from '../config'
+import { Config } from '../config';
 
-const MEDIA_FILE_EXTENSIONS = 'css gif ico jpg js otf jpeg png svg ttf webp woff woff2 csv json'.split(' ')
-const hasMediaFileExtension = (path: string): boolean => {
-  const ext = path.split('.').pop()?.toLowerCase()
-  return ext ? MEDIA_FILE_EXTENSIONS.includes(ext) : false
-}
-
-export default function normalizeRequest(request: Request, routes: Config['routes']): { request: Request, cache: boolean } {
-  const originalUrl = request.url
-  const originalUrlWithoutScheme = originalUrl.replace(/^https?:\/\//, '')
-  const path = originalUrlWithoutScheme.replace(/^.*?\//gi, '')
+const MEDIA_FILE_EXTENSIONS = new Set([
+  'css',
+  'csv',
+  'gif',
+  'ico',
+  'jpeg',
+  'jpg',
+  'js',
+  'json',
+  'otf',
+  'png',
+  'svg',
+  'ttf',
+  'webp',
+  'woff',
+  'woff2',
+]);
+const hasMediaFileExtension = (path: string): boolean => MEDIA_FILE_EXTENSIONS.has(path.split('.').pop()?.toLowerCase() || '');
 
-  for (const [key, value] of Object.entries(routes)) {
-    let url = originalUrl
-    let newUrl = value
-    if (url.indexOf(key) !== -1) {
 
-      if (originalUrlWithoutScheme.startsWith(key) === false && key.startsWith('/') === false) {
-        break
-      }
+export default function normalizeRequest(request: Request, routes: Config['routes']): { request: Request, cache: boolean } {
+  const url = new URL(request.url);
+  const originalUrlWithoutScheme = url.hostname + url.pathname;
+  const path = originalUrlWithoutScheme.replace(/^.*?\//gi, '');
 
-      const singlePageApp = newUrl.indexOf('s3://') === 0
-      const isMediaFile = hasMediaFileExtension(originalUrl)
+  for (const [route, replacement] of Object.entries(routes)) {
+    if (request.url.includes(route) && (originalUrlWithoutScheme.startsWith(route) || route.startsWith('/'))) {
+      let newUrl = replacement;
+      const singlePageApp = newUrl.startsWith('s3://');
+
+      const isMediaFile = hasMediaFileExtension(request.url)
       if (singlePageApp) {
         newUrl = newUrl.replace(new RegExp('s3://([^.]+).([^/]+)(/?)(.*)'), 'https://s3.$1.amazonaws.com/$2$3$4')
       }
 
-      const lastChar = newUrl[newUrl.length - 1]
-      url = originalUrlWithoutScheme.replace(key, newUrl)
-      // console.log(path, { singlePageApp, isMediaFile })
+      let updatedUrl = originalUrlWithoutScheme.replace(route, newUrl)
       if (singlePageApp && !isMediaFile) {
-        url = newUrl + '/index.html'
-      }
-      if (lastChar === '/') {
-        url = url + path
+        updatedUrl = newUrl + '/index.html'
       }
-      if (url.indexOf('https://') !== 0) {
-        url = 'https://' + url
+      updatedUrl += newUrl.endsWith('/') ? updatedUrl + path : ''
+      if (!updatedUrl.startsWith('https://')) {
+        updatedUrl = 'https://' + updatedUrl
       }
-      // Make sure we only cache requests from the stated routes
-      return { request: new Request(url), cache: true }
+
+      return { request: new Request(updatedUrl), cache: true };
     }
   }
 
-  return { request, cache: false }
+  return { request, cache: false };
 }

test/setup.ts

@@ -1,3 +1,5 @@
+/* eslint-disable */
+
 import jestFetchMock from 'jest-fetch-mock'
 
 jestFetchMock.enableMocks()

test/utils/with-auth.test.ts

@@ -16,8 +16,6 @@ const MOCK_DEPLOYMENT_WITH_AUTH: Deployment = {
   ],
 }
 const MOCK_DEPLOYMENT_WITHOUT_AUTH: Deployment = {
-  accountId: '12345',
-  zoneId: '12345',
   routes: [
     '*example.com/*',
   ],

tsconfig.json

@@ -8,7 +8,7 @@
     "noImplicitAny": true,
     "preserveConstEnums": true,
     "outDir": "./dist",
-    "moduleResolution": "node"
+    "moduleResolution": "node",
   },
   "include": [
     "index.ts",