feat: add guard (#2345)

midwayjs · Oct 6, 2022 · 1b952a1 · 1b952a1
1 parent a7c6e03
commit 1b952a1
Show file tree

Hide file tree

Showing 123 changed files with 694 additions and 173 deletions.
diff --git a/packages-legacy/egg-layer/jest.config.js b/packages-legacy/egg-layer/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-legacy/express-layer/jest.config.js b/packages-legacy/express-layer/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-legacy/koa-layer/jest.config.js b/packages-legacy/koa-layer/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-legacy/orm/jest.config.js b/packages-legacy/orm/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-legacy/runtime-engine/jest.config.js b/packages-legacy/runtime-engine/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-legacy/runtime-mock/jest.config.js b/packages-legacy/runtime-mock/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-legacy/serverless-app/jest.config.js b/packages-legacy/serverless-app/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-legacy/serverless-aws-starter/jest.config.js b/packages-legacy/serverless-aws-starter/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-legacy/serverless-fc-starter/jest.config.js b/packages-legacy/serverless-fc-starter/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-legacy/serverless-fc-trigger/jest.config.js b/packages-legacy/serverless-fc-trigger/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-legacy/serverless-scf-starter/jest.config.js b/packages-legacy/serverless-scf-starter/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-legacy/serverless-scf-trigger/jest.config.js b/packages-legacy/serverless-scf-trigger/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-legacy/serverless-vercel-starter/jest.config.js b/packages-legacy/serverless-vercel-starter/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-legacy/serverless-vercel-trigger/jest.config.js b/packages-legacy/serverless-vercel-trigger/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-legacy/serverless-worker-starter/jest.config.js b/packages-legacy/serverless-worker-starter/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: '@midwayjs/jest-environment-service-worker',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-legacy/static-layer/jest.config.js b/packages-legacy/static-layer/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-serverless/midway-fc-starter/jest.config.js b/packages-serverless/midway-fc-starter/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages-serverless/serverless-http-parser/jest.config.js b/packages-serverless/serverless-http-parser/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages/async-hooks-context-manager/jest.config.js b/packages/async-hooks-context-manager/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages/axios/jest.config.js b/packages/axios/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages/bootstrap/jest.config.js b/packages/bootstrap/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages/cache/jest.config.js b/packages/cache/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages/code-dye/jest.config.js b/packages/code-dye/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages/consul/jest.config.js b/packages/consul/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages/core/jest.config.js b/packages/core/jest.config.js
@@ -2,6 +2,6 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
-  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/', '<rootDir>/dist/'],
   setupFilesAfterEnv: ['./jest.setup.js'],
 };
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -8,7 +8,8 @@
     "build": "tsc",
     "test": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand",
     "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand --coverage --forceExit",
-    "link": "npm link"
+    "link": "npm link",
+    "madge": "madge --circular --extensions ts,tsx --exclude 'node_modules|test|dist' src"
   },
   "keywords": [
     "midway",

diff --git a/packages/core/src/baseFramework.ts b/packages/core/src/baseFramework.ts
@@ -9,10 +9,13 @@ import {
   MidwayProcessTypeEnum,
   CommonFilterUnion,
   MiddlewareRespond,
+  CommonGuardUnion,
+} from './interface';
+import {
   REQUEST_CTX_LOGGER_CACHE_KEY,
   ASYNC_CONTEXT_KEY,
   ASYNC_CONTEXT_MANAGER_KEY,
-} from './interface';
+} from './constants';
 import { Inject, Destroy, Init } from './decorator';
 import {
   ILogger,
@@ -29,13 +32,13 @@ import { ContextMiddlewareManager } from './common/middlewareManager';
 import { MidwayMiddlewareService } from './service/middlewareService';
 import { FilterManager } from './common/filterManager';
 import { MidwayMockService } from './service/mockService';
-
 import * as util from 'util';
 import {
   ASYNC_ROOT_CONTEXT,
   AsyncContextManager,
   NoopContextManager,
 } from './common/asyncContextManager';
+import { GuardManager } from './common/guardManager';
 const debug = util.debuglog('midway:debug');
 
 export abstract class BaseFramework<
@@ -55,6 +58,7 @@ export abstract class BaseFramework<
   protected contextLoggerFormat: LoggerContextFormat;
   protected middlewareManager = this.createMiddlewareManager();
   protected filterManager = this.createFilterManager();
+  protected guardManager = this.createGuardManager();
   protected composeMiddleware = null;
   protected bootstrapOptions: IMidwayBootstrapOptions;
   protected asyncContextManager: AsyncContextManager;
@@ -250,6 +254,10 @@ export abstract class BaseFramework<
         return this.createLogger(name, options);
       },
 
+      getFramework: () => {
+        return this;
+      },
+
       getProjectName: () => {
         return this.getProjectName();
       },
@@ -294,17 +302,24 @@ export abstract class BaseFramework<
       getAttr: <T>(key: string): T => {
         return this.getApplicationContext().getAttr(key);
       },
