8789384661

Committed 22 Apr 2024 06:55PM UTC coverage: 32.012% (-0.07%) from 32.08%

Build # 8789384661

Build Type

Pull #8981

github

Committed by

jpaddison3

Commit Message

clicks open in new tab

Co-authored-by: oetherington <ollie@etherington.xyz>

Pull Request Pull Request #8981: [EA] People directory

Run Details

4692 of 38232 branches covered (12.27%)

Branch coverage included in aggregate %.

249 of 597 new or added lines in 52 files covered. (41.71%)

61 existing lines in 7 files now uncovered.

27382 of 61961 relevant lines covered (44.19%)

180.7 hits per line

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

28.24

/packages/lesswrong/lib/routeUtil.tsx

import { isServer, getServerPort } from './executionEnvironment';
import qs from 'qs';
import React, { useCallback, useContext } from 'react';
import { LocationContext, ServerRequestStatusContext, SubscribeLocationContext, ServerRequestStatusContextType, NavigationContext } from './vulcan-core/appContext';
import type { RouterLocation } from './vulcan-lib/routes';
import * as _ from 'underscore';
import { ForumOptions, forumSelect } from './forumTypeUtils';
import type { LocationDescriptor } from 'history';
import {siteUrlSetting} from './instanceSettings'

// React Hook which returns the page location (parsed URL and route).
// Return value contains:
// {
//   currentRoute
//     The object that was passed to addRoute.
//   RouteComponent
//     The component used to render this route.
//   location
//     The react-router location. Inconsistent between client and SSR.
//   pathname
//     All of the URL after the domain. ie if the URL is
//     "http://lesswrong.com/foo?x=1&y=abc" then pathname is "/foo?x=1&y=abc". <-- this documentatino might be false! pathname does not return this, and oli says it shouldn't
//   hash
//     The within-page location part of a URL. Ie if the URL is
//     "http://lesswrong.com/foo#abc", the hash is "#abc".
//   params
//     Parsed components of the route path. Eg if the route path is
//     "/posts/:_id/:slug?" this might be {_id:"123", slug:"abc"}.
//   query
//     Parsed object for the portion of the URL after the ?, eg if the URL is
//     "http://lesswrong.com/foo?x=1&y=abc" this will be {x:"1",y:"abc"}. If
//     the URL does not contain a ?, this is the empty object.
// }
// Does not trigger rerenders on navigation events. If you want your component
// to rerender on navigations, use useSubscribedLocation instead.
export const useLocation = (): RouterLocation => {
  return useContext(LocationContext)!;
}

// React Hook which returns the server-side server request status, used to set 404s or redirects
// The relevant handling happens in the renderPage function
// This hook only works on the server and will throw an error when called on the client
export const useServerRequestStatus = (): ServerRequestStatusContextType|null => {
  return useContext(ServerRequestStatusContext)
}

// React Hook which returns the page location, formatted as in useLocation, and
// triggers a rerender whenever navigation occurs.
export const useSubscribedLocation = (): RouterLocation => {
  return useContext(SubscribeLocationContext)!;
}

export type NavigateFunction = ReturnType<typeof useNavigate>
/**
 * React Hook which returns an acessor-object for page navigation. Contains one
 * field, `history`. See https://github.com/ReactTraining/history for
 * documentation on it.
 * Use of this hook will never trigger rerenders.
 */
export const useNavigate = () => {
  const { history } = useContext(NavigationContext)!;
  return useCallback((locationDescriptor: LocationDescriptor, options?: {replace?: boolean, openInNewTab?: boolean}) => {
    if (options?.openInNewTab) {
      const href = typeof locationDescriptor === 'string' ?
        locationDescriptor :
        history.createHref(locationDescriptor);
      window.open(href, '_blank')?.focus();
    } else if (options?.replace) {
      history.replace(locationDescriptor);
    } else {
      history.push(locationDescriptor);
    }
  }, [history]);
}

