WIP: Issue/99 Update UE instrumentation to use data-aue-component #109

hydralien · 2025-10-28T18:41:54Z

Description

Adjusting the code to use data-aue-component property instead of data-aue-model and/or data-aue-filter and da-aue-behaviour.

The page configuration PR is at aemsites/da-block-collection#21

Related Issue

#99

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have signed the Adobe Open Source CLA.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

maximilianvoss · 2025-10-29T13:39:19Z

src/ue/attributes.js

      'data-aue-label': 'Page',
      'data-aue-type': 'component',
-      'data-aue-model': 'page-metadata',
+      'data-aue-component': 'page-metadata',


here I'm not sure if we should call it page instead of page-metadata. Also, will this be within the component-definition? Can we create a page-metadata component?
If not, it would make sense to keep this one with data-aue-model

We used the page-metadata model for page wide properties. So far page-metadata was not in the component definition, only in models definition.

Then let's keep it page-metadata. As it is neither supposed to be added/removed/moved/copied, I would keep it as it was with data-aue-model

reverted to data-aue-model

maximilianvoss · 2025-10-29T13:39:46Z

src/ue/attributes.js

      'data-aue-type': 'container',
      'data-aue-label': 'Main Content',
-      'data-aue-filter': 'main',
+      'data-aue-component': 'main',


Same as above main is unique and usually you can not add a new main component.

Correct, projects can not do anything on main we only need it for the filter as main has n sections. Should we keep the filter here?

I'd say so, no data-aue-component, just the filter as it was

reverted to filter

mhaack · 2025-10-29T13:53:52Z

src/ue/attributes.js

 */
 function addBlockFieldAttributes(ueConfig, block) {
-  const blockName = block.properties['data-aue-model'];
+  const blockName = block.properties['data-aue-component'];


Should we keep reading data-aue-model as fallback for projects which have not adjusted the instrumentation files. With the assumption the model name == component name? @maximilianvoss WDYT?

How many customers would we potentially break?

3 live sites I'm aware of (but we have good contact to ACS) and x number of commerce team demos.

added fallback

mhaack · 2025-10-29T13:56:48Z

src/ue/attributes.js

      'data-aue-label': 'Page',
      'data-aue-type': 'component',
-      'data-aue-model': 'page-metadata',
+      'data-aue-component': 'page-metadata',


We used the page-metadata model for page wide properties. So far page-metadata was not in the component definition, only in models definition.

mhaack · 2025-10-29T13:58:07Z

src/ue/attributes.js

      'data-aue-type': 'container',
      'data-aue-label': 'Main Content',
-      'data-aue-filter': 'main',
+      'data-aue-component': 'main',


Correct, projects can not do anything on main we only need it for the filter as main has n sections. Should we keep the filter here?

mhaack · 2025-10-29T14:09:55Z

I marked the PR as WIP. As this will be breaking and while we can deploy this to STAGE we should not get this on the main branch as it will break projects. Lets collect all breaking changes in a "v1" branch.

hydralien · 2025-10-30T11:29:14Z

@mhaack by

Lets collect all breaking changes in a "v1" branch

do you mean this branch shoul dbe renamed, or we just consider this branch a "v1"?

mhaack · 2025-10-30T12:35:26Z

do you mean this branch shoul dbe renamed, or we just consider this branch a "v1"?

No lets leave it, just don't merge to main. We have no automatic stage deployment for the worker. I was thinking we add a stage branch which we merge into and use that for stage deployments. Too be discussed.

maximilianvoss · 2025-10-30T12:50:51Z

wrangler.toml


 [env.dev]
-vars = { ENVIRONMENT = "dev", UE_HOST = "localhost:4712", UE_SERVICE = "https://localhost:8000", DA_ADMIN = "https://admin.da.live" }
+vars = { ENVIRONMENT = "dev", UE_HOST = "localhost:4712", UE_SERVICE = "https://localhost.corp.adobe.com:8000", DA_ADMIN = "https://admin.da.live" }


will require that you are on VPN the whole time. Didn't it work with localhost?

sorry I meant to move it to another PR for the configuration template, I'll remove it from here. That doesn't require VPN, it's ought to be registered at /etc/hosts to work but the benefit is we have a certificate for that. But that's another story.

Borys Turchyk added 2 commits October 28, 2025 19:37

Flying blind

aa65039

Ignore idea

8735f74

hydralien changed the title ~~Issue/99 Update instrumentation~~ Issue/99 Update UE instrumentation to use data-aue-component Oct 29, 2025

hydralien marked this pull request as ready for review October 29, 2025 13:03

maximilianvoss reviewed Oct 29, 2025

View reviewed changes

mhaack reviewed Oct 29, 2025

View reviewed changes

mhaack changed the title ~~Issue/99 Update UE instrumentation to use data-aue-component~~ WIP: Issue/99 Update UE instrumentation to use data-aue-component Oct 29, 2025

Address feedback

9f683be

hydralien requested review from maximilianvoss and mhaack October 30, 2025 11:34

maximilianvoss reviewed Oct 30, 2025

View reviewed changes

maximilianvoss approved these changes Oct 30, 2025

View reviewed changes

loclhosting

3ba7e31

hydralien changed the base branch from main to stage November 11, 2025 09:07

mhaack approved these changes Nov 11, 2025

View reviewed changes

hydralien merged commit b25941b into adobe:stage Nov 11, 2025
3 checks passed

WIP: Issue/99 Update UE instrumentation to use data-aue-component #109

WIP: Issue/99 Update UE instrumentation to use data-aue-component #109

Uh oh!

Conversation

hydralien commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hydralien Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mhaack commented Oct 29, 2025

Uh oh!

hydralien commented Oct 30, 2025

Uh oh!

mhaack commented Oct 30, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hydralien commented Oct 28, 2025 •

edited

Loading

hydralien Oct 30, 2025 •

edited

Loading