Show warnings in action editors when components are excluded from the build #450

shammowla · 2025-01-09T21:04:45Z

Description

Added alerts to notify users when required components are disabled:

applyPropositions.jsx: Alert for disabled Personalization component
setConsent.jsx: Alert for disabled Consent component
sendStreamingMediaEvent.jsx: Alert for disabled Streaming Media component
createMediaTracker.jsx: Alert for disabled Media Analytics Bridge component
evaluateRulesets.jsx: Alert for disabled Rules Engine component

Each action view will now display a red alert message using React Spectrum's InlineAlert
component when its required component is disabled in the extension configuration.

Related Issue

Motivation and Context

Screenshots (if appropriate):

Types of changes

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

Checklist:

I have signed the Adobe Open Source CLA or I'm an Adobe employee.
I have made any necessary test changes and all tests pass.
I have run the Sandbox successfully.
I've updated the schema in extension.json or no changes are necessary.
My change requires a change to the documentation.

carterworks · 2025-01-13T18:48:30Z

Should we also show a warning in the send event action when the activity collection component is disabled?

Jon's PR #449 will remove the sections and replace them with a "this component is disabled" message. We should unify on one strategy and messaging.

jonsnyder

You missed:

subscribeRulesetItem event - rulesEngine
eventMergeId dataElement - eventMerge
resetEventMergeId action - eventMerge

jonsnyder · 2025-01-21T16:55:11Z

src/view/actions/applyPropositions.jsx

@@ -17,8 +17,13 @@ import textField from "../forms/textField";
 import objectArray from "../forms/objectArray";
 import dataElement from "../forms/dataElement";
 import comboBox from "../forms/comboBox";
+import ExcludedComponentNotice from "../forms/excludedComponentNotice";


Can you make this lowercase like the others? "excludedComponentNotice"

jonsnyder · 2025-01-21T16:56:24Z

src/view/actions/setConsent.jsx

