@orion-js/dogs 3.1.0-alpha.9 → 3.1.6

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Orionjs Team
+Copyright (c) 2022 Orionjs Team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/events.test.js

@@ -3,6 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 require("reflect-metadata");
 const helpers_1 = require("@orion-js/helpers");
 const _1 = require(".");
+const logger_1 = require("@orion-js/logger");
+(0, logger_1.setLogLevel)('error');
 describe('Event tests', () => {
     it('Should run an event job', async () => {
         let count = 0;
@@ -16,8 +18,7 @@ describe('Event tests', () => {
             jobs: { job3 },
             workersCount: 1,
             pollInterval: 10,
-            cooldownPeriod: 10,
-            logLevel: 'none'
+            cooldownPeriod: 10
         });
         expect(count).toBe(0);
         await (0, _1.scheduleJob)({
@@ -55,8 +56,7 @@ describe('Event tests', () => {
             jobs: { job4 },
             workersCount: 1,
             pollInterval: 10,
-            cooldownPeriod: 10,
-            logLevel: 'none'
+            cooldownPeriod: 10
         });
         expect(passes).toBe(false);
         await (0, _1.scheduleJob)({
@@ -90,8 +90,7 @@ describe('Event tests', () => {
             workersCount: 2,
             pollInterval: 10,
             cooldownPeriod: 10,
-            lockTime: 10,
-            logLevel: 'none'
+            lockTime: 10
         });
         await (0, _1.scheduleJob)({
             name: jobId,
@@ -115,8 +114,7 @@ describe('Event tests', () => {
             jobs: { [jobId]: job },
             workersCount: 1,
             pollInterval: 10,
-            cooldownPeriod: 10,
-            logLevel: 'none'
+            cooldownPeriod: 10
         });
         await (0, _1.scheduleJob)({
             name: jobId,

package/lib/history.test.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const helpers_1 = require("@orion-js/helpers");
 const _1 = require(".");
+const logger_1 = require("@orion-js/logger");
+(0, logger_1.setLogLevel)('error');
 describe('Test Jobs History', () => {
     it('Should save success history types', async () => {
         const jobId = (0, helpers_1.generateId)();
@@ -58,8 +60,7 @@ describe('Test Jobs History', () => {
         const instance = (0, _1.startWorkers)({
             jobs: { [jobId]: job },
             workersCount: 1,
-            pollInterval: 10,
-            logLevel: 'none'
+            pollInterval: 10
         });
         await (0, _1.scheduleJob)({
             name: jobId,
@@ -101,8 +102,7 @@ describe('Test Jobs History', () => {
             jobs: { [jobId]: job },
             workersCount: 1,
             pollInterval: 10,
-            lockTime: 10,
-            logLevel: 'none'
+            lockTime: 10
         });
         await (0, _1.scheduleJob)({
             name: jobId,

package/lib/recurrent.test.js

@@ -3,6 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 require("reflect-metadata");
 const helpers_1 = require("@orion-js/helpers");
 const _1 = require(".");
+const logger_1 = require("@orion-js/logger");
+(0, logger_1.setLogLevel)('error');
 describe('Recurrent tests', () => {
     it('Should run a recurrent job', async () => {
         let ran = false;
@@ -17,8 +19,7 @@ describe('Recurrent tests', () => {
             jobs: { job1 },
             workersCount: 1,
             pollInterval: 100,
-            cooldownPeriod: 100,
-            logLevel: 'none'
+            cooldownPeriod: 100
         });
         await (0, helpers_1.sleep)(500);
         await instance.stop();
@@ -37,8 +38,7 @@ describe('Recurrent tests', () => {
             jobs: { job2 },
             workersCount: 1,
             pollInterval: 10,
-            cooldownPeriod: 10,
-            logLevel: 'none'
+            cooldownPeriod: 10
         });
         await (0, helpers_1.sleep)(200);
         await instance.stop();

package/lib/repos/JobsRepo.js

@@ -7,9 +7,9 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JobsRepo = void 0;
+const logger_1 = require("@orion-js/logger");
 const mongodb_1 = require("@orion-js/mongodb");
 const services_1 = require("@orion-js/services");
-const log_1 = require("../log");
 const JobRecord_1 = require("../types/JobRecord");
 let JobsRepo = class JobsRepo {
     constructor() {
@@ -67,7 +67,7 @@ let JobsRepo = class JobsRepo {
             return;
         let tries = job.tries || 1;
         if (job.lockedUntil) {
-            (0, log_1.log)('info', `Running job "${job.jobName}" that was staled`);
+            logger_1.logger.info(`Running job "${job.jobName}" that was staled`);
             this.jobs.updateOne(job._id, { $inc: { tries: 1 } });
             tries++;
         }
@@ -104,6 +104,7 @@ let JobsRepo = class JobsRepo {
         });
     }
     async ensureJobRecord(job) {
+        await this.jobs.connectionPromise;
         const result = await this.jobs.upsert({
             jobName: job.name
         }, {
@@ -116,10 +117,10 @@ let JobsRepo = class JobsRepo {
             }
         });
         if (result.upsertedId) {
-            (0, log_1.log)('info', `Created job record for "${job.name}"`);
+            logger_1.logger.info(`Created job record for "${job.name}"`);
         }
         else {
-            (0, log_1.log)('info', `Record for job "${job.name}" already exists`);
+            logger_1.logger.info(`Record for job "${job.name}" already exists`);
         }
     }
     async scheduleJob(options) {
@@ -135,7 +136,7 @@ let JobsRepo = class JobsRepo {
         }
         catch (error) {
             if (error.code === 11000 && options.uniqueIdentifier) {
-                (0, log_1.log)('info', `Job "${options.name}" with identifier "${options.uniqueIdentifier}" already exists`);
+                logger_1.logger.info(`Job "${options.name}" with identifier "${options.uniqueIdentifier}" already exists`);
             }
             else {
                 throw error;

package/lib/services/EventsService.js

@@ -10,13 +10,13 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EventsService = void 0;
+const logger_1 = require("@orion-js/logger");
 const services_1 = require("@orion-js/services");
-const log_1 = require("../log");
 const JobsRepo_1 = require("../repos/JobsRepo");
 const getNextRunDate_1 = require("./getNextRunDate");
 let EventsService = class EventsService {
     async scheduleJob(options) {
-        (0, log_1.log)('info', 'Scheduling job...', options);
+        logger_1.logger.info('Scheduling job...', options);
         await this.jobsRepo.scheduleJob({
             name: options.name,
             priority: options.priority || 1,

package/lib/services/Executor.d.ts

@@ -15,6 +15,6 @@ export declare class Executor {
         job: JobDefinition;
         jobToRun: JobToRun;
     }): Promise<void>;
-    afterExecutionSuccess(job: JobDefinition, jobToRun: JobToRun): Promise<void>;
+    afterExecutionSuccess(job: JobDefinition, jobToRun: JobToRun, context: ExecutionContext): Promise<void>;
     executeJob(jobs: JobsDefinition, jobToRun: JobToRun): Promise<void>;
 }

package/lib/services/Executor.js

@@ -10,8 +10,8 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Executor = void 0;
+const logger_1 = require("@orion-js/logger");
 const services_1 = require("@orion-js/services");
-const log_1 = require("../log");
 const JobsHistoryRepo_1 = require("../repos/JobsHistoryRepo");
 const JobsRepo_1 = require("../repos/JobsRepo");
 const getNextRunDate_1 = require("./getNextRunDate");
@@ -27,13 +27,17 @@ let Executor = class Executor {
                 clearTimeout(staleTimeout);
                 staleTimeout = setTimeout(() => onStale(), extraTime);
                 await this.jobsRepo.extendLockTime(jobToRun.jobId, extraTime);
-            }
+            },
+            logger: logger_1.logger.addMetadata({
+                jobName: jobToRun.name,
+                jobId: jobToRun.jobId
+            })
         };
     }
     getJobDefinition(jobToRun, jobs) {
         const job = jobs[jobToRun.name];
         if (jobToRun.type !== job.type) {
-            (0, log_1.log)('warn', `Job record "${jobToRun.name}" is "${jobToRun.type}" but definition is "${job.type}"`);
+            logger_1.logger.warn(`Job record "${jobToRun.name}" is "${jobToRun.type}" but definition is "${job.type}"`);
             return;
         }
         return job;
@@ -49,12 +53,12 @@ let Executor = class Executor {
             }
         };
         if (!job.onError) {
-            (0, log_1.log)('error', `Error executing job "${jobToRun.name}"`, error);
+            context.logger.error(`Error executing job "${jobToRun.name}"`, error);
             await scheduleRecurrent();
             return;
         }
         else {
-            (0, log_1.log)('info', `Error executing job "${jobToRun.name}"`, error);
+            context.logger.info(`Error executing job "${jobToRun.name}"`, error);
         }
         const result = await job.onError(error, jobToRun.params, context);
         if (result.action === 'dismiss') {
@@ -73,7 +77,8 @@ let Executor = class Executor {
         const { startedAt, status, errorMessage, result, job, jobToRun } = options;
         const endedAt = new Date();
         if (job.saveExecutionsFor !== 0) {
-            const saveExecutionsFor = job.saveExecutionsFor || 24 * 60 * 60 * 1000;
+            const oneWeek = 1000 * 60 * 60 * 24 * 7;
+            const saveExecutionsFor = job.saveExecutionsFor || oneWeek;
             await this.jobsHistoryRepo.saveExecution({
                 executionId: jobToRun.jobId,
                 jobName: jobToRun.name,
@@ -92,9 +97,9 @@ let Executor = class Executor {
             });
         }
     }
-    async afterExecutionSuccess(job, jobToRun) {
+    async afterExecutionSuccess(job, jobToRun, context) {
         if (job.type === 'recurrent') {
-            (0, log_1.log)('info', `Scheduling next run for recurrent job "${jobToRun.name}"`);
+            context.logger.info(`Scheduling next run for recurrent job "${jobToRun.name}"`);
             await this.jobsRepo.scheduleNextRun({
                 jobId: jobToRun.jobId,
                 nextRunAt: (0, getNextRunDate_1.getNextRunDate)(job),
@@ -102,7 +107,7 @@ let Executor = class Executor {
             });
         }
         if (job.type === 'event') {
-            (0, log_1.log)('info', `Removing event job after success "${jobToRun.name}"`);
+            context.logger.info(`Removing event job after success "${jobToRun.name}"`);
             await this.jobsRepo.deleteEventJob(jobToRun.jobId);
         }
     }
@@ -113,11 +118,11 @@ let Executor = class Executor {
         const startedAt = new Date();
         const onStale = () => {
             if (job.onStale) {
-                (0, log_1.log)('info', `Job "${jobToRun.name}" is stale`);
+                context.logger.info(`Job "${jobToRun.name}" is stale`);
                 job.onStale(jobToRun.params, context);
             }
             else {
-                (0, log_1.log)('error', `Job "${jobToRun.name}" is stale`);
+                context.logger.error(`Job "${jobToRun.name}" is stale`);
             }
             this.saveExecution({
                 startedAt,
@@ -140,7 +145,7 @@ let Executor = class Executor {
                 job,
                 jobToRun
             });
-            await this.afterExecutionSuccess(job, jobToRun);
+            await this.afterExecutionSuccess(job, jobToRun, context);
         }
         catch (error) {
             context.clearStaleTimeout();

package/lib/services/WorkerService.js

@@ -15,7 +15,7 @@ const lodash_1 = require("lodash");
 const JobsRepo_1 = require("../repos/JobsRepo");
 const helpers_1 = require("@orion-js/helpers");
 const Executor_1 = require("./Executor");
-const log_1 = require("../log");
+const logger_1 = require("@orion-js/logger");
 let WorkerService = class WorkerService {
     getJobNames(jobs) {
         return Object.keys(jobs);
@@ -30,20 +30,20 @@ let WorkerService = class WorkerService {
     }
     async runWorkerLoop(config) {
         const names = this.getJobNames(config.jobs);
-        (0, log_1.log)('debug', `Running worker loop for jobs "${names.join(', ')}"...`);
+        logger_1.logger.debug(`Running worker loop for jobs "${names.join(', ')}"...`);
         const jobToRun = await this.jobsRepo.getJobAndLock(names, config.lockTime);
         if (!jobToRun) {
-            (0, log_1.log)('debug', 'No job to run');
+            logger_1.logger.debug('No job to run');
             return false;
         }
-        (0, log_1.log)('info', `Got job to run: ${JSON.stringify(jobToRun)}`);
+        logger_1.logger.info(`Got job to run:`, jobToRun);
         await this.executor.executeJob(config.jobs, jobToRun);
         return true;
     }
     async startWorker(config, workersInstance) {
         while (true) {
             if (!workersInstance.running) {
-                (0, log_1.log)('info', 'Got signal to stop. Stopping worker...');
+                logger_1.logger.info('Got signal to stop. Stopping worker...');
                 return;
             }
             try {
@@ -54,7 +54,7 @@ let WorkerService = class WorkerService {
                     await (0, helpers_1.sleep)(config.cooldownPeriod);
             }
             catch (error) {
-                (0, log_1.log)('error', `Error in job runner. Waiting and running again`, error);
+                logger_1.logger.error(`Error in job runner. Waiting and running again`, error);
                 await (0, helpers_1.sleep)(config.pollInterval);
             }
         }
@@ -65,7 +65,7 @@ let WorkerService = class WorkerService {
             workersCount: config.workersCount,
             workers: [],
             stop: async () => {
-                (0, log_1.log)('debug', 'Stopping workers...', workersInstance.workers);
+                logger_1.logger.debug('Stopping workers...', workersInstance.workers);
                 workersInstance.running = false;
                 await Promise.all(workersInstance.workers);
             }
@@ -77,15 +77,15 @@ let WorkerService = class WorkerService {
         await Promise.all(jobs
             .filter(job => job.type === 'recurrent')
             .map(async (job) => {
-            (0, log_1.log)('info', `Ensuring records for job "${job.name}"...`);
+            logger_1.logger.info(`Ensuring records for job "${job.name}"...`);
             await this.jobsRepo.ensureJobRecord(job);
         }));
     }
     async runWorkers(config, workersInstance) {
-        (0, log_1.log)('info', 'Will ensure records for recurrent jobs');
+        logger_1.logger.info('Will ensure records for recurrent jobs');
         await this.ensureRecords(config);
         for (const workerIndex of (0, lodash_1.range)(config.workersCount)) {
-            (0, log_1.log)('info', `Starting worker ${workerIndex}`);
+            logger_1.logger.info(`Starting worker ${workerIndex}`);
             const workerPromise = this.startWorker(config, workersInstance);
             workersInstance.workers.push(workerPromise);
         }
@@ -96,16 +96,14 @@ let WorkerService = class WorkerService {
             cooldownPeriod: 100,
             pollInterval: 3000,
             workersCount: 4,
-            lockTime: 30 * 1000,
-            logLevel: 'info'
+            lockTime: 30 * 1000
         };
         const config = {
             ...defaultConfig,
             ...userConfig
         };
-        (0, log_1.setLogLevel)(config.logLevel);
         const workersInstance = this.createWorkersInstanceDefinition(config);
-        (0, log_1.log)('info', 'Starting workers', config);
+        logger_1.logger.info('Starting workers', config);
         this.runWorkers(config, workersInstance);
         return workersInstance;
     }

package/lib/types/JobsDefinition.d.ts

@@ -24,7 +24,7 @@ export interface BaseJobDefinition {
      */
     onStale?: (params: PlainObject, context: ExecutionContext) => Promise<void>;
     /**
-     * Save the executions of the job time in milliseconds. Default is 1 day. Set to 0 to disable.
+     * Save the executions of the job time in milliseconds. Default is 1 week. Set to 0 to disable.
      */
     saveExecutionsFor?: number;
 }

package/lib/types/StartConfig.d.ts

@@ -25,8 +25,4 @@ export interface StartWorkersConfig {
      * You can extend this time inside a job by calling extendLockTime from context.
      */
     lockTime: number;
-    /**
-     * logLevel is the level of logging to use. Default is 'info'.
-     */
-    logLevel: LogLevels;
 }

package/lib/types/Worker.d.ts

@@ -1,3 +1,4 @@
+import { OrionLogger } from '@orion-js/logger';
 import { PlainObject } from './HistoryRecord';
 import { JobDefinition } from './JobsDefinition';
 export interface JobToRun {
@@ -14,6 +15,7 @@ export interface ExecutionContext {
     record: JobToRun;
     definition: JobDefinition;
     tries: number;
+    logger: OrionLogger;
     extendLockTime: (extraTime: number) => Promise<void>;
     clearStaleTimeout: () => void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orion-js/dogs",
-  "version": "3.1.0-alpha.9",
+  "version": "3.1.6",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -17,12 +17,16 @@
     "upgrade-interactive": "yarn upgrade-interactive"
   },
   "dependencies": {
-    "@orion-js/helpers": "^3.0.36",
-    "@orion-js/mongodb": "^3.1.0-alpha.0",
-    "@orion-js/services": "^3.1.0-alpha.0",
-    "@orion-js/typed-model": "^3.0.38"
+    "@orion-js/helpers": "^3.1.6",
+    "@orion-js/mongodb": "^3.1.6",
+    "@orion-js/services": "^3.1.6",
+    "@orion-js/typed-model": "^3.1.6"
+  },
+  "peerDependencies": {
+    "@orion-js/logger": "3.1.0-alpha.12"
   },
   "devDependencies": {
+    "@orion-js/logger": "^3.1.6",
     "@shelf/jest-mongodb": "^2.1.0",
     "@types/jest": "^27.0.2",
     "@types/lodash": "4.14.176",
@@ -35,5 +39,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "65ebf7047a46aa5e93e9066d82ca70f81d69f10c"
+  "gitHead": "cb180a6a89ee2042f9d3dc80725f3aa05705a963"
 }

package/lib/log/index.d.ts

@@ -1,5 +0,0 @@
-import { LogLevels } from '../types/StartConfig';
-export declare let appLogLevel: LogLevels;
-export declare const levelToInt: (level: LogLevels) => 0 | 1 | 2 | 3;
-export declare const log: (level: LogLevels, ...args: any[]) => void;
-export declare const setLogLevel: (level: LogLevels) => void;

package/lib/log/index.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setLogLevel = exports.log = exports.levelToInt = exports.appLogLevel = void 0;
-exports.appLogLevel = 'info';
-const levelToInt = (level) => {
-    switch (level) {
-        case 'debug':
-            return 0;
-        case 'info':
-            return 1;
-        case 'warn':
-            return 2;
-        case 'error':
-            return 3;
-    }
-};
-exports.levelToInt = levelToInt;
-const log = (level, ...args) => {
-    if (exports.appLogLevel === 'none')
-        return;
-    const levelInt = (0, exports.levelToInt)(level);
-    const appLogLevelInt = (0, exports.levelToInt)(exports.appLogLevel);
-    if (levelInt < appLogLevelInt)
-        return;
-    console[level](...args);
-};
-exports.log = log;
-const setLogLevel = (level) => {
-    exports.appLogLevel = level;
-};
-exports.setLogLevel = setLogLevel;