Skip to content

Latest commit

 

History

History
190 lines (168 loc) · 13.3 KB

README.md

File metadata and controls

190 lines (168 loc) · 13.3 KB
Raw

Universal Adobe Debugger

Debugger tool for Adobe Launch, AEP and Adobe Analytics.

Table of Contents

Purpose

The purpose can be divided in a few segments, sorted by importance desc:

  • Make it faster for Adobe Analytics implementation engineers and analysts to debug the front-end part of Adobe Analytics, AEP or Adobe Launch. Ideally, as fast as possible while still keeping it universal.
  • Make it more comfortable to consume the debugging data.
  • Make it possible for a larger analytics community to contribute to open source debugging tools not associated with any corp.
  • Make it easier for associated third parties like front-end developers and QAs to see the live analytics data.

Scope

This extension essentially has four parts accomplishing different facets of AA/Launch debugging:

  • Essential info Popup. Make it easier and faster to get essential information about the Launch library and primitive highlighting of essential concerns:

    alt no Launch Present Screenshot alt Launch Present Screenshot

  • Console logging. Completely reimplement and improve what the AA Debugger extension does, fixing its bugs and ui, adding more configuration options:

    alt console logging

  • Library Replacement. Reimplement the Switch extension, essentially, but simpler and working properly. Simple logic to redirect the launch library fetch to a custom library.

  • AEP Debugging. The Web SDK debugging. (I should add screenshots here)

Plan

