sveltekit-adapter-middy 0.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 will Farrell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,91 @@
+<div align="center">
+  <h1>Middy SvelteKit Adapter</h1>
+  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.svg"/>
+  <p><strong>SvelteKit adapter for AWS Lambda using Middy</strong></p>
+<p>
+  <a href="https://www.npmjs.com/package/@middy/http-router?activeTab=versions">
+    <img src="https://badge.fury.io/js/%40middy%2Fhttp-router.svg" alt="npm version" style="max-width:100%;">
+  </a>
+  <a href="https://packagephobia.com/result?p=@middy/http-router">
+    <img src="https://packagephobia.com/badge?p=@middy/http-router" alt="npm install size" style="max-width:100%;">
+  </a>
+  <a href="https://github.com/middyjs/middy/actions/workflows/tests.yml">
+    <img src="https://github.com/middyjs/middy/actions/workflows/tests.yml/badge.svg?branch=main&event=push" alt="GitHub Actions CI status badge" style="max-width:100%;">
+  </a>
+  <br/>
+   <a href="https://standardjs.com/">
+    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  </a>
+  <a href="https://snyk.io/test/github/middyjs/middy">
+    <img src="https://snyk.io/test/github/middyjs/middy/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/middyjs/middy" style="max-width:100%;">
+  </a>
+  <a href="https://github.com/middyjs/middy/actions/workflows/sast.yml">
+    <img src="https://github.com/middyjs/middy/actions/workflows/sast.yml/badge.svg
+?branch=main&event=push" alt="CodeQL" style="max-width:100%;">
+  </a>
+  <a href="https://bestpractices.coreinfrastructure.org/projects/5280">
+    <img src="https://bestpractices.coreinfrastructure.org/projects/5280/badge" alt="Core Infrastructure Initiative (CII) Best Practices"  style="max-width:100%;">
+  </a>
+  <br/>
+  <a href="https://gitter.im/middyjs/Lobby">
+    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter" style="max-width:100%;">
+  </a>
+  <a href="https://stackoverflow.com/questions/tagged/middy?sort=Newest&uqlId=35052">
+    <img src="https://img.shields.io/badge/StackOverflow-[middy]-yellow" alt="Ask questions on StackOverflow" style="max-width:100%;">
+  </a>
+</p>
+<!--<p>You can read the documentation at: <a href="https://middy.js.org/docs/ssr/sveltekit">https://middy.js.org/docs/ssr/sveltekit</a></p>-->
+</div>
+
+Creates a lambda that supports a Function URL with streaming responses.
+
+## Features
+
+- Response Stream
+- Extendable with Middy middlewares:
+  - `http-content-encoding`
+  - `http-security-headers`
+  - `ssm`/`secrets-manger`
+- Removes `x-sveltekit-page` headers
+
+Note: Bring your own deployment.
+
+## Getting started
+
+```js
+import adapter from 'sveltekit-adapter-middy'
+
+export default {
+  kit: {
+    adapter: adapter({
+      // options
+    })
+  }
+}
+```
+
+### Options
+
+- `handlerPath` (string): Relative path to handler override file. Overriding allows you to add in Content-Encoding, Security Headers, and pass in secrets more securely. Defaults to build-in minimalist handler.
+- `out` (string): Relative path to build dir. Defaults to `build`
+- `esbuildOptions` (object): `esbuild` option overrides. See [code]() for defaults.
+
+## Recommended Infrastructure
+
+- CloudFront: Route to static assets / pages, with fallback to server side rendering
+- S3: store static assets and pages
+- Lambda Function URL: server side rendering
+
+## Roadmap
+
+- infra diagram
+- cli to sync static assets to S3 w/ headers
+- LLRT
+
+## License
+
+Licensed under [MIT License](LICENSE). Copyright (c) 2017-2024 [Luciano Mammino](https://github.com/lmammino), [will Farrell](https://github.com/willfarrell), and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
+
+<a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy?ref=badge_large">
+  <img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy.svg?type=large" alt="FOSSA Status"  style="max-width:100%;">
+</a>

package/handler.js

@@ -0,0 +1,11 @@
+import middy from '@middy/core'
+
+import sveltekitMiddleware from './sveltekitMiddleware.js'
+import sveltekitHandler from './sveltekitHandler.js'
+
+export const handler = middy({ streamifyResponse: true })
+  .use([
+    // other middleware here
+    sveltekitMiddleware()
+  ])
+  .handler(sveltekitHandler)

package/index.js

@@ -0,0 +1,98 @@
+import { readFileSync, writeFileSync } from 'node:fs'
+import { fileURLToPath } from 'node:url'
+import esbuild from 'esbuild'
+
+const name = '@middy/sveltekit'
+const files = fileURLToPath(new URL('./', import.meta.url).href)
+
+const sveltekitAdapterMiddy = (opts = {}) => {
+  const {
+    out = 'build',
+    handlerPath = `${files}/handler.js`,
+    esbuildOptions = {}
+  } = opts
+
+  return {
+    name,
+    async adapt(builder) {
+      const tmp = builder.getBuildDirectory('adapter-middy')
+
+      builder.rimraf(out)
+      builder.rimraf(tmp)
+
+      builder.log.minor('Copying static assets')
+      const clientFiles = await builder.writeClient(
+        `${out}/assets${builder.config.kit.paths.base}`
+      )
+
+      builder.log.minor('Building server')
+      await builder.writeServer(tmp)
+      writeFileSync(
+        `${tmp}/manifest.js`,
+        [
+          `export const manifest = ${builder.generateManifest({
+            relativePath: './'
+          })};`,
+          `export const prerendered = new Set(${JSON.stringify(
+            builder.prerendered.paths
+          )});`,
+          `export const base = ${JSON.stringify(
+            builder.config.kit.paths.base
+          )};`
+        ].join('\n\n')
+      )
+
+      builder.copy(
+        `${files}/sveltekitMiddleware.js`,
+        `${tmp}/sveltekitMiddleware.js`
+      )
+      builder.copy(`${files}/sveltekitHandler.js`, `${tmp}/sveltekitHandler.js`)
+      builder.copy(handlerPath, `${tmp}/handler.js`)
+
+      try {
+        const result = await esbuild.build({
+          target: 'node20',
+          bundle: true,
+          platform: 'node',
+          format: 'esm',
+          treeShaking: true,
+          ...esbuildOptions,
+          entryPoints: [`${tmp}/handler.js`],
+          outfile: `${out}/index.mjs`,
+          external: ['node:*', ...(esbuildOptions?.external ?? [])]
+        })
+
+        if (result.warnings.length > 0) {
+          const formatted = await esbuild.formatMessages(result.warnings, {
+            kind: 'warning',
+            color: true
+          })
+
+          console.error(formatted.join('\n'))
+        }
+      } catch (err) {
+        const formatted = await esbuild.formatMessages(err.errors, {
+          kind: 'error',
+          color: true
+        })
+
+        console.error(formatted.join('\n'))
+
+        throw new Error(
+          `Bundling with esbuild failed with ${err.errors.length} ${
+            err.errors.length === 1 ? 'error' : 'errors'
+          }`
+        )
+      }
+
+      builder.log.minor('Prerendering static pages')
+      const prerenderedFiles = await builder.writePrerendered(
+        `${out}/prerendered${builder.config.kit.paths.base}`
+      )
+    },
+    supports: {
+      read: () => true
+    }
+  }
+}
+export default sveltekitAdapterMiddy

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "sveltekit-adapter-middy",
+  "version": "0.0.0-alpha.0",
+  "description": "SvelteKit adapter for AWS Lambda with Middy",
+  "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
+  "engineStrict": true,
+  "publishConfig": {
+    "access": "public"
+  },
+  "module": "./index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "default": "./index.js"
+      }
+    }
+  },
+  "files": [
+    "index.js",
+    "handler.js",
+    "sveltekitMiddleware.js",
+    "sveltekitHandler.js"
+  ],
+  "scripts": {
+    "test": "echo test"
+  },
+  "license": "MIT",
+  "keywords": [
+    "SvelteKit",
+    "Middy",
+    "Lambda",
+    "Middleware",
+    "Serverless",
+    "AWS",
+    "AWS Lambda",
+    "Middy",
+    "HTTP",
+    "SSR"
+  ],
+  "author": {
+    "name": "contributors",
+    "url": "https://github.com/willfarrell/sveltekit-adapter-middy/graphs/contributors"
+  },
+  "repository": {
+    "type": "git",
+    "url": "github:willfarrell/sveltekit-adapter-middy",
+    "directory": ""
+  },
+  "bugs": {
+    "url": "https://github.com/willfarrell/sveltekit-adapter-middy/issues"
+  },
+  "homepage": "https://middy.js.org",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/willfarrell"
+  },
+  "dependencies": {
+    "@datastream/string": "0.0.36",
+    "@middy/core": "5.4.0",
+    "esbuild": "^0.21.0",
+    "set-cookie-parser": "2.6.0"
+  }
+}

