8621685598

Committed 09 Apr 2024 08:12PM UTC coverage: 87.353% (-0.04%) from 87.397%

Build # 8621685598

Build Type

Pull #762

github

Committed by

web-flow

Commit Message

Merge ad5dececa into ae4f4ee0c

Pull Request Pull Request #762: feature(framework): introduce status symbols

Run Details

464 of 691 branches covered (67.15%)

Branch coverage included in aggregate %.

24 of 29 new or added lines in 2 files covered. (82.76%)

1 existing line in 1 file now uncovered.

4944 of 5500 relevant lines covered (89.89%)

1125.61 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

81.46

/framework/src/cli/check-routes.ts

/* eslint no-console: 0 */
import jobCreator from '../helper/job-creator.js';
import language, {
  locale,
} from '../helper/language.js';
import {
  DEFAULT_LANGUAGE,
  ONE,
  EMPTY,
  FIRST_ARGUMENT,
} from '../constants.js';
import validateTasks from '../validate-tasks.js';
import taskTypes from '../task-types.js';
import Task from '../task.js';
import Job from '../job.js';
import taskType from '../task-type.js';
import Request from '../request.js';
import logSymbols from 'log-symbols';
import languageKey from '../locales/language-key.js';

const warn = (key: languageKey, ...argList: string[]) => {
  console.warn(logSymbols.warning + ' ' + language(key, ...argList,),);
};
const error = (key: languageKey, ...argList: string[]) => {
  console.error(logSymbols.error + ' ' + language(key, ...argList,),);
};

// eslint-disable-next-line complexity
const checkMiddleware = (type: 'pre'|'post', route: Task,) => {
  if (typeof route[type] === 'undefined') {
    return true;
  }
  const data = route[type];
  delete route[type];
  if (typeof data !== 'object' || ! Array.isArray(data,)) {
    error(`invalid_${ type }_definition`, route.id,);
    return false;
  }
  for (const middleware of data) {
    if (typeof middleware !== 'string') {
      error(`invalid_${ type }_definition`, route.id,);
      return false;
    }
  }
  return true;
};

// eslint-disable-next-line complexity
const checkRequest = (main: Request, id: string,): {
  invalid: boolean,
  risky: boolean,
} => {
  const properties = [
    {
      name: 'method',
      type: 'string',
      required: true,
    },
    {
      name: 'headers',
      type: 'object',
      required: false,
    },
    {
      name: 'cookies',
      type: 'object',
      required: false,
    },
    {
      name: 'body',
      type: [
        'string',
        'object',
      ],
      required: false,
    },
    {
      name: 'autohandle',
      type: 'string',
      required: false,
    },
    {
      name: 'url',
      type: 'string',
      required: true,
    },
    {
      name: 'maxDuration',
      type: 'number',
      required: false,
    },
  ];
  let valid = true;
  for (const property of properties) {
    if (property.required && typeof main[property.name] === 'undefined') {
      error('invalid_request_property', id, property.name,);
      valid = false;
    } else if (typeof main[property.name] !== property.type) {
      error('invalid_request_property', id, property.name,);
      valid = false;
      delete main[property.name];
    } else {
      delete main[property.name];
    }
  }
  if (Object.keys(main,).length === EMPTY) {
    warn('invalid_request', id,);
    return {
      invalid: ! valid,
      risky: true,
    };
  }
  return {
    invalid: ! valid,
    risky: false,
  };
};

// eslint-disable-next-line complexity
const checkType = (job: Job, type: taskType,) => {
  if (typeof job[type] === 'undefined') {
    return {
      errors: 0,
      warnings: 0,
    };
  }
  let errors = 0;
  let warnings = 0;
  if (job[type].length > EMPTY) {
    for (const route of job[type]) {
      if (! checkMiddleware('pre', route,)) {
        errors ++;
      }
      if (! checkMiddleware('post', route,)) {
        errors ++;
      }
      const id = route.id;
      delete route.id;
      const result = checkRequest(route.main, id,);
      if (result.invalid) {
        errors ++;
      }
      if (result.risky) {
        warnings ++;
      }
      delete route.main;
      for (const key of Object.keys(route,)) {
        warn('unknown_route_property', key, id,);
        warnings ++;
      }
    }
  }
  return {
    errors,
    warnings,
  };
};

