Merge branch 'main' into sukamat-patch-1

README.md

@@ -58,3 +58,23 @@ If you need to lint just one file, you can run:
 ```sh
 npx eslint file1.js
 ```
+
+## Logging
+When logging do not use `console` but instead use `window.lana.log`, these logs will then be visible in Splunk. 
+Use tags to help filter logs. Tags should have the severity, see below, and the module/block name. 
+Tags should provide context, categorization, or help in filtering, etc.
+
+Severity:
+```
+info = network issues or extra details to identify important information.
+warn = authoring related mis-configurations or similar - this could lead to generating tickets.
+error = actual error ( ex. cannot read Y of undefined ) - this could lead to generating tickets / CSOs depending on context.
+```
+Work with OPS to generate automatic tickets / CSOs, for example if an error causes the page or block not to render.
+
+Example Logging:
+```js
+window.lana.log('message', 'info, block-name');
+```
+
+More info: https://wiki.corp.adobe.com/display/WCMSOps/Best+Practices

blocks/faas-decode/faas-decode.js

@@ -6,8 +6,7 @@ export default async function init(el) {
   const resp = await fetch(url);
 
   if (!resp?.ok) {
-    // eslint-disable-next-line no-console
-    console.log(`Error fetching data from url: ${url}`);
+    window.lana?.log(`Error fetching data from url: ${url}`, { tags: 'info, faas-decode' });
     return;
   }
 

blocks/tree-view/tree-view.js

@@ -11,8 +11,7 @@ export const isCurrentPage = (link) => {
 
     if (isBacomHost && url.pathname.replace('.html', '') === currentPath) return true;
   } catch (e) {
-    // eslint-disable-next-line no-console
-    console.log('Tree View error:', e);
+    window.lana?.log(`Tree View error:${e.message}`, { tags: 'info, tree-view' });
   }
 
   return false;

scripts/scripts.js

@@ -189,6 +189,6 @@ const miloLibs = setLibs(LIBS);
     }
   }
   setConfig({ ...CONFIG, miloLibs });
-  loadLana({ clientId: 'bacom' });
+  loadLana({ clientId: 'bacom', tags: 'info' });
   await loadArea();
 }());

test/blocks/faas-decode/faas-decode.test.js

@@ -4,9 +4,11 @@ import init from '../../../blocks/faas-decode/faas-decode.js';
 import { setLibs } from '../../../scripts/utils.js';
 import waitForElement from '../../helpers/waitForElement.js';
 
+window.lana = { log: () => {} };
+
 describe('FaaS Decode', () => {
   before(() => {
-    sinon.spy(console, 'log');
+    sinon.stub(window.lana, 'log');
     setLibs('/libs');
   });
 
@@ -18,7 +20,7 @@ describe('FaaS Decode', () => {
     document.body.innerHTML = '<div class="faas-decode"><div><div><a href="/404"></a></div></div></div>';
     const el = document.querySelector('.faas-decode');
     await init(el);
-    expect(console.log.args[0][0]).to.include('Error fetching data from url:');
+    expect(window.lana.log.args[0][0]).to.include('Error fetching data from url:');
   });
 
   it('creates a table', async () => {

test/blocks/tree-view/tree-view.test.js

@@ -5,6 +5,7 @@ import { setLibs } from '../../../scripts/utils.js';
 
 const { default: init, isCurrentPage } = await import('../../../blocks/tree-view/tree-view.js');
 
+window.lana = { log: () => {} };
 setLibs('libs');
 
 describe('Tree View', () => {
@@ -38,10 +39,10 @@ describe('Tree View', () => {
   });
 
   it('isCurrentPage catches error', () => {
-    sinon.spy(console, 'log');
+    sinon.stub(window.lana, 'log');
     isCurrentPage('/relative-link');
-    expect(console.log.args[0][0]).to.equal('Tree View error:');
-    console.log.restore();
+    expect(window.lana.log.args[0][0]).to.contain('Tree View error:');
+    window.lana.log.restore();
   });
 
   describe('accordion', () => {