tachybase_todo/packages/plugins/@nocobase/plugin-verification/src/server/Plugin.ts
ChengLei Shao 261d4c4137
refactor: establish a sound testing system (#3179)
* chore: use vitest to replace jest

* chore: support vitest

* feat: vitest 1.0

* fix: test

* chore: yarn.lock

* chore: github actions

* fix: test

* fix: test

* fix: test

* fix: test

* fix: jest.fn

* fix: require

* fix: test

* fix: build

* fix: test

* fix: test

* fix: test

* fix: test

* fix: test

* fix: test

* fix: test

* fix: dynamic import

* fix: bug

* chore: yarn run test command

* chore: package.json

* chore: package.json

* chore: vite 5

* fix: fix variable test

* fix: import json

* feat: initEnv

* fix: env.APP_ENV_PATH

* chore: get package json

* fix: remove GlobalThmeProvider

* chore: update snap

* chore: test env

* chore: test env

* chore: import module

* chore: jest

* fix: load package json

* chore: test

* fix: bug

* chore: test

* chore: test

* chore: test

* chore: test

* chore: test

* fix: import file in windows

* chore: import module with absolute file path

* fix: test error

* test: update snapshot

* chore: update yarn.lock

* fix: front-end tests do not include utils folder

* refactor: use vitest-dom

* fix: fix build

* fix: test error

* fix: change to vitest.config.mts

* fix: types error

* fix: types error

* fix: types error

* fix: error

* fix: test

* chore: test

* fix: test package

* feat: update dependencies

* refactor: test

* fix: error

* fix: error

* fix: __dirname is not defined in ES module scope

* fix: allow only

* fix: error

* fix: error

* fix: error

* fix: create-app

* fix: install-deps

* feat: update docs

---------

Co-authored-by: chenos <chenlinxh@gmail.com>
Co-authored-by: dream2023 <1098626505@qq.com>
Co-authored-by: Zeke Zhang <958414905@qq.com>
2023-12-21 20:39:11 +08:00

163 lines
4.4 KiB
TypeScript

import path from 'path';
import { Context } from '@nocobase/actions';
import { Op } from '@nocobase/database';
import { HandlerType } from '@nocobase/resourcer';
import { Plugin } from '@nocobase/server';
import { Registry } from '@nocobase/utils';
import { Provider, namespace } from '.';
import initActions from './actions';
import { CODE_STATUS_UNUSED, CODE_STATUS_USED, PROVIDER_TYPE_SMS_ALIYUN } from './constants';
import { zhCN } from './locale';
import initProviders from './providers';
export interface Interceptor {
manual?: boolean;
expiresIn?: number;
getReceiver(ctx): string;
getCode?(ctx): string;
validate?(ctx: Context, receiver: string): boolean | Promise<boolean>;
}
export default class VerificationPlugin extends Plugin {
providers: Registry<typeof Provider> = new Registry();
interceptors: Registry<Interceptor> = new Registry();
intercept: HandlerType = async (context, next) => {
const { resourceName, actionName, values } = context.action.params;
const key = `${resourceName}:${actionName}`;
const interceptor = this.interceptors.get(key);
if (!interceptor) {
return context.throw(400);
}
const receiver = interceptor.getReceiver(context);
const content = interceptor.getCode ? interceptor.getCode(context) : values.code;
if (!receiver || !content) {
return context.throw(400);
}
// check if code match, then call next
// find the code based on action params
const VerificationRepo = this.db.getRepository('verifications');
const item = await VerificationRepo.findOne({
filter: {
receiver,
type: key,
content,
expiresAt: {
[Op.gt]: new Date(),
},
status: CODE_STATUS_UNUSED,
},
});
if (!item) {
return context.throw(400, {
code: 'InvalidVerificationCode',
message: context.t('Verification code is invalid', { ns: namespace }),
});
}
// TODO: code should be removed if exists in values
// context.action.mergeParams({
// values: {
// }
// });
try {
await next();
} finally {
// or delete
await item.update({
status: CODE_STATUS_USED,
});
}
};
async install() {
const {
DEFAULT_SMS_VERIFY_CODE_PROVIDER,
INIT_ALI_SMS_ACCESS_KEY,
INIT_ALI_SMS_ACCESS_KEY_SECRET,
INIT_ALI_SMS_ENDPOINT = 'dysmsapi.aliyuncs.com',
INIT_ALI_SMS_VERIFY_CODE_TEMPLATE,
INIT_ALI_SMS_VERIFY_CODE_SIGN,
} = process.env;
if (
DEFAULT_SMS_VERIFY_CODE_PROVIDER &&
INIT_ALI_SMS_ACCESS_KEY &&
INIT_ALI_SMS_ACCESS_KEY_SECRET &&
INIT_ALI_SMS_VERIFY_CODE_TEMPLATE &&
INIT_ALI_SMS_VERIFY_CODE_SIGN
) {
const ProviderRepo = this.db.getRepository('verifications_providers');
const existed = await ProviderRepo.count({
filterByTk: DEFAULT_SMS_VERIFY_CODE_PROVIDER,
});
if (existed) {
return;
}
await ProviderRepo.create({
values: {
id: DEFAULT_SMS_VERIFY_CODE_PROVIDER,
type: PROVIDER_TYPE_SMS_ALIYUN,
title: 'Default SMS sender',
options: {
accessKeyId: INIT_ALI_SMS_ACCESS_KEY,
accessKeySecret: INIT_ALI_SMS_ACCESS_KEY_SECRET,
endpoint: INIT_ALI_SMS_ENDPOINT,
sign: INIT_ALI_SMS_VERIFY_CODE_SIGN,
template: INIT_ALI_SMS_VERIFY_CODE_TEMPLATE,
},
default: true,
},
});
}
}
async load() {
const { app, db, options } = this;
app.i18n.addResources('zh-CN', namespace, zhCN);
await this.importCollections(path.resolve(__dirname, 'collections'));
await initProviders(this);
initActions(this);
// add middleware to action
app.resourcer.use(async (context, next) => {
const { resourceName, actionName, values } = context.action.params;
const key = `${resourceName}:${actionName}`;
const interceptor = this.interceptors.get(key);
if (!interceptor || interceptor.manual) {
return next();
}
return this.intercept(context, next);
});
app.acl.allow('verifications', 'create', 'public');
this.app.acl.registerSnippet({
name: `pm.${this.name}.providers`,
actions: ['verifications_providers:*'],
});
}
async getDefault() {
const providerRepo = this.db.getRepository('verifications_providers');
return providerRepo.findOne({
filter: {
default: true,
},
});
}
}