// HoC which adds a `location` property to an object, which contains the page
// location (parsed URL and route). See `useLocation`.
export const withLocation = (WrappedComponent: any) => {
  return (props: AnyBecauseTodo) => (
    <LocationContext.Consumer>
      {location =>
        <WrappedComponent
          {...props}
          location={location}
        />
      }
    </LocationContext.Consumer>
  );
}

export const getUrlClass = (): typeof URL => {
  if (isServer) {
    return require('url').URL
  } else {
    return URL
  }
}

// Given a URL which might or might not have query parameters, return a URL in
// which any query parameters found in queryParameterBlacklist are removed.
export const removeUrlParameters = (url: string, queryParameterBlacklist: string[]): string => {
  if (url.indexOf("?") < 0) return url;
  const [baseUrl, queryAndHash] = url.split("?");
  const [query, hash] = queryAndHash.split("#");
  
  const parsedQuery = qs.parse(query);
  let filteredQuery: AnyBecauseTodo = {};
  for (let key of _.keys(parsedQuery)) {
    if (_.indexOf(queryParameterBlacklist, key) < 0) {
      filteredQuery[key] = parsedQuery[key];
    }
  }
  
  return baseUrl + (Object.keys(filteredQuery).length>0 ? '?'+qs.stringify(filteredQuery) : '') + (hash ? '#'+hash : '');
}

interface DomainList {
  onsiteDomains: string[]
  mirrorDomains: string[]
}

const LwAfDomainWhitelist: DomainList = {
  onsiteDomains: [
    "lesswrong.com",
    "lesserwrong.com",
    "lessestwrong.com",
    "alignmentforum.org",
    "alignment-forum.com",
    `localhost:${getServerPort()}`,
  ],
  mirrorDomains: [
    "greaterwrong.com",
  ],
}

const URLClass = getUrlClass()
const forumDomainWhitelist: ForumOptions<DomainList> = {
  LessWrong: LwAfDomainWhitelist,
  AlignmentForum: LwAfDomainWhitelist,
  EAForum: {
    onsiteDomains: [
      'forum.effectivealtruism.org',
      'forum-staging.effectivealtruism.org',
      `localhost:${getServerPort()}`,
    ],
    mirrorDomains: ['ea.greaterwrong.com'],
  },
  default: {
    onsiteDomains: [
      new URLClass(siteUrlSetting.get()).host,
      `localhost:${getServerPort()}`,
    ],
    mirrorDomains: [],
  }
}

const domainWhitelist: DomainList = forumSelect(forumDomainWhitelist)

export const classifyHost = (host: string): "onsite"|"offsite"|"mirrorOfUs" => {
  let urlType: "onsite"|"offsite"|"mirrorOfUs" = "offsite";
  
  // Returns true if two domains are either the same, or differ only by addition or removal of a "www."
  function isSameDomainModuloWWW(a: string, b: string) {
    return a===b || "www."+a===b || a==="www."+b;
  }

  domainWhitelist.onsiteDomains.forEach((domain) => {
    if (isSameDomainModuloWWW(host, domain))
      urlType = "onsite";
  })
  domainWhitelist.mirrorDomains.forEach((domain) => {
    if (isSameDomainModuloWWW(host, domain))
      urlType = "mirrorOfUs";
  })

  return urlType;
}

// Returns whether a string could, conservatively, possibly be a database ID.
// Used for disambiguating hashes, which in some URL formats could either point
// to an anchor within a post, or a comment on that post.
// A string could possibly be an ID if is in the range of meteor's `Random.id`.
export const looksLikeDbIdString = (str: string): boolean => {
  return /^[a-zA-Z0-9]{17}$/.test(str);
}