package/sveltekitHandler.js

@@ -0,0 +1,66 @@
+import { splitCookiesString } from 'set-cookie-parser'
+
+const lambdaHandler = async (event, context, { signal }) => {
+  const { server, env } = context
+  const { headers, rawQueryString, body: rawBody, isBase64Encoded } = event
+  const { method, path } = event.requestContext.http
+
+  // Copy secrets from ssm into import.meta scope
+  Object.assign(import.meta.env, env)
+
+  // Override origin
+  headers.origin = process.env.ORIGIN ?? headers.origin
+
+  const queryString = rawQueryString ? `?${rawQueryString}` : ''
+  const url = `${headers.origin}${path}${queryString}`
+
+  const encoding = isBase64Encoded
+    ? 'base64'
+    : headers['content-encoding'] ?? 'utf-8'
+  const body =
+    typeof rawBody === 'string' ? Buffer.from(rawBody, encoding) : rawBody
+
+  await init
+
+  const rendered = await server.respond(
+    new Request(url, {
+      method,
+      headers: new Headers(headers),
+      body
+    }),
+    {
+      getClientAddress() {
+        console.log('getClientAddress', headers['x-forwarded-for'])
+        return headers['x-forwarded-for']
+      }
+    }
+  )
+
+  if (rendered) {
+    const response = {
+      statusCode: rendered.status,
+      headers: {
+        'cache-control': 'no-cache'
+      },
+      multiValueHeaders: {},
+      body: rendered.body
+    }
+
+    for (const [key, value] of rendered.headers.entries()) {
+      if (key === 'set-cookie') {
+        response.multiValueHeaders[key] = setCookie.splitCookiesString(value)
+      } else if (key === 'x-sveltekit-page') {
+        // excluded, security
+      } else {
+        response.headers[key] = value
+      }
+    }
+
+    return response
+  }
+
+  return {
+    statusCode: 404
+  }
+}
+export default lambdaHandler

