Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Audience Segmentation component path structure. #8495

Closed
4 of 7 tasks
techanvil opened this issue Apr 8, 2024 · 2 comments
Closed
4 of 7 tasks

Update Audience Segmentation component path structure. #8495

techanvil opened this issue Apr 8, 2024 · 2 comments
Labels
Module: Analytics Google Analytics module related issues P1 Medium priority Squad 2 (Team M) Issues for Squad 2 Type: Enhancement Improvement of an existing feature

Comments

@techanvil
Copy link
Collaborator

techanvil commented Apr 8, 2024

Feature Description

The initial spec for the Audience Segmentation component code organisation is a little inconsistent and has caused us to provide a workaround to satisfy for our assets/js/modules/index.test.js test suite.

We should improve the organisation and move all of the Audience Segmentation components under a new assets/js/modules/analytics-4/components/audience-segmentation/ directory.

This is a non-critical issue that can be implemented post-launch if needs be, hence the P2 priority.


Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

  • The components under assets/js/modules/analytics-4/components/dashboard/AudienceSegmentation/, assets/js/modules/analytics-4/components/settings/AudienceSegmentation/ etc should be moved to:
    • assets/js/modules/analytics-4/components/audience-segmentation/dashboard/
    • assets/js/modules/analytics-4/components/audience-segmentation/settings/
    • ... and so forth.

Implementation Brief

Note, it looks like the workaround mentioned in the Feature Description will have been removed and the related test suite updated instead. The workaround or test suite update should be revised/removed as appropriate.

  • Move all files from assets/js/modules/analytics-4/components/dashboard/AudienceSegmentation to assets/js/modules/analytics-4/components/audience-segmentation/dashboard.
  • Mode all files from assets/js/modules/analytics-4/components/settings/AudienceSegmentation/ to assets/js/modules/analytics-4/components/audience-segmentation/settings.
  • Update imports in the moved files and the consuming files.
  • Update story labels when appropriator.
  • In assets/js/modules/index.test.js:
    • Remove the AudienceSegmentation workaround from components/%s has an index module with all components exported test.

Test Coverage

  • Update any failing test and snapshots.

QA Brief

QA Eng

  • The QA process can be skipped since no user-facing changes are implemented as part of this ticket. Hence, QA can be carried out during the code review.
  • Verify that the Audience Segmentation dashboard components are moved to the new assets/js/modules/analytics-4/components/audience-segmentation/dashboard directory.
  • Verify that the Audience Segmentation settings components are moved to the new assets/js/modules/analytics-4/components/audience-segmentation/settings directory.
  • Verify that the stories are organized into Modules/Analytics4/Components/AudienceSegmentation/Dashboard and Modules/Analytics4/Components/AudienceSegmentation/Settings respectively.
  • Verify all the stories work as expected.

Changelog entry

  • N/A
@techanvil techanvil added Module: Analytics Google Analytics module related issues P2 Low priority Type: Enhancement Improvement of an existing feature labels Apr 8, 2024
@ivonac4 ivonac4 added the Squad 2 (Team M) Issues for Squad 2 label Apr 9, 2024
@ivonac4 ivonac4 added P1 Medium priority Next Up Issues to prioritize for definition and removed P2 Low priority labels Apr 16, 2024
@kuasha420 kuasha420 assigned kuasha420 and unassigned kuasha420 Apr 23, 2024
@techanvil techanvil self-assigned this Apr 24, 2024
@techanvil
Copy link
Collaborator Author

IB ✅

The estimate looks a little on the high side, but I'll leave it, we have had a tendency to go over the estimate for Audience Segmentation issues and it's possible there could be unexpected complications when updating the tests.

@techanvil techanvil removed their assignment Apr 24, 2024
@ivonac4 ivonac4 removed the Next Up Issues to prioritize for definition label Apr 25, 2024
@hussain-t hussain-t self-assigned this Apr 29, 2024
hussain-t added a commit that referenced this issue May 2, 2024
@hussain-t hussain-t removed their assignment May 2, 2024
@techanvil techanvil self-assigned this May 3, 2024
techanvil added a commit that referenced this issue May 3, 2024
…ion-component-path-structure

Enhance/#8495 - Update Audience Segmentation component path structure
@techanvil
Copy link
Collaborator Author

As per the QAB, this is simply a code reorg with no user facing changes, which I've effectively QA'd during CR.

QA ✅

  • Verify that the Audience Segmentation dashboard components are moved to the new assets/js/modules/analytics-4/components/audience-segmentation/dashboard directory. ✅
  • Verify that the Audience Segmentation settings components are moved to the new assets/js/modules/analytics-4/components/audience-segmentation/settings directory. ✅
  • Verify that the stories are organized into Modules/Analytics4/Components/AudienceSegmentation/Dashboard and Modules/Analytics4/Components/AudienceSegmentation/Settings respectively. ✅
  • Verify all the stories work as expected. ✅

@techanvil techanvil removed their assignment May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Module: Analytics Google Analytics module related issues P1 Medium priority Squad 2 (Team M) Issues for Squad 2 Type: Enhancement Improvement of an existing feature
Projects
None yet
Development

No branches or pull requests

5 participants