loopback4-dynamic-datasource

This is a loopback 4 extension to connect dynamic datasources runtime. In todays world there can be a use case of multi tenant system in which we need the physical seperation of the databses so in loopback we need to connect to those datasources runtime and maintain and reuse those connection.

Install

npm install loopback4-dynamic-datasource

Usage

In order to use this component into your LoopBack application, please follow below steps.

• Add component to application.

this.component(Loopback4DynamicDatasourceComponent);

• Now add action provider to the action based sequence (This step is not required in case of middleware based sequence)

export class MySequence implements SequenceHandler {

    constructor(
        ...
        @inject(DynamicDatasourceBindings.DYNAMIC_DATASOURCE_ACTION)
        private readonly setupDatasource: SetupDatasourceFn,
        ...
    ) {}

    async handle(context: RequestContext) {
        const requestTime = Date.now();
        try {
            ...
            await this.setupDatasource(context);
            ...
        } catch (err) {
            this.reject(context, err);
        }
    }

}

• Now write a datasource identifier provider that is used to identify runtime which source we need to connect. In below example getting the identifier from the tenantId coming in query of the request.

import {DatasourceIdentifierFn} from 'loopback4-dynamic-datasouce';

export class CustomDatasourceIdentifierProvider implements Provider {
    constructor() {
    }

    value(): DatasourceIdentifierFn {
        return async (requestCtx) => {
            const tenantId = requestCtx.request.query['tenantId'] as string;
            return tenantId == null ? null : {id: tenantId};
        };
    }
}

Now bind that provider in application.ts

this.bind(DynamicDatasourceBindings.DATASOURCE_IDENTIFIER_PROVIDER).toProvider(CustomDatasourceIdentifierProvider); 

• Now write a datasource provider to get datasources runtime. these datasource will be created runtime on require basis

export class CustomDatasourceProvider implements Provider {
    constructor(
        @repository(TenantRepository)
        private tenantRepo: TenantRepository,
    ) {
    }

    value(): DatasourceProviderFn {
        return async (datasourceIdentifier) => {
            return {
                pgdb: async () => {
                    const tenantData = await this.tenantRepo.findById(datasourceIdentifier.id);
                    return new juggler.DataSource({
                        ...tenantData.dbConfig,
                    });
                }
            }
        }
    }
}

Now bind that provider in application.ts

this.bind(DynamicDatasourceBindings.DATASOURCE_PROVIDER).toProvider(CustomDatasourceProvider);

Note:- connector of following datasource should be present in package.json like in this example we are using loopback-connector-postgresql

Now return of this provider is an object where you can give as many keys you want but that should return juggler.Datasource This is used as the intention of connecting multiple datasource for tenant. pgdb this key is custom and it can be used as per your choice but your repository must use specified key in injection

export class UserRepository extends DefaultCrudRepository {
    constructor(
        @inject('datasources.pgdb') dataSource: JugglerDataSource,
    ) {
        super(User, dataSource);
    }
}

That's all.

Feedback

If you've noticed a bug or have a question or have a feature request, search the issue tracker to see if someone else in the community has already created a ticket. If not, go ahead and make one! All feature requests are welcome. Implementation time may vary. Feel free to contribute the same, if you can. If you think this extension is useful, please star it. Appreciation really helps in keeping this project alive.

Contributing

Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.

Code of conduct

Code of conduct guidelines here.

License

MIT