Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: service factory client & clients merge #2248

Merged
merged 6 commits into from
Aug 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions packages/axios/src/configuration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,19 @@ import { HttpServiceFactory } from './serviceManager';
},
},
],
importConfigFilter: config => {
if (config['axios']) {
if (!config['axios']['clients'] || !config['axios']['client']) {
config['axios'] = {
default: {},
clients: {
default: config['axios'],
},
};
}
}
return config;
},
})
export class AxiosConfiguration {
async onReady(container) {
Expand Down
5 changes: 4 additions & 1 deletion packages/axios/src/serviceManager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {
Scope,
ScopeEnum,
} from '@midwayjs/decorator';
import { ServiceFactory } from '@midwayjs/core';
import { MidwayCommonError, ServiceFactory } from '@midwayjs/core';
import { AxiosHttpService } from './interface';

@Provide()
Expand Down Expand Up @@ -57,6 +57,9 @@ export class HttpService implements AxiosHttpService {
@Init()
protected async init() {
this.instance = this.serviceFactory.get('default');
if (!this.instance) {
throw new MidwayCommonError('axios default instance not found.');
}
}

getUri(config?: AxiosRequestConfig): string {
Expand Down
15 changes: 6 additions & 9 deletions packages/core/src/common/serviceFactory.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import * as assert from 'assert';
import { extend } from '../util/extend';

/**
Expand All @@ -10,18 +9,16 @@ export abstract class ServiceFactory<T> {

protected async initClients(options: any = {}): Promise<void> {
this.options = options;
assert(
!(options.client && options.clients),
`midway:${this.getName()} can not set options.client and options.clients both`
);

// alias app[name] as client, but still support createInstance method
// merge options.client to options.clients['default']
if (options.client) {
await this.createInstance(options.client, 'default');
return;
options.clients = options.clients || {};
options.clients['default'] = options.clients['default'] || {};
extend(true, options.clients['default'], options.client);
delete options.client;
}

// multi client, use app[name].getInstance(id)
// multi client
if (options.clients) {
for (const id of Object.keys(options.clients)) {
await this.createInstance(options.clients[id], id);
Expand Down
9 changes: 7 additions & 2 deletions packages/core/src/service/configService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export class MidwayConfigService implements IConfigService {
unittest: 'test',
};
private configMergeOrder: Array<ConfigMergeInfo> = [];
protected configuration;
protected configuration = {};
protected isReady = false;
protected externalObject: Record<string, unknown>[] = [];
protected appInfo: MidwayAppInfo;
Expand Down Expand Up @@ -187,6 +187,11 @@ export class MidwayConfigService implements IConfigService {
for (let externalObject of this.externalObject) {
if (externalObject) {
externalObject = this.runWithFilter(externalObject);
if (!externalObject) {
debug('[config]: Filter config and got undefined will be drop it');
continue;
}

debug('[config]: Loaded external object %j', externalObject);
extend(true, target, externalObject);
this.configMergeOrder.push({
Expand Down Expand Up @@ -236,7 +241,7 @@ export class MidwayConfigService implements IConfigService {
}

public clearAllConfig() {
this.configuration.clear();
this.configuration = {};
}

public clearConfigMergeOrder() {
Expand Down
14 changes: 0 additions & 14 deletions packages/core/test/common/serviceFactory.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,18 +59,4 @@ describe('test/common/serviceFactory.test.ts', () => {
});
expect(instance.get('default')).toBeDefined();
});

it('should config must with client or clients', async () => {
const instance = new TestServiceFactory();
let err;
try {
await instance.initClients({
client: {},
clients: {}
});
} catch (e) {
err = e;
}
expect(err).toBeDefined();
});
});
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { MidwayError, registerErrorCode } from '../src';
import { MidwayError, MidwayHttpError, registerErrorCode } from '../../src';

describe('/test/error.test.ts', function () {
describe('/test/error/error.test.ts', function () {
it('should test base error', function () {
expect(() => {
throw new MidwayError('custom error');
Expand Down Expand Up @@ -46,4 +46,29 @@ describe('/test/error.test.ts', function () {
} as const);
}).toThrowError(MidwayError);
});

it('should test http error', function () {
expect(() => {
throw new MidwayHttpError('custom error', 302);
}).toThrowError(MidwayHttpError);
});

it('should test http error with err obj', function () {
const err = new Error('custom message');
expect(() => {
throw new MidwayHttpError(err, 302);
}).toThrowError(/custom message/);
});

it('should test with options', function () {
const cause = new Error('custom');
const err = new MidwayError('custom error', {
status: 10,
cause,
});

expect(() => {
throw err;
}).toThrowError(/custom error/);
});
});
69 changes: 69 additions & 0 deletions packages/core/test/error/http.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
import { httpError } from '../../src';

describe('test/error/http.test.ts', function () {
it('should test throw http error', function () {
expect(() => {
throw new httpError.BadRequestError();
}).toThrowError(httpError.BadRequestError);

expect(() => {
throw new httpError.UnauthorizedError();
}).toThrowError(httpError.UnauthorizedError);

expect(() => {
throw new httpError.NotFoundError();
}).toThrowError(httpError.NotFoundError);

expect(() => {
throw new httpError.ForbiddenError();
}).toThrowError(httpError.ForbiddenError);

expect(() => {
throw new httpError.NotAcceptableError();
}).toThrowError(httpError.NotAcceptableError);

expect(() => {
throw new httpError.RequestTimeoutError();
}).toThrowError(httpError.RequestTimeoutError);

expect(() => {
throw new httpError.ConflictError();
}).toThrowError(httpError.ConflictError);

expect(() => {
throw new httpError.GoneError();
}).toThrowError(httpError.GoneError);

expect(() => {
throw new httpError.PayloadTooLargeError();
}).toThrowError(httpError.PayloadTooLargeError);

expect(() => {
throw new httpError.UnsupportedMediaTypeError();
}).toThrowError(httpError.UnsupportedMediaTypeError);

expect(() => {
throw new httpError.UnprocessableEntityError();
}).toThrowError(httpError.UnprocessableEntityError);

expect(() => {
throw new httpError.InternalServerErrorError();
}).toThrowError(httpError.InternalServerErrorError);

expect(() => {
throw new httpError.NotImplementedError();
}).toThrowError(httpError.NotImplementedError);

expect(() => {
throw new httpError.BadGatewayError();
}).toThrowError(httpError.BadGatewayError);

expect(() => {
throw new httpError.ServiceUnavailableError();
}).toThrowError(httpError.ServiceUnavailableError);

expect(() => {
throw new httpError.GatewayTimeoutError();
}).toThrowError(httpError.GatewayTimeoutError);
})
});
36 changes: 33 additions & 3 deletions packages/core/test/service/configService.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -257,10 +257,40 @@ describe('/test/service/configService.test.ts', () => {
await cfg.load();

expect(cfg.getConfiguration().bb).toEqual('111');
});

cfg.addObject({bb: 333, cc: 222});
it('should test config filter and test return undefined', async () => {
const cfg = await createConfigService();

expect(cfg.getConfiguration().bb).toEqual('111');
expect(cfg.getConfiguration().cc).toEqual(222);
cfg.addFilter((config) => {
if(config['key']) {
return undefined;
}
return config;
});

cfg.add([
{
default: {
key: 111,
}
}
]);

await cfg.load();

cfg.addObject({bb: 222});

expect(cfg.getConfiguration().bb).toEqual(222);
expect(cfg.getConfiguration().key).toEqual(undefined);
});

it('should clear all config', async () => {
const cfg = new MidwayConfigService();
cfg['isReady'] = true;
cfg.addObject({bb: 222});
expect(Object.keys(cfg.getConfiguration()).length).toEqual(1);
cfg.clearAllConfig();
expect(Object.keys(cfg.getConfiguration()).length).toEqual(0);
});
});
10 changes: 8 additions & 2 deletions packages/cos/src/manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ import {
Scope,
ScopeEnum,
} from '@midwayjs/decorator';
import { ServiceFactory, delegateTargetPrototypeMethod } from '@midwayjs/core';
import {
ServiceFactory,
delegateTargetPrototypeMethod,
MidwayCommonError,
} from '@midwayjs/core';
import * as assert from 'assert';
import * as COS from 'cos-nodejs-sdk-v5';

Expand Down Expand Up @@ -46,12 +50,14 @@ export class COSService implements COS {
@Inject()
private serviceFactory: COSServiceFactory;

// @ts-expect-error used
private instance: COS;

@Init()
async init() {
this.instance = this.serviceFactory.get('default');
if (!this.instance) {
throw new MidwayCommonError('cos default instance not found.');
}
}
}

Expand Down
8 changes: 8 additions & 0 deletions packages/cos/test/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,12 @@ describe('/test/index.test.ts', () => {
expect(cosService).toBeDefined();
await close(app);
});

it('should throw error when instance not found', async () => {
await expect(async () => {
const service = new COSService();
(service as any).serviceFactory = new Map();
await service.init();
}).rejects.toThrowError(/instance not found/);
});
});
5 changes: 4 additions & 1 deletion packages/mongoose/src/manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import {
DataSourceManager,
delegateTargetMethod,
delegateTargetProperties,
MidwayCommonError,
} from '@midwayjs/core';
import {
Config,
Expand Down Expand Up @@ -128,12 +129,14 @@ export class MongooseConnectionService implements mongoose.Connection {
@Inject()
private mongooseDataSourceManager: MongooseDataSourceManager;

// @ts-expect-error used
private instance: mongoose.Connection;

@Init()
async init() {
this.instance = this.mongooseDataSourceManager.getDataSource('default');
if (!this.instance) {
throw new MidwayCommonError('mongoose default instance not found.');
}
}
}

Expand Down
10 changes: 10 additions & 0 deletions packages/mongoose/test/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,14 @@ describe('/test/index.test.ts', () => {
console.log(doc.email);
await close(app);
});

it('should throw error when instance not found', async () => {
await expect(async () => {
const service = new MongooseConnectionService();
(service as any).mongooseDataSourceManager = {
getDataSource() {}
}
await service.init();
}).rejects.toThrowError(/instance not found/);
});
});
13 changes: 11 additions & 2 deletions packages/oss/src/manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ import {
} from '@midwayjs/decorator';
import * as OSS from 'ali-oss';
import * as assert from 'assert';
import { ServiceFactory, delegateTargetPrototypeMethod } from '@midwayjs/core';
import {
ServiceFactory,
delegateTargetPrototypeMethod,
MidwayCommonError,
} from '@midwayjs/core';
import type {
OSSServiceFactoryReturnType,
MWOSSClusterOptions,
Expand Down Expand Up @@ -72,12 +76,14 @@ export class OSSService implements OSS {
@Inject()
private serviceFactory: OSSServiceFactory<OSS>;

// @ts-expect-error used
private instance: OSS;

@Init()
async init() {
this.instance = this.serviceFactory.get('default');
if (!this.instance) {
throw new MidwayCommonError('oss default instance not found.');
}
}
}

Expand All @@ -99,6 +105,9 @@ export class OSSSTSService implements OSS.STS {
@Init()
async init() {
this.instance = this.serviceFactory.get('default');
if (!this.instance) {
throw new MidwayCommonError('oss sts default instance not found.');
}
}

async assumeRole(
Expand Down
Loading