feat: introduce plugin system to offset non-essenial logic #348

ramboz · 2025-01-14T00:26:29Z

As discussed over Slack, we want to introduce a plugin system to offset some of the non-essential logic and reduce the core library's overall file size.

At a high level, we want:

a minimalistic probing logic that checks the markup or page context for some "markers" that indicate additional optional logic is needed
a loader script that pulls in the required script for the particular plugin
the plugin should have a default export that gets the required context passed as input

Test Url: https://rum-plugin-system--helix-website--adobe.aem.live/?rum=on
PR against helix website: adobe/helix-website#754

aem-code-sync · 2025-01-14T00:26:34Z

Hello, I'm the AEM Code Sync Bot and I will run some actions to deploy your branch and validate page speed.
In case there are problems, just click a checkbox below to rerun the respective action.

Re-run PSI checks
Re-sync branch

Commits

e3ad482 ✅ (latest)
f531f09 ✅
a8fa936 ✅
be228fa ✅
aacaf8d ✅
1f1fa8f ✅
351876c ✅
ab954d7 ✅
b2e0b5d ✅
08d9933 ✅
9a9608b ✅
3181698 ✅
29e7138 ✅
8ee7b04 ✅
8964f80 ✅
f77d736 ✅
c73eb31 ✅
93b4537 ✅
b3f32eb ✅
7d89e9f ✅
d88b010 ✅
1c21afd ✅
5c9adbc ✅
95a653e ✅
068c5c5 ✅
9726dc8 ✅
4613b00 ✅
d5aa373 ✅
8642557 ✅
6066f0b ✅

adobe-bot · 2025-01-14T00:34:16Z

This PR will trigger a minor release when merged.

ramboz · 2025-01-14T00:34:25Z

This is a first draft that brings the code down to ~12.5kB.

ramboz · 2025-01-14T01:04:14Z

modules/index.js

@@ -64,99 +111,6 @@ function processQueue() {
  }
 }

