feat(orap): update ttl type from number to Milliseconds

Author: murongg

packages/orap/src/flow/task.ts

@@ -1,3 +1,4 @@
+import type { Milliseconds } from '@ora-io/utils'
 import { alphabetHex, memoryStore, randomStr } from '@ora-io/utils'
 import type { Context, TaskRaplized } from '../task'
 import { StoreManager } from '../store'
@@ -15,15 +16,15 @@ const defaultHandleFn: HandleFn = () => {
 }
 
 const defaultToKeyFn: ToKeyFn = _ => randomStr(8, alphabetHex)
-export interface TaskFlowTTL { taskTtl: number; doneTtl: number }
+export interface TaskFlowTTL { taskTtl: Milliseconds; doneTtl: Milliseconds }
 
 // TODO: add 'Failed-Task:' ?
 export class TaskFlow implements Flow {
   sm: StoreManager = new StoreManager(memoryStore())
   taskPrefix: Prefix = 'Task:'
   donePrefix: Prefix = 'Done-Task:'
-  taskTtl?: number
-  doneTtl?: number
+  taskTtl?: Milliseconds
+  doneTtl?: Milliseconds
   toKeyFn: ToKeyFn = defaultToKeyFn
   handleFn: HandleFn = defaultHandleFn
   successFn: HandleResultFn = defaultSuccessFn
@@ -60,10 +61,10 @@ export class TaskFlow implements Flow {
     return this
   }
 
-  ttl(TTLs: number): this
+  ttl(TTLs: Milliseconds): this
   ttl(TTLs: TaskFlowTTL): this
-  ttl(taskTtl: number, doneTtl: number): this
-  ttl(TTLs: TaskFlowTTL | number, doneTtl?: number): this {
+  ttl(taskTtl: Milliseconds, doneTtl: Milliseconds): this
+  ttl(TTLs: TaskFlowTTL | Milliseconds, doneTtl?: Milliseconds): this {
     if (typeof TTLs === 'number') {
       this.taskTtl = TTLs
       this.doneTtl = doneTtl ?? TTLs

packages/orap/src/task/storable.ts

@@ -1,4 +1,4 @@
-import type { Awaitable, Constructor } from '@ora-io/utils'
+import type { Awaitable, Constructor, Milliseconds } from '@ora-io/utils'
 import type { StoreManager } from '../store/storemanager'
 import type { Context } from './context'
 import { TaskBase } from './base'
@@ -9,8 +9,8 @@ export abstract class TaskStorable extends TaskBase {
   // overwrite these for store key customize
   static readonly taskPrefix: string = 'Task:'
   static readonly taskPrefixDone: string = 'Done-Task:'
-  static readonly taskTtl: number | undefined = undefined
-  static readonly taskTtlDone: number | undefined = undefined
+  static readonly taskTtl: Milliseconds | undefined = undefined
+  static readonly taskTtlDone: Milliseconds | undefined = undefined
 
   getTaskPrefix(_context?: Context): Awaitable<string> {
     return (this.constructor as TypeofTaskStorable).taskPrefix
@@ -20,19 +20,19 @@ export abstract class TaskStorable extends TaskBase {
     return (this.constructor as TypeofTaskStorable).taskPrefixDone
   }
 
-  get taskTtl(): number | undefined {
+  get taskTtl(): Milliseconds | undefined {
     return (this.constructor as TypeofTaskStorable).taskTtl
   }
 
-  get taskTtlDone(): number | undefined {
+  get taskTtlDone(): Milliseconds | undefined {
     return (this.constructor as TypeofTaskStorable).taskTtlDone
   }
 
-  getTaskTtl(_context?: Context): number | undefined {
+  getTaskTtl(_context?: Context): Milliseconds | undefined {
     return (this.constructor as TypeofTaskStorable).taskTtl
   }
 
-  getTaskTtlDone(_context?: Context): number | undefined {
+  getTaskTtlDone(_context?: Context): Milliseconds | undefined {
     return (this.constructor as TypeofTaskStorable).taskTtlDone
   }
 

packages/orap/src/task/verse.ts

@@ -1,3 +1,4 @@
+import type { Milliseconds } from '@ora-io/utils'
 import { composeFns, isJsonString, isString, stripPrefix } from '@ora-io/utils'
 import type { TaskFlow } from '../flow'
 import { HandleSuccessMiddleware } from '../middlewares/HandleSuccessMiddleware'
@@ -28,11 +29,11 @@ export class TaskRaplized extends TaskStorable {
       : await this.flow.donePrefix(this.flow.ctx)
   }
 
-  get taskTtl(): number | undefined {
+  get taskTtl(): Milliseconds | undefined {
     return this.flow.taskTtl
   }
 
-  get taskTtlDone(): number | undefined {
+  get taskTtlDone(): Milliseconds | undefined {
     return this.flow.doneTtl
   }