3.0.41

.gitlab-ci.yml

@@ -19,23 +19,35 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
+  tags:
+    - docker
+
+auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
     - npmci command npm install --ignore-scripts
     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +62,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +73,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +93,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

package.json

@@ -1,32 +1,34 @@
 {
   "name": "@pushrocks/smarttime",
   "private": false,
-  "version": "3.0.20",
+  "version": "3.0.41",
   "description": "handle time in smart ways",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
-    "test": "(tstest ./test/)",
+    "test": "(tstest ./test)",
     "build": "(tsbuild --web && tsbundle npm)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
-    "@gitzone/tsbundle": "^1.0.72",
-    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.41",
-    "@pushrocks/tapbundle": "^3.2.9",
-    "@types/node": "^14.0.22",
-    "tslint": "^6.1.2",
+    "@gitzone/tsbuild": "^2.1.28",
+    "@gitzone/tsbundle": "^1.0.88",
+    "@gitzone/tsrun": "^1.2.18",
+    "@gitzone/tstest": "^1.0.60",
+    "@pushrocks/tapbundle": "^3.2.14",
+    "@types/node": "^16.11.6",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartdelay": "^2.0.10",
-    "@pushrocks/smartpromise": "^3.0.2",
-    "croner": "^1.1.23",
-    "dayjs": "^1.8.29",
-    "is-nan": "^1.3.0"
+    "@pushrocks/lik": "^5.0.0",
+    "@pushrocks/smartdelay": "^2.0.13",
+    "@pushrocks/smartpromise": "^3.1.6",
+    "croner": "^4.0.69",
+    "dayjs": "^1.10.7",
+    "is-nan": "^1.3.2",
+    "pretty-ms": "^7.0.1"
   },
   "files": [
     "ts/**/*",

test/test.cronmanager.both.ts

@@ -0,0 +1,60 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+
+import * as smarttime from '../ts/index';
+
+let testCronManager: smarttime.CronManager;
+
+tap.test('should create a valid instance of cronmanager', async () => {
+  testCronManager = new smarttime.CronManager();
+  expect(testCronManager).to.be.instanceOf(smarttime.CronManager);
+});
+
+tap.test('should create a valid cronJon', async (tools) => {
+  const done = tools.defer();
+  const done2 = tools.defer();
+  const done3 = tools.defer();
+  let counter = 0;
+  let counter2 = 0;
+  let counter3 = 0;
+  const cronJob = testCronManager.addCronjob('*/2 * * * * *', async () => {
+    if (counter === 5) {
+      testCronManager.removeCronjob(cronJob);
+      done.resolve();
+    }
+    counter++;
+    console.log(`${new Date().getSeconds()} hey ${counter} -> runs every 2 seconds`);
+  });
+  const cronJob2 = testCronManager.addCronjob('*/3 * * * * *', async () => {
+    if (counter2 === 5) {
+      testCronManager.removeCronjob(cronJob2);
+      done2.resolve();
+    }
+    counter2++;
+    console.log(`${new Date().getSeconds()} hey ${counter2} -> runs every 3 seconds`);
+  });
+  const cronJob3 = testCronManager.addCronjob('*/4 * * * * *', async () => {
+    if (counter3 === 5) {
+      done3.resolve();
+    }
+    counter3++;
+    console.log(`${new Date().getSeconds()} hey ${counter3} -> runs every 4 seconds`);
+  });
+  testCronManager.start();
+  await done.promise;
+  await done2.promise;
+  await done3.promise;
+  testCronManager.stop();
+  testCronManager.removeCronjob(cronJob3);
+});
+
+tap.test('runs every full minute', async (tools) => {
+  const done = tools.defer();
+  const cronJob = testCronManager.addCronjob('0 * * * * *', async () => {
+    done.resolve();
+  });
+  testCronManager.start();
+  await done.promise;
+  testCronManager.stop();
+});
+
+tap.start();

test/test.cronmanager.browser.ts

@@ -1,27 +0,0 @@
-import { tap, expect } from '@pushrocks/tapbundle';
-
-import * as smarttime from '../ts/index';
-
-let testCronManager: smarttime.CronManager;
-
-tap.test('should create a valid instance of cronmanager', async () => {
-  testCronManager = new smarttime.CronManager();
-  expect(testCronManager).to.be.instanceOf(smarttime.CronManager);
-});
-
-tap.test('should create a valid cronJon', async (tools) => {
-  const done = tools.defer();
-  let counter = 0;
-  testCronManager.addCronjob('*/2 * * * * *', () => {
-    if (counter === 10) {
-      done.resolve();
-    }
-    counter++;
-    console.log(`hey ${counter}`);
-  });
-  testCronManager.start();
-  await done.promise;
-  testCronManager.stop();
-});
-
-tap.start();

test/test.cronmanager.ts

@@ -1,27 +0,0 @@
-import { tap, expect } from '@pushrocks/tapbundle';
-
-import * as smarttime from '../ts/index';
-
-let testCronManager: smarttime.CronManager;
-
-tap.test('should create a valid instance of cronmanager', async () => {
-  testCronManager = new smarttime.CronManager();
-  expect(testCronManager).to.be.instanceOf(smarttime.CronManager);
-});
-
-tap.test('should create a valid cronJon', async (tools) => {
-  const done = tools.defer();
-  let counter = 0;
-  testCronManager.addCronjob('*/2 * * * * *', () => {
-    if (counter === 10) {
-      done.resolve();
-    }
-    counter++;
-    console.log(`hey ${counter}`);
-  });
-  testCronManager.start();
-  await done.promise;
-  testCronManager.stop();
-});
-
-tap.start();

test/test.extendeddate.ts

@@ -2,6 +2,11 @@ import { expect, tap } from '@pushrocks/tapbundle';
 
 import * as smarttime from '../ts/index';
 
+tap.test('should create a valid JavaScript Date', async () => {
+  const extendedDate = new smarttime.ExtendedDate(Date.now());
+  console.log(extendedDate);
+});
+
 tap.test('should create a valid JavaScript Date from European TimeStamp', async () => {
   const extendedDate = smarttime.ExtendedDate.fromEuropeanDate('1.6.2018');
   console.log(extendedDate);
@@ -21,4 +26,9 @@ tap.test('should create a European date string', async () => {
   expect(extendedDate.exportToEuropeanDate()).to.equal('13.02.2018');
 });
 
+tap.test('should format a date', async () => {
+  const extendedDate = new smarttime.ExtendedDate(Date.now());
+  console.log(extendedDate.format('YYYY-MM-DD - hh:mm'));
+})
+
 tap.start();

ts/index.ts

@@ -1,4 +1,5 @@
 export * from './smarttime.classes.cronmanager';
+export * from './smarttime.classes.cronjob';
 export * from './smarttime.classes.extendeddate';
 export * from './smarttime.classes.hrtmeasurement';
 export * from './smarttime.classes.interval';

ts/smarttime.classes.cronjob.ts

@@ -1,10 +1,12 @@
 import * as plugins from './smarttime.plugins';
 import { CronManager } from './smarttime.classes.cronmanager';
 
+import { CronParser } from './smarttime.classes.cronparser';
+
 export type TJobFunction = (() => void) | (() => Promise<any>);
 
 export class CronJob {
-  public croner;
+  public cronParser: CronParser | typeof plugins.croner;
   public status: 'started' | 'stopped' | 'initial' = 'initial';
   public cronExpression: string;
   public jobFunction: TJobFunction;
@@ -13,7 +15,7 @@ export class CronJob {
   constructor(cronManager: CronManager, cronExpressionArg: string, jobFunction: TJobFunction) {
     this.cronExpression = cronExpressionArg;
     this.jobFunction = jobFunction;
-    this.croner = plugins.croner(this.cronExpression);
+    this.cronParser = plugins.croner(cronExpressionArg);
   }
 
   /**
@@ -21,15 +23,29 @@ export class CronJob {
    */
   public checkExecution(): number {
     if (this.nextExecutionUnix === 0) {
-      this.nextExecutionUnix = this.croner.msToNext();
+      this.getNextExecutionTime();
     }
     if (Date.now() > this.nextExecutionUnix) {
-      this.jobFunction();
-      this.nextExecutionUnix = this.croner.msToNext();
+      const maybePromise = this.jobFunction();
+      if (maybePromise instanceof Promise) {
+        maybePromise.catch(e => console.log(e));
+      }
+      this.nextExecutionUnix = this.getNextExecutionTime();
     }
     return this.nextExecutionUnix;
   }
 
+  public getNextExecutionTime() {
+    return this.nextExecutionUnix = Date.now() + this.getTimeToNextExecution();
+  }
+
+  /**
+   * gets the time to next execution
+   */
+  public getTimeToNextExecution() {
+    return this.cronParser.msToNext();
+  }
+
   public start() {
     this.status = 'started';
   }

ts/smarttime.classes.cronmanager.ts

@@ -1,58 +1,84 @@
 import * as plugins from './smarttime.plugins';
 import { CronJob } from './smarttime.classes.cronjob';
+import { getMilliSecondsAsHumanReadableString } from './smarttime.units';
 
 export class CronManager {
   public executionTimeout: plugins.smartdelay.Timeout<void>;
 
   public status: 'started' | 'stopped' = 'stopped';
-  public cronjobs: CronJob[] = [];
+  public cronjobs = new plugins.lik.ObjectMap<CronJob>();
 
   constructor() {}
 
-  public addCronjob(cronIdentifierArg: string, cronFunctionArg: () => any) {
+  public addCronjob(cronIdentifierArg: string, cronFunctionArg: () => Promise<void>) {
     const newCronJob = new CronJob(this, cronIdentifierArg, cronFunctionArg);
-    this.cronjobs.push(newCronJob);
+    this.cronjobs.add(newCronJob);
     if (this.status === 'started') {
       newCronJob.start();
     }
+
+    return newCronJob;
+  }
+
+  public removeCronjob(cronjobArg: CronJob) {
+    cronjobArg.stop();
+    this.cronjobs.remove(cronjobArg);
   }
 
   /**
    * starts the cronjob
    */
   public start() {
-    this.status = 'started';
-    for (const cronJob of this.cronjobs) {
-      cronJob.start();
-    }
-    this.executionTimeout = new plugins.smartdelay.Timeout(0);
-
-    // recursion
-    const runCheckExecution = () => {
-      console.log(`Next CronJob scheduled in ${this.executionTimeout.getTimeLeft()} milliseconds`);
-      this.executionTimeout.promise.then(() => {
-        let timeToNextOverallExecution: number;
-        for (const cronJob of this.cronjobs) {
-          const timeToNextJobExecution = cronJob.checkExecution();
-          if (timeToNextJobExecution < timeToNextOverallExecution || !timeToNextOverallExecution) {
-            timeToNextOverallExecution = timeToNextJobExecution;
+    if (this.status !== 'started') {
+      this.status = 'started';
+      for (const cronJob of this.cronjobs.getArray()) {
+        cronJob.start();
+      }
+      const runCronCycle = async () => {
+        this.executionTimeout = new plugins.smartdelay.Timeout(0);
+        do {
+          let nextRunningCronjob: CronJob;
+          for (const cronJob of this.cronjobs.getArray()) {
+            cronJob.checkExecution();
+            if (
+              !nextRunningCronjob ||
+              cronJob.getTimeToNextExecution() < nextRunningCronjob.getTimeToNextExecution()
+            ) {
+              nextRunningCronjob = cronJob;
+            }
+          }
+          if (nextRunningCronjob) {
+            this.executionTimeout = new plugins.smartdelay.Timeout(
+              nextRunningCronjob.getTimeToNextExecution()
+            );
+            console.log(
+              `Next CronJob scheduled in ${getMilliSecondsAsHumanReadableString(
+                this.executionTimeout.getTimeLeft()
+              )}`
+            );
+          } else {
+            this.executionTimeout = new plugins.smartdelay.Timeout(1000);
+            console.log('no cronjobs specified! Checking again in 1 second');
           }
-        }
-        this.executionTimeout = new plugins.smartdelay.Timeout(timeToNextOverallExecution);
-        runCheckExecution();
-      });
-    };
 
-    runCheckExecution();
+          await this.executionTimeout.promise;
+        } while (this.status === 'started');
+      };
+      runCronCycle();
+    }
   }
 
   /**
    * stops all cronjobs
    */
   public stop() {
-    this.status = 'stopped';
-    this.executionTimeout.cancel();
-    for (const cron of this.cronjobs) {
+    if (this.status === 'started') {
+      this.status = 'stopped';
+      this.executionTimeout.cancel();
+    } else {
+      console.log(`You tried to stop a CronManager that was not actually started.`);
+    }
+    for (const cron of this.cronjobs.getArray()) {
       cron.stop();
     }
   }

ts/smarttime.classes.cronparser.ts

@@ -0,0 +1,88 @@
+import * as plugins from './smarttime.plugins';
+
+export class CronParser {
+  public cronExpression: string;
+  public get cronArray() {
+    return this.cronExpression.split(' ');
+  }
+  constructor(cronExpressionArg: string) {
+    this.cronExpression = cronExpressionArg;
+    if (this.cronArray.length < 6) {
+      throw new Error('CronParser needs second level accuracy');
+    }
+  }
+
+  private getNextPartMatch(cronPart: string, startValue: number, moduloArg: number) {
+    if (cronPart === '*') {
+      return startValue;
+    }
+    if (cronPart.includes('/')) {
+      const every = parseInt(cronPart.split('/')[1], 10);
+      const findEvenMatch = (recursionStartArg: number): number => {
+        if (recursionStartArg % every === 0) {
+          return recursionStartArg;
+        } else {
+          return findEvenMatch(recursionStartArg + 1);
+        }
+      };
+      return findEvenMatch(startValue);
+    }
+    if (parseInt(cronPart, 10) || cronPart === '0') {
+      const match = parseInt(cronPart, 10);
+      return match;
+    }
+  }
+
+  public msToNext() {
+    const cronArray = this.cronArray;
+    const secondExpression = cronArray[0];
+    const minuteExpression = cronArray[1];
+    const hourExpression = cronArray[2];
+    const dayExpression = cronArray[3];
+    const monthExpression = cronArray[4];
+    const yearExpression = cronArray[5];
+
+    let currentDate = new Date();
+    let currentSecond = currentDate.getSeconds() + 1;
+    let currentMinute = currentDate.getMinutes();
+    let currentHour = currentDate.getHours();
+    let currentDay = currentDate.getDate();
+    let currentMonth = currentDate.getMonth();
+    let currentYear = currentDate.getFullYear();
+
+    const targetSecond = this.getNextPartMatch(secondExpression, currentSecond, 59);
+    if (targetSecond < currentSecond) {
+      currentMinute = (currentMinute + 1) % 59;
+    }
+    const targetMinute = this.getNextPartMatch(minuteExpression, currentMinute, 59);
+    if (targetMinute < currentMinute) {
+      currentHour = (currentHour + 1) % 23;
+    }
+    const targetHour = this.getNextPartMatch(hourExpression, currentHour, 23);
+    if (targetHour < currentHour) {
+      currentDay = (currentDay + 1) % 30;
+    }
+    
+    const targetDay = currentDay;
+    if (targetDay < currentDay) {
+      currentMonth = (currentMonth + 1) % 11;
+    }
+
+    const targetMonth = currentMonth;
+    if (targetMonth < currentMonth) {
+      currentYear = (currentYear + 1);
+    }
+    const targetYear = currentYear;
+
+    const targetDate = new Date(
+      targetYear,
+      targetMonth,
+      targetDay,
+      targetHour,
+      targetMinute,
+      targetSecond
+    );
+    const targetTime = targetDate.getTime();
+    return targetTime - Date.now();
+  }
+}

ts/smarttime.classes.extendeddate.ts

@@ -1,4 +1,5 @@
 import * as plugins from './smarttime.plugins';
+import * as units from './smarttime.units';
 
 export type TAvailableZone = 'Europe/Berlin';
 
@@ -72,7 +73,7 @@ export class ExtendedDate extends Date {
   // INSTANCE
   public timezone: TAvailableZone;
 
-  constructor(unixMilli: number) {
+  constructor(unixMilli: number = Date.now()) {
     super(unixMilli);
   }
 
@@ -121,4 +122,25 @@ export class ExtendedDate extends Date {
       dayOfTheWeekName: daysArray[this.getDay()],
     };
   }
+
+  public format (formatArg: string) {
+    return plugins.dayjs(this.getTime()).format(formatArg);
+  }
+
+  /**
+   * boolean checks
+   */
+  public isToday () {
+    return plugins.dayjs(this.getTime()).isToday();
+  }
+
+  public lessTimePassedToNow(unitArgs: units.IUnitCombinationArg): boolean {
+    const maxPassedUnixTime = units.getMilliSecondsFromUnits(unitArgs);
+    const actualPassedUnixTime = Date.now() - this.getTime();
+    return actualPassedUnixTime < maxPassedUnixTime;
+  }
+
+  public moreTimePassedToNow(unitArgs: units.IUnitCombinationArg) {
+    return !this.lessTimePassedToNow(unitArgs);
+  }
 }

ts/smarttime.classes.timestamp.ts

@@ -8,7 +8,7 @@ export class TimeStamp {
   /**
    * returns new TimeStamp from milliseconds
    */
-  public static fromMilliSeconds(milliSecondsArg) {
+  public static fromMilliSeconds(milliSecondsArg: number) {
     return new TimeStamp(milliSecondsArg);
   }
 

ts/smarttime.plugins.ts

@@ -1,11 +1,16 @@
 // @pushrocks scope
+import * as lik from '@pushrocks/lik';
 import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartpromise from '@pushrocks/smartpromise';
 
-export { smartdelay, smartpromise };
+export { lik, smartdelay, smartpromise };
 
-// third parties
-import croner from 'croner';
+// third parties;
+const croner: any = require('croner');
 import dayjs from 'dayjs';
+import isToday from 'dayjs/plugin/isToday';
+import prettyMs from 'pretty-ms';
 
-export { croner, dayjs };
+dayjs.extend(isToday);
+
+export { croner, dayjs, prettyMs };

ts/smarttime.units.ts

@@ -1,3 +1,5 @@
+import * as plugins from './smarttime.plugins';
+
 export let units = {
   years: (timesArg = 1): number => {
     return timesArg * 3.154e10;
@@ -30,7 +32,7 @@ export interface IUnitCombinationArg {
 
 export let getMilliSecondsFromUnits = (combinationArg: IUnitCombinationArg) => {
   let timeInMilliseconds = 0;
-  let addMilliSeconds = (milliSecondsArg) => {
+  let addMilliSeconds = (milliSecondsArg: number) => {
     timeInMilliseconds = timeInMilliseconds + milliSecondsArg;
   };
   if (combinationArg.years) {
@@ -54,3 +56,7 @@ export let getMilliSecondsFromUnits = (combinationArg: IUnitCombinationArg) => {
 
   return timeInMilliseconds;
 };
+
+export const getMilliSecondsAsHumanReadableString = (milliSecondsArg: number): string => {
+  return plugins.prettyMs(milliSecondsArg);
+}