@@ -360,6 +359,10 @@ const SetConsent = () => {
        const orgId = instanceSettings?.orgId ?? initInfo.company.orgId;
        return (
          <FormElementContainer>
+            <ExcludedComponentNotice


Here you need to use the componentDependencyAlert directly. This view has not been converted to the form component system yet so it just uses regular React components. (Be sure to pass the initInfo. The React component needs this parameter)

jonsnyder · 2025-01-21T16:59:40Z

src/view/actions/evaluateRulesets.jsx

@@ -45,6 +46,10 @@ const evaluateRulesetsForm = form(
    wrapGetSettings,
  },
  [
+    ExcludedComponentNotice({
+      requiredComponent: "decisioningEngine",


This has been renamed to rulesEngine

jonsnyder · 2025-01-21T17:07:12Z

src/view/actions/createMediaTracker.jsx


 const createMediaTrackerForm = form({}, [
+  ExcludedComponentNotice({
+    requiredComponent: "legacyMediaAnalytics",


This has been renamed to mediaAnalyticsBridge

jonsnyder · 2025-01-21T17:07:48Z

src/view/actions/setConsent.jsx

@@ -360,6 +359,10 @@ const SetConsent = () => {
        const orgId = instanceSettings?.orgId ?? initInfo.company.orgId;
        return (
          <FormElementContainer>
+            <ExcludedComponentNotice
+              requiredComponent="privacy"


This has been renamed to consent

jonsnyder · 2025-01-21T17:10:11Z

src/view/components/componentDependencyAlert.jsx

+      <Content>
+        This action requires the {componentLabel} component which is currently
+        disabled in the extension configuration. Please enable it to use this
+        action.


Instead of "Please enable it..." how about, "If you do not enable the component in the extension configuration, this will not work."

jonsnyder · 2025-01-21T17:44:12Z

src/view/actions/sendStreamingMediaEvent.jsx

@@ -27,6 +27,7 @@ import dataElement from "../forms/dataElement";
 import mediaStates from "./constants/mediaStates";
 import mediaContentTypes from "./constants/mediaContentTypes";
 import mediaShowTypes from "./constants/mediaShowTypes";
+import ExcludedComponentNotice from "../forms/excludedComponentNotice";


lowercase e

jonsnyder · 2025-01-21T17:46:18Z

Also, rebase with main and resolve the conflicting package-lock

jonsnyder · 2025-01-21T18:17:19Z

Should we also show a warning in the send event action when the activity collection component is disabled?

Jon's PR #449 will remove the sections and replace them with a "this component is disabled" message. We should unify on one strategy and messaging.

When activity collection component is disabled, sendEvent still works. This does bring up a good point though because for example personalization fields in the send event action aren't going to work when personalization component is disabled.

Regarding your second suggestion to replace the form with a this component is disabled. Let's discuss when we review this tomorrow during standup.

… build.

…action views.

… eventMergeId and subscribeRulesetItems.

carterworks · 2025-01-22T17:10:03Z

.gitignore

@@ -8,4 +8,3 @@ coverage
 .parcel-cache
 .token-cache.json
 extension.json
-.DS_Store


This should stay in the .gitignore

shammowla changed the base branch from main to custom_build_config January 9, 2025 21:05

shammowla requested review from jonsnyder, carterworks and dompuiu January 10, 2025 17:05

jonsnyder requested changes Jan 21, 2025

View reviewed changes

jonsnyder approved these changes Jan 21, 2025

View reviewed changes

shammowla changed the base branch from custom_build_config to main January 21, 2025 17:47

shammowla force-pushed the PDCL-12822 branch 2 times, most recently from c495ee8 to 0cfaf99 Compare January 21, 2025 18:12

shammowla force-pushed the PDCL-12822 branch 2 times, most recently from 64fec03 to 0cfaf99 Compare January 21, 2025 18:24

dompuiu and others added 16 commits January 21, 2025 13:55

Add alloy custom build option to the extension.

ebb566e

Add test for extension configuration.

56fc394

Use helpers methods.

eb226fa

Put handle error code back.

76f113c

Generate package-lock.json now.

5e0a32c

Fix path.

e95c75e

WIP Hide configuration parameters when components are removed

671ab52

Update validation so invalid hidden fields do not fail validation

d86f834

Remove bad reference to fullscreenModal

eb5d5b0

Update the reactor sandbox version.

62f9492

Show warnings in action editors when components are excluded from the…

2c839fd

… build.

Create alert within the form react form context.

a7946b2

Replace ComponentDependencyAlert with ExcludedComponentNotice in all …

4983969

…action views.

Fix naming and add component dependency alerts for resetEventMergeId,…

0579a04

… eventMergeId and subscribeRulesetItems.

Fix naming and add component dependency alerts for resetEventMergeId,…

6ba3448

… eventMergeId and subscribeRulesetItems.

Rebase main.

ff30c15

shammowla force-pushed the PDCL-12822 branch from 69dcdf2 to ff30c15 Compare January 21, 2025 19:00

shammowla added 5 commits January 21, 2025 14:05

Fix new line issue.

85fd89c

Restore deleted file from rebase.

dd87b2a

Fix white space issue.

0b49c05

Remove .DS_Store files from repository

0cc46c1

Remove dstore from the gitignore.

e703dfb

carterworks reviewed Jan 22, 2025

View reviewed changes

Fix the sizing of the component to match notice.

4283198

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show warnings in action editors when components are excluded from the build #450

Show warnings in action editors when components are excluded from the build #450

shammowla commented Jan 9, 2025

carterworks commented Jan 13, 2025 •

edited

Loading

jonsnyder left a comment

jonsnyder Jan 21, 2025

jonsnyder Jan 21, 2025

jonsnyder Jan 21, 2025

jonsnyder Jan 21, 2025

jonsnyder Jan 21, 2025

jonsnyder Jan 21, 2025

jonsnyder Jan 21, 2025

jonsnyder commented Jan 21, 2025

jonsnyder commented Jan 21, 2025

carterworks Jan 22, 2025

Show warnings in action editors when components are excluded from the build #450

Are you sure you want to change the base?

Show warnings in action editors when components are excluded from the build #450

Conversation

shammowla commented Jan 9, 2025

Description

Related Issue

Motivation and Context

Screenshots (if appropriate):

Types of changes

Checklist:

carterworks commented Jan 13, 2025 • edited Loading

jonsnyder left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonsnyder commented Jan 21, 2025

jonsnyder commented Jan 21, 2025

Choose a reason for hiding this comment

carterworks commented Jan 13, 2025 •

edited

Loading