Standardize console messages in @polar/core

Relates: #41

Author: dopenguin

packages/core/src/components/MapContainer.vue

@@ -198,7 +198,7 @@ export default Vue.extend({
                 }
                 // always print status code for debugging purposes
                 console.error(
-                  `Ping to "${service.id}" returned "${statusCode}".`
+                  `@polar/core: Ping to "${service.id}" returned "${statusCode}".`
                 )
                 // always add to error log for listener purposes
                 this.$store.commit('setErrors', [
@@ -211,7 +211,7 @@ export default Vue.extend({
                 ])
               }
             })
-            .catch(console.error)
+            .catch((e) => console.error('@polar/core', e))
         )
     },
     updateHasSmallDisplay() {

packages/core/src/monkeyHeaderLoader.ts

@@ -28,7 +28,7 @@ function customLoader(tile, url) {
         tile.getImage().src = URL.createObjectURL(blob)
       }
     })
-    .catch(console.error)
+    .catch((e) => console.error('@polar/core', e))
 }
 
 // Original addLayer method

packages/core/src/storeModules/capabilities.ts

@@ -25,7 +25,7 @@ export const CapabilitiesModule: Module<CoreCapabilitiesState, object> = {
       const previous = getters.capabilities[id]
       if (typeof previous !== 'undefined' && previous !== null) {
         console.warn(
-          `Re-fired loadCapabilities on id '${id}' albeit the GetCapabilities have already been successfully fetched. No re-fetch will occur.`
+          `@polar/core: Re-fired loadCapabilities on id '${id}' albeit the GetCapabilities have already been successfully fetched. No re-fetch will occur.`
         )
         return
       }
@@ -35,7 +35,9 @@ export const CapabilitiesModule: Module<CoreCapabilitiesState, object> = {
 
       const service = rawLayerList.getLayerWhere({ id })
       if (!service || !service.url || !service.version || !service.typ) {
-        console.error(`Missing data for service with id '${id}': ${service}`)
+        console.error(
+          `@polar/core: Missing data for service '${service}' with id '${id}'.`
+        )
         return
       }
 
@@ -46,8 +48,8 @@ export const CapabilitiesModule: Module<CoreCapabilitiesState, object> = {
         .then((string) => commit('addCapabilities', { id, string }))
         .catch((e) => {
           console.error(
-            e,
-            `Capabilities from ${capabilitiesUrl} could not be fetched.`
+            `@polar/core: Capabilities from ${capabilitiesUrl} could not be fetched.`,
+            e
           )
           commit('addCapabilities', { id, string: null })
         })
@@ -69,7 +71,10 @@ export const CapabilitiesModule: Module<CoreCapabilitiesState, object> = {
             const json = parser.read(xml)
             return json
           } catch (e) {
-            console.error(e, `Error reading xml for id '${id}': ${xml}`)
+            console.error(
+              `@polar/core: Error reading xml '${xml}' for id '${id}'.`,
+              e
+            )
           }
         }
         return null

packages/core/src/utils/addPlugins.ts

@@ -6,8 +6,7 @@ export default function addPlugins(this, plugins) {
       plugins.forEach((initializePlugin) => initializePlugin(instance))
       return instance
     } catch (error) {
-      console.error('Map creation failed.')
-      console.error(error)
+      console.error('@polar/core: Map creation failed.', error)
     }
   }
 }

packages/core/src/utils/createMap/makeShadowRoot.ts

@@ -57,7 +57,7 @@ export const makeShadowRoot = (containerId: string): Promise<ShadowRoot> =>
           return
         }
         console.error(
-          `containerId "${containerId}" not found on website.
+          `@polar/core: containerId "${containerId}" not found on website.
             POLAR map client won't render.
             Retrying in ${waitTime}ms ...`
         )

packages/core/src/utils/createMap/pullPolarStyleToShadow.ts

@@ -18,7 +18,7 @@ export const pullPolarStyleToShadow = (
 
     if (!devMode) {
       console.warn(
-        `Stylesheets have been pulled to the ShadowDOM. This mechanism is deprecated and will be removed in the next major version. In the future, POLAR will try to create the relevant style nodes itself, and can be configured as to where the file to be imported is located. This removes the flash of misstyled content POLAR could previously produce on the outlying page, and is an overall more clean solution. See the @polar/core documentation, field 'stylePath'.`
+        `@polar/core: Stylesheets have been pulled to the ShadowDOM. This mechanism is deprecated and will be removed in the next major version. In the future, POLAR will try to create the relevant style nodes itself, and can be configured as to where the file to be imported is located. This removes the flash of misstyled content POLAR could previously produce on the outlying page, and is an overall more clean solution. See the @polar/core documentation, field 'stylePath'.`
       )
     }
   } else {
@@ -27,7 +27,7 @@ export const pullPolarStyleToShadow = (
     link.rel = 'stylesheet'
     link.onerror = (e) =>
       console.error(
-        `core.createMap: Couldn't find required stylesheets, map won't render. ${
+        `@polar/core: Couldn't find required stylesheets, map won't render. ${
           stylePath === defaultStylePath
             ? `The default stylePath ${defaultStylePath} did not work. Please check @polar/core's documentation of 'stylePath' on how this can be configured.`
             : `It seems the provided stylePath (${stylePath}) did not work. Please verify its correctness. The value should be given as it would be correct in a link tag's href.`

packages/core/src/utils/createMap/pullVuetifyStyleToShadow.ts

@@ -6,7 +6,7 @@ export const pullVuetifyStyleToShadow = (shadowRoot: ShadowRoot) => {
   const vuetifyStyle = document.getElementById('vuetify-theme-stylesheet')
   if (vuetifyStyle === null) {
     console.error(
-      `The POLAR map client did not find the vuetify theme stylesheet. It is supposed to be created programmatically. This is probably a bug in POLAR.`
+      `@polar/core: The POLAR map client did not find the vuetify theme stylesheet. It is supposed to be created programmatically. This is probably a bug in POLAR.`
     )
     return
   }

packages/core/src/utils/createMap/updateSizeOnReady.ts

@@ -18,12 +18,14 @@ export const updateSizeOnReady = (instance: Vue) => {
       instance.$store.getters.map.updateSize()
     } else if (attemptCounter === 100) {
       console.error(
-        `The POLAR map client could not update its size. The map is probably invisible due to having 0 width or 0 height. This might be a CSS issue – please check the wrapper's size.`
+        `@polar/core: The POLAR map client could not update its size. The map is probably invisible due to having 0 width or 0 height. This might be a CSS issue – please check the wrapper's size.`
       )
     } else {
       // OL prints warnings – add this log to reduce confusion
       // eslint-disable-next-line no-console
-      console.log(`The map now has dimensions and can be rendered.`)
+      console.log(
+        `@polar/core: The map now has dimensions and can be rendered.`
+      )
       clearInterval(intervalId)
     }
   }, 0)

packages/core/src/utils/markers.ts

@@ -73,7 +73,7 @@ const memoizeStyle = (getMarker: GetMarkerFunction): GetMarkerFunction => {
     cache.set(style, markerStyle)
     if (cache.size > 1000) {
       console.warn(
-        `@polar/core/src/utils/markers.ts: 1000+ styles have been created. This is possibly a memory leak. Please mind that the methods exported by this module are memoized. You *may* be calling the methods with constantly newly generated objects, or maybe there's just a lot of styles.`
+        `@polar/core: 1000+ styles have been created. This is possibly a memory leak. Please mind that the methods exported by this module are memoized. You *may* be calling the methods with constantly newly generated objects, or maybe there's just a lot of styles.`
       )
     }
     return markerStyle