NAS-114805 / 22.12 / NAS-114805: Refactoring scheduler component

jest.config.js

@@ -2,6 +2,7 @@ const { pathsToModuleNameMapper } = require('ts-jest/utils');
 const { compilerOptions } = require('./tsconfig');
 
 require('jest-preset-angular/ngcc-jest-processor');
+process.env.TZ = 'UTC';
 
 module.exports = {
   preset: 'jest-preset-angular',

package.json

@@ -90,6 +90,7 @@
     "chartist": "~0.11.4",
     "core-js": "~3.6.4",
     "cron-parser": "~4.2.1",
+    "croner": "~4.1.97",
     "cronstrue": "~1.113.0",
     "d3": "~5.16.0",
     "d3-transition": "~1.2.0",

src/app/interfaces/schedule.interface.ts

@@ -1,9 +1,11 @@
 export interface Schedule {
+  // TODO: Check question marks
   minute?: string;
   hour?: string;
   dom?: string;
   month?: string;
   dow?: string;
+  // TODO: May not belong here.
   begin?: string;
   end?: string;
 }

src/app/modules/entity/entity-form/components/form-scheduler/form-scheduler.component.ts

@@ -1,33 +1,34 @@
 import { Overlay } from '@angular/cdk/overlay';
 import {
-  Component, OnInit, ViewChild, ElementRef, Renderer2,
-  ChangeDetectorRef, AfterViewInit, AfterViewChecked,
+  AfterViewChecked,
+  AfterViewInit,
+  ChangeDetectorRef,
+  Component,
+  ElementRef,
+  OnInit,
+  Renderer2,
+  ViewChild,
 } from '@angular/core';
-import { FormGroup, FormControl, AbstractControl } from '@angular/forms';
+import { AbstractControl, FormControl, FormGroup } from '@angular/forms';
 import { MatMonthView } from '@angular/material/datepicker';
 import { UntilDestroy, untilDestroyed } from '@ngneat/until-destroy';
 import { Store } from '@ngrx/store';
 import { TranslateService } from '@ngx-translate/core';
-import { CronDate } from 'cron-parser';
 import * as parser from 'cron-parser';
+import { CronDate } from 'cron-parser';
 import { CronExpression } from 'cron-parser/types';
 import * as dateFns from 'date-fns';
 import * as dateFnsTz from 'date-fns-tz';
 import globalHelptext from 'app/helptext/global-helptext';
 import { FormSchedulerConfig } from 'app/modules/entity/entity-form/models/field-config.interface';
 import { Field } from 'app/modules/entity/entity-form/models/field.interface';
 import { EntityUtils } from 'app/modules/entity/utils';
+import { CronPreset } from 'app/modules/scheduler/interfaces/cron-preset.interface';
 import { LocaleService } from 'app/services/locale.service';
 import { WebSocketService } from 'app/services/ws.service';
 import { AppState } from 'app/store';
 import { selectTimezone } from 'app/store/system-config/system-config.selectors';
 
-interface CronPreset {
-  label: string;
-  value: string;
-  description?: string;
-}
-
 @UntilDestroy()
 @Component({
   selector: 'form-scheduler',
@@ -228,22 +229,6 @@ export class FormSchedulerComponent implements Field, OnInit, AfterViewInit, Aft
     },
   ];
 
-  get textInput(): string {
-    return this._textInput;
-  }
-
-  set textInput(val: string) {
-    this._textInput = val;
-  }
-
-  get colorProxy(): string {
-    return this.group.value[this.config.name];
-  }
-
-  set colorProxy(val: string) {
-    this.group.controls[this.config.name].setValue(val);
-  }
-
   private _preset: CronPreset;
 
   get preset(): CronPreset {

src/app/modules/entity/entity-form/models/field-config.interface.ts

@@ -201,7 +201,7 @@ export interface FormRadioOption {
 }
 
 export interface FormSchedulerConfig<P = unknown> extends BaseFieldConfig<P> {
-  options?: string[];
+  options?: [startTime: string, endTime: string];
   noMinutes?: boolean;
   onChangeOption?(data: { event: Event }): void;
   type: 'scheduler';

src/app/modules/ix-forms/components/ix-input/ix-input.component.ts

@@ -57,7 +57,6 @@ export class IxInputComponent implements ControlValueAccessor {
     }
     this.formatted = formatted;
     this.value = value;
-    this.cdr.markForCheck();
   }
 
   input(ixInput: HTMLInputElement): void {

src/app/modules/ix-forms/components/ix-select/ix-select.harness.ts

@@ -4,7 +4,7 @@ import { IxFormControlHarness } from 'app/modules/ix-forms/interfaces/ix-form-co
 import { getErrorText } from '../../utils/harness.utils';
 
 export interface IxSelectHarnessFilters extends SelectHarnessFilters {
-  label: string;
+  label?: string;
 }
 
 export class IxSelectHarness extends ComponentHarness implements IxFormControlHarness {

src/app/modules/jobs/components/jobs-panel/jobs-panel.component.spec.ts

@@ -96,7 +96,14 @@ describe('JobsPanelComponent', () => {
   it('loads jobs when adminUiInitialized is dispatched', () => {
     spectator.inject(Store).dispatch(adminUiInitialized());
 
-    expect(websocket.call).toHaveBeenCalledWith('core.get_jobs');
+    expect(websocket.call).toHaveBeenCalledWith(
+      'core.get_jobs',
+      [[['state', '!=', JobState.Success]]],
+    );
+    expect(websocket.call).toHaveBeenCalledWith(
+      'core.get_jobs',
+      [[['state', '=', JobState.Success]], { limit: 30, order_by: ['-id'] }],
+    );
   });
 
   it('checks component header is present', () => {

src/app/modules/jobs/store/job.effects.ts

@@ -1,11 +1,12 @@
 import { Injectable } from '@angular/core';
 import { Actions, createEffect, ofType } from '@ngrx/effects';
 import { TranslateService } from '@ngx-translate/core';
-import { of } from 'rxjs';
+import { forkJoin, of } from 'rxjs';
 import {
   catchError, filter, map, switchMap,
 } from 'rxjs/operators';
 import { ApiEventMessage } from 'app/enums/api-event-message.enum';
+import { JobState } from 'app/enums/job-state.enum';
 import {
   abortJobPressed, jobAdded, jobChanged, jobRemoved, jobsLoaded, jobsNotLoaded,
 } from 'app/modules/jobs/store/job.actions';
@@ -18,8 +19,16 @@ export class JobEffects {
   loadJobs$ = createEffect(() => this.actions$.pipe(
     ofType(adminUiInitialized),
     switchMap(() => {
-      return this.ws.call('core.get_jobs').pipe(
-        map((jobs) => jobsLoaded({ jobs })),
+      const getNotCompletedJobs$ = this.ws.call('core.get_jobs', [[['state', '!=', JobState.Success]]]);
+      const getCompletedJobs$ = this.ws.call('core.get_jobs', [[['state', '=', JobState.Success]], { order_by: ['-id'], limit: 30 }]);
+
+      return forkJoin([
+        getNotCompletedJobs$,
+        getCompletedJobs$,
+      ]).pipe(
+        map(([notCompletedJobs, recentlyCompletedJobs]) => {
+          return jobsLoaded({ jobs: [...notCompletedJobs, ...recentlyCompletedJobs] });
+        }),
         catchError((error) => {
           console.error(error);
           // TODO: See if it would make sense to parse middleware error.

src/app/modules/scheduler/classes/cron-schedule-preview/cron-schedule-preview.ts

@@ -0,0 +1,116 @@
+import Cron from 'croner';
+import {
+  addDays,
+  endOfMonth,
+  getDate, getMonth, isBefore, isWithinInterval,
+  setHours,
+  setMinutes,
+  subMinutes,
+} from 'date-fns';
+import { toDate, utcToZonedTime, zonedTimeToUtc } from 'date-fns-tz';
+
+export interface CronSchedulerPreviewOptions {
+  crontab: string;
+  timezone: string;
+  startTime?: string;
+  endTime?: string;
+}
+
+export class CronSchedulePreview {
+  private readonly cron: Cron;
+  private readonly timezone: string;
+
+  constructor(private options: CronSchedulerPreviewOptions) {
+    this.timezone = this.options.timezone;
+    this.cron = new Cron(this.options.crontab, {
+      timezone: this.timezone,
+    });
+  }
+
+  /**
+   * Returns next {limit} dates from startDate to the end of month.
+   * startDate is specified in target timezone.
+   * Returned dates are in local time, but stored in UTC (ordinary JS way).
+   * @param startDate Starting date.
+   * @param limit
+   */
+  listNextRunsInMonth(startDate: string, limit: number): Date[] {
+    const nextRuns: Date[] = [];
+    let previousDate: Date = this.getZonedStartDate(startDate);
+    const zonedEndDate = this.getZoneEndDate(startDate);
+
+    for (let i = 0; i < limit;) {
+      const exampleDate = this.cron.next(previousDate);
+      previousDate = exampleDate;
+
+      if (!exampleDate || !isBefore(exampleDate, zonedEndDate)) {
+        break;
+      }
+
+      if (!this.isWithinTimeConstrains(exampleDate)) {
+        continue;
+      }
+
+      nextRuns.push(exampleDate);
+      i = i + 1;
+    }
+
+    return nextRuns;
+  }
+
+  getNextDaysInMonthWithRuns(startDate: string): Set<number> {
+    const monthDaysWithRuns = new Set<number>([]);
+
+    let previousDate = toDate(startDate, { timeZone: 'UTC' });
+    const startingMonth = getMonth(previousDate);
+
+    do {
+      const zonedPreviousDate = zonedTimeToUtc(previousDate, this.timezone);
+      const zonedNextRun = this.cron.next(subMinutes(zonedPreviousDate, 1));
+      const nextRun = utcToZonedTime(zonedNextRun, this.timezone);
+
+      if (!nextRun || getMonth(nextRun) !== startingMonth) {
+        break;
+      }
+
+      if (!this.isWithinTimeConstrains(nextRun)) {
+        previousDate = nextRun;
+        continue;
+      }
+
+      previousDate = addDays(previousDate, 1);
+
+      const dayNumber = getDate(nextRun);
+      monthDaysWithRuns.add(dayNumber);
+    } while (getMonth(previousDate) === startingMonth);
+
+    return monthDaysWithRuns;
+  }
+
+  private getZonedStartDate(forMonth: string): Date {
+    const zonedForMonth = toDate(forMonth, { timeZone: this.timezone });
+    return subMinutes(zonedForMonth, 1);
+  }
+
+  private getZoneEndDate(forMonth: string): Date {
+    const zonedForMonth = toDate(forMonth, { timeZone: 'UTC' });
+    const endDate = endOfMonth(zonedForMonth);
+    return zonedTimeToUtc(endDate, this.timezone);
+  }
+
+  private isWithinTimeConstrains(date: Date): boolean {
+    return true;
+    // TODO: Will be implemented later.
+    if (!this.options.startTime || !this.options.endTime) {
+      return true;
+    }
+
+    const [startHour, startMinutes] = this.options.startTime.split(':');
+    const [endHour, endMinutes] = this.options.endTime.split(':');
+
+    const startDate = setMinutes(setHours(date, Number(startHour)), Number(startMinutes));
+    const endDate = setMinutes(setHours(date, Number(endHour)), Number(endMinutes));
+
+    return isWithinInterval(date, { start: startDate, end: endDate });
+  }
+}