// eslint-disable-next-line complexity
export default async(args: string[], cwd: string,): Promise<void> => {
  await locale(args[FIRST_ARGUMENT] || DEFAULT_LANGUAGE,);
  const job = await jobCreator(cwd,);
  validateTasks(ONE, ONE, job.main,);
  let errors = 0;
  let warnings = 0;
  for (const type of taskTypes) {
    const result = checkType(job, type,);
    errors += result.errors;
    warnings += result.warnings;
  }
  if (errors > EMPTY) {
    error('validation_errors', `${ errors }`,);
  }
  if (warnings > EMPTY) {
    error('validation_warnings', `${ warnings }`,);
  }
  if (warnings === EMPTY && errors === EMPTY) {
    console.log(logSymbols.success + ' ' + language('no_errors_warnings',),);
  }
};

1	/* eslint no-console: 0 */	4✔
2	import jobCreator from '../helper/job-creator.js';	4✔
3	import language, {	4✔
4	locale,	4✔
5	} from '../helper/language.js';	4✔
6	import {	4✔
7	DEFAULT_LANGUAGE,	4✔
8	ONE,	4✔
9	EMPTY,	4✔
10	FIRST_ARGUMENT,	4✔
11	} from '../constants.js';	4✔
12	import validateTasks from '../validate-tasks.js';	4✔
13	import taskTypes from '../task-types.js';	4✔
14	import Task from '../task.js';	4✔
15	import Job from '../job.js';	4✔
16	import taskType from '../task-type.js';	4✔
17	import Request from '../request.js';	4✔
18	import logSymbols from 'log-symbols';	4✔
19	import languageKey from '../locales/language-key.js';	4✔
20		4✔
21	const warn = (key: languageKey, ...argList: string[]) => {	4✔
22	console.warn(logSymbols.warning + ' ' + language(key, ...argList,),);	6✔
23	};	6✔
24	const error = (key: languageKey, ...argList: string[]) => {	4✔
25	console.error(logSymbols.error + ' ' + language(key, ...argList,),);	22✔
26	};	22✔
27		4✔
28	// eslint-disable-next-line complexity	4✔
29	const checkMiddleware = (type: 'pre'\|'post', route: Task,) => {	4✔
30	if (typeof route[type] === 'undefined') {	12✔
31	return true;	12✔
32	}	12✔
33	const data = route[type];	×
34	delete route[type];	×
35	if (typeof data !== 'object' \|\| ! Array.isArray(data,)) {	12!
NEW 36	error(`invalid_${ type }_definition`, route.id,);	×
37	return false;	×
38	}	×
39	for (const middleware of data) {	×
40	if (typeof middleware !== 'string') {	×
NEW 41	error(`invalid_${ type }_definition`, route.id,);	×
42	return false;	×
43	}	×
44	}	×
45	return true;	×
46	};	×
47		4✔
48	// eslint-disable-next-line complexity	4✔
49	const checkRequest = (main: Request, id: string,): {	4✔
50	invalid: boolean,	6✔
51	risky: boolean,	6✔
52	} => {	6✔
53	const properties = [	6✔
54	{	6✔
55	name: 'method',	6✔
56	type: 'string',	6✔
57	required: true,	6✔
58	},	6✔
59	{	6✔
60	name: 'headers',	6✔
61	type: 'object',	6✔
62	required: false,	6✔
63	},	6✔
64	{	6✔
65	name: 'cookies',	6✔
66	type: 'object',	6✔
67	required: false,	6✔
68	},	6✔
69	{	6✔
70	name: 'body',	6✔
71	type: [	6✔
72	'string',	6✔
73	'object',	6✔
74	],	6✔
75	required: false,	6✔
76	},	6✔
77	{	6✔
78	name: 'autohandle',	6✔
79	type: 'string',	6✔
80	required: false,	6✔
81	},	6✔
82	{	6✔
83	name: 'url',	6✔
84	type: 'string',	6✔
85	required: true,	6✔
86	},	6✔
87	{	6✔
88	name: 'maxDuration',	6✔
89	type: 'number',	6✔
90	required: false,	6✔
91	},	6✔
92	];	6✔
93	let valid = true;	6✔
94	for (const property of properties) {	6✔
95	if (property.required && typeof main[property.name] === 'undefined') {	42!
NEW 96	error('invalid_request_property', id, property.name,);	×
97	valid = false;	×
98	} else if (typeof main[property.name] !== property.type) {	42✔
99	error('invalid_request_property', id, property.name,);	18✔
100	valid = false;	18✔
101	delete main[property.name];	18✔
102	} else {	42✔
103	delete main[property.name];	24✔
104	}	24✔
105	}	42✔
106	if (Object.keys(main,).length === EMPTY) {	6✔
107	warn('invalid_request', id,);	6✔
108	return {	6✔
109	invalid: ! valid,	6✔
110	risky: true,	6✔
111	};	6✔
112	}	6✔
113	return {	×
114	invalid: ! valid,	×
115	risky: false,	×
116	};	×
117	};	×
118		4✔
119	// eslint-disable-next-line complexity	4✔
120	const checkType = (job: Job, type: taskType,) => {	4✔
121	if (typeof job[type] === 'undefined') {	14✔
122	return {	4✔
123	errors: 0,	4✔
124	warnings: 0,	4✔
125	};	4✔
126	}	4✔
127	let errors = 0;	10✔
128	let warnings = 0;	10✔
129	if (job[type].length > EMPTY) {	14✔
130	for (const route of job[type]) {	4✔
131	if (! checkMiddleware('pre', route,)) {	6!
132	errors ++;	×
133	}	×
134	if (! checkMiddleware('post', route,)) {	6!
135	errors ++;	×
136	}	×
137	const id = route.id;	6✔
138	delete route.id;	6✔
139	const result = checkRequest(route.main, id,);	6✔
140	if (result.invalid) {	6✔
141	errors ++;	6✔
142	}	6✔
143	if (result.risky) {	6✔
144	warnings ++;	6✔
145	}	6✔
146	delete route.main;	6✔
147	for (const key of Object.keys(route,)) {	6!
NEW 148	warn('unknown_route_property', key, id,);	×
149	warnings ++;	×
150	}	×
151	}	6✔
152	}	4✔
153	return {	10✔
154	errors,	10✔
155	warnings,	10✔
156	};	10✔
157	};	10✔
158		4✔
159	// eslint-disable-next-line complexity	4✔
160	export default async(args: string[], cwd: string,): Promise<void> => {	4✔
161	await locale(args[FIRST_ARGUMENT] \|\| DEFAULT_LANGUAGE,);	2✔
162	const job = await jobCreator(cwd,);	2✔
163	validateTasks(ONE, ONE, job.main,);	2✔
164	let errors = 0;	2✔
165	let warnings = 0;	2✔
166	for (const type of taskTypes) {	2✔
167	const result = checkType(job, type,);	14✔
168	errors += result.errors;	14✔
169	warnings += result.warnings;	14✔
170	}	14✔
171	if (errors > EMPTY) {	2✔
172	error('validation_errors', `${ errors }`,);	2✔
173	}	2✔
174	if (warnings > EMPTY) {	2✔
175	error('validation_warnings', `${ warnings }`,);	2✔
176	}	2✔
177	if (warnings === EMPTY && errors === EMPTY) {	2!
NEW 178	console.log(logSymbols.success + ' ' + language('no_errors_warnings',),);	×
UNCOV 179	}	×
180	};	2✔

Idrinth / api-bench / 8621685598

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous