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.

Sign up for GitHub

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

Jump to bottom

fix(core): make model and resposiory customizable #124

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix(core): make model and resposiory customizable #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37ea818
fix(core): make model and resposiory customizable
yeshamavani Jun 13, 2024
c075f96
fix(core): readme in docs folder also updated
yeshamavani Jun 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
145 changes: 109 additions & 36 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ npm install @sourceloop/audit-log

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

- Add audit model class as Entity.
- If you wish to modify the one provided by this extension create your own model class just the one shown below. You can use `lb4 model` command to create new model

```ts
import {Entity, model, property} from '@loopback/repository';
Expand Down Expand Up @@ -154,7 +154,8 @@ export class AuditDataSource
}
```

- Using `lb4 repository` command, create a repository file. After that, change the inject paramater as below so as to refer to correct data source name.
- If you have a custom model and you wish to use that in your repository class you can
Using `lb4 repository` command, create a repository file. After that, change the inject paramater as below so as to refer to correct data source name.
`@inject(`datasources.\${AuditDbSourceName}`) dataSource: AuditDataSource,`

One example below.
Expand Down Expand Up @@ -187,8 +188,7 @@ import {Group, GroupRelations} from '../models';
import {PgdbDataSource} from '../datasources';
import {inject, Getter, Constructor} from '@loopback/core';
import {AuthenticationBindings, IAuthUser} from 'loopback4-authentication';
import {AuditRepositoryMixin} from '@sourceloop/audit-log';
import {AuditLogRepository} from './audit-log.repository';
import {AuditRepositoryMixin, AuditLogRepository} from '@sourceloop/audit-log';

const groupAuditOpts: IAuditMixinOptions = {
actionKey: 'Group_Logs',
Expand All @@ -207,14 +207,64 @@ export class GroupRepository extends AuditRepositoryMixin<
@inject('datasources.pgdb') dataSource: PgdbDataSource,
@inject.getter(AuthenticationBindings.CURRENT_USER)
public getCurrentUser: Getter<IAuthUser>,
@repository.getter('AuditLogRepository')
@repository.getter(AuditLogRepository)
public getAuditLogRepository: Getter<AuditLogRepository>,
) {
super(Group, dataSource, getCurrentUser);
}
}
```

and also bind the component of this extension in your application.ts

```ts
import {AuditLogComponent} from '@sourceloop/audit-log';

this.component(AuditLogComponent);
```

- The above code uses the default repository provided by this extension
- If you wish to use your custom repository and model class do the following

```ts
import {repository} from '@loopback/repository';
import {Group, GroupRelations} from '../models';
import {PgdbDataSource} from '../datasources';
import {inject, Getter, Constructor} from '@loopback/core';
import {AuthenticationBindings, IAuthUser} from 'loopback4-authentication';
import {AuditRepositoryMixin} from '@sourceloop/audit-log';
import {CustomAuditLogRepository} from './audit-log.repository';
import {CustomAuditLogModel} from '../models';

const groupAuditOpts: IAuditMixinOptions = {
actionKey: 'Group_Logs',
};

export class GroupRepository extends AuditRepositoryMixin<
Group,
typeof Group.prototype.id,
GroupRelations,
string,
Constructor<
DefaultCrudRepository<Group, typeof Group.prototype.id, GroupRelations>
>,
// pass the below two parameters when you want your custom model to be used
// otheriwise the default model and repository will be used
CustomAuditLogModel,
CustomAuditLogRepository
>(DefaultCrudRepository, groupAuditOpts) {
constructor(
@inject('datasources.pgdb') dataSource: PgdbDataSource,
@inject.getter(AuthenticationBindings.CURRENT_USER)
public getCurrentUser: Getter<IAuthUser>,
@repository.getter(CustomAuditLogRepository)
public getAuditLogRepository: Getter<CustomAuditLogRepository>,
) {
super(Group, dataSource, getCurrentUser);
}
}
```

You can pass any extra attributes to save into audit table using the `IAuditMixinOptions` parameter of mixin function.

Make sure you provide `getCurrentUser` and `getAuditLogRepository` Getter functions in constructor.
Expand All @@ -227,7 +277,7 @@ This will create all insert, update, delete audits for this model.
create(data, {noAudit: true});
```

- The Actor field is now configurable and can save any string type value in the field.
- The Actor field is configurable and can save any string type value in the field.
Though the default value will be userId a developer can save any string field from the current User that is being passed.

```ts
Expand Down Expand Up @@ -265,6 +315,15 @@ this.bind(AuthServiceBindings.ActorIdKey).to('username');
public actorIdKey?: ActorId,
```