+
       useMiddleware: (
         middleware: CommonMiddlewareUnion<CTX, ResOrNext, Next>
       ) => {
         return this.useMiddleware(middleware);
       },
+
       getMiddleware: (): ContextMiddlewareManager<CTX, ResOrNext, Next> => {
         return this.getMiddleware();
       },
+
       useFilter: (Filter: CommonFilterUnion<CTX, ResOrNext, Next>) => {
         return this.useFilter(Filter);
       },
+
+      useGuard: (guard: CommonGuardUnion<CTX>) => {
+        return this.useGuard(guard);
+      },
     };
     for (const method of whiteList) {
       delete defaultApplicationProperties[method];
@@ -439,8 +454,20 @@ export abstract class BaseFramework<
     return this.middlewareManager;
   }
 
-  public useFilter(Filter: CommonFilterUnion<CTX, ResOrNext, Next>) {
-    return this.filterManager.useFilter(Filter);
+  public useFilter(filter: CommonFilterUnion<CTX, ResOrNext, Next>) {
+    return this.filterManager.useFilter(filter);
+  }
+
+  public useGuard(guards: CommonGuardUnion<CTX>) {
+    return this.guardManager.addGlobalGuard(guards);
+  }
+
+  public async runGuard(
+    ctx: CTX,
+    supplierClz: new (...args) => any,
+    methodName: string
+  ): Promise<boolean> {
+    return this.guardManager.runGuard(ctx, supplierClz, methodName);
   }
 
   protected createMiddlewareManager() {
@@ -450,4 +477,8 @@ export abstract class BaseFramework<
   protected createFilterManager() {
     return new FilterManager<CTX, ResOrNext, Next>();
   }
+
+  protected createGuardManager() {
+    return new GuardManager<CTX>();
+  }
 }
diff --git a/packages/core/src/common/dataSourceManager.ts b/packages/core/src/common/dataSourceManager.ts
@@ -6,7 +6,7 @@ import { MidwayCommonError, MidwayParameterError } from '../error';
 import { run } from '@midwayjs/glob';
 import { join } from 'path';
 import { Types } from '../util/types';
-import { DEFAULT_PATTERN, IGNORE_PATTERN } from '../interface';
+import { DEFAULT_PATTERN, IGNORE_PATTERN } from '../constants';
 
 export abstract class DataSourceManager<T> {
   protected dataSource: Map<string, T> = new Map();

diff --git a/packages/core/src/common/fileDetector.ts b/packages/core/src/common/fileDetector.ts
@@ -6,7 +6,7 @@ import {
 import { Types } from '../util/types';
 import { run } from '@midwayjs/glob';
 import { MidwayDuplicateClassNameError } from '../error';
-import { DEFAULT_PATTERN, IGNORE_PATTERN } from '../interface';
+import { DEFAULT_PATTERN, IGNORE_PATTERN } from '../constants';
 import { getProviderName } from '../decorator';
 
 export abstract class AbstractFileDetector<T> implements IFileDetector {

diff --git a/packages/core/src/common/guardManager.ts b/packages/core/src/common/guardManager.ts
@@ -0,0 +1,58 @@
+import { CommonGuardUnion, IGuard, IMidwayContext } from '../interface';
+import { getClassMetadata, getPropertyMetadata, GUARD_KEY } from '../decorator';
+
+export class GuardManager<
+  CTX extends IMidwayContext = IMidwayContext
+> extends Array<new (...args) => IGuard<any>> {
+  public addGlobalGuard(guards: CommonGuardUnion<CTX>) {
+    if (!Array.isArray(guards)) {
+      this.push(guards);
+    } else {
+      this.push(...guards);
+    }
+  }
+
+  public async runGuard(
+    ctx: CTX,
+    supplierClz: new (...args) => any,
+    methodName: string
+  ) {
+    // check global guard
+    for (const Guard of this) {
+      const guard = await ctx.requestContext.getAsync<IGuard<any>>(Guard);
+      const isPassed = await guard.canActivate(ctx, supplierClz, methodName);
+      if (!isPassed) {
+        return false;
+      }
+    }
+
+    // check class Guard
+    const classGuardList = getClassMetadata(GUARD_KEY, supplierClz);
+    if (classGuardList) {
+      for (const Guard of classGuardList) {
+        const guard = await ctx.requestContext.getAsync<IGuard<any>>(Guard);
+        const isPassed = await guard.canActivate(ctx, supplierClz, methodName);
+        if (!isPassed) {
+          return false;
+        }
+      }
+    }
+
+    // check method Guard
+    const methodGuardList = getPropertyMetadata(
+      GUARD_KEY,
+      supplierClz,
+      methodName
+    );
+    if (methodGuardList) {
+      for (const Guard of methodGuardList) {
+        const guard = await ctx.requestContext.getAsync<IGuard<any>>(Guard);
+        const isPassed = await guard.canActivate(ctx, supplierClz, methodName);
+        if (!isPassed) {
+          return false;
+        }
+      }
+    }
+    return true;
+  }
+}