1	import { isServer, getServerPort } from './executionEnvironment';	101✔
2	import qs from 'qs';	24✔
3	import React, { useCallback, useContext } from 'react';	24✔
4	import { LocationContext, ServerRequestStatusContext, SubscribeLocationContext, ServerRequestStatusContextType, NavigationContext } from './vulcan-core/appContext';	24✔
5	import type { RouterLocation } from './vulcan-lib/routes';
6	import * as _ from 'underscore';	24✔
7	import { ForumOptions, forumSelect } from './forumTypeUtils';	24✔
8	import type { LocationDescriptor } from 'history';
9	import {siteUrlSetting} from './instanceSettings'	24✔
10
11	// React Hook which returns the page location (parsed URL and route).
12	// Return value contains:
13	// {
14	// currentRoute
15	// The object that was passed to addRoute.
16	// RouteComponent
17	// The component used to render this route.
18	// location
19	// The react-router location. Inconsistent between client and SSR.
20	// pathname
21	// All of the URL after the domain. ie if the URL is
22	// "http://lesswrong.com/foo?x=1&y=abc" then pathname is "/foo?x=1&y=abc". <-- this documentatino might be false! pathname does not return this, and oli says it shouldn't
23	// hash
24	// The within-page location part of a URL. Ie if the URL is
25	// "http://lesswrong.com/foo#abc", the hash is "#abc".
26	// params
27	// Parsed components of the route path. Eg if the route path is
28	// "/posts/:_id/:slug?" this might be {_id:"123", slug:"abc"}.
29	// query
30	// Parsed object for the portion of the URL after the ?, eg if the URL is
31	// "http://lesswrong.com/foo?x=1&y=abc" this will be {x:"1",y:"abc"}. If
32	// the URL does not contain a ?, this is the empty object.
33	// }
34	// Does not trigger rerenders on navigation events. If you want your component
35	// to rerender on navigations, use useSubscribedLocation instead.
36	export const useLocation = (): RouterLocation => {	24✔
37	return useContext(LocationContext)!;	×
38	}
39
40	// React Hook which returns the server-side server request status, used to set 404s or redirects
41	// The relevant handling happens in the renderPage function
42	// This hook only works on the server and will throw an error when called on the client
43	export const useServerRequestStatus = (): ServerRequestStatusContextType\|null => {	24✔
44	return useContext(ServerRequestStatusContext)	×
45	}
46
47	// React Hook which returns the page location, formatted as in useLocation, and
48	// triggers a rerender whenever navigation occurs.
49	export const useSubscribedLocation = (): RouterLocation => {	24✔
50	return useContext(SubscribeLocationContext)!;	×
51	}
52
53	export type NavigateFunction = ReturnType<typeof useNavigate>
54	/**
55	* React Hook which returns an acessor-object for page navigation. Contains one
56	* field, `history`. See https://github.com/ReactTraining/history for
57	* documentation on it.
58	* Use of this hook will never trigger rerenders.
59	*/
60	export const useNavigate = () => {	24✔
61	const { history } = useContext(NavigationContext)!;	×
NEW 62	return useCallback((locationDescriptor: LocationDescriptor, options?: {replace?: boolean, openInNewTab?: boolean}) => {	×
NEW 63	if (options?.openInNewTab) {	×
NEW 64	const href = typeof locationDescriptor === 'string' ?	×
65	locationDescriptor :	×
66	history.createHref(locationDescriptor);
NEW 67	window.open(href, '_blank')?.focus();	×
NEW 68	} else if (options?.replace) {	×
UNCOV 69	history.replace(locationDescriptor);	×
70	} else {
71	history.push(locationDescriptor);	×
72	}
73	}, [history]);
74	}
75
76	// HoC which adds a `location` property to an object, which contains the page
77	// location (parsed URL and route). See `useLocation`.
78	export const withLocation = (WrappedComponent: any) => {	24✔
79	return (props: AnyBecauseTodo) => (	2✔
80	<LocationContext.Consumer>	×
81	{location =>
82	<WrappedComponent	×
83	{...props}
84	location={location}
85	/>
86	}
87	</LocationContext.Consumer>
88	);
89	}
90
91	export const getUrlClass = (): typeof URL => {	24✔
92	if (isServer) {	51!
93	return require('url').URL	51✔
94	} else {
95	return URL	×
96	}
97	}
98
99	// Given a URL which might or might not have query parameters, return a URL in
100	// which any query parameters found in queryParameterBlacklist are removed.
101	export const removeUrlParameters = (url: string, queryParameterBlacklist: string[]): string => {	24✔
102	if (url.indexOf("?") < 0) return url;	×
103	const [baseUrl, queryAndHash] = url.split("?");	×
104	const [query, hash] = queryAndHash.split("#");	×
105
106	const parsedQuery = qs.parse(query);	×
107	let filteredQuery: AnyBecauseTodo = {};	×
108	for (let key of _.keys(parsedQuery)) {	×
109	if (_.indexOf(queryParameterBlacklist, key) < 0) {	×
110	filteredQuery[key] = parsedQuery[key];	×
111	}
112	}
113
114	return baseUrl + (Object.keys(filteredQuery).length>0 ? '?'+qs.stringify(filteredQuery) : '') + (hash ? '#'+hash : '');	×
115	}
116
117	interface DomainList {
118	onsiteDomains: string[]
119	mirrorDomains: string[]
120	}
121
122	const LwAfDomainWhitelist: DomainList = {	24✔
123	onsiteDomains: [
124	"lesswrong.com",
125	"lesserwrong.com",
126	"lessestwrong.com",
127	"alignmentforum.org",
128	"alignment-forum.com",
129	`localhost:${getServerPort()}`,
130	],
131	mirrorDomains: [
132	"greaterwrong.com",
133	],
134	}
135
136	const URLClass = getUrlClass()	24✔
137	const forumDomainWhitelist: ForumOptions<DomainList> = {	24✔
138	LessWrong: LwAfDomainWhitelist,
139	AlignmentForum: LwAfDomainWhitelist,
140	EAForum: {
141	onsiteDomains: [
142	'forum.effectivealtruism.org',
143	'forum-staging.effectivealtruism.org',
144	`localhost:${getServerPort()}`,
145	],
146	mirrorDomains: ['ea.greaterwrong.com'],
147	},
148	default: {
149	onsiteDomains: [
150	new URLClass(siteUrlSetting.get()).host,
151	`localhost:${getServerPort()}`,
152	],
153	mirrorDomains: [],
154	}
155	}
156
157	const domainWhitelist: DomainList = forumSelect(forumDomainWhitelist)	24✔
158
159	export const classifyHost = (host: string): "onsite"\|"offsite"\|"mirrorOfUs" => {	24✔
160	let urlType: "onsite"\|"offsite"\|"mirrorOfUs" = "offsite";	×
161
162	// Returns true if two domains are either the same, or differ only by addition or removal of a "www."
163	function isSameDomainModuloWWW(a: string, b: string) {
164	return a===b \|\| "www."+a===b \|\| a==="www."+b;	×
165	}
166
167	domainWhitelist.onsiteDomains.forEach((domain) => {	×
168	if (isSameDomainModuloWWW(host, domain))	×
169	urlType = "onsite";	×
170	})
171	domainWhitelist.mirrorDomains.forEach((domain) => {	×
172	if (isSameDomainModuloWWW(host, domain))	×
173	urlType = "mirrorOfUs";	×
174	})
175
176	return urlType;	×
177	}
178
179	// Returns whether a string could, conservatively, possibly be a database ID.
180	// Used for disambiguating hashes, which in some URL formats could either point
181	// to an anchor within a post, or a comment on that post.
182	// A string could possibly be an ID if is in the range of meteor's `Random.id`.
183	export const looksLikeDbIdString = (str: string): boolean => {	24✔
184	return /^[a-zA-Z0-9]{17}$/.test(str);	×
185	}

ForumMagnum / ForumMagnum / 8789384661

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