diff --git a/front/src/api/player.ts b/front/src/api/player.ts index 53c72d5a0..97b91a851 100644 --- a/front/src/api/player.ts +++ b/front/src/api/player.ts @@ -4,6 +4,10 @@ import { createEventHook, refDefault, type EventHookOn, useEventListener } from import { createAudioSource } from '~/composables/audio/audio-api' import { effectScope, reactive, ref, type Ref } from 'vue' +import useLogger from '~/composables/useLogger' + +const logger = useLogger() + export interface SoundSource { uuid: string mimetype: string @@ -73,7 +77,7 @@ export class HTMLSound implements Sound { this.#audio.src = source this.#audio.preload = 'auto' - console.log('CREATED SOUND INSTANCE', this) + logger.log('CREATED SOUND INSTANCE', this) this.#scope.run(() => { useEventListener(this.#audio, 'ended', () => this.#soundEndEventHook.trigger(this)) @@ -84,19 +88,19 @@ export class HTMLSound implements Sound { }) useEventListener(this.#audio, 'waiting', () => { - console.log('>> AUDIO WAITING', this) + logger.log('>> AUDIO WAITING', this) }) useEventListener(this.#audio, 'playing', () => { - console.log('>> AUDIO PLAYING', this) + logger.log('>> AUDIO PLAYING', this) }) useEventListener(this.#audio, 'stalled', () => { - console.log('>> AUDIO STALLED', this) + logger.log('>> AUDIO STALLED', this) }) useEventListener(this.#audio, 'suspend', () => { - console.log('>> AUDIO SUSPEND', this) + logger.log('>> AUDIO SUSPEND', this) }) useEventListener(this.#audio, 'loadeddata', () => { @@ -106,7 +110,7 @@ export class HTMLSound implements Sound { useEventListener(this.#audio, 'error', (err) => { if (this.#ignoreError) return - console.error('>> AUDIO ERRORED', err, this) + logger.error('>> AUDIO ERRORED', err, this) this.isErrored.value = true this.isLoaded.value = true }) @@ -116,7 +120,7 @@ export class HTMLSound implements Sound { async preload () { this.isDisposed.value = false this.isErrored.value = false - console.log('CALLING PRELOAD ON', this) + logger.log('CALLING PRELOAD ON', this) this.#audio.load() } @@ -141,7 +145,7 @@ export class HTMLSound implements Sound { try { await this.#audio.play() } catch (err) { - console.error('>> AUDIO PLAY ERROR', err, this) + logger.error('>> AUDIO PLAY ERROR', err, this) this.isErrored.value = true } } diff --git a/front/src/components/Home.vue b/front/src/components/Home.vue index 7cabd3cc6..23e16ea77 100644 --- a/front/src/components/Home.vue +++ b/front/src/components/Home.vue @@ -5,6 +5,7 @@ import ChannelsWidget from '~/components/audio/ChannelsWidget.vue' import LoginForm from '~/components/auth/LoginForm.vue' import SignupForm from '~/components/auth/SignupForm.vue' import useMarkdown from '~/composables/useMarkdown' +import useLogger from '~/composables/useLogger' import { humanSize } from '~/utils/filters' import { useStore } from '~/store' import { computed } from 'vue' @@ -18,6 +19,7 @@ const labels = computed(() => ({ })) const store = useStore() +const logger = useLogger() const nodeinfo = computed(() => store.state.instance.nodeinfo) const podName = computed(() => get(nodeinfo.value, 'metadata.nodeName') || 'Funkwhale') @@ -54,7 +56,7 @@ const headerStyle = computed(() => { // TODO (wvffle): Check if needed const router = useRouter() whenever(() => store.state.auth.authenticated, () => { - console.log('Authenticated, redirecting to /library…') + logger.log('Authenticated, redirecting to /library…') router.push('/library') }) diff --git a/front/src/components/RemoteSearchForm.vue b/front/src/components/RemoteSearchForm.vue index 7d3859d71..00e0c858b 100644 --- a/front/src/components/RemoteSearchForm.vue +++ b/front/src/components/RemoteSearchForm.vue @@ -9,6 +9,7 @@ import { useStore } from '~/store' import axios from 'axios' import updateQueryString from '~/composables/updateQueryString' +import useLogger from '~/composables/useLogger' type Type = 'rss' | 'artists' | 'both' @@ -37,6 +38,7 @@ const type = ref(props.initialType) const id = ref(props.initialId) const errors = ref([] as string[]) +const logger = useLogger() const { t } = useI18n() const labels = computed(() => ({ title: type.value === 'rss' @@ -102,7 +104,7 @@ const submit = () => { const isLoading = ref(false) const createFetch = async () => { - console.log(id.value, props.standalone) + logger.debug(id.value, props.standalone) if (!id.value) return if (props.standalone) { history.replaceState(history.state, '', updateQueryString(location.href, 'id', id.value)) diff --git a/front/src/components/admin/SettingsGroup.vue b/front/src/components/admin/SettingsGroup.vue index 609dd8a6e..ae05e1e48 100644 --- a/front/src/components/admin/SettingsGroup.vue +++ b/front/src/components/admin/SettingsGroup.vue @@ -18,15 +18,16 @@ const values = reactive({} as Record) const result = ref(null) const errors = ref([] as string[]) -const fileRefs = reactive({} as Record) -const setFileRef = (identifier: string) => (el: FunctionRef) => { - console.log(el) - fileRefs[identifier] = el as HTMLInputElement -} - const logger = useLogger() const store = useStore() +// TODO (wvffle): Use VueUse +const fileRefs = reactive({} as Record) +const setFileRef = (identifier: string) => (el: FunctionRef) => { + logger.debug(el) + fileRefs[identifier] = el as HTMLInputElement +} + const settings = computed(() => { const byIdentifier = props.settingsData.reduce((acc, entry) => { acc[entry.identifier] = entry diff --git a/front/src/components/auth/ApplicationNew.vue b/front/src/components/auth/ApplicationNew.vue index b099263fd..9cb2ac956 100644 --- a/front/src/components/auth/ApplicationNew.vue +++ b/front/src/components/auth/ApplicationNew.vue @@ -9,6 +9,8 @@ import { useStore } from '~/store' import ApplicationForm from '~/components/auth/ApplicationForm.vue' +import useLogger from '~/composables/useLogger' + interface Props { name?: string scopes?: string @@ -27,6 +29,7 @@ const defaults = reactive({ redirectUris: props.redirectUris }) +const logger = useLogger() const { t } = useI18n() const labels = computed(() => ({ title: t('components.auth.ApplicationNew.title') @@ -37,7 +40,7 @@ const store = useStore() const created = (application: Application) => { store.state.auth.applicationSecret = application.client_secret - console.log(application) + logger.debug(application) return router.push({ name: 'settings.applications.edit', params: { diff --git a/front/src/components/auth/SignupForm.vue b/front/src/components/auth/SignupForm.vue index e08cbb1a7..71c37543c 100644 --- a/front/src/components/auth/SignupForm.vue +++ b/front/src/components/auth/SignupForm.vue @@ -42,7 +42,7 @@ const labels = computed(() => ({ const signupRequiresApproval = computed(() => props.signupApprovalEnabled ?? store.state.instance.settings.moderation.signup_approval_enabled.value) const formCustomization = computed(() => props.customization ?? store.state.instance.settings.moderation.signup_form_customization.value) -watchEffect(() => console.log(store.state.instance.settings.moderation.signup_approval_enabled.value)) +watchEffect(() => logger.debug(store.state.instance.settings.moderation.signup_approval_enabled.value)) const payload = reactive({ username: '', diff --git a/front/src/components/common/ContentForm.vue b/front/src/components/common/ContentForm.vue index 3905cdb55..afa02f994 100644 --- a/front/src/components/common/ContentForm.vue +++ b/front/src/components/common/ContentForm.vue @@ -4,6 +4,8 @@ import { useVModel, watchDebounced, useTextareaAutosize, syncRef } from '@vueuse import { ref, computed, watchEffect, onMounted, nextTick, watch } from 'vue' import { useI18n } from 'vue-i18n' +import useLogger from '~/composables/useLogger' + interface Events { (e: 'update:modelValue', value: string): void } @@ -26,6 +28,8 @@ const props = withDefaults(defineProps(), { required: false }) +const logger = useLogger() + const { t } = useI18n() const { textarea, input } = useTextareaAutosize() const value = useVModel(props, 'modelValue', emit) @@ -47,7 +51,7 @@ const loadPreview = async () => { const response = await axios.post('text-preview/', { text: value.value, permissive: props.permissive }) preview.value = response.data.rendered } catch (error) { - console.error(error) + logger.error(error) } isLoadingPreview.value = false } diff --git a/front/src/components/favorites/List.vue b/front/src/components/favorites/List.vue index 83f6b23a0..cd6a7f540 100644 --- a/front/src/components/favorites/List.vue +++ b/front/src/components/favorites/List.vue @@ -65,7 +65,7 @@ const fetchFavorites = async () => { } try { - logger.time('Loading user favorites') + const stop = logger.time('Loading user favorites') const response = await axios.get('tracks/', { params }) results.length = 0 @@ -81,7 +81,7 @@ const fetchFavorites = async () => { } catch (error) { useErrorHandler(error as Error) } finally { - logger.timeEnd('Loading user favorites') + stop() isLoading.value = false } } diff --git a/front/src/components/library/AlbumBase.vue b/front/src/components/library/AlbumBase.vue index 257d4a9e7..a03100672 100644 --- a/front/src/components/library/AlbumBase.vue +++ b/front/src/components/library/AlbumBase.vue @@ -15,6 +15,7 @@ import TagsList from '~/components/tags/List.vue' import AlbumDropdown from './AlbumDropdown.vue' import useErrorHandler from '~/composables/useErrorHandler' +import useLogger from '~/composables/useLogger' interface Events { (e: 'deleted'): void @@ -39,6 +40,8 @@ const isSerie = computed(() => object.value?.artist.content_category === 'podcas const totalDuration = computed(() => sum((object.value?.tracks ?? []).map(track => track.uploads[0]?.duration ?? 0))) const publicLibraries = computed(() => libraries.value?.filter(library => library.privacy_level === 'everyone') ?? []) +const logger = useLogger() + const { t } = useI18n() const labels = computed(() => ({ title: t('components.library.AlbumBase.title') @@ -93,7 +96,7 @@ const fetchTracks = async () => { tracks.push(...response.data.results) } } catch (error) { - console.error(error) + logger.error(error) } finally { isLoadingTracks.value = false } diff --git a/front/src/components/library/Albums.vue b/front/src/components/library/Albums.vue index aab3ef9f3..db9f64271 100644 --- a/front/src/components/library/Albums.vue +++ b/front/src/components/library/Albums.vue @@ -72,7 +72,7 @@ const fetchData = async () => { content_category: 'music' } - logger.time('Fetching albums') + const stop = logger.time('Fetching albums') try { const response = await axios.get('albums/', { params, @@ -86,7 +86,7 @@ const fetchData = async () => { useErrorHandler(error as Error) result.value = undefined } finally { - logger.timeEnd('Fetching albums') + stop() isLoading.value = false } } diff --git a/front/src/components/library/Artists.vue b/front/src/components/library/Artists.vue index 4bfd1935b..8b2e99d7c 100644 --- a/front/src/components/library/Artists.vue +++ b/front/src/components/library/Artists.vue @@ -73,7 +73,7 @@ const fetchData = async () => { has_albums: excludeCompilation.value } - logger.time('Fetching artists') + const stop = logger.time('Fetching artists') try { const response = await axios.get('artists/', { params, @@ -87,7 +87,7 @@ const fetchData = async () => { useErrorHandler(error as Error) result.value = undefined } finally { - logger.timeEnd('Fetching artists') + stop() isLoading.value = false } } diff --git a/front/src/components/library/Home.vue b/front/src/components/library/Home.vue index 8ff6b2552..c2bd01223 100644 --- a/front/src/components/library/Home.vue +++ b/front/src/components/library/Home.vue @@ -32,7 +32,7 @@ const labels = computed(() => ({ const isLoading = ref(false) const fetchData = async () => { isLoading.value = true - logger.time('Loading latest artists') + const stop = logger.time('Loading latest artists') const params = { ordering: '-creation_date', @@ -47,7 +47,7 @@ const fetchData = async () => { } isLoading.value = false - logger.timeEnd('Loading latest artists') + stop() } fetchData() diff --git a/front/src/components/library/Podcasts.vue b/front/src/components/library/Podcasts.vue index c01ee6a1c..35a9e4596 100644 --- a/front/src/components/library/Podcasts.vue +++ b/front/src/components/library/Podcasts.vue @@ -74,7 +74,7 @@ const fetchData = async () => { content_category: 'podcast' } - logger.time('Fetching podcasts') + const stop = logger.time('Fetching podcasts') try { const response = await axios.get('artists/', { params, @@ -88,7 +88,7 @@ const fetchData = async () => { useErrorHandler(error as Error) result.value = undefined } finally { - logger.timeEnd('Fetching podcasts') + stop() isLoading.value = false } } diff --git a/front/src/components/library/Radios.vue b/front/src/components/library/Radios.vue index 9ebb1a02b..145f91116 100644 --- a/front/src/components/library/Radios.vue +++ b/front/src/components/library/Radios.vue @@ -64,7 +64,7 @@ const fetchData = async () => { ordering: orderingString.value } - logger.time('Fetching radios') + const stop = logger.time('Fetching radios') try { const response = await axios.get('radios/radios/', { params @@ -75,7 +75,7 @@ const fetchData = async () => { useErrorHandler(error as Error) result.value = undefined } finally { - logger.timeEnd('Fetching radios') + stop() isLoading.value = false } } diff --git a/front/src/components/manage/moderation/ReportCard.vue b/front/src/components/manage/moderation/ReportCard.vue index 8305710ab..c68989b40 100644 --- a/front/src/components/manage/moderation/ReportCard.vue +++ b/front/src/components/manage/moderation/ReportCard.vue @@ -15,6 +15,7 @@ import NoteForm from '~/components/manage/moderation/NoteForm.vue' import useReportConfigs from '~/composables/moderation/useReportConfigs' import useErrorHandler from '~/composables/useErrorHandler' import useMarkdown from '~/composables/useMarkdown' +import useLogger from '~/composables/useLogger' interface Events { (e: 'updated', updating: { type: string }): void @@ -29,6 +30,7 @@ const emit = defineEmits() const props = defineProps() const configs = useReportConfigs() +const logger = useLogger() const obj = ref(props.initObj) const summary = useMarkdown(() => obj.value.summary ?? '') @@ -77,11 +79,11 @@ const actions = computed(() => { handler: async () => { try { await axios.delete(deleteUrl) - console.log('Target deleted') + logger.info('Target deleted') obj.value.target = undefined resolveReport(true) } catch (error) { - console.log('Error while deleting target', error) + logger.error('Error while deleting target', error) useErrorHandler(error as Error) } } diff --git a/front/src/composables/audio/player.ts b/front/src/composables/audio/player.ts index d2704e9e4..e9291b3f7 100644 --- a/front/src/composables/audio/player.ts +++ b/front/src/composables/audio/player.ts @@ -9,6 +9,8 @@ import { useStore } from '~/store' import axios from 'axios' import { useClamp } from '@vueuse/math' +import useLogger from '~/composables/useLogger' + // Looping export enum LoopingMode { None, @@ -17,7 +19,6 @@ export enum LoopingMode { } // Pausing - export enum PauseReason { UserInput, EndOfQueue, @@ -26,6 +27,8 @@ export enum PauseReason { EndOfRadio } +const logger = useLogger() + const MODE_MAX = 1 + Math.max(...Object.values(LoopingMode).filter(mode => typeof mode === 'number') as number[]) export const looping: Ref = useStorage('player:looping', LoopingMode.None) @@ -131,12 +134,12 @@ export const usePlayer = createGlobalState(() => { const trackListenSubmissions = () => { const store = useStore() whenever(listenSubmitted, async () => { - console.log('Listening submitted!') + logger.log('Listening submitted!') if (!store.state.auth.authenticated) return if (!currentTrack.value) return await axios.post('history/listenings/', { track: currentTrack.value.id }) - .catch((error) => console.error('Could not record track in history', error)) + .catch((error) => logger.error('Could not record track in history', error)) }) } diff --git a/front/src/composables/audio/queue.ts b/front/src/composables/audio/queue.ts index dd415a371..b906612a4 100644 --- a/front/src/composables/audio/queue.ts +++ b/front/src/composables/audio/queue.ts @@ -11,6 +11,8 @@ import { delMany, getMany, setMany } from '~/composables/data/indexedDB' import { setGain } from '~/composables/audio/audio-api' import { useTracks } from '~/composables/audio/tracks' +import useLogger from '~/composables/useLogger' + import axios from 'axios' export interface QueueTrackSource { @@ -36,6 +38,8 @@ export interface QueueTrack { sources: QueueTrackSource[] } +const logger = useLogger() + // Queue const tracks = useStorage('queue:tracks', [] as number[]) const shuffledIds = useStorage('queue:tracks:shuffled', [] as number[]) @@ -69,7 +73,7 @@ watchEffect(async () => { tracksById.set(track.id, track) } } catch (error) { - console.error(error) + logger.error(error) } finally { fetchingTracks.value = false } @@ -344,7 +348,7 @@ export const useQueue = createGlobalState(() => { const store = useStore() watchEffect(() => { if (store.state.radios.running && currentIndex.value === tracks.value.length - 1) { - console.log('POPULATING QUEUE FROM RADIO') + logger.log('POPULATING QUEUE FROM RADIO') return store.dispatch('radios/populateQueue') } }) @@ -379,7 +383,7 @@ export const useQueue = createGlobalState(() => { currentIndex.value = index delete localStorage.queue - })().catch((error) => console.error('Could not successfully migrate between queue versions', error)) + })().catch((error) => logger.error('Could not successfully migrate between queue versions', error)) } if (localStorage.player) { @@ -389,7 +393,7 @@ export const useQueue = createGlobalState(() => { setGain(volume ?? 0.7) delete localStorage.player } catch (error) { - console.error('Could not successfully migrate between player versions', error) + logger.error('Could not successfully migrate between player versions', error) } } } diff --git a/front/src/composables/audio/tracks.ts b/front/src/composables/audio/tracks.ts index 95b1214bb..8ea991867 100644 --- a/front/src/composables/audio/tracks.ts +++ b/front/src/composables/audio/tracks.ts @@ -11,6 +11,7 @@ import { useQueue } from '~/composables/audio/queue' import { soundImplementation } from '~/api/player' import useLRUCache from '~/composables/data/useLRUCache' +import useLogger from '~/composables/useLogger' import store from '~/store' import axios from 'axios' @@ -18,6 +19,8 @@ import axios from 'axios' const ALLOWED_PLAY_TYPES: (CanPlayTypeResult | undefined)[] = ['maybe', 'probably'] const AUDIO_ELEMENT = document.createElement('audio') +const logger = useLogger() + const soundPromises = new Map>() const soundCache = useLRUCache({ max: 3, @@ -95,7 +98,7 @@ export const useTracks = createGlobalState(() => { const sound = new SoundImplementation(sources) sound.onSoundEnd(() => { - console.log('TRACK ENDED, PLAYING NEXT') + logger.log('TRACK ENDED, PLAYING NEXT') // NOTE: We push it to the end of the job queue setTimeout(() => playNext(), 0) @@ -140,7 +143,7 @@ export const useTracks = createGlobalState(() => { return sound } - console.log('NO TRACK IN CACHE, CREATING', track) + logger.log('NO TRACK IN CACHE, CREATING', track) const soundPromise = createSoundPromise() soundPromises.set(track.id, soundPromise) return soundPromise @@ -171,7 +174,7 @@ export const useTracks = createGlobalState(() => { const { queue, currentIndex } = useQueue() if (queue.value.length <= index || index === -1) return - console.log('LOADING TRACK', index) + logger.log('LOADING TRACK', index) const track = queue.value[index] const sound = await createSound(track) @@ -181,7 +184,7 @@ export const useTracks = createGlobalState(() => { return } - console.log('CONNECTING NODE', sound) + logger.log('CONNECTING NODE', sound) sound.audioNode.disconnect() connectAudioSource(sound.audioNode) diff --git a/front/src/composables/audio/visualizer.ts b/front/src/composables/audio/visualizer.ts index e59f23e13..14c518a29 100644 --- a/front/src/composables/audio/visualizer.ts +++ b/front/src/composables/audio/visualizer.ts @@ -4,6 +4,8 @@ import { AUDIO_CONTEXT, GAIN_NODE } from './audio-api' import { useResizeObserver, useStorage } from '@vueuse/core' import { watchEffect, ref, markRaw } from 'vue' +import useLogger from '~/composables/useLogger' + // @ts-expect-error butterchurn has no typings import butterchurnPresets from 'butterchurn-presets' @@ -11,6 +13,8 @@ import butterchurnPresets from 'butterchurn-presets' import butterchurn from 'butterchurn' export const useMilkDrop = (canvas: Ref) => { + const logger = useLogger() + const presets = Object.keys(butterchurnPresets) const visualizer = ref() @@ -24,7 +28,7 @@ export const useMilkDrop = (canvas: Ref) => { const name = presetName.value if (name === undefined) return - console.log(`Switching to preset: '${name}'`) + logger.log(`Switching to preset: '${name}'`) visualizer.value?.loadPreset(butterchurnPresets[name], 1) }) @@ -67,7 +71,7 @@ export const useMilkDrop = (canvas: Ref) => { try { visualizer.value?.render() } catch (error) { - console.error(error) + logger.error(error) loadRandomPreset() } } diff --git a/front/src/composables/navigation/useOrdering.ts b/front/src/composables/navigation/useOrdering.ts index edb02cff1..d712cf06b 100644 --- a/front/src/composables/navigation/useOrdering.ts +++ b/front/src/composables/navigation/useOrdering.ts @@ -34,7 +34,6 @@ export default (props: OrderingProps) => { }) const queryOrdering = useRouteQuery('ordering', perfOrderingDirection.value + perfOrdering.value) - console.log(queryOrdering.value) watch(queryOrdering, (ordering) => { perfOrderingDirection.value = ordering[0] === '-' ? '-' : '+' diff --git a/front/src/composables/onKeyboardShortcut.ts b/front/src/composables/onKeyboardShortcut.ts index 2f066775e..b54d428d3 100644 --- a/front/src/composables/onKeyboardShortcut.ts +++ b/front/src/composables/onKeyboardShortcut.ts @@ -2,6 +2,8 @@ import { DefaultMagicKeysAliasMap, tryOnScopeDispose, useEventListener } from '@ import { isEqual, isMatch } from 'lodash-es' import { reactive } from 'vue' +import useLogger from './useLogger' + type KeyFilter = string | string[] interface Entry { @@ -10,6 +12,7 @@ interface Entry { __location?: string } +const logger = useLogger() const combinations = reactive(new Map()) const current = new Set() @@ -59,7 +62,7 @@ export default (key: KeyFilter, handler: () => unknown, prevent = false) => { } if (collisions.length) { - console.warn([ + logger.warn([ 'onKeyboardShortcut detected a possible collision in:', `${entry.__location}: ${combination.join(' + ')}`, ...collisions diff --git a/front/src/composables/useLogger.ts b/front/src/composables/useLogger.ts index 660c79385..e6d3942e6 100644 --- a/front/src/composables/useLogger.ts +++ b/front/src/composables/useLogger.ts @@ -1,11 +1,119 @@ -import Logger from 'js-logger' +// import Logger from 'js-logger' +// +// Logger.useDefaults({ +// defaultLevel: import.meta.env.DEV +// ? Logger.DEBUG +// : Logger.WARN +// }) +// +// export default (logger?: string) => logger +// ? Logger.get(logger) +// : Logger -Logger.useDefaults({ - defaultLevel: import.meta.env.DEV - ? Logger.DEBUG - : Logger.WARN -}) +type LogLevel = 'info' | 'warn' | 'error' | 'debug' | 'time' -export default (logger?: string) => logger - ? Logger.get(logger) - : Logger +const LOG_LEVEL_LABELS: Record = { + info: ' INFO', + warn: ' WARN', + error: 'ERROR', + debug: 'DEBUG', + time: ' TIME' +} + +const LOG_LEVEL_BACKGROUND: Record = { + info: '#a6e22e', + warn: '#FF9800', + error: '#F44336', + debug: '#00BCD4', + time: '#00BCD4' +} + +const LOG_LEVEL_COLOR: Record = { + info: '#000', + warn: '#000', + error: '#fff', + debug: '#000', + time: '#000' +} + +const TIMESTAMP_COLOR = '#9E9E9E' + +const FILETYPE_BACKGROUND: Record = { + js: '#f1e05a', + ts: '#2b7489', + vue: '#41b883', + html: '#e34c26', + default: '#ccc' +} + +const FILETYPE_COLOR: Record = { + js: '#000', + ts: '#fff', + vue: '#fff', + html: '#fff', + default: '#000' +} + +const getFile = () => { + const { stack } = new Error() + const line = stack?.split('\n')[2] ?? '' + const [, method, url, lineNo] = line.match(/^(\w+)?(?:\/<)*@(.+?)(?:\?.*)?:(\d+):\d+$/) ?? [] + const file = url.startsWith(location.origin) ? url.slice(location.origin.length) : url + return { method, file, lineNo } +} + +// NOTE: We're pushing all logs to the end of the event loop +const createLoggerFn = (level: LogLevel) => { + return (...args: any[]) => { + const timestamp = new Date().toUTCString() + const { method, file, lineNo } = getFile() + + const ext = file?.split('.').pop() ?? 'default' + + // NOTE: Don't log time and debug in production + if (level === 'time' || level === 'debug') { + if (import.meta.env.PROD) return + } + + console[level === 'time' ? 'debug' : level]( + '%c %c [%s] %c %s %c%s', + `background: ${LOG_LEVEL_BACKGROUND[level]};border-radius:1em`, + `color: ${TIMESTAMP_COLOR}`, + timestamp, + `background: ${LOG_LEVEL_BACKGROUND[level]}; color: ${LOG_LEVEL_COLOR[level]}; border-radius: 1em 0 0 1em`, + LOG_LEVEL_LABELS[level], + `background: ${FILETYPE_BACKGROUND[ext]}; color: ${FILETYPE_COLOR[ext]}; border-radius: 0 1em 1em 0`, + method !== undefined + ? ` ${file}:${lineNo} ${method}() ` + : ` ${file}:${lineNo} `, + ...args + ) + } +} + +const infoLogger = createLoggerFn('info') +const warnLogger = createLoggerFn('warn') +const timeLogger = createLoggerFn('time') + +const errorLogger = createLoggerFn('error') +const debugLogger = createLoggerFn('debug') + +export const logger = { + log: infoLogger, + info: infoLogger, + warn: warnLogger, + error: errorLogger, + debug: debugLogger, + time: (label: string) => { + const now = performance.now() + + timeLogger(`${label}: start`) + + return () => { + const duration = performance.now() - now + timeLogger(`${label}: ${duration.toFixed(2)}ms`) + } + } +} + +export default () => logger diff --git a/front/src/init/axios.ts b/front/src/init/axios.ts index 6b474fd14..35d17deb1 100644 --- a/front/src/init/axios.ts +++ b/front/src/init/axios.ts @@ -118,7 +118,7 @@ export const install: InitModule = ({ store, router }) => { const refreshAuth = async (failedRequest: AxiosError) => { if (store.state.auth.oauth.accessToken) { - console.log('Failed request, refreshing auth…') + logger.warn('Failed request, refreshing auth…') try { // maybe the token was expired, let's try to refresh it diff --git a/front/src/init/webSocket.ts b/front/src/init/webSocket.ts index b8fe0c151..0033a893f 100644 --- a/front/src/init/webSocket.ts +++ b/front/src/init/webSocket.ts @@ -3,9 +3,12 @@ import type { InitModule } from '~/types' import { watchEffect, watch } from 'vue' import { useWebSocket, whenever } from '@vueuse/core' import useWebSocketHandler from '~/composables/useWebSocketHandler' +import useLogger from '~/composables/useLogger' import { CLIENT_RADIOS } from '~/utils/clientRadios' export const install: InitModule = ({ store }) => { + const logger = useLogger() + watch(() => store.state.instance.instanceUrl, () => { const url = store.getters['instance/absoluteUrl']('api/v1/activity') .replace(/^http/, 'ws') @@ -25,7 +28,7 @@ export const install: InitModule = ({ store }) => { }) watchEffect(() => { - console.log('Websocket status:', status.value) + logger.log('Websocket status:', status.value) }) }, { immediate: true }) diff --git a/front/src/router/guards.ts b/front/src/router/guards.ts index f9084416a..46804b98c 100644 --- a/front/src/router/guards.ts +++ b/front/src/router/guards.ts @@ -1,20 +1,23 @@ import type { NavigationGuardNext, RouteLocationNamedRaw, RouteLocationNormalized } from 'vue-router' import type { Permission } from '~/store/auth' +import useLogger from '~/composables/useLogger' import store from '~/store' +const logger = useLogger() + export const hasPermissions = (permission: Permission) => (to: RouteLocationNormalized, from: RouteLocationNormalized, next: NavigationGuardNext) => { if (store.state.auth.authenticated && store.state.auth.availablePermissions[permission]) { return next() } - console.log('Not authenticated. Redirecting to library.') + logger.warn('Not authenticated. Redirecting to library.') next({ name: 'library.index' }) } export const requireLoggedIn = (fallbackLocation?: RouteLocationNamedRaw) => (to: RouteLocationNormalized, from: RouteLocationNormalized, next: NavigationGuardNext) => { if (store.state.auth.authenticated) return next() - console.log('!', to) + logger.debug('!', to) return next(fallbackLocation ?? { name: 'login', query: { next: to.fullPath } }) } diff --git a/front/src/store/auth.ts b/front/src/store/auth.ts index a8b581890..d2a3f1530 100644 --- a/front/src/store/auth.ts +++ b/front/src/store/auth.ts @@ -168,7 +168,7 @@ const store: Module = { try { await axios.post('users/logout') } catch (error) { - console.log('Error while logging out, probably logged in via oauth') + logger.error('Error while logging out, probably logged in via oauth', error) } const modules = [ @@ -249,11 +249,11 @@ const store: Module = { const redirectUri = encodeURIComponent(`${location.origin}/auth/callback`) const params = `response_type=code&scope=${encodeURIComponent(NEEDED_SCOPES)}&redirect_uri=${redirectUri}&state=${next}&client_id=${state.oauth.clientId}` const authorizeUrl = `${rootState.instance.instanceUrl}authorize?${params}` - console.log('Redirecting user...', authorizeUrl) + logger.log('Redirecting user...', authorizeUrl) window.location.href = authorizeUrl }, async handleOauthCallback ({ state, commit, dispatch }, authorizationCode) { - console.log('Fetching token...') + logger.log('Fetching token...') const payload = { client_id: state.oauth.clientId, client_secret: state.oauth.clientSecret, diff --git a/front/src/store/ui.ts b/front/src/store/ui.ts index 9baf941ce..f7ad005df 100644 --- a/front/src/store/ui.ts +++ b/front/src/store/ui.ts @@ -5,6 +5,8 @@ import type { SUPPORTED_LOCALES } from '~/init/locale' import axios from 'axios' import moment from 'moment' +import useLogger from '~/composables/useLogger' + type SupportedExtension = 'flac' | 'ogg' | 'mp3' | 'opus' | 'aac' | 'm4a' | 'aiff' | 'aif' export type WebSocketEventName = 'inbox.item_added' | 'import.status_updated' | 'mutation.created' | 'mutation.updated' @@ -50,6 +52,8 @@ export interface State { websocketEventsHandlers: Record } +const logger = useLogger() + const store: Module = { namespaced: true, state: { @@ -236,7 +240,7 @@ const store: Module = { websocketEvent ({ state }, event: WebSocketEvent) { const handlers = state.websocketEventsHandlers[event.type] - console.log('Dispatching websocket event', event, handlers) + logger.log('Dispatching websocket event', event, handlers) if (!handlers) { return } diff --git a/front/src/views/Search.vue b/front/src/views/Search.vue index f187894cc..4288e5d97 100644 --- a/front/src/views/Search.vue +++ b/front/src/views/Search.vue @@ -19,6 +19,7 @@ import RadioCard from '~/components/radios/Card.vue' import TagsList from '~/components/tags/List.vue' import useErrorHandler from '~/composables/useErrorHandler' +import useLogger from '~/composables/useLogger' type QueryType = 'artists' | 'albums' | 'tracks' | 'playlists' | 'tags' | 'radios' | 'podcasts' | 'series' | 'rss' @@ -35,6 +36,8 @@ syncRef(pageQuery, page, { direction: 'both' }) +const logger = useLogger() + const q = useRouteQuery('q', '') const query = ref(q.value) syncRef(q, query, { direction: 'ltr' }) @@ -209,8 +212,7 @@ const radioConfig = computed(() => { } as RadioConfig } - // TODO (wvffle): Use logger - console.info('This type is not yet supported for radio') + logger.warn('This type is not yet supported for radio') } return null diff --git a/front/src/views/admin/moderation/ReportsList.vue b/front/src/views/admin/moderation/ReportsList.vue index 40e40e7b9..d1ab1d1e0 100644 --- a/front/src/views/admin/moderation/ReportsList.vue +++ b/front/src/views/admin/moderation/ReportsList.vue @@ -20,6 +20,7 @@ import useSharedLabels from '~/composables/locale/useSharedLabels' import useOrdering from '~/composables/navigation/useOrdering' import useErrorHandler from '~/composables/useErrorHandler' import usePage from '~/composables/navigation/usePage' +import useLogger from '~/composables/useLogger' interface Props extends SmartSearchProps, OrderingProps { mode?: 'card' @@ -37,6 +38,8 @@ const props = withDefaults(defineProps(), { orderingConfigName: undefined }) +const logger = useLogger() + const search = ref() const page = usePage() @@ -68,7 +71,7 @@ const fetchData = async () => { result.value = response.data if (query.value === 'resolved:no') { - console.log('Refreshing sidebar notifications') + logger.log('Refreshing sidebar notifications') store.commit('ui/incrementNotifications', { type: 'pendingReviewReports', value: response.data.count diff --git a/front/src/views/content/remote/Card.vue b/front/src/views/content/remote/Card.vue index 5ed2fa0eb..ef95ba805 100644 --- a/front/src/views/content/remote/Card.vue +++ b/front/src/views/content/remote/Card.vue @@ -12,6 +12,7 @@ import RadioButton from '~/components/radios/Button.vue' import useErrorHandler from '~/composables/useErrorHandler' import useReport from '~/composables/moderation/useReport' +import useLogger from '~/composables/useLogger' interface Emits { (e: 'followed'): void @@ -31,6 +32,8 @@ const props = withDefaults(defineProps(), { displayCopyFid: true }) +const logger = useLogger() + const { report, getReportableObjects } = useReport() const store = useStore() @@ -80,7 +83,7 @@ const follow = async () => { library.value.follow = response.data emit('followed') } catch (error) { - console.error(error) + logger.error(error) store.commit('ui/addMessage', { content: t('views.content.remote.Card.error.follow', { error }), date: new Date() diff --git a/front/src/views/playlists/List.vue b/front/src/views/playlists/List.vue index feba0aeb9..99e4d74be 100644 --- a/front/src/views/playlists/List.vue +++ b/front/src/views/playlists/List.vue @@ -65,7 +65,7 @@ const fetchData = async () => { playable: true } - logger.time('Fetching albums') + const stop = logger.time('Fetching albums') try { const response = await axios.get('playlists/', { params @@ -76,7 +76,7 @@ const fetchData = async () => { useErrorHandler(error as Error) result.value = undefined } finally { - logger.timeEnd('Fetching albums') + stop() isLoading.value = false } }