Upgrade Analyst to React 18

Upgrade Analyst to React 18

 

Created Date

Nov 15, 2022

Target PI

PI 1

Target Release

Jira Epic

https://economicmodeling.atlassian.net/browse/ARK-8914

Document Status

Draft

Epic Owner

@Isaac Neace (Deactivated) @Arika Pischel

Stakeholder

@Ben Bradley @Christian Asivido

Engineering Team(s) Involved

Analyst

Customer/User Job-to-be-Done or Problem

Currently, Analyst is unable to use several features that come with React and common React libraries because they are reliant on React 18. Reasons to upgrade to React 18:

  • We want to use React Suspense so that we can fetch our data correctly (move away from using useEffect and useQuery to fetch data)

  • We want to use the latest version of MUI so that we can stay on supported versions and use new features added

  • We want to use React 18 so that we can stay up to date with the docs and new features that come with React upgrades

Value to Customers & Users

Ultimately, this will keep our product up to date with React which will continue to allow us to keep our code quality up which decreases tech debt, which allows us to release more feature.

Value to Lightcast

Quality of life for engineers will go up because we can use modern technologies.

Target User Role/Client/Client Category

Employees and clients

Delivery Mechanism

Will not be a direct noticeable change right away. Will be implemented in the code

Success Criteria & Metrics

React 18 will be in Analyst. That is how we will know that we have upgraded.

 

Aspects that are out of scope (of this phase)

What is explicitly not a part of this epic? List things that have been discussed but will not be included. Things you imagine in a phase 2, etc.

Solution Description

Early UX (wireframes or mockups)

<FigmaLink>

 

Non-Functional Attributes & Usage Projections

Consider performance characteristics, privacy/security implications, localization requirements, mobile requirements, accessibility requirements

 

Dependencies

Is there any work that must precede this? Feature work? Ops work? 

 

Legal and Ethical Considerations

Just answer yes or no.

Have you thought through these considerations (e.g. data privacy) and raised any potential concerns with the Legal team?

High-Level Rollout Strategies

  • Initial rollout to [internal employees|sales demos|1-2 specific beta customers|all customers]

    • If specific beta customers, will it be for a specific survey launch date or report availability date 

  • How will this guide the rollout of individual stories in the epic?

  • The rollout strategy should be discussed with CS, Marketing, and Sales.

  • How long we would tolerate having a “partial rollout” -- rolled out to some customers but not all

 

Risks

Focus on risks unique to this feature, not overall delivery/execution risks. 

 

Open Questions

What are you still looking to resolve?

 


Complete with Engineering Teams

 

Effort Size Estimate

Estimated Costs

Direct Financial Costs

Are there direct costs that this feature entails? Dataset acquisition, server purchasing, software licenses, etc.?

 

Team Effort

Each team involved should give a general t-shirt size estimate of their work involved. As the epic proceeds, they can add a link to the Jira epic/issue associated with their portion of this work.

Team

Effort Estimate (T-shirt sizes)

Jira Link

Team

Effort Estimate (T-shirt sizes)

Jira Link