#### Making current user not mandatory

Incase you dont have current user binded in your application context and wish to log the activities within your application then in that case you can pass the actor id along with the
options just like

```ts
await productRepo.create(product, {noAudit: false, actorId: 'userId'});
```

- The package exposes a conditional mixin for your repository classes. Just extend your repository class with `ConditionalAuditRepositoryMixin`, for all those repositories where you need audit data based on condition whether `ADD_AUDIT_LOG_MIXIN` is set true. See an example below. For a model `Group`, here we are extending the `GroupRepository` with `AuditRepositoryMixin`.

```ts
Expand All @@ -273,8 +332,10 @@ import {Group, GroupRelations} from '../models';
import {PgdbDataSource} from '../datasources';
import {inject, Getter, Constructor} from '@loopback/core';
import {AuthenticationBindings, IAuthUser} from 'loopback4-authentication';
import {ConditionalAuditRepositoryMixin} from '@sourceloop/audit-log';
import {AuditLogRepository} from './audit-log.repository';
import {
ConditionalAuditRepositoryMixin,
AuditLogRepository,
} from '@sourceloop/audit-log';

const groupAuditOpts: IAuditMixinOptions = {
actionKey: 'Group_Logs',
Expand All @@ -300,15 +361,6 @@ export class GroupRepository extends ConditionalAuditRepositoryMixin(
}
```

### Making current user not mandatory

Incase you dont have current user binded in your application context and wish to log the activities within your application then in that case you can pass the actor id along with the
options just like

```ts
await productRepo.create(product, {noAudit: false, actorId: 'userId'});
```

## Using with Sequelize ORM

This extension provides support to both juggler (the default loopback ORM) and sequelize.
Expand All @@ -318,33 +370,50 @@ If your loopback project is already using `SequelizeCrudRepository` from [@loopb
1. The import statements should have the suffix `/sequelize`, like below:

```ts
import {
AuditRepositoryMixin,
AuditLogRepository,
} from '@sourceloop/audit-log/sequelize';
```

2. The Audit datasource's parent class should be `SequelizeDataSource`.

```ts
import {SequelizeDataSource} from '@loopback/sequelize';
import {repository} from '@loopback/repository';
import {Group, GroupRelations} from '../models';
import {PgdbDataSource} from '../datasources';
import {inject, Getter, Constructor} from '@loopback/core';
import {AuthenticationBindings, IAuthUser} from 'loopback4-authentication';
import {AuditRepositoryMixin} from '@sourceloop/audit-log';
import {AuditLogRepository as SequelizeAuditLogRepository} from '@sourceloop/auidt-log/sequelize';

export class AuditDataSource
extends SequelizeDataSource
implements LifeCycleObserver
{
static dataSourceName = AuditDbSourceName;
static readonly defaultConfig = config;
const groupAuditOpts: IAuditMixinOptions = {
actionKey: 'Group_Logs',
};

export class GroupRepository extends AuditRepositoryMixin<
Group,
typeof Group.prototype.id,
GroupRelations,
string,
Constructor<
DefaultCrudRepository<Group, typeof Group.prototype.id, GroupRelations>
>,
AuditLog,
SequelizeAuditLogRepository
>(DefaultCrudRepository, groupAuditOpts) {
constructor(
@inject('datasources.config.audit', {optional: true})
dsConfig: object = config,
@inject('datasources.pgdb') dataSource: PgdbDataSource,
@inject.getter(AuthenticationBindings.CURRENT_USER)
public getCurrentUser: Getter<IAuthUser>,
@repository.getter(AuditLogRepository)
public getAuditLogRepository: Getter<SequelizeAuditLogRepository>,
) {
super(dsConfig);
super(Group, dataSource, getCurrentUser);
}
}
```

Also add the following to your application.ts file to bind the Sequelize repository

```ts
import {AuditLog} from '@sourceloop/auidt-log/';
import {AuditLogRepository} from '@sourceloop/auidt-log/sequelize';

this.repositories = [AuditLogRepository<AuditLog>];
```

## Feedback

If you've noticed a bug or have a question or have a feature request, [search the issue tracker](https://github.com/sourcefuse/loopback4-audit-log/issues) to see if someone else in the community has already created a ticket.
Expand All @@ -363,3 +432,7 @@ Code of conduct guidelines [here](https://github.com/sourcefuse/loopback4-audit-
## License

[MIT](https://github.com/sourcefuse/loopback4-audit-log/blob/master/LICENSE)

```

```