Skip to content

Commit

Permalink
refactor: refactor tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@shadowgate15
shadowgate15 committed Feb 6, 2021
1 parent 701e32b commit 255f60a
Show file tree
Hide file tree
Showing 24 changed files with 1,928 additions and 1,901 deletions.
13 changes: 13 additions & 0 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,19 @@
],
"ignore": [
"config.js"
],
"rules": {
"capitalized-comments": "off"
},
"overrides": [
{
"files": [
"test/jobs/*.js"
],
"rules": {
"unicorn/no-process-exit": "off"
}
}
]
}
}
2 changes: 2 additions & 0 deletions src/index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,9 @@ class Bree extends EventEmitter {
if (Number.isFinite(closeWorkerAfterMs) && closeWorkerAfterMs > 0) {
debug('worker has close set', name, closeWorkerAfterMs);
this.closeWorkerAfterMs[name] = setTimeout(() => {
/* istanbul ignore else */
if (this.workers[name]) {
debug('worker has been terminated', name);
this.workers[name].terminate();
}
}, closeWorkerAfterMs);
Expand Down
18 changes: 10 additions & 8 deletions src/job-builder.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ const buildJob = (job, config) => {
};
}

// process job.path
// Process job.path
if (typeof job.path === 'function') {
const path = `(${job.path.toString()})()`;

Expand All @@ -59,7 +59,7 @@ const buildJob = (job, config) => {
if (isValidPath(path)) {
job.path = path;
} else {
// assume that it's a transformed eval string
// Assume that it's a transformed eval string
job.worker = {
eval: true,
...job.worker
Expand All @@ -75,11 +75,11 @@ const buildJob = (job, config) => {
job.interval = parseValue(job.interval);
}

// build cron
// Build cron
if (typeof job.cron !== 'undefined') {
if (isSchedule(job.cron)) {
job.interval = job.cron;
// delete job.cron;
// Delete job.cron;
} else {
job.interval = later.parse.cron(
job.cron,
Expand All @@ -92,7 +92,7 @@ const buildJob = (job, config) => {
}
}

// if timeout was undefined, cron was undefined,
// If timeout was undefined, cron was undefined,
// and date was undefined then set the default
// (as long as the default timeout is >= 0)
if (
Expand All @@ -102,10 +102,11 @@ const buildJob = (job, config) => {
typeof job.cron === 'undefined' &&
typeof job.date === 'undefined' &&
typeof job.interval === 'undefined'
)
) {
job.timeout = config.timeout;
}

// if interval was undefined, cron was undefined,
// If interval was undefined, cron was undefined,
// and date was undefined then set the default
// (as long as the default interval is > 0, or it was a schedule, or it was valid)
if (
Expand All @@ -114,8 +115,9 @@ const buildJob = (job, config) => {
typeof job.interval === 'undefined' &&
typeof job.cron === 'undefined' &&
typeof job.date === 'undefined'
)
) {
job.interval = config.interval;
}

return job;
};
Expand Down
85 changes: 54 additions & 31 deletions src/job-validator.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,21 @@ const threads = require('bthreads');
const { getName, isSchedule, parseValue } = require('./job-utils');

const validateReservedJobName = (name) => {
// don't allow a job to have the `index` file name
if (['index', 'index.js', 'index.mjs'].includes(name))
// Don't allow a job to have the `index` file name
if (['index', 'index.js', 'index.mjs'].includes(name)) {
return new Error(
'You cannot use the reserved job name of "index", "index.js", nor "index.mjs"'
);
}
};

const validateStringJob = (job, i, config) => {
const errors = [];

const jobNameError = validateReservedJobName(job);
if (jobNameError) throw jobNameError;
if (jobNameError) {
throw jobNameError;
}

if (!config.root) {
errors.push(
Expand All @@ -43,22 +46,26 @@ const validateStringJob = (job, i, config) => {
/* istanbul ignore next */
if (!threads.browser) {
const stats = fs.statSync(path);
if (!stats.isFile())
if (!stats.isFile()) {
throw new Error(`Job #${i + 1} "${job}" path missing: ${path}`);
}
}
};

const validateFunctionJob = (job, i) => {
const errors = [];

const path = `(${job.toString()})()`;
// can't be a built-in or bound function
if (path.includes('[native code]'))
// Can't be a built-in or bound function
if (path.includes('[native code]')) {
errors.push(
new Error(`Job #${i + 1} can't be a bound or built-in function`)
);
}

if (errors.length > 0) throw combineErrors(errors);
if (errors.length > 0) {
throw combineErrors(errors);
}
};

const validateJobPath = (job, prefix, config) => {
Expand All @@ -67,17 +74,18 @@ const validateJobPath = (job, prefix, config) => {
if (typeof job.path === 'function') {
const path = `(${job.path.toString()})()`;

// can't be a built-in or bound function
if (path.includes('[native code]'))
// Can't be a built-in or bound function
if (path.includes('[native code]')) {
errors.push(new Error(`${prefix} can't be a bound or built-in function`));
}
} else if (!isSANB(job.path) && !config.root) {
errors.push(
new Error(
`${prefix} requires root directory option to auto-populate path`
)
);
} else {
// validate path
// Validate path
const path = isSANB(job.path)
? job.path
: join(
Expand All @@ -92,10 +100,12 @@ const validateJobPath = (job, prefix, config) => {
if (!threads.browser) {
const stats = fs.statSync(path);
// eslint-disable-next-line max-depth
if (!stats.isFile())
if (!stats.isFile()) {
throw new Error(`${prefix} path missing: ${path}`);
}
}
} catch (err) {
/* istanbul ignore next */
errors.push(err);
}
}
Expand Down Expand Up @@ -133,7 +143,7 @@ const validateCron = (job, prefix, config) => {
const errors = [];

if (!isSchedule(job.cron)) {
// if `hasSeconds` was `true` then set `cronValidate` and inherit any existing options
// If `hasSeconds` was `true` then set `cronValidate` and inherit any existing options
const cronValidate = job.hasSeconds
? cronValidateWithSeconds(job, config)
: config.cronValidate;
Expand Down Expand Up @@ -183,9 +193,11 @@ const validateJobName = (job, i, reservedNames) => {
const errors = [];
const name = getName(job);

if (!name) errors.push(new Error(`Job #${i + 1} is missing a name`));
if (!name) {
errors.push(new Error(`Job #${i + 1} is missing a name`));
}

// throw an error if duplicate job names
// Throw an error if duplicate job names
if (reservedNames.includes(name)) {
errors.push(
new Error(`Job #${i + 1} has a duplicate job name of ${getName(job)}`)
Expand All @@ -198,40 +210,46 @@ const validateJobName = (job, i, reservedNames) => {
const validate = (job, i, names, config) => {
const errors = validateJobName(job, i, names);

if (errors.length > 0) throw combineErrors(errors);
if (errors.length > 0) {
throw combineErrors(errors);
}

// support a simple string which we will transform to have a path
// Support a simple string which we will transform to have a path
if (isSANB(job)) {
return validateStringJob(job, i, config);
}

// job is a function
// Job is a function
if (typeof job === 'function') {
return validateFunctionJob(job, i);
}

// use a prefix for errors
// Use a prefix for errors
const prefix = `Job #${i + 1} named "${job.name}"`;

errors.push(...validateJobPath(job, prefix, config));

// don't allow users to mix interval AND cron
// Don't allow users to mix interval AND cron
if (typeof job.interval !== 'undefined' && typeof job.cron !== 'undefined') {
errors.push(
new Error(`${prefix} cannot have both interval and cron configuration`)
);
}

// don't allow users to mix timeout AND date
if (typeof job.timeout !== 'undefined' && typeof job.date !== 'undefined')
// Don't allow users to mix timeout AND date
if (typeof job.timeout !== 'undefined' && typeof job.date !== 'undefined') {
errors.push(new Error(`${prefix} cannot have both timeout and date`));
}

const jobNameError = validateReservedJobName(job.name);
if (jobNameError) errors.push(jobNameError);
if (jobNameError) {
errors.push(jobNameError);
}

// validate date
if (typeof job.date !== 'undefined' && !(job.date instanceof Date))
// Validate date
if (typeof job.date !== 'undefined' && !(job.date instanceof Date)) {
errors.push(new Error(`${prefix} had an invalid Date of ${job.date}`));
}

['timeout', 'interval'].forEach((prop) => {
if (typeof job[prop] !== 'undefined') {
Expand All @@ -248,44 +266,49 @@ const validate = (job, i, names, config) => {
}
});

// validate hasSeconds
// Validate hasSeconds
if (
typeof job.hasSeconds !== 'undefined' &&
typeof job.hasSeconds !== 'boolean'
)
) {
errors.push(
new Error(
`${prefix} had hasSeconds value of ${job.hasSeconds} (it must be a Boolean)`
)
);
}

// validate cronValidate
// Validate cronValidate
if (
typeof job.cronValidate !== 'undefined' &&
typeof job.cronValidate !== 'object'
)
) {
errors.push(
new Error(
`${prefix} had cronValidate value set, but it must be an Object`
)
);
}

if (typeof job.cron !== 'undefined') {
errors.push(...validateCron(job, prefix, config));
}

// validate closeWorkerAfterMs
// Validate closeWorkerAfterMs
if (
typeof job.closeWorkerAfterMs !== 'undefined' &&
(!Number.isFinite(job.closeWorkerAfterMs) || job.closeWorkerAfterMs <= 0)
)
) {
errors.push(
new Error(
`${prefix} had an invalid closeWorkersAfterMs value of ${job.closeWorkersAfterMs} (it must be a finite number > 0)`
)
);
}

if (errors.length > 0) throw combineErrors(errors);
if (errors.length > 0) {
throw combineErrors(errors);
}
};

module.exports = validate;
Expand Down

0 comments on commit 255f60a

Please sign in to comment.