Expanding things.

Signed-off-by: Alexander Trauzzi <[email protected]>

Author: atrauzzi

src/implementation/Client/HTTPClient/jobs.ts

@@ -15,7 +15,7 @@ import IClientJobs from "../../../interfaces/Client/IClientJobs";
 import HTTPClient from "./HTTPClient";
 import { THTTPExecuteParams } from "../../../types/http/THTTPExecuteParams.type";
 import { Job } from "../../../types/jobs/Job.type";
-import { JobSchedule } from "../../../types/jobs/JobSchedule.type";
+import { Schedule, ScheduleUnboxer } from "../../../types/jobs/JobSchedule.type";
 
 export default class HTTPClientJobs implements IClientJobs {
 
@@ -27,19 +27,22 @@ export default class HTTPClientJobs implements IClientJobs {
   async schedule(
     jobName: string,
     data: object | string,
-    schedule: JobSchedule | null = null,
+    schedule: Schedule | null = null,
     dueTime: string | Date | null = null,
     repeats: number | null = null,
     ttl: string | null = null,
   ): Promise<void> {
+
+    const boxedSchedule = new ScheduleUnboxer(schedule);
+
     await this.httpClient.executeWithApiVersion(HTTPClientJobs.ApiVersion, `/${HTTPClientJobs.Path}/${jobName}`, {
       method: "POST",
       body: {
         data,
-        schedule,
         dueTime,
         repeats,
         ttl,
+        schedule: boxedSchedule.unbox(),
       },
       headers: {
         "content-type": "application/json",

src/types/jobs/CronExpression.type.ts

@@ -11,6 +11,9 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// note: This can get crazy, more than TS can really handle.
+export type CronExpressionString = `${string} ${string} ${string} ${string} ${string} ${string}`;
+
 export enum CronPeriod {
   Second,
   Minute,
@@ -191,7 +194,7 @@ export class CronExpression {
     return this;
   }
 
-  public toString() {
+  public toString(): CronExpressionString {
     return `${this.seconds} ${this.minutes} ${this.hours} ${this.dayOfMonth} ${this.month} ${this.dayOfWeek}`;
   }
 

src/types/jobs/JobSchedule.type.ts

@@ -11,37 +11,57 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-export enum PrefixedPeriodExpression {
+import { CronExpression, CronExpressionString } from "./CronExpression.type";
+
+export enum PeriodConstant {
     Yearly = "@yearly",
     Monthly = "@monthly",
     Weekly = "@weekly",
     Daily = "@daily",
     Hourly = "@hourly",
 }
 
-type EveryPeriod = `@every ${string}`;
+type EveryExpressionString = `@every ${string}`;
+
+class EveryExpression {
 
-// note: This can get crazy, more than TS can really handle.
-type SystemDCronExpression = `${string} ${string} ${string} ${string} ${string} ${string}`;
+    private static readonly EveryExpressionValue = /^(d+(m?s|m|h))+$/;
 
-type ScheduleString = PrefixedPeriodExpression | EveryPeriod | SystemDCronExpression;
+    private readonly value: string;
 
-class Schedule {
+    public static isEveryExpression(value: string) {
+        return EveryExpression.EveryExpressionValue.test(`@every ${value}`);
+    }
 
-    private static readonly IsEveryExpression = /^@every (d+(m?s|m|h))+$/;
+    constructor(value: string) {
 
-    private readonly value: ScheduleString;
+        if (! EveryExpression.isEveryExpression(value))
+            throw new Error(`${value} is not a valid every expression value.`);
 
-    constructor(scheduleString: ScheduleString) {
-        this.value = scheduleString;
+        this.value = value;
     }
 
-    public get isPrefixedPeriodExpression() {
-      return (
-          Object.values(PrefixedPeriodExpression).includes(this.value as PrefixedPeriodExpression)
-          || this.value.match(Schedule.IsEveryExpression)
-      );
+    public toString(): EveryExpressionString {
+        return `@every ${this.value}`;
     }
 }
 
-export type JobSchedule = ScheduleString | Schedule;
+export type Schedule = PeriodConstant | EveryExpression | EveryExpressionString | CronExpression | CronExpressionString;
+
+export class ScheduleUnboxer {
+
+    private readonly value: Schedule | null;
+
+    constructor(value: Schedule | null) {
+        this.value = value;
+    }
+
+    public unbox(): string | null {
+        if(this.value instanceof EveryExpression)
+            return this.value.toString();
+        if(this.value instanceof CronExpression)
+            return this.value.toString();
+
+        return this.value;
+    }
+}

test/unit/jobs/jobs.test.ts

@@ -13,7 +13,7 @@ limitations under the License.
 
 import HTTPClient from "../../../src/implementation/Client/HTTPClient/HTTPClient";
 import HTTPClientJobs from "../../../src/implementation/Client/HTTPClient/jobs";
-import { PrefixedPeriodExpression } from "../../../src/types/jobs/JobSchedule.type";
+import { PeriodConstant } from "../../../src/types/jobs/JobSchedule.type";
 
 jest.mock("../../../src/implementation/Client/HTTPClient/HTTPClient");
 
@@ -35,7 +35,7 @@ describe("Jobs Client", () => {
             {
                 some: "data",
             },
-            PrefixedPeriodExpression.Daily
+            PeriodConstant.Daily
         );
 
         expect(httpClient.executeWithApiVersion).toHaveBeenCalledTimes(1);