-function addCWVTracking() {


Moved to cwv.js

ramboz · 2025-01-14T01:04:23Z

modules/index.js

-  }, 2000); // wait for delayed
-}
-
-function addNavigationTracking() {


Moved to navigation.js

ramboz · 2025-01-14T01:05:02Z

modules/index.js

@@ -211,8 +165,6 @@ function getIntersectionObsever(checkpoint) {
  if (!window.IntersectionObserver) {
    return null;
  }
-  activateBlocksMO();


Moved down addTrackingFromConfig

ramboz · 2025-01-14T01:05:12Z

modules/index.js

@@ -251,28 +203,6 @@ function addViewMediaTracking(parent) {
  }
 }

-function addFormTracking(parent) {


Moved to form.js

modules/index.js

ramboz · 2025-01-14T01:06:16Z

modules/index.js

-import {
-  addAdsParametersTracking,
-  addCookieConsentTracking,
-  addEmailParameterTracking,
-  addUTMParametersTracking,
-} from './martech.js';


Moved to martech.js & onetrust.js

trieloff · 2025-01-14T17:13:03Z

Custom plugins can be defined at the project level via window.RUM_PLUGINS

Let's make that a non-goal:

~~Custom plugins can be defined at the project level via window.RUM_PLUGINS~~

trieloff

That's a good start. I wonder if we can make the CWS plugin more elegant, so that it does not need to load two files after another. Maybe rollup the dependency.

modules/index.js

plugins/onetrust.js

ramboz · 2025-01-16T01:52:23Z

I tried a few ways to include the web-vitals lib directly in the cwv.js plugin to avoid another network roundtrip… but I'm hitting: aMarCruz/rollup-plugin-cleanup#16

So unless we stop cleaning up the output files in rollup, I think we'll be stuck having to load this separately

…king all resources, not just same host

# [2.29.0](v2.28.0...v2.29.0) (2025-01-15) ### Features * **loadresource:** add `allresources` feature flag that enables tracking all resources, not just same host ([7c536d7](7c536d7))

the target field was until now unused. this change uses it for the status code and in turn tracks all errored resources as `missingresource`

# [2.30.0](v2.29.0...v2.30.0) (2025-01-15) ### Features * **missingresource:** report all resource error with http status code ([e238136](e238136))

# [2.31.0-beta.1](v2.30.0...v2.31.0-beta.1) (2025-01-16) ### Features * handle pre-rendering ([bb11187](bb11187))

This reverts commit bb11187.

# [2.31.0-beta.2](v2.31.0-beta.1...v2.31.0-beta.2) (2025-01-16) ### Reverts * Revert "feat: handle pre-rendering" ([6471af5](6471af5))

# [2.31.0-beta.3](v2.31.0-beta.2...v2.31.0-beta.3) (2025-01-16) ### Bug Fixes * bugs and failing tests ([5c9adbc](5c9adbc)) * cross-browser compatibility ([1c21afd](1c21afd)) * set proper url base for plugins ([9726dc8](9726dc8)) * use proper fully qualified URLs for plugin path to avoid CORS ([c73eb31](c73eb31)) ### Features * allow external extension via window.RUM_PLUGINS ([4613b00](4613b00)) * inline web-vitals.js ([7d89e9f](7d89e9f)) * introduce minimal plugin system to offset non-essenial logic ([8642557](8642557)) * introduce minimal plugin system to offset non-essenial logic ([6066f0b](6066f0b))

# [2.31.0-beta.4](v2.31.0-beta.3...v2.31.0-beta.4) (2025-01-16) ### Bug Fixes * plugin path resolution ([f464652](f464652))

# [2.31.0-beta.5](v2.31.0-beta.4...v2.31.0-beta.5) (2025-01-17) ### Bug Fixes * just forcing a release ([84ab687](84ab687))

ramboz · 2025-01-17T01:34:12Z

plugins/video.js

+
+export default function addVideoTracking({ context }) {
+  context.querySelectorAll('video').forEach(() => {
+    // TODO: Add video tracking


Just an empty placeholder for now

feat: introduce minimal plugin system to offset non-essenial logic

6066f0b

feat: introduce minimal plugin system to offset non-essenial logic

8642557

aem-code-sync bot temporarily deployed to plugin-system January 14, 2025 00:34 Inactive

refactor: rreduce code duplication and add error handling

d5aa373

aem-code-sync bot temporarily deployed to plugin-system January 14, 2025 00:56 Inactive

feat: allow external extension via window.RUM_PLUGINS

4613b00

aem-code-sync bot temporarily deployed to plugin-system January 14, 2025 01:02 Inactive

ramboz commented Jan 14, 2025

View reviewed changes

modules/index.js

@@ -64,99 +111,6 @@ function processQueue() {

}

}

function addCWVTracking() {

Copy link

Collaborator Author

ramboz Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to cwv.js

ramboz commented Jan 14, 2025

View reviewed changes

modules/index.js

}, 2000); // wait for delayed

}

function addNavigationTracking() {

Copy link

Collaborator Author

ramboz Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to navigation.js

ramboz commented Jan 14, 2025

View reviewed changes

modules/index.js Outdated Show resolved Hide resolved

ramboz commented Jan 14, 2025

View reviewed changes

ramboz requested a review from trieloff January 14, 2025 01:07

fix: set proper url base for plugins

9726dc8

aem-code-sync bot temporarily deployed to plugin-system January 14, 2025 01:14 Inactive

trieloff reviewed Jan 14, 2025

View reviewed changes

refactor: address PR feedback

068c5c5

aem-code-sync bot temporarily deployed to plugin-system January 16, 2025 00:04 Inactive

refactor: address PR feedback

95a653e

aem-code-sync bot temporarily deployed to plugin-system January 16, 2025 01:53 Inactive

ramboz added 2 commits January 16, 2025 10:12

fix: bugs and failing tests

5c9adbc

fix: cross-browser compatibility

1c21afd

aem-code-sync bot temporarily deployed to plugin-system January 16, 2025 18:27 Inactive

build(rollup): remove broken cleanup plugin, replace with babel plugin

d88b010

trieloff and others added 17 commits January 16, 2025 17:26

ci(github): report test results in github, pretty

351876c

ci(github): update test results reporter format to jest-junit

1f1fa8f

test: implement custom JSON test reporter

aacaf8d

ci(github): use the test-summary action instead

be228fa

feat(loadresource): add allresources feature flag that enables trac…

a8fa936

…king all resources, not just same host

chore(release): 2.29.0 [skip ci]

f531f09

# [2.29.0](v2.28.0...v2.29.0) (2025-01-15) ### Features * **loadresource:** add `allresources` feature flag that enables tracking all resources, not just same host ([7c536d7](7c536d7))

feat(missingresource): report all resource error with http status code

e3ad482

the target field was until now unused. this change uses it for the status code and in turn tracks all errored resources as `missingresource`

chore(release): 2.30.0 [skip ci]

8bf19f4

# [2.30.0](v2.29.0...v2.30.0) (2025-01-15) ### Features * **missingresource:** report all resource error with http status code ([e238136](e238136))

chore: align with main branch

f1bf66a

chore(release): 2.31.0-beta.1 [skip ci]

b030130

# [2.31.0-beta.1](v2.30.0...v2.31.0-beta.1) (2025-01-16) ### Features * handle pre-rendering ([bb11187](bb11187))

Revert "feat: handle pre-rendering"

9603927

This reverts commit bb11187.

chore(release): 2.31.0-beta.2 [skip ci]

179dd62

# [2.31.0-beta.2](v2.31.0-beta.1...v2.31.0-beta.2) (2025-01-16) ### Reverts * Revert "feat: handle pre-rendering" ([6471af5](6471af5))

chore(release): 2.31.0-beta.4 [skip ci]

65ee6dc

# [2.31.0-beta.4](v2.31.0-beta.3...v2.31.0-beta.4) (2025-01-16) ### Bug Fixes * plugin path resolution ([f464652](f464652))

fix: just forcing a release

0a643d5

chore(release): 2.31.0-beta.5 [skip ci]

361afee

# [2.31.0-beta.5](v2.31.0-beta.4...v2.31.0-beta.5) (2025-01-17) ### Bug Fixes * just forcing a release ([84ab687](84ab687))

fix: plugins are not executing because they are exported as iife

dfc1eea

aem-code-sync bot temporarily deployed to plugin-system January 17, 2025 01:27 Inactive

Merge branch 'main' into plugin-system

325e9be

aem-code-sync bot temporarily deployed to plugin-system January 17, 2025 01:31 Inactive

chore: cleanup PR

10decef

aem-code-sync bot temporarily deployed to plugin-system January 17, 2025 01:32 Inactive

chore: cleanup PR

f3a3385

aem-code-sync bot temporarily deployed to plugin-system January 17, 2025 01:33 Inactive

ramboz commented Jan 17, 2025

View reviewed changes

chore: ignore uncovered lines

2bb5f45

aem-code-sync bot temporarily deployed to plugin-system January 17, 2025 22:21 Inactive

trieloff self-requested a review January 20, 2025 14:58

Merge branch 'main' into plugin-system

fa1ac2b

aem-code-sync bot deployed to plugin-system January 20, 2025 16:34 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: introduce plugin system to offset non-essenial logic #348

feat: introduce plugin system to offset non-essenial logic #348

ramboz commented Jan 14, 2025 •

edited

Loading

aem-code-sync bot commented Jan 14, 2025 •

edited

Loading

adobe-bot commented Jan 14, 2025

ramboz commented Jan 14, 2025 •

edited

Loading

ramboz Jan 14, 2025

ramboz Jan 14, 2025

ramboz Jan 14, 2025

ramboz Jan 14, 2025

ramboz Jan 14, 2025 •

edited

Loading

trieloff commented Jan 14, 2025

trieloff left a comment

ramboz commented Jan 16, 2025

ramboz Jan 17, 2025

feat: introduce plugin system to offset non-essenial logic #348

Are you sure you want to change the base?

feat: introduce plugin system to offset non-essenial logic #348

Conversation

ramboz commented Jan 14, 2025 • edited Loading

aem-code-sync bot commented Jan 14, 2025 • edited Loading

adobe-bot commented Jan 14, 2025

ramboz commented Jan 14, 2025 • edited Loading

ramboz Jan 14, 2025

Choose a reason for hiding this comment

ramboz Jan 14, 2025

Choose a reason for hiding this comment

ramboz Jan 14, 2025

Choose a reason for hiding this comment

ramboz Jan 14, 2025

Choose a reason for hiding this comment

ramboz Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

trieloff commented Jan 14, 2025

trieloff left a comment

Choose a reason for hiding this comment

ramboz commented Jan 16, 2025

ramboz Jan 17, 2025

Choose a reason for hiding this comment

ramboz commented Jan 14, 2025 •

edited

Loading

aem-code-sync bot commented Jan 14, 2025 •

edited

Loading

ramboz commented Jan 14, 2025 •

edited

Loading

ramboz Jan 14, 2025 •

edited

Loading