aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/helpers/init.ts
diff options
context:
space:
mode:
authorWouter Admiraal <wouter.admiraal@sonarsource.com>2021-08-19 12:49:11 +0200
committersonartech <sonartech@sonarsource.com>2021-08-20 20:03:09 +0000
commit6f17541395dcedb52fe54e7755be95f2e5941086 (patch)
treece3d742aee2af87e018c193c97eea5e7fc81a4e5 /server/sonar-web/src/main/js/helpers/init.ts
parent4ce76b5cde3ee915a6c45bfa452e0c7c61c642a5 (diff)
downloadsonarqube-6f17541395dcedb52fe54e7755be95f2e5941086.tar.gz
sonarqube-6f17541395dcedb52fe54e7755be95f2e5941086.zip
SONAR-15297 Move all code from sonar-ui-common back to respective sonar-web folders
Diffstat (limited to 'server/sonar-web/src/main/js/helpers/init.ts')
-rw-r--r--server/sonar-web/src/main/js/helpers/init.ts88
1 files changed, 88 insertions, 0 deletions
diff --git a/server/sonar-web/src/main/js/helpers/init.ts b/server/sonar-web/src/main/js/helpers/init.ts
new file mode 100644
index 00000000000..fd9ab571dd6
--- /dev/null
+++ b/server/sonar-web/src/main/js/helpers/init.ts
@@ -0,0 +1,88 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2021 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+import { Messages } from './l10n';
+
+let urlContext: string | undefined; // Is the base path (web context) in SQ
+let messages: Messages | undefined;
+let locale: string | undefined;
+let reactDomContainerSelector: string | undefined; // CSS selector of the DOM node where the React App is attached
+
+export const IS_SSR = typeof window === 'undefined';
+export const DEFAULT_LOCALE = 'en';
+export const DEFAULT_MESSAGES = {
+ // eslint-disable-next-line camelcase
+ default_error_message: 'The request cannot be processed. Try again later.'
+};
+const LOGGER_PREFIX = 'sonar-ui-common init:';
+
+export default {
+ setUrlContext(newUrlContext?: string) {
+ urlContext = newUrlContext;
+ return this;
+ },
+ setLocale(newLocale: string) {
+ locale = newLocale;
+ return this;
+ },
+ setMessages(newMessages?: Messages) {
+ messages = newMessages;
+ return this;
+ },
+ setReactDomContainer(nodeSelector: string) {
+ reactDomContainerSelector = nodeSelector;
+ return this;
+ }
+};
+
+export function getMessages() {
+ if (typeof messages === 'undefined') {
+ logWarning('L10n messages are not initialized. Use default messages.');
+ return DEFAULT_MESSAGES;
+ }
+ return messages;
+}
+
+export function getLocale() {
+ if (typeof locale === 'undefined') {
+ logWarning('L10n locale is not initialized. Use default locale.');
+ return DEFAULT_LOCALE;
+ }
+ return locale;
+}
+
+export function getReactDomContainerSelector() {
+ return reactDomContainerSelector || '#content';
+}
+
+export function getUrlContext() {
+ if (typeof urlContext === 'undefined') {
+ throw new Error(
+ `${LOGGER_PREFIX} web context needs to be initialized by Initializer.setUrlContext before being used`
+ );
+ }
+ return urlContext;
+}
+
+function logWarning(message: string) {
+ if (process.env.NODE_ENV !== 'production') {
+ // eslint-disable-next-line no-console
+ console.warn(`${LOGGER_PREFIX} ${message}`);
+ }
+}