Create a backend focused value object out of Onboarding::Status

Currently, the Onboarding::Status may be tightly coupled with other parts of the system or may contain logic that's not strictly related to its data representation. To improve the design and maintainability of our codebase, we should create a backend-focused value object out of Onboarding::Status.

Objectives

1. Create a new value object class for Onboarding::Status.
2. Ensure the value object is immutable and represents the status data without any additional behavior.
3. Move any relevant status-related data and validation logic into this new value object.
4. Update existing code to use the new value object where appropriate.
5. Implement proper serialization and deserialization methods if needed.

Expected Benefits

• Improved separation of concerns
• Enhanced code readability and maintainability
• Easier testing of status-related logic
• Potential performance improvements due to immutability

Implementation Details

1. Create a new class, e.g., Onboarding::UserStatus.
2. Define attributes that represent the status data.
3. Implement a constructor that initializes the object with all necessary data.
4. Ensure all attributes are read-only to maintain immutability.
5. Implement any necessary equality comparison methods.
6. Add validation logic if required.
7. Update existing Onboarding::Status to use the new value object.

Acceptance Criteria

• New Onboarding::UserStatus class is created.
• All relevant status data is moved to the new value object.
• Existing functionality using Onboarding::Status remains unchanged.
• Unit tests are added for the new value object.
• Integration tests are updated or added to ensure proper usage in the system.

Additional Notes

• Ensure backwards compatibility if this change affects any public APIs.

Related Links

• Value Object Pattern
• Ruby Style Guide on immutability

added gitlab-org#15847 (closed) as parent epic

changed milestone to %Backlog

added Next Up automation:ml devopsgrowth groupacquisition maintenancerefactor sectiongrowth typemaintenance workflowstart labels

changed the description

assigned to @dstull

marked this issue as blocking #503176 (closed)

assigned to myself, but sending through regular refinement process for visibility

added workflowplanning breakdown label and removed workflowstart label

mentioned in commit d61afa53

mentioned in merge request !171960 (merged)

mentioned in commit 437f4439

mentioned in commit e42b27bf

mentioned in commit 9722f6cb

set weight to 2

added workflowin review label and removed workflowplanning breakdown label

changed milestone to %17.6

mentioned in commit 0448dc5d

marked the checklist item New Onboarding::UserStatus class is created. as completed

marked the checklist item All relevant status data is moved to the new value object. as completed

marked the checklist item Existing functionality using Onboarding::Status remains unchanged. as completed

marked the checklist item Unit tests are added for the new value object. as completed

marked the checklist item Integration tests are updated or added to ensure proper usage in the system. as completed

closed

mentioned in commit a259dc90

mentioned in commit f22d5903

mentioned in merge request !172717 (merged)