Skip to content

armgit / dashy

Public Imported from GitHub
0

πŸš€ A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!

:sparkles: Implements optional, off by default crash reporting

Alicia Sykes309dcee3c356
diff --git a/src/main.js b/src/main.js
index 7af5b0aa..44fff3e8 100644
--- a/src/main.js
+++ b/src/main.js
@@ -1,22 +1,25 @@
+/* eslint-disable no-multi-spaces */
// Import core framework and essential utils
import Vue from 'vue';
import VueI18n from 'vue-i18n'; // i18n for localization
// Import component Vue plugins, used throughout the app
-import VTooltip from 'v-tooltip'; // A Vue directive for Popper.js, tooltip component
-import VModal from 'vue-js-modal'; // Modal component
-import VSelect from 'vue-select'; // Select dropdown component
-import VTabs from 'vue-material-tabs'; // Tab view component, used on the config page
-import Toasted from 'vue-toasted'; // Toast component, used to show confirmation notifications
+import VTooltip from 'v-tooltip'; // A Vue directive for Popper.js, tooltip component
+import VModal from 'vue-js-modal'; // Modal component
+import VSelect from 'vue-select'; // Select dropdown component
+import VTabs from 'vue-material-tabs'; // Tab view component, used on the config page
+import Toasted from 'vue-toasted'; // Toast component, used to show confirmation notifications
// Import base Dashy components and utils
-import Dashy from '@/App.vue';
-import router from '@/router';
-import registerServiceWorker from '@/registerServiceWorker';
-import clickOutside from '@/utils/ClickOutside';
-import { toastedOptions, language as defaultLanguage } from '@/utils/defaults';
-import { messages } from '@/utils/languages';
-
+import Dashy from '@/App.vue'; // Main Dashy Vue app
+import router from '@/router'; // Router, for navigation
+import serviceWorker from '@/utils/InitServiceWorker'; // Service worker initialization
+import clickOutside from '@/utils/ClickOutside'; // Directive for closing popups, modals, etc
+import { messages } from '@/utils/languages'; // Language texts
+import ErrorReporting from '@/utils/ErrorReporting'; // Error reporting initializer (off)
+import { toastedOptions, language as defaultLanguage } from '@/utils/defaults'; // Defaults
+
+// Initialize global Vue components
Vue.use(VueI18n);
Vue.use(VTooltip);
Vue.use(VModal);
@@ -25,7 +28,7 @@ Vue.use(Toasted, toastedOptions);
Vue.component('v-select', VSelect);
Vue.directive('clickOutside', clickOutside);
-Vue.config.productionTip = false;
+Vue.config.productionTip = false; // Disable annoying console message
// Setup i18n translations
const i18n = new VueI18n({
@@ -34,8 +37,11 @@ const i18n = new VueI18n({
messages,
});
-// Register Service Worker
-registerServiceWorker();
+// Checks if service worker not disable, and if so will registers it
+serviceWorker();
+
+// Checks if user enabled error reporting, and if so will initialize it
+ErrorReporting(Vue, router);
// Render function
const render = (awesome) => awesome(Dashy);
diff --git a/src/utils/ErrorReporting.js b/src/utils/ErrorReporting.js
new file mode 100644
index 00000000..9b0a2a97
--- /dev/null
+++ b/src/utils/ErrorReporting.js
@@ -0,0 +1,39 @@
+/**
+ * NOTE: No data is EVER sent to any external service without your explicit consent.
+ * In the case of error reporting, Sentry will not even be initialized unless
+ * you have purposely set appConfig.enableErrorReporting: true.
+ * It is false by default.
+ * You may want to enable error reporting if you have encountered a bug,
+ * as access to the console errors enable it to be triaged an fixed effectively
+ */
+
+/* eslint-disable global-require */
+
+import ConfigAccumulator from '@/utils/ConfigAccumalator';
+
+const ErrorTracking = (Vue, router) => {
+ // Fetch users config
+ const appConfig = new ConfigAccumulator().appConfig() || {};
+ // Check if error reporting is enabled. Only proceed if user has turned it on.
+ if (appConfig.enableErrorReporting) {
+ // Import Sentry
+ const Sentry = require('@sentry/vue');
+ const { Integrations } = require('@sentry/tracing');
+ const dsn = 'https://[email protected]/5887934';
+ // Initialize Sentry
+ Sentry.init({
+ Vue,
+ dsn,
+ integrations: [
+ new Integrations.BrowserTracing({
+ routingInstrumentation: Sentry.vueRouterInstrumentation(router),
+ }),
+ ],
+ tracesSampleRate: 1.0,
+ });
+ } else {
+ // Error reporting not enabled. Do Nothing.
+ }
+};
+
+export default ErrorTracking;