Skip to content

refactor: Use formik and yup, and simplify hooks#2993

Draft
xitij2000 wants to merge 3 commits intomasterfrom
kshitij/image-css-editor
Draft

refactor: Use formik and yup, and simplify hooks#2993
xitij2000 wants to merge 3 commits intomasterfrom
kshitij/image-css-editor

Conversation

@xitij2000
Copy link
Copy Markdown
Contributor

@xitij2000 xitij2000 commented Apr 10, 2026

Description

This change converts the Image Editor Modal to TypeScript and simplifies the hooks switching to Formik + Yup for form validation.

It updates the tests to check the behaviour of the component as a whole rather than testing small components.

This lays the groundwork for the CSS editor work.

Supporting information

Testing instructions

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

  • Any new files are using TypeScript (.ts, .tsx).
  • Avoid propTypes and defaultProps in any new or modified code.
  • Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
  • Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
  • Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
  • All new i18n messages in messages.ts files have a description for translators to use.
  • Avoid using ../ in import paths. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Apr 10, 2026
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @xitij2000!

This repository is currently maintained by @bradenmacdonald.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

This commit is mainly to get git to reconise the rename so file history is
maintained.
@xitij2000 xitij2000 force-pushed the kshitij/image-css-editor branch 2 times, most recently from 146be13 to ab0d327 Compare April 11, 2026 07:52
isOpen={isConfirmOpen}
close={() => { setConfirmOpen(false); }}
title={<FormattedMessage {...messages[`ConfirmSwitchMessageTitle-${editorType}`]} />}
title={intl.formatMessage(messages[`ConfirmSwitchMessageTitle-${editorType}`])}
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed because title is only supposed to be a string and not a ReactNode.

@xitij2000 xitij2000 force-pushed the kshitij/image-css-editor branch from ab0d327 to 488b887 Compare April 13, 2026 09:40
This change converts the Image Editor Modal to typescript and simplifies the hooks switching to Formik + Yup for form validation.

It updates the tests to check the behaviour of the component as a whole rather than testing small components.
@xitij2000 xitij2000 force-pushed the kshitij/image-css-editor branch from 488b887 to ad087a0 Compare April 13, 2026 09:44
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 13, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.62%. Comparing base (f5d874a) to head (1bd49b0).
⚠️ Report is 6 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2993      +/-   ##
==========================================
+ Coverage   95.57%   95.62%   +0.05%     
==========================================
  Files        1366     1378      +12     
  Lines       31507    32234     +727     
  Branches     6885     7120     +235     
==========================================
+ Hits        30113    30824     +711     
- Misses       1344     1361      +17     
+ Partials       50       49       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants