Use @nextcloud/logger for all logging

The nextcloud logger take account for the configured logging level,
so only messages the user / administrator wants are logged.
This fixes #2846 (no debug messages are logged if not configured).

Signed-off-by: Ferdinand Thiessen <[email protected]>

Author: susnux

package-lock.json

@@ -43,6 +43,7 @@
     "@nextcloud/event-bus": "^3.0.2",
     "@nextcloud/initial-state": "^2.0.0",
     "@nextcloud/l10n": "^1.6.0",
+    "@nextcloud/logger": "^2.3.0",
     "@nextcloud/moment": "^1.2.1",
     "@nextcloud/router": "^2.0.0",
     "@nextcloud/vue": "^7.0.0-beta.2",

package.json

@@ -1,9 +1,9 @@
-/*
+/**
  * @copyright Copyright (c) 2019 Julius Härtl <[email protected]>
  *
  * @author Julius Härtl <[email protected]>
  *
- * @license GNU AGPL version 3 or any later version
+ * @license AGPL-3.0-or-later
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -18,38 +18,46 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  *
-*/
+ */
 
 /* eslint-disable import/no-named-as-default */
 import History from '@tiptap/extension-history'
 import Placeholder from '@tiptap/extension-placeholder'
 /* eslint-enable import/no-named-as-default */
 
 import TrailingNode from './nodes/TrailingNode.js'
+import EmojiListWrapper from './components/EmojiListWrapper.vue'
 import EditableTable from './nodes/EditableTable.js'
+import MentionSuggestion from './components/Mention/suggestion.js'
+
+import tippy from 'tippy.js'
+import 'proxy-polyfill'
+
 import { Editor } from '@tiptap/core'
-import { Emoji, Markdown, Mention, PlainText, RichText } from './extensions/index.js'
+import { VueRenderer } from '@tiptap/vue-2'
 import { translate as t } from '@nextcloud/l10n'
+import { emojiSearch } from '@nextcloud/vue/dist/Functions/emoji.js'
 import { listLanguages, registerLanguage } from 'lowlight/lib/core.js'
 import { emojiSearch } from '@nextcloud/vue/dist/Functions/emoji.js'
 import { VueRenderer } from '@tiptap/vue-2'
-import EmojiListWrapper from './components/EmojiListWrapper.vue'
+import EmojiList from './components/EmojiList.vue'
 import MentionSuggestion from './components/Mention/suggestion.js'
 import tippy from 'tippy.js'
 
-import 'proxy-polyfill'
+import { logger } from './helpers/logger.js'
+import { Emoji, Markdown, Mention, PlainText, RichText } from './extensions/index.js'
 
 const loadSyntaxHighlight = async (language) => {
 	const list = listLanguages()
-	console.info(list)
+	logger.debug('Supported languages', { list })
 	if (!listLanguages().includes(language)) {
 		try {
 			// eslint-disable-next-line n/no-missing-import
 			const syntax = await import(/* webpackChunkName: "highlight/[request]" */'highlight.js/lib/languages/' + language)
 			registerLanguage(language, syntax.default)
-		} catch (e) {
-			// No matching highlighing found, fallback to none
-			console.debug(e)
+		} catch (error) {
+			// fallback to none
+			logger.debug('No matching highlighing found', { error })
 		}
 	}
 }

src/EditorFactory.js

@@ -1,9 +1,9 @@
-/*
+/**
  * @copyright Copyright (c) 2022 Vinicius Reis <[email protected]>
  *
  * @author Vinicius Reis <[email protected]>
  *
- * @license GNU AGPL version 3 or any later version
+ * @license AGPL-3.0-or-later
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -20,6 +20,8 @@
  *
  */
 
+import { logger } from '../helpers/logger.js'
+
 export const EDITOR = Symbol('tiptap:editor')
 export const FILE = Symbol('editor:file')
 export const ATTACHMENT_RESOLVER = Symbol('attachment:resolver')
@@ -84,7 +86,7 @@ export const useAttachmentResolver = {
 			from: ATTACHMENT_RESOLVER,
 			default: {
 				resolve(src) {
-					console.warn('No attachment resolver provided. Some attachment sources cannot be resolved.')
+					logger.warn('No attachment resolver provided. Some attachment sources cannot be resolved.')
 					return [src]
 				},
 			},

src/components/Editor.provider.js

@@ -85,6 +85,7 @@ import {
 	SYNC_SERVICE,
 } from './Editor.provider.js'
 
+import { logger } from '../helpers/logger.js'
 import { SyncService, ERROR_TYPE, IDLE_TIMEOUT } from './../services/SyncService.js'
 import AttachmentResolver from './../services/AttachmentResolver.js'
 import { extensionHighlight } from '../helpers/mappings.js'
@@ -568,8 +569,8 @@ export default {
 				this.$nextTick(() => {
 					this.$emit('sync-service:sync')
 				})
-			} catch (e) {
-				console.error('Failed to update steps in collaboration plugin', e)
+			} catch (error) {
+				logger.error('Failed to update steps in collaboration plugin', { error })
 				// TODO: we should recreate the editing session when this happens
 			}
 			this.document = document
@@ -663,8 +664,8 @@ export default {
 					this.unlistenEditorEvents()
 					this.$editor.destroy()
 					this.$editor = null
-				} catch (err) {
-					console.warn(err)
+				} catch (error) {
+					logger.warn('Failed to destroy editor', { error })
 				}
 			}
 			return true

src/components/Editor.vue

@@ -3,7 +3,7 @@
   -
   - @author Vinicius Reis <[email protected]>
   -
-  - @license GNU AGPL version 3 or any later version
+  - @license AGPL-3.0-or-later
   -
   - This program is free software: you can redistribute it and/or modify
   - it under the terms of the GNU Affero General Public License as
@@ -43,6 +43,7 @@
 <script>
 import { getCurrentUser } from '@nextcloud/auth'
 import { showError } from '@nextcloud/dialogs'
+import { logger } from '../../helpers/logger.js'
 
 import {
 	useEditorMixin,
@@ -122,9 +123,9 @@ export default {
 			})
 
 			return Promise.all(uploadPromises)
-				.catch(err => {
-					console.error(err)
-					showError(err?.response?.data?.error || err.message)
+				.catch(error => {
+					logger.error('Uploading multiple images failed', { error })
+					showError(error?.response?.data?.error || error.message)
 				})
 				.then(() => {
 					this.state.isUploadingAttachments = false
@@ -141,7 +142,7 @@ export default {
 					)
 				})
 				.catch((error) => {
-					console.error(error)
+					logger.error('Uploading image failed', { error })
 					showError(error?.response?.data?.error)
 				})
 				.then(() => {
@@ -167,7 +168,7 @@ export default {
 					null, response.data?.dirname
 				)
 			}).catch((error) => {
-				console.error(error)
+				logger.error('Failed to insert image path', { error })
 				showError(error?.response?.data?.error || error.message)
 			}).then(() => {
 				this.state.isUploadingAttachments = false

src/components/Editor/MediaHandler.vue

@@ -4,7 +4,7 @@
   - @author Vinicius Reis <[email protected]>
   - @author Julius Härtl <[email protected]>
   -
-  - @license GNU AGPL version 3 or any later version
+  - @license AGPL-3.0-or-later
   -
   - This program is free software: you can redistribute it and/or modify
   - it under the terms of the GNU Affero General Public License as

src/components/Menu/MenuBar.vue

@@ -1,9 +1,9 @@
-/*
+/**
  * @copyright Copyright (c) 2019 Julius Härtl <[email protected]>
  *
  * @author Julius Härtl <[email protected]>
  *
- * @license GNU AGPL version 3 or any later version
+ * @license AGPL-3.0-or-later
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -21,11 +21,13 @@
  */
 
 import Vue from 'vue'
-import { registerFileActionFallback, FilesWorkspacePlugin } from './helpers/files.js'
-import FilesSettings from './views/FilesSettings.vue'
-import { loadState } from '@nextcloud/initial-state'
 import { linkTo } from '@nextcloud/router'
+import { loadState } from '@nextcloud/initial-state'
+
 import store from './store/index.js'
+import FilesSettings from './views/FilesSettings.vue'
+import { logger } from './helpers/logger.js'
+import { registerFileActionFallback, FilesWorkspacePlugin } from './helpers/files.js'
 
 __webpack_nonce__ = window.btoa(OC.requestToken) // eslint-disable-line
 __webpack_public_path__ = linkTo('text', 'js/') // eslint-disable-line
@@ -35,11 +37,11 @@ const workspaceEnabled = loadState('text', 'workspace_enabled')
 
 document.addEventListener('DOMContentLoaded', () => {
 	if (typeof OCA.Viewer === 'undefined') {
-		console.error('Viewer app is not installed')
+		logger.error('Viewer app is not installed')
 		registerFileActionFallback()
 	}
 
-	if (workspaceAvailable && OCA && OCA.Files && OCA.Files.Settings) {
+	if (workspaceAvailable && OCA && OCA?.Files?.Settings) {
 		Vue.prototype.t = window.t
 		Vue.prototype.n = window.n
 		Vue.prototype.OCA = window.OCA

src/files.js

@@ -1,9 +1,9 @@
-/*
+/**
  * @copyright Copyright (c) 2020 Azul <[email protected]>
  *
  * @author Azul <[email protected]>
  *
- * @license GNU AGPL version 3 or any later version
+ * @license AGPL-3.0-or-later
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -21,6 +21,8 @@
  */
 
 import { generateUrl } from '@nextcloud/router'
+
+import { logger } from '../helpers/logger.js'
 import markdownit from './../markdownit/index.js'
 
 const absolutePath = function(base, rel) {
@@ -105,7 +107,7 @@ const openLink = function(event, _attrs) {
 		return
 	}
 	if (!markdownit.validateLink(htmlHref)) {
-		console.error('Invalid link', htmlHref)
+		logger.error('Invalid link', { htmlHref })
 		return false
 	}
 	if (fragment) {

src/helpers/links.js

@@ -0,0 +1,10 @@
+import { getLoggerBuilder } from '@nextcloud/logger'
+
+const logger = getLoggerBuilder()
+	.setApp('text')
+	.detectUser()
+	.build()
+
+export {
+	logger,
+}