Local Filter

Create Filter

For example, create a local filter: test in the module demo-student to customize the log output for the custom error demo-student:1001

1. Cli command

$ vona :create:bean filter test --module=demo-student

2. Menu command

TIP

Context Menu - [Module Path]: Vona Aspect/Filter

Filter Definition

export interface IFilterOptionsTest extends IDecoratorFilterOptions {}

@Filter<IFilterOptionsTest>()
class FilterTest {
  async log(err: Error, _options: IFilterOptionsTest, next: Next): Promise<boolean> {
    // next
    if ((await next()) === true) return true;
    // custom
    if (err.code === 'demo-student:1001') {
      console.error(`Custom Error: ${err.code}, ${err.message}`);
      return true;
    }
    return false;
  }
}

• First call next(). If it returns true, the error has been handled, and then return directly
• Handle the specified error. If true is returned, it means it has been handled, ignoring the system's default logging behavior

Using Filter

1. Annotating controller actions

import { Aspect } from 'vona-module-a-aspect';

@Controller()
class ControllerStudent {
  @Web.post()
+ @Aspect.filter('demo-student:test')
  async create() {}
}

• @Aspect.filter: This decorator is used to use local filter. Simply pass the filter name
  • The test filter belongs to the demo-student module, so the full name is demo-student:test

2. Annotating controller class

You can use filter for controller classes so that all actions in the class will apply this filter

import { Aspect } from 'vona-module-a-aspect';

@Controller()
+ @Aspect.filter('demo-student:test')
class ControllerStudent {
  @Web.post()
  async create() {}
}

Filter Parameters

You can define parameters for filter, allowing for more flexible configuration of filter logic

For example, define the prefix parameter for the test filter to customize the format of the log output

1. Defining parameter types

export interface IFilterOptionsTest extends IDecoratorFilterOptions {
+  prefix: string;
}

2. Providing default values ​​for parameters

@Filter<IFilterOptionsTest>({
+ prefix: 'Custom Error',
})

3. Using Parameters

export interface IFilterOptionsTest extends IDecoratorFilterOptions {
  prefix: string;
}

@Filter<IFilterOptionsTest>({
  prefix: 'Custom Error',
})
export class FilterTest extends BeanBase implements IFilterLog {
  async log(err: Error, options: IFilterOptionsTest, next: Next): Promise<boolean> {
    // next
    if ((await next()) === true) return true;
    // custom
    if (err.code === 'demo-student:1001') {
-     console.error(`Custom Error: ${err.code}, ${err.message}`);
+     console.error(`${options.prefix}: ${err.code}, ${err.message}`);
      return true;
    }
    return false;
  }
}

4. Specify parameters when using

You can specify local filter parameters for a specific API

class ControllerStudent {
  @Web.post()
+ @Aspect.filter('demo-student:test', { prefix: 'Test Error' })
  async create(){}
}

• When using filter, just provide the parameter value directly

5. App config

Filter parameters can be configured in App config

src/backend/config/config/config.ts

// onions
config.onions = {
  filter: {
    'demo-student:test': {
      prefix: 'Test Error',
    },
  },
};

6. Parameter precedence

Specify parameters when using > App config > Default values