Adds additional scheduler methods (#55)

* fix: export and existing method names

* feat: additional SchedulerClient methods and test

Author: gulam159

src/core/__test__/schedulerExecutor.test.ts

@@ -67,18 +67,18 @@ describe("ScheduleExecutor", () => {
       },
     };
     await expect(
-      executor.registerSchedule(schedulerDefinition)
+      executor.saveSchedule(schedulerDefinition)
     ).resolves.not.toThrowError();
-    const scheduler = await executor.get(name);
+    const scheduler = await executor.getSchedule(name);
     expect(scheduler.name).toEqual(name);
     expect(scheduler.cronExpression).toEqual(cronExpression);
   });
 
   test("Should be able to resume the schedule", async () => {
     const client = await clientPromise;
     const executor = new SchedulerClient(client);
-    await executor.startResume(name);
-    const scheduler = await executor.get(name);
+    await executor.resumeSchedule(name);
+    const scheduler = await executor.getSchedule(name);
     expect(scheduler.paused).toBeFalsy();
   });
 
@@ -99,24 +99,32 @@ describe("ScheduleExecutor", () => {
   test("Should be able to pause the schedule", async () => {
     const client = await clientPromise;
     const executor = new SchedulerClient(client);
-    await executor.pause(name);
-    const scheduler = await executor.get(name);
+    await executor.pauseSchedule(name);
+    const scheduler = await executor.getSchedule(name);
     expect(scheduler.paused).toBeTruthy();
   });
 
   test("Should be able to delete the schedule", async () => {
     const client = await clientPromise;
     const executor = new SchedulerClient(client);
-    await executor.delete(name);
+    await executor.deleteSchedule(name);
     // delete workflowDef too
     await client.metadataResource.unregisterWorkflowDef(
       workflowName,
       workflowVersion
     );
-    const schedulerList = await executor.getAll();
+    const schedulerList = await executor.getAllSchedules();
     const testSchedule = schedulerList.some(
       (schedule) => schedule.name === name
     );
     expect(testSchedule).toBeFalsy();
   });
+
+  test("Should be able to retrieve  next (default 3) execution times for a scheduler", async () => {
+    const cronExpression = "0 0 * ? * *"; //every hour
+    const client = await clientPromise;
+    const executor = new SchedulerClient(client);
+    const result = await executor.getNextFewSchedules(cronExpression);
+    expect(result?.length).toBeGreaterThan(0);
+  });
 });

src/core/index.ts

@@ -3,3 +3,4 @@ export * from "./types";
 export * from "./human";
 export * from "./sdk";
 export * from "./generators";
+export * from "./schedulerClient";

src/core/schedulerClient.ts

@@ -18,7 +18,7 @@ export class SchedulerClient {
    * @param requestBody
    * @returns
    */
-  public registerSchedule(param: SaveScheduleRequest): Promise<void> {
+  public saveSchedule(param: SaveScheduleRequest): Promise<void> {
     return tryCatchReThrow(() =>
       this._client.schedulerResource.saveSchedule(param)
     );
@@ -57,7 +57,7 @@ export class SchedulerClient {
    * @param name
    * @returns SaveScheduleRequest
    */
-  public get(name: string): Promise<SaveScheduleRequest> {
+  public getSchedule(name: string): Promise<SaveScheduleRequest> {
     return tryCatchReThrow(() =>
       this._client.schedulerResource.getSchedule(name)
     );
@@ -68,7 +68,7 @@ export class SchedulerClient {
    * @param name
    * @returns
    */
-  public pause(name: string): Promise<void> {
+  public pauseSchedule(name: string): Promise<void> {
     return tryCatchReThrow(() =>
       this._client.schedulerResource.pauseSchedule(name)
     );
@@ -80,7 +80,7 @@ export class SchedulerClient {
    * @param name
    * @returns
    */
-  public startResume(name: string): Promise<void> {
+  public resumeSchedule(name: string): Promise<void> {
     return tryCatchReThrow(() =>
       this._client.schedulerResource.resumeSchedule(name)
     );
@@ -92,22 +92,80 @@ export class SchedulerClient {
    * @param name
    * @returns
    */
-  public delete(name: string): Promise<void> {
+  public deleteSchedule(name: string): Promise<void> {
     return tryCatchReThrow(() =>
       this._client.schedulerResource.deleteSchedule(name)
     );
   }
 
-
   /**
-   * Get all existing workflow schedules and optionally filter by workflow name 
+   * Get all existing workflow schedules and optionally filter by workflow name
    * @param workflowName
    * @returns Array<WorkflowSchedule>
    */
-  public getAll(workflowName?: string):Promise<Array<WorkflowSchedule>>{
-    return tryCatchReThrow(()=>
-        this._client.schedulerResource.getAllSchedules(workflowName)
-    )
+  public getAllSchedules(
+    workflowName?: string
+  ): Promise<Array<WorkflowSchedule>> {
+    return tryCatchReThrow(() =>
+      this._client.schedulerResource.getAllSchedules(workflowName)
+    );
+  }
+
+  /**
+   * Get list of the next x (default 3, max 5) execution times for a scheduler
+   * @param cronExpression
+   * @param scheduleStartTime
+   * @param scheduleEndTime
+   * @param limit
+   * @returns number OK
+   * @throws ApiError
+   */
+  public getNextFewSchedules(
+    cronExpression: string,
+    scheduleStartTime?: number,
+    scheduleEndTime?: number,
+    limit: number = 3
+  ): Promise<Array<number[]>> {
+    return tryCatchReThrow(() =>
+      this._client.schedulerResource.getNextFewSchedules(
+        cronExpression,
+        scheduleStartTime,
+        scheduleEndTime,
+        limit
+      )
+    );
   }
 
+  /**
+   * Pause all scheduling in a single conductor server instance (for debugging only)
+   * @returns any OK
+   * @throws ApiError
+   */
+  public pauseAllSchedules(): Promise<void> {
+    return tryCatchReThrow(() =>
+      this._client.schedulerResource.pauseAllSchedules()
+    );
+  }
+
+  /**
+   * Requeue all execution records
+   * @returns any OK
+   * @throws ApiError
+   */
+  public requeueAllExecutionRecords(): Promise<void> {
+    return tryCatchReThrow(() =>
+      this._client.schedulerResource.requeueAllExecutionRecords()
+    );
+  }
+
+  /**
+   * Resume all scheduling
+   * @returns any OK
+   * @throws ApiError
+   */
+  public resumeAllSchedules(): Promise<void> {
+    return tryCatchReThrow(() =>
+      this._client.schedulerResource.resumeAllSchedules()
+    );
+  }
 }