Skip to content

Commit

Permalink
Use helpers to check environment in frontend (mastodon#27633)
Browse files Browse the repository at this point in the history
  • Loading branch information
renchap authored Oct 31, 2023
1 parent 7ef56d6 commit 277e696
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 9 deletions.
4 changes: 3 additions & 1 deletion app/javascript/mastodon/components/icon.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ import classNames from 'classnames';

import { ReactComponent as CheckBoxOutlineBlankIcon } from '@material-symbols/svg-600/outlined/check_box_outline_blank.svg';

import { isProduction } from 'mastodon/utils/environment';

interface SVGPropsWithTitle extends React.SVGProps<SVGSVGElement> {
title?: string;
}
Expand All @@ -24,7 +26,7 @@ export const Icon: React.FC<Props> = ({
}) => {
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
if (!IconComponent) {
if (process.env.NODE_ENV !== 'production') {
if (!isProduction()) {
throw new Error(
`<Icon id="${id}" className="${className}"> is missing an "icon" prop.`,
);
Expand Down
3 changes: 2 additions & 1 deletion app/javascript/mastodon/components/router.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import type {
import { createBrowserHistory } from 'history';

import { layoutFromWindow } from 'mastodon/is_mobile';
import { isDevelopment } from 'mastodon/utils/environment';

interface MastodonLocationState {
fromMastodon?: boolean;
Expand Down Expand Up @@ -40,7 +41,7 @@ function normalizePath(
} else if (
location.state !== undefined &&
state !== undefined &&
process.env.NODE_ENV === 'development'
isDevelopment()
) {
// eslint-disable-next-line no-console
console.log(
Expand Down
3 changes: 2 additions & 1 deletion app/javascript/mastodon/containers/mastodon.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ import UI from 'mastodon/features/ui';
import initialState, { title as siteTitle } from 'mastodon/initial_state';
import { IntlProvider } from 'mastodon/locales';
import { store } from 'mastodon/store';
import { isProduction } from 'mastodon/utils/environment';

const title = process.env.NODE_ENV === 'production' ? siteTitle : `${siteTitle} (Dev)`;
const title = isProduction() ? siteTitle : `${siteTitle} (Dev)`;

const hydrateAction = hydrateStore(initialState);

Expand Down
4 changes: 3 additions & 1 deletion app/javascript/mastodon/locales/global_locale.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { isDevelopment } from 'mastodon/utils/environment';

export interface LocaleData {
locale: string;
messages: Record<string, string>;
Expand All @@ -11,7 +13,7 @@ export function setLocale(locale: LocaleData) {

export function getLocale(): LocaleData {
if (!loadedLocale) {
if (process.env.NODE_ENV === 'development') {
if (isDevelopment()) {
throw new Error('getLocale() called before any locale has been set');
} else {
return { locale: 'unknown', messages: {} };
Expand Down
4 changes: 3 additions & 1 deletion app/javascript/mastodon/locales/intl_provider.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@ import { useEffect, useState } from 'react';

import { IntlProvider as BaseIntlProvider } from 'react-intl';

import { isProduction } from 'mastodon/utils/environment';

import { getLocale, isLocaleLoaded } from './global_locale';
import { loadLocale } from './load_locale';

function onProviderError(error: unknown) {
// Silent the error, like upstream does
if (process.env.NODE_ENV === 'production') return;
if (isProduction()) return;

// This browser does not advertise Intl support for this locale, we only print a warning
// As-per the spec, the browser should select the best matching locale
Expand Down
4 changes: 3 additions & 1 deletion app/javascript/mastodon/main.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import * as perf from 'mastodon/performance';
import ready from 'mastodon/ready';
import { store } from 'mastodon/store';

import { isProduction } from './utils/environment';

/**
* @returns {Promise<void>}
*/
Expand All @@ -21,7 +23,7 @@ function main() {
root.render(<Mastodon {...props} />);
store.dispatch(setupBrowserNotifications());

if (process.env.NODE_ENV === 'production' && me && 'serviceWorker' in navigator) {
if (isProduction() && me && 'serviceWorker' in navigator) {
const { Workbox } = await import('workbox-window');
const wb = new Workbox('/sw.js');
/** @type {ServiceWorkerRegistration} */
Expand Down
8 changes: 5 additions & 3 deletions app/javascript/mastodon/performance.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@

import * as marky from 'marky';

if (process.env.NODE_ENV === 'development') {
import { isDevelopment } from './utils/environment';

if (isDevelopment()) {
if (typeof performance !== 'undefined' && performance.setResourceTimingBufferSize) {
// Increase Firefox's performance entry limit; otherwise it's capped to 150.
// See: https://bugzilla.mozilla.org/show_bug.cgi?id=1331135
Expand All @@ -18,13 +20,13 @@ if (process.env.NODE_ENV === 'development') {
}

export function start(name) {
if (process.env.NODE_ENV === 'development') {
if (isDevelopment()) {
marky.mark(name);
}
}

export function stop(name) {
if (process.env.NODE_ENV === 'development') {
if (isDevelopment()) {
marky.stop(name);
}
}
7 changes: 7 additions & 0 deletions app/javascript/mastodon/utils/environment.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export function isDevelopment() {
return process.env.NODE_ENV === 'development';
}

export function isProduction() {
return process.env.NODE_ENV === 'production';
}

0 comments on commit 277e696

Please sign in to comment.