package/sveltekitMiddleware.js

@@ -0,0 +1,46 @@
+import { createTransformStream } from '@datastream/core'
+import { Server } from './index.js'
+import { manifest } from './manifest.js'
+
+const server = new Server(manifest)
+const init = server.init({ env: process.env })
+
+// TODO replace with @datastream/string
+export const stringReplaceStream = (options, streamOptions) => {
+  const { pattern, replacement } = options
+  let previousChunk = ''
+  const transform = (chunk, enqueue) => {
+    const newChunk = (previousChunk + chunk).replace(pattern, replacement)
+    enqueue(newChunk.substring(0, previousChunk.length))
+    previousChunk = newChunk.substring(previousChunk.length)
+  }
+  const flush = (enqueue) => {
+    enqueue(previousChunk)
+  }
+  return createTransformStream(transform, flush, streamOptions)
+}
+
+const formActionPattern = /action="\?\//g
+const formActionReplacement = 'action="?%2F'
+const sveltekitMiddleware = () => {
+  const sveltekitMiddlewareBefore = async (request) => {
+    request.context.server = server
+    await init
+  }
+
+  const sveltekitMiddlewareAfter = async (request) => {
+    // Workaround: AWS Function URLs doesn't support querystring keys that contain `/`
+    if (request.response['Content-Type'].inlcudes('text/html')) {
+      const stream = stringReplaceStream({
+        pattern: formActionPattern,
+        replacement: formActionReplacement
+      })
+      request.response.body.pipe(stream)
+    }
+  }
+  return {
+    before: sveltekitMiddlewareBefore,
+    after: sveltekitMiddlewareAfter
+  }
+}
+export default sveltekitMiddleware