Merge pull request #13 from movie-web/nitro-todos

Final TODOS

.github/workflows/cloudflare.yml

@@ -0,0 +1,36 @@
+name: Deploy Worker
+
+# this action is for the "deploy to cloudflare" button
+# repository_dispatch is triggered by CF
+# secrets should also be made by CF
+
+on: ["repository_dispatch"]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    steps:
+      - uses: actions/checkout@v3
+        
+      - uses: pnpm/action-setup@v2
+        with:
+          version: latest
+
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: 'pnpm'
+
+      - name: Install packages
+        run: pnpm install --frozen-lockfile
+
+      - name: Build Project
+        run: pnpm build:cloudflare
+
+      - name: Build & Deploy Worker
+        uses: cloudflare/wrangler-action@v3
+        with:
+          apiToken: ${{ secrets.CF_API_TOKEN }}
+          accountId: ${{ secrets.CF_ACCOUNT_ID }}

.github/workflows/linting.yml

@@ -15,21 +15,25 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-      
+        
+      - uses: pnpm/action-setup@v2
+        with:
+          version: latest
+
       - name: Install Node.js
         uses: actions/setup-node@v3
         with:
           node-version: 18
-          cache: 'npm'
+          cache: 'pnpm'
 
-      - name: Install npm packages
+      - name: Install packages
-        run: npm install
+        run: pnpm install --frozen-lockfile
 
       - name: Prepare for linting
-        run: npm run prepare
+        run: pnpm prepare
 
       - name: Run ESLint
-        run: npm run lint
+        run: pnpm lint
 
   building:
     name: Build project
@@ -38,15 +42,19 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: latest
       
       - name: Install Node.js
         uses: actions/setup-node@v3
         with:
           node-version: 18
-          cache: 'npm'
+          cache: 'pnpm'
       
-      - name: Install npm packages
+      - name: Install pnpm packages
-        run: npm install
+        run: pnpm install --frozen-lockfile
 
       - name: Build Project
-        run: npm run build
+        run: pnpm build

.github/workflows/release.yml

@@ -11,20 +11,71 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout code
+      - name: Checkout code
-      uses: actions/checkout@v3
+        uses: actions/checkout@v3
+        
+      - uses: pnpm/action-setup@v2
+        with:
+          version: latest
 
-    - name: Get version
+      - name: Get version
-      id: package-version
+        id: package-version
-      uses: martinbeentjes/npm-get-version-action@main
+        uses: martinbeentjes/npm-get-version-action@main
 
-    - name: Create Release
+      - name: Install packages
-      id: create_release
+        run: pnpm install --frozen-lockfile
-      uses: actions/create-release@v1
+
-      env:
+      - name: Build for cloudflare
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: pnpm build:cloudflare && cp ./.output/server/index.mjs ./cloudflare.worker.mjs
-      with:
+
-        tag_name: v${{ steps.package-version.outputs.current-version }}
+      - name: Build for AWS
-        release_name: Bot v${{ steps.package-version.outputs.current-version }}
+        run: pnpm build:aws && cd .output/server && zip -r ../../lambda.zip .
-        draft: false
+
-        prerelease: false
+      - name: Build for Node
+        run: pnpm build:node && cd .output/server && zip -r ../../nodejs.zip .
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: v${{ steps.package-version.outputs.current-version }}
+          release_name: Bot v${{ steps.package-version.outputs.current-version }}
+          draft: false
+          prerelease: false
+          body: |
+            Instead of downloading a package, you can also run it in docker:
+            ```sh
+            docker run movie-web/simple-proxy:${{ steps.package-version.outputs.current-version }}
+            ```
+
+      - name: Upload cloudflare build
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./cloudflare.worker.mjs
+          asset_name: simple-proxy-cloudflare.mjs
+          asset_content_type: text/javascript
+
+      - name: Upload AWS build
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./lambda.zip
+          asset_name: simple-proxy-aws-lambda.zip
+          asset_content_type: application/zip
+
+      - name: Upload Node build
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./node.zip
+          asset_name: simple-proxy-nodejs.zip
+          asset_content_type: application/zip

Dockerfile

@@ -4,10 +4,11 @@ WORKDIR /app
 # Build layer
 FROM base as build
 
-COPY package-lock.json package.json ./
+RUN npm i -g pnpm
-RUN npm install --frozen-lockfile
+COPY pnpm-lock.yaml package.json ./
+RUN pnpm install --frozen-lockfile
 COPY . .
-RUN npm run build
+RUN pnpm build
 
 # Production layer
 FROM base as production

README.md

@@ -2,16 +2,16 @@
 
 Simple reverse proxy to bypass CORS, used by [movie-web](https://movie-web.app).
 
-features:
+[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/movie-web/simple-proxy)
+
+---
+
+### features:
  - Deployable on many platforms - thanks to nitro
  - header rewrites - read and write protected headers
  - bypass CORS - always allows browser to send requests through it
 
-supported platforms:
+### supported platforms:
  - cloudflare workers
+ - AWS lambda
  - nodejs
-
-## Todos:
- - [ ] release with multi platform
- - [ ] Easy deploy to cloudflare button (just needs CI)
- - [ ] Test on cloudflare

nitro.config.ts

@@ -1,5 +1,10 @@
+import { join } from "path";
+
 //https://nitro.unjs.io/config
 export default defineNitroConfig({
   noPublicDir: true,
-  srcDir: "./src"
+  srcDir: "./src",
+  alias: {
+    "@": join(__dirname, "src")
+  }
 });

package.json

@@ -6,11 +6,16 @@
     "prepare": "nitropack prepare",
     "dev": "nitropack dev",
     "build": "nitropack build",
+    "build:cloudflare": "NITRO_PRESET=cloudflare npm run build",
+    "build:aws": "NITRO_PRESET=aws_lambda npm run build",
+    "build:node": "NITRO_PRESET=node-server npm run build",
     "start": "node .output/server/index.mjs",
-    "lint": "eslint --ext .js src/",
+    "lint": "eslint --ext .ts src/",
-    "lint:fix": "eslint --fix --ext .js src/"
+    "lint:fix": "eslint --fix --ext .ts src/",
+    "preinstall": "npx only-allow pnpm"
   },
   "dependencies": {
+    "h3": "^1.8.1",
     "nitropack": "latest"
   },
   "devDependencies": {

src/routes/index.ts

@@ -1,4 +1,4 @@
-import { getProxyHeaders, getAfterResponseHeaders } from '../utils/headers';
+import { getProxyHeaders, getAfterResponseHeaders } from '@/utils/headers';
 
 export default defineEventHandler(async (event) => {
   // handle cors, if applicable
@@ -6,7 +6,14 @@ export default defineEventHandler(async (event) => {
 
   // parse destination URL
   const destination = getQuery<{ destination?: string }>(event).destination;
-  if (!destination) throw new Error('invalid destination');
+  if (!destination)
+    return sendJson({
+      event,
+      status: 400,
+      data: {
+        error: 'destination query parameter invalid',
+      },
+    });
 
   // proxy
   await proxyRequest(event, destination, {

src/utils/sending.ts

@@ -0,0 +1,11 @@
+import { H3Event, EventHandlerRequest } from 'h3';
+
+export function sendJson(ops: {
+  event: H3Event<EventHandlerRequest>;
+  data: Record<string, any>;
+  status?: number;
+}) {
+  setResponseStatus(ops.event, ops.status ?? 200);
+  appendResponseHeader(ops.event, 'content-type', 'application/json');
+  send(ops.event, JSON.stringify(ops.data, null, 2));
+}