9519717997

Committed 14 Jun 2024 05:02PM UTC coverage: 7.135% (-5.7%) from 12.844%

Build # 9519717997

Build Type

push

github

Committed by

web-flow

Commit Message

Show welcome modal to new signups only (#8135)

* Only show welcome modal to new users/signups

* Fix training cards showing after dismiss

* Fix CI

* Fix CI

* Updated `isWelcomeOnboardFlowComplete` to `is_welcome_onboard_flow_complete`

Run Details

2016 of 35286 branches covered (5.71%)

Branch coverage included in aggregate %.

1 of 13 new or added lines in 6 files covered. (7.69%)

2194 existing lines in 238 files now uncovered.

2994 of 34932 relevant lines covered (8.57%)

2.04 hits per line

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

0.0

/packages/commonwealth/server/middleware/methodNotAllowed.ts

import { stats } from '@hicommonwealth/core';
import {
  NextFunction,
  Request,
  RequestHandler,
  Response,
  Router,
} from 'express';
import { ValidationChain } from 'express-validator';

const routesMethods: { [key: string]: string[] } = {};

type ValidateThenHandle = [ValidationChain[], ...RequestHandler[]];

// middleware to capture route traffic and latency
const statsMiddleware = (method: string, path: string) => (req, res, next) => {
  try {
    const routePattern = `${method.toUpperCase()} ${path}`;
    stats().increment('cw.path.called', {
      path: routePattern,
    });
    const start = Date.now();
    res.on('finish', () => {
      const latency = Date.now() - start;
      stats().histogram(`cw.path.latency`, latency, {
        path: routePattern,
      });
    });
  } catch (err) {
    console.error(err);
  }
  next();
};

/**
 * Use this function to register a route on a given Express Router. This function updates an object that stores the
 * valid methods available for each given path. For example the object may contain the '/comment' path which is valid
 * with the 'post', 'delete', and 'get' methods. Once a route is registered in this object, the
 * methodNotAllowedMiddleware can function correctly.
 * @param router The router on which to add the request/route handlers.
 * @param method The HTTP method of the route e.g. 'post', 'get', 'patch', etc.
 * @param path The path of the route e.g. '/comments'.
 * @param handlers Any request body validators or route handlers.
 */
export const registerRoute = (
  router: Router,
  method: 'get' | 'post' | 'put' | 'patch' | 'delete',
  path: string,
  ...handlers: RequestHandler[] | ValidateThenHandle
) => {
  const realPath = `/api${path}`;
  router[method](path, statsMiddleware(method, realPath), ...handlers);
  if (!routesMethods[realPath]) routesMethods[realPath] = [];
  routesMethods[realPath].push(method.toUpperCase());
};

/*
 * This middleware function checks whether the requested path and method are valid (have a matching handler).
 * If they are not, the middleware will set the `Allow` header indicating what methods are allowed with the requested
 * path and then return with a status code of 405 (Method Not Allowed).
 */
export const methodNotAllowedMiddleware = () => {
  return (req: Request, res: Response, next: NextFunction) => {
    const methods = routesMethods[req.path];
    if (methods && !methods.includes(req.method)) {
      res.set('Allow', methods ? methods.join(', ') : '');
      return res
        .status(405)
        .json({ result: 'Method Not Allowed', status: 405 });
    } else {
      return next();
    }
  };
};

1	import { stats } from '@hicommonwealth/core';
2	import {
3	NextFunction,
4	Request,
5	RequestHandler,
6	Response,
7	Router,
8	} from 'express';
9	import { ValidationChain } from 'express-validator';
10
UNCOV 11	const routesMethods: { [key: string]: string[] } = {};	×
12
13	type ValidateThenHandle = [ValidationChain[], ...RequestHandler[]];
14
15	// middleware to capture route traffic and latency
UNCOV 16	const statsMiddleware = (method: string, path: string) => (req, res, next) => {	×
UNCOV 17	try {	×
UNCOV 18	const routePattern = `${method.toUpperCase()} ${path}`;	×
UNCOV 19	stats().increment('cw.path.called', {	×
20	path: routePattern,
21	});
UNCOV 22	const start = Date.now();	×
UNCOV 23	res.on('finish', () => {	×
UNCOV 24	const latency = Date.now() - start;	×
UNCOV 25	stats().histogram(`cw.path.latency`, latency, {	×
26	path: routePattern,
27	});
28	});
29	} catch (err) {
30	console.error(err);	×
31	}
UNCOV 32	next();	×
33	};
34
35	/**
36	* Use this function to register a route on a given Express Router. This function updates an object that stores the
37	* valid methods available for each given path. For example the object may contain the '/comment' path which is valid
38	* with the 'post', 'delete', and 'get' methods. Once a route is registered in this object, the
39	* methodNotAllowedMiddleware can function correctly.
40	* @param router The router on which to add the request/route handlers.
41	* @param method The HTTP method of the route e.g. 'post', 'get', 'patch', etc.
42	* @param path The path of the route e.g. '/comments'.
43	* @param handlers Any request body validators or route handlers.
44	*/
UNCOV 45	export const registerRoute = (	×
46	router: Router,
47	method: 'get' \| 'post' \| 'put' \| 'patch' \| 'delete',
48	path: string,
49	...handlers: RequestHandler[] \| ValidateThenHandle
50	) => {
UNCOV 51	const realPath = `/api${path}`;	×
UNCOV 52	router[method](path, statsMiddleware(method, realPath), ...handlers);	×
UNCOV 53	if (!routesMethods[realPath]) routesMethods[realPath] = [];	×
UNCOV 54	routesMethods[realPath].push(method.toUpperCase());	×
55	};
56
57	/*
58	* This middleware function checks whether the requested path and method are valid (have a matching handler).
59	* If they are not, the middleware will set the `Allow` header indicating what methods are allowed with the requested
60	* path and then return with a status code of 405 (Method Not Allowed).
61	*/
UNCOV 62	export const methodNotAllowedMiddleware = () => {	×
UNCOV 63	return (req: Request, res: Response, next: NextFunction) => {	×
UNCOV 64	const methods = routesMethods[req.path];	×
UNCOV 65	if (methods && !methods.includes(req.method)) {	×
66	res.set('Allow', methods ? methods.join(', ') : '');	×
67	return res	×
68	.status(405)
69	.json({ result: 'Method Not Allowed', status: 405 });
70	} else {
UNCOV 71	return next();	×
72	}
73	};
74	};

hicommonwealth / commonwealth / 9519717997

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