The dev plan and event log:
  • Release v1.10.
  • Create an infrastructure around the codebase of the extension, introduce unit tests, look into CI.
  • Support for Mozilla FF. Same extension. Cross-browsers. Seems like mostly only background will have to be reimplemented, but many APIs may be off. We'll see.
  • Implement Launch UI improvements.
  • Add transaction id in the product string prettifier for Appmeasurement logging.
  • Add an option to print general alloy config
  • Release v1.09.50
  • Rename the content-script.js to something more interesting. It's visible in the console and can be filtered by.
  • Web SDK: Further improve the custom logging, allowing shorthands: p12/c12/v12/e12/l2.
  • Apply all the shorthanded custom logging to Appmeasurement logging too.
  • Release v1.09.1 To the webstore only.
  • Fix a bug in custom logging, in event shortcuts for the data.__adobe.analytics usecases.
  • Fix a bug in custom logging, in prop shortcuts for the data.__adobe.analytics usecases.
  • Release v1.09.
  • Web SDK: Expose the event type in the logging header.
  • Web SDK: Improve the custom logger to also check the data.__adobe.analytics object when using shortcuts.
  • Web SDK: Make it easier for non-technical people to use the custom logging: don't require them to specify the full path to evars, props or events for xdm payloads. If users ask for evars and it's an xdm event, just add the correct path to it.
  • Reimplement page load time to something like performance.getEntriesByType("navigation")[0]?.duration
  • Release v1.08.
  • Web SDK: On errors, in custom logs, add an indication that the request resulted in an error. This is for people who use filters in the console like pros. Thanks Arun for noticing.
  • Web SDK: MVP tracking the navigator.sendBeacon() ping network requests. No access to their payloads, however, because the Chrome devteam neglects fixing related bugs.
  • Delete requests from the map on other callbacks too to avoid misreporting calls as such that didn't receive the server response.
  • v1.07.1: increase the timeout limit from 1 to 2 seconds.
  • Release v1.07.
  • Print the extension version, getting it from the manifest.
  • UX improvements, CSS fixes.
  • Add a bug submission button in info.
  • Web SDK: Add an option to log all fields there are, giving the user the raw object.
  • Add a callback and error logging for "cancelled" requests. That's when the browser cancels the request. And a few other types of requests. Thanks to Arun for the suggestion.
  • Web SDK: Apply the error logging logic to Web SDK tracking too
  • Small popup UI improvements.
  • Release v1.06 (Byanka's Web SDK improvements update)
  • Web SDK: Reinforce the custom logging field, allow people to use the xdm. reference in the list of params.
  • Web SDK: Add logging for the data.__adobe object. Off by default in settings.
  • Web SDK: Improve the logging for non-object fields.
  • Web SDK: Add a setting to remove the essentially useless xdm fields that are rarely useful to look at. On by default.
  • Web SDK: Change the default logging a bit to maybe try and expand the analytics object automatically.
  • Web SDK: Refactor logging. Make it less confusing. No more nested groups.
  • Web SDK: Improve the tracking of network errors when edge network requests fail.
  • Web SDK: Surface the Edge config ids for every request, make them visible just like AA Report Suites. To ease the debugging of multi-destinational tracking. First 5 characters should suffice.
  • Web SDK: Improve autodebugging: indicate when linkClicks will be treated as pageviews in AA due to the web fields set.
  • Replace the counter of PVs and links with AA calls and WebSDK calls
  • Release v1.05.
  • Small reporting improvements.
  • Allow the underscore in the field names.
  • QOL Improvements for the custom web SDK logging.
  • Release v1.04.
  • Configure selective logging for the web SDK.
  • Release v1.03.
  • Add a line to indicate the end of the main logging group for easier reading.
  • Fix a bug in the new custom logging code.
  • CSS improvements of the extension popup. Thanks Chip!
  • Release v1.02.
  • Small cosmetic improvements.
  • Improve _satellite.setDebug(0) to work immediately rather than after a page reload.
  • Allow the user to set their own variables to be included in the header of the logging. Thanks Arun T for suggesting.
  • Release v1.01.
  • A bit more ui improvements.
  • The "Other" reporting section is now collapsed by default due to the number of not-so-useful new dimensions added there.
  • Add reporting for s.zip, currency code, org id (mcorgid) and visitor id (mid).
  • Merchandising variables logging improvements (", " delimiter instead of the pipe "|").
  • Add a feature to highlight merch events that aren't present in s.events. Why would Adobe do this? Feels like a bug.
  • Code refactory in the popup scripts.
  • Release v1.00.
  • Raccooning!
  • Release v0.99.
  • Update extension store/repo screenshots.
  • Slight UI adjustments.
  • setDebug made more reliable.
  • Web SDK/AEP MVP logging implementation.
  • OT - Allow All and Deny All buttons.
  • Release v0.98.
  • Context data logging: https://experienceleague.adobe.com/docs/analytics/implementation/vars/page-vars/contextdata.html?lang=en Thanks to chip for suggesting it!
  • Also detect /satelliteLib- libraries besides /launch-
  • Release v0.97.
  • setDebug reimplementation. Now it works better.
  • Release v0.96.
  • Add useful snippets to the extension. Basically window.onbeforeunload = ()=>false and one trust stuff maybe.
  • Better date formatting.
  • Deletion of all redirection rules must delete both dynamic and sync rules.
  • Implement _satellite.setDebug() polling logic for when the lib is not loaded when the extension tries to set it.
  • Release v0.95.
  • Deal properly with empty dataLayers found. (the extension throws)
  • Instead of reporting into an active tab, report into the one the listeners are deployed to.
  • Add an option for redirects to be session-based. By default.
  • Make sure redirects logic is synced and enabled automatically when user uses a different browser with the same account and extension sync is on.
  • Add a button to delete all redirects.
  • Implement the actual library switching logic (redirects)
  • Add an option to quickly kill current page's redirection from the Settings tab.
  • Less bold text in ui.
  • SetDebug's default state is not taken into account.
  • Redirections management tab and logic.
  • Redirections settings/error reporting logic.
  • Simplest Launch library detection logic (from DOM only, whatever has /launch-.*8.js) (MVP)
  • Formatting improvements in Settings.
  • Release the v0.90
  • Implement logging for failed server calls. Maybe an SSL error is a good one to simulate.
  • A pageview is misfiring on adobe launch site. When there's no page/link name in a call, make it clear.
  • Empty product fields are reported as Undefined when they're not defined. Replace it with a less generic message or just an empty string to avoid confusion for when "undefined" is the actual value of it
  • When last event in DL found, clicking on the its cell will neatly print it to the console.
  • When DL found, clicking on the DL cell will neatly print it to the console.
  • Release the v0.88
  • Implement server call counting in logging
  • Add logging for the Site Section near the PV info
  • Wrong DL is checked sometimes for the last event info (GTM's DL instead of DM)
  • Initial release to the Chrome web store v0.87 - first release: https://chromewebstore.google.com/detail/adobe-launch-debugger/ehadnibhemgjphdjgkallndphbghlpkn
  • Get some help from designers on the favicon, popup ui and logging
  • Deploy a test launch property with AA tracking for advanced testing
  • Add settings to change the default behavior of the main console log to be collapsed
  • Add a settings and info tabs to the popup
  • Adjust colors in the console logging to work well in the light console
  • Finish the Product string parsing and reporting
  • Finish the Hierarchies parsing and logging
  • Add logic to parse POST b/ss requests too
Questionable features
  • Consider integrating with devtools to better monitor all network tab activity. https://chromedevtools.github.io/devtools-protocol/tot/Network/#method-enable
  • Consider adding support for other consent management systems, mostly TrustArc and Adobe's Evidon. I would love to, but they lack documentation. Maybe next time I have to work with them.
  • Web SDK: Make an option to exclude Target Web Sdk calls when they don't land in Anaytics. Have them excluded by default. I'm not sure they don't land in AA. I think they do. Will skip this one until I run into it.
  • Hesitant: Find an elegant way to inject a library rather than replace it. Should probably be one/domain. To avoid doing it globally. Maybe not... It's so rare that we would need it, just use Overrides for ad-hoc injections?
  • Hesitant: Web SDK: Allow for custom Edge base path. It's /ee/ by default, but it can be customized, in which case the extension won't catch the network requests. (who uses a custom Edge base path?)
  • Hesitant: Web SDK: Add a setting to limit the number of characters for the config id logging in the websdk tracking. 4 characters by default.

Contributions

Contributions are welcome! Whether it's code, ux/ui solutions or just advice. If you're inspired to do so, please contribute!

To install the extension in the unpacked state:

  • Clone the repo
  • Open your Chrome -> open chrome://extensions/ -> in the top right of the page, there's a Developer mode slider. Enable it
  • In the extensions page, select the Load unpacked option. Load this repo's folder.
  • Done, you've installed it

To test changes:

If it's a UI change in the extension-script.js, css files or main.html, just click the extension icon in the browser to reload its popup window and you'll see your changes

If it's a deeper change of the content-script.js or background.js or manifest, you'll have to reload the extension:

  • Open the extensions page chrome://extensions/
  • Click the reload CTA in the extension card near the enable/disable slider.

Special thanks

  • To the #adobe-launch and #adobe-analytics channels of Measure Slack community for early testing and precious feedback from staff enterprise analytics experts.
  • To the #javascript channel of Libera Chat community and especially to LJHarb in there for always being able to answer even most complex JS questions with kindness and patience.
  • To the Chromium Extensions Google group and especially to wOxxOm there and on Stack Overflow for guiding me through most critical stages of extension development.

License

Mozilla Public License Version 2.0