base-repo v3.1.10

Description

Cache Invalidation at model level extended features for sequelize-typescript (v2.1.0 or later)

Installation

$ npm install base-repo sequelize@^6.x.x sequelize-typescript@^2.x.x

Your tsconfig.json needs the following flags:

"target": "es6", // or a more recent ecmascript version
"experimentalDecorators": true,
"emitDecoratorMetadata": true

Module Definition

make sure defined all model of sequelize at this level and

@Module({
  ...
  imports: [
    RedisModule.register(cacheConfig() as RedisModuleOptions),

    SequelizeCacheModule.register({
      defaultTTL: 5, // DEFINE TTL FOR ALL PROJECT seconds
      // DEFINE HOW TO GET CACHE FROM GIVEN KEY
      callbackGet: async ({ key }) => CacheConfigModule.store.get(key),
      // DEFINE HOW TO INVALIDATE CACHE FROM GIVEN KEY
      callbackInvalidate: ({ key }) => (CacheConfigModule?.store?.del?.(key) || null),
      // DEFINE HOW TO SET CACHE FROM GIVEN KEY VALUE AND TTL
      callbackSet: async ({ key, value, ttl }) => CacheConfigModule.store.set(key, value, { ttl }),
      callbackGetKey: async ({ keyPattern }) => CacheConfigModule.store.keys?.(`${process.env.CACHE_PREFIX}${keyPattern}`) || [],
    }),

    SequelizeModule.forRoot({
      ...DBOptions,
    }),
   ...
  ],
})

export class CacheConfigModule {
  static store: Store;

  constructor(@Inject(CACHE_MANAGER) private store: Store) {
    CacheConfigModule.store = this.store;
  }
}

Model Definition

@Cache(options)

the @Cache is used for defined ttl and cache for findOne and automatically invalidate findOneCache/findByPkCache

@Cache API Options

@Cache({
  ttl: 100,
})
@Table()
export class DmCourse extends BaseModel {}

Extend BaseModel

@Cache({
  ttl: 100,
})
@Table()
export class DmCourse extends BaseModel {
  // default `{modelName} data not found'
  static notFoundMessage = 'your model not found message';

  /**
   *  @default `updatedAt`
   * @description `this is for checking newest updated timestamp for cached list.`
  */
  static onUpdateAttribute = 'modifiedAt'

   @UpdatedAt
  @Column({ field: 'UpdatedAt' })
    modifiedAt: Date;
}

the Model need to extends BaseModel

More Strict

interface DmCourseAtt {
  id: number
  name: string;
  type: number;
}

interface DmCreateAtt extends DmCourseAtt Omit<DmCourseAtt, 'id'>

@Cache({
  ttl: 100,
})
@Table()
export class DmCourse extends BaseModel<DmCourseAtt, DmCreateAtt> {}

for strict type that can used at default function from sequelize-typescript can be planted at generic type 2 and 3 sequelize-typescript strict

How to use

Model.findOneCache(cacheOptions)

• cacheOptions : FindOptions limited findOptions from sequelize-typescript

// file: DmCourse.ts

@Cache() //default ttl module
@Table()
export class DmCourse extends BaseModel<DmCourseAtt, DmCreateAtt> {}

...

// file: Course.controller.ts

class CourseController {
  async getCourse() {
    const course = await DmCourse.findOneCache({
      where: {
        isDeleted: false,
        name: 'Math',
      },
      rejectOnEmpty: true, // use model default throw, or use use throw Exception
      // rejectOnEmpty: new BadRequestException('message')
    })
  }
}

• you have to use All defined cache attributes that has name byIsDeletedAndName
• every query that outside of defined cache will not executed

findOneCache API Options

Model.findByPkCache(id, options)

class CourseController {
  async getCourse() {
    const course = await DmCourse.findByPkCache(1, {
      ttl: 100,
    });
  }
}

• find By Primary Cache will invalidate when any destroy or update

findByPkCache API Options

Model.findAllCache(cacheOptions)

class CourseController {
  async getCourse() {
    const course = await DmCourse.findAllCache({
     ttl: 100,
     attributes: ['id','name','type']
     where: {
       isDeleted: false,
     },
     order: [
       ['id','desc']
     ],
     include: [
       {
         // any association
       }
     ],
     limit: 10,
    })
  }
}

• find all data and Cache it when has value. will invalidate and update cache when ttl reach 0 or when get max updates or count is different from before

findAllCache API Options

Stay in touch

• Author - Fauzi Fadhillah
• Email