✨ feat: support node runtime

arvinxx · arvinxx · commit a8e293316fc5 · 2023-12-13T22:29:41.000+08:00
diff --git a/api/v1/edge.ts b/api/v1/edge.ts
@@ -0,0 +1,7 @@
+import { createGatewayOnEdgeRuntime } from '../../src';
+
+export const config = {
+  runtime: 'edge',
+};
+
+export default createGatewayOnEdgeRuntime();
diff --git a/api/v1/node.ts b/api/v1/node.ts
@@ -0,0 +1,3 @@
+import { createGatewayOnNodeRuntime } from '../../src';
+
+export default createGatewayOnNodeRuntime();
diff --git a/api/v1/runner.ts b/api/v1/runner.ts
@@ -1,7 +1,7 @@
-import { createLobeChatPluginGateway } from '../../src';
+import { createGatewayOnEdgeRuntime } from '../../src';
 
 export const config = {
   runtime: 'edge',
 };
 
-export default createLobeChatPluginGateway();
+export default createGatewayOnEdgeRuntime();
diff --git a/package.json b/package.json
@@ -50,9 +50,11 @@
     "not ie <= 10"
   ],
   "dependencies": {
+    "@babel/runtime": "^7",
     "@cfworker/json-schema": "^1",
-    "@lobehub/chat-plugin-sdk": "latest",
-    "swagger-client": "^3.24.5",
+    "@lobehub/chat-plugin-sdk": "^1",
+    "ajv": "^8",
+    "swagger-client": "^3",
     "zod": "^3"
   },
   "devDependencies": {
@@ -71,7 +73,7 @@
     "remark-cli": "^11",
     "semantic-release": "^21",
     "typescript": "^5",
-    "vercel": "^28.20.0",
+    "vercel": "^32.7.1",
     "vitest": "0.34.6"
   },
   "publishConfig": {
diff --git a/src/gateway.ts b/src/gateway.ts
@@ -1,7 +1,8 @@
 // reason to use cfworker json schema:
 // https://github.com/vercel/next.js/discussions/47063#discussioncomment-5303951
-import { Validator } from '@cfworker/json-schema';
+import { Schema } from '@cfworker/json-schema';
 import {
+  IPluginErrorType,
   LobeChatPluginApi,
   LobeChatPluginManifest,
   LobeChatPluginsMarketIndex,
@@ -13,11 +14,15 @@ import {
   pluginMetaSchema,
   pluginRequestPayloadSchema,
 } from '@lobehub/chat-plugin-sdk';
-import { IPluginErrorType } from '@lobehub/chat-plugin-sdk/lib/error';
+// @ts-ignore
+import SwaggerClient from 'swagger-client';
 
 export const DEFAULT_PLUGINS_INDEX_URL = 'https://chat-plugins.lobehub.com';
 
+type IValidator = (schema: Schema, value: any) => { errors?: any; valid: boolean };
+
 export interface GatewayOptions {
+  Validator?: IValidator;
   /**
    * @default https://chat-plugins.lobehub.com
    */
@@ -33,23 +38,40 @@ export interface GatewayErrorResponse {
   errorType: IPluginErrorType;
   success: false;
 }
+
 export class Gateway {
   private pluginIndexUrl = DEFAULT_PLUGINS_INDEX_URL;
+  private _validator: IValidator | undefined;
 
   constructor(options?: GatewayOptions) {
     if (options?.pluginsIndexUrl) {
       this.pluginIndexUrl = options.pluginsIndexUrl;
     }
+    if (options?.Validator) {
+      this._validator = options.Validator;
+    }
   }
 
-  createSuccessResponse = (data: string) => {
+  private createSuccessResponse = (data: string) => {
     return { data, success: true } as const;
   };
 
-  createErrorResponse = (errorType: IPluginErrorType | string, body?: string | object) => {
+  private createErrorResponse = (errorType: IPluginErrorType | string, body?: string | object) => {
     throw { body, errorType, success: false };
   };
 
+  private async validate(schema: Schema, value: any) {
+    if (this._validator) return this._validator(schema, value);
+
+    // reason to use cfworker json schema:
+    // https://github.com/vercel/next.js/discussions/47063#discussioncomment-5303951
+    const { Validator } = await import('@cfworker/json-schema');
+    const v = new Validator(schema);
+    const validator = v.validate(value);
+    if (!validator.valid) return { errors: validator.errors, valid: false };
+    return { valid: true };
+  }
+
   execute = async (
     payload: PluginRequestPayload,
     settings?: any,
@@ -164,11 +186,11 @@ export class Gateway {
     // ==========  6. 校验是否按照 manifest 包含了 settings 配置 ========== //
 
     if (manifest.settings) {
-      const v = new Validator(manifest.settings as any);
-      const validator = v.validate(settings || {});
-      if (!validator.valid)
+      const { valid, errors } = await this.validate(manifest.settings as any, settings || {});
+
+      if (!valid)
         return this.createErrorResponse(PluginErrorType.PluginSettingsInvalid, {
-          error: validator.errors,
+          error: errors,
           message: '[plugin] your settings is invalid with plugin manifest setting schema',
           settings,
         });
@@ -188,14 +210,13 @@ export class Gateway {
       });
 
     if (args) {
-      const v = new Validator(api.parameters as any);
       const params = JSON.parse(args!);
-      const validator = v.validate(params);
+      const { valid, errors } = await this.validate(api.parameters as any, params);
 
-      if (!validator.valid)
+      if (!valid)
         return this.createErrorResponse(PluginErrorType.PluginApiParamsError, {
           api,
-          error: validator.errors,
+          error: errors,
           message: '[plugin] args is invalid with plugin manifest api schema',
           request: params,
         });
@@ -247,7 +268,7 @@ export class Gateway {
     const { arguments: args, apiName } = payload;
 
     // @ts-ignore
-    const { default: SwaggerClient } = await import('swagger-client');
+    // const { default: SwaggerClient } = await import('swagger-client');
 
     const authorizations = {} as {
       [key: string]: any;
diff --git a/src/index.ts b/src/index.ts
@@ -1,5 +1,10 @@
 export {
   createGatewayOnEdgeRuntime,
+  /**
+   * please use `createGatewayOnEdgeRuntime` instead
+   * @deprecated
+   */
   createGatewayOnEdgeRuntime as createLobeChatPluginGateway,
 } from './edge';
 export * from './gateway';
+export * from './node';
diff --git a/src/node.ts b/src/node.ts
@@ -0,0 +1,54 @@
+import {
+  PluginErrorType,
+  PluginRequestPayload,
+  getPluginErrorStatus,
+  getPluginSettingsFromHeaders,
+} from '@lobehub/chat-plugin-sdk';
+import { VercelRequest, VercelResponse } from '@vercel/node';
+import Ajv from 'ajv';
+
+import { Gateway, GatewayErrorResponse, GatewayOptions } from './gateway';
+
+export type NodeRuntimeGatewayOptions = Pick<GatewayOptions, 'pluginsIndexUrl'>;
+
+export const createGatewayOnNodeRuntime = (options: NodeRuntimeGatewayOptions = {}) => {
+  const gateway = new Gateway({
+    ...options,
+    Validator: (schema, value) => {
+      const ajv = new Ajv();
+      const validate = ajv.compile(schema);
+
+      const valid = validate(value);
+      return {
+        errors: validate.errors,
+        valid,
+      };
+    },
+  });
+
+  return async (req: VercelRequest, res: VercelResponse) => {
+    // ==========  1. 校验请求方法 ========== //
+    if (req.method !== 'POST') {
+      res.status(PluginErrorType.MethodNotAllowed).send({
+        message: '[gateway] only allow POST method',
+      });
+
+      return;
+    }
+
+    const requestPayload = req.body as PluginRequestPayload;
+
+    const settings = getPluginSettingsFromHeaders(req.headers as any);
+
+    try {
+      const { data } = await gateway.execute(requestPayload, settings);
+
+      res.send(data);
+    } catch (error) {
+      console.log(error);
+      const { errorType, body } = error as GatewayErrorResponse;
+
+      res.status(getPluginErrorStatus(errorType)).send({ body, errorType });
+    }
+  };
+};
diff --git a/tests/gateway.test.ts b/tests/gateway.test.ts
@@ -0,0 +1,10 @@
+import { Gateway } from '@lobehub/chat-plugins-gateway';
+import { describe, expect, it } from 'vitest';
+
+describe('Gateway', () => {
+  it('should init with pluginIndexUrl', () => {
+    const gateway = new Gateway({ pluginsIndexUrl: 'https://test-market-index-url.com' });
+
+    expect(gateway['pluginIndexUrl']).toBe('https://test-market-index-url.com');
+  });
+});

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { createGatewayOnNodeRuntime } from '../../src';`
	`2`	`+`
	`3`	`+export default createGatewayOnNodeRuntime();`