Merge branch 'main' into docs

Author: Akshay-66

.github/README.cn.md

@@ -2,7 +2,7 @@
 <img src="/docs/images/gateway-border.png" width=350>
 
 <p align="right">
-<a href="./README.md">English</a>|<strong>中文</strong> 
+<a href="../README.md">English</a> | <strong>中文</strong> | <a href="./README.jp.md">日本語</a>
 </p>
 
 # AI Gateway
@@ -213,6 +213,7 @@ const client = new OpenAI({
 - 在 [Discord](https://portkey.ai/community) 上与我们实时交流
 - 在 [Twitter](https://twitter.com/PortkeyAI) 上关注我们
 - 在 [LinkedIn](https://www.linkedin.com/company/portkey-ai/) 上与我们建立联系
+- 阅读日文版文档 [日本語](./README.jp.md)
 
 <!-- - 在 [YouTube](https://www.youtube.com/channel/UCZph50gLNXAh1DpmeX8sBdw) 上访问我们 --> <!-- - 加入我们的 [Dev 社区](https://dev.to/portkeyai) --> <!-- - 在 [Stack Overflow](https://stackoverflow.com/questions/tagged/portkey) 上查看标记为 #portkey 的问题 -->
 

.github/README.jp.md

@@ -1,23 +1,29 @@
-name: Run Gateway tests
+name: Gateway Tests
 
 on:
-  pull_request:
-    types: [opened, synchronize, reopened]
+  issue_comment:
+    types: [created]
 
 jobs:
   gateway-tests:
+    if: ${{ github.event.issue.pull_request && contains(github.event.comment.body, 'run tests') }}
     runs-on: ubuntu-latest
     environment: production
     steps:
       - name: Checkout head
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
+
       - name: Install dependencies
         run: npm ci
+
       - name: Build
         run: npm run build
+
       - name: Start gateway and run tests
+        id: run-tests
+        continue-on-error: true
         run: |
           npm run build/start-server.js &
           echo "Waiting for gateway to start..."
@@ -27,6 +33,43 @@ jobs:
           echo "Gateway is ready. Running tests..."
           npm run test:gateway
 
+      - name: Update PR Check
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          script: |
+            const { owner, repo } = context.repo;
+            const issue_number = context.issue.number;
+            
+            try {
+              const { data: pull_request } = await github.rest.pulls.get({
+                owner,
+                repo,
+                pull_number: issue_number,
+              });
+              
+              const sha = pull_request.head.sha;
+              
+              await github.rest.checks.create({
+                owner,
+                repo,
+                name: 'Gateway Tests (Comment Triggered)',
+                head_sha: sha,
+                status: 'completed',
+                conclusion: '${{ steps.run-tests.outcome }}',
+                output: {
+                  title: 'Gateway Test Results',
+                  summary: 'Gateway tests have completed.',
+                  text: 'These tests were triggered by a comment on the PR.'
+                },
+              });
+              
+              console.log('Check run created successfully');
+            } catch (error) {
+              console.error('Error creating check run:', error);
+              core.setFailed(`Action failed with error: ${error}`);
+            }
+
 env:
   OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
   COHERE_API_KEY: ${{ secrets.COHERE_API_KEY }}

.github/workflows/run_tests.yml

@@ -1,7 +1,7 @@
 <div align="center">
 
 <p align="right">
-   <strong>English</strong> | <a href="./.github/README.cn.md">中文</a> 
+   <strong>English</strong> | <a href="./.github/README.cn.md">中文</a> | <a href="./.github/README.jp.md">日本語</a>
 </p>
 
 
@@ -289,6 +289,7 @@ Join our growing community around the world, for help, ideas, and discussions on
 - Chat with us on [Discord](https://portkey.ai/community)
 - Follow us on [Twitter](https://twitter.com/PortkeyAI)
 - Connect with us on [LinkedIn](https://www.linkedin.com/company/portkey-ai/)
+- Read the documentation in [Japanese](./.github/README.jp.md)
 <!-- - Visit us on [YouTube](https://www.youtube.com/channel/UCZph50gLNXAh1DpmeX8sBdw) -->
 <!-- - Join our [Dev community](https://dev.to/portkeyai) -->
 <!-- - Questions tagged #portkey on [Stack Overflow](https://stackoverflow.com/questions/tagged/portkey) -->

README.md

@@ -1,6 +1,6 @@
 {
   "name": "@portkey-ai/gateway",
-  "version": "1.8.0",
+  "version": "1.8.1",
   "description": "A fast AI gateway by Portkey",
   "repository": {
     "type": "git",
@@ -42,11 +42,13 @@
   "dependencies": {
     "@aws-crypto/sha256-js": "^5.2.0",
     "@hono/node-server": "^1.3.3",
+    "@hono/node-ws": "^1.0.4",
     "@portkey-ai/mustache": "^2.1.2",
     "@smithy/signature-v4": "^2.1.1",
     "@types/mustache": "^4.2.5",
     "async-retry": "^1.3.3",
-    "hono": "^3.12.0",
+    "hono": "^4.6.10",
+    "ws": "^8.18.0",
     "zod": "^3.22.4"
   },
   "devDependencies": {
@@ -57,6 +59,7 @@
     "@types/async-retry": "^1.4.5",
     "@types/jest": "^29.5.12",
     "@types/node": "20.8.3",
+    "@types/ws": "^8.5.12",
     "husky": "^9.1.4",
     "jest": "^29.7.0",
     "prettier": "3.2.5",

package-lock.json

@@ -10,6 +10,7 @@ import { handler as logHandler } from './log';
 import { handler as allUppercaseHandler } from './alluppercase';
 import { handler as endsWithHandler } from './endsWith';
 import { handler as allLowerCaseHandler } from './alllowercase';
+import { handler as modelWhitelistHandler } from './modelWhitelist';
 
 import { z } from 'zod';
 import { PluginContext, PluginParameters } from '../types';
@@ -802,3 +803,36 @@ describe('allLowercase handler', () => {
     expect(result.verdict).toBe(false);
   });
 });
+
+describe('modelWhitelist handler', () => {
+  it('should return true verdict when the model requested is part of the whitelist', async () => {
+    const context: PluginContext = {
+      request: { json: { model: 'gemini-1.5-flash-001' } },
+    };
+
+    const parameters: PluginParameters = {
+      models: ['gemini-1.5-flash-001'],
+    };
+    const eventType = 'beforeRequestHook';
+
+    const result = await modelWhitelistHandler(context, parameters, eventType);
+
+    expect(result.error).toBe(null);
+    expect(result.verdict).toBe(true);
+  });
+  it('should return false verdict when the model requested is not part of the whitelist', async () => {
+    const context: PluginContext = {
+      request: { json: { model: 'gemini-1.5-pro-001' } },
+    };
+
+    const parameters: PluginParameters = {
+      models: ['gemini-1.5-flash-001'],
+    };
+    const eventType = 'beforeRequestHook';
+
+    const result = await modelWhitelistHandler(context, parameters, eventType);
+
+    expect(result.error).toBe(null);
+    expect(result.verdict).toBe(false);
+  });
+});

package.json

@@ -475,6 +475,37 @@
         }
       ],
       "parameters": {}
+    },
+    {
+      "name": "Model whitelisting",
+      "id": "modelwhitelist",
+      "type": "guardrail",
+      "supportedHooks": ["beforeRequestHook"],
+      "description": [
+        {
+          "type": "subHeading",
+          "text": "Check if the model in the request is part of the allowed model list."
+        }
+      ],
+      "parameters": {
+        "type": "object",
+        "properties": {
+          "models": {
+            "type": "array",
+            "label": "Model list",
+            "description": [
+              {
+                "type": "subHeading",
+                "text": "Enter the allowed models."
+              }
+            ],
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "required": ["models"]
+      }
     }
   ]
 }

plugins/default/default.test.ts

@@ -0,0 +1,25 @@
+import {
+  HookEventType,
+  PluginContext,
+  PluginHandler,
+  PluginParameters,
+} from '../types';
+
+export const handler: PluginHandler = async (
+  context: PluginContext,
+  parameters: PluginParameters,
+  eventType: HookEventType
+) => {
+  let error = null;
+  let verdict = false;
+
+  try {
+    const modelList = parameters.models;
+    let requestModel = context.request?.json.model;
+    verdict = modelList.includes(requestModel);
+  } catch (e) {
+    error = e as Error;
+  }
+
+  return { error, verdict };
+};

plugins/default/manifest.json

@@ -12,6 +12,7 @@ import { handler as defaultcontainsCode } from './default/containsCode';
 import { handler as defaultalluppercase } from './default/alluppercase';
 import { handler as defaultalllowercase } from './default/alllowercase';
 import { handler as defaultendsWith } from './default/endsWith';
+import { handler as defaultmodelWhitelist } from './default/modelWhitelist';
 import { handler as portkeymoderateContent } from './portkey/moderateContent';
 import { handler as portkeylanguage } from './portkey/language';
 import { handler as portkeypii } from './portkey/pii';
@@ -48,6 +49,7 @@ export const plugins = {
     alluppercase: defaultalluppercase,
     alllowercase: defaultalllowercase,
     endsWith: defaultendsWith,
+    modelWhitelist: defaultmodelWhitelist,
   },
   portkey: {
     moderateContent: portkeymoderateContent,