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

Remove Zendesk component from Learner Dashboard (fixes #519) #532

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

paulbert
Copy link

  • Deletes the ZendeskFab component
  • Removes the mock for ZendeskFab from App.test.jsx
  • Removes react-zendesk package

I'm not sure about the "Update Jest snapshot" part but I ran the tests locally and they all passed.

Also there are references to a ZENDESK_KEY environment variable that don't seem to be used anywhere. Should I remove that in this PR?

Issue references:
Fixes #519 #496 #225

@paulbert paulbert requested a review from a team as a code owner December 13, 2024 21:33
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 13, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @paulbert!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @2U-aperture. Tag them in a comment and let them know that your changes are ready for review.

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.

Copy link

codecov bot commented Dec 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.39%. Comparing base (84b281a) to head (c697256).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #532      +/-   ##
==========================================
- Coverage   97.40%   97.39%   -0.01%     
==========================================
  Files         157      155       -2     
  Lines        1389     1384       -5     
  Branches      231      232       +1     
==========================================
- Hits         1353     1348       -5     
  Misses         34       34              
  Partials        2        2              

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

@jsnwesson
Copy link
Contributor

Hey @paulbert , thanks for picking this up! I forgot to add the environment variable, but that should also be removed in this work, thanks!

For the Jest snapshots, I realize now that the only snapshots that existed for this component were in the Zendesk directory, so I don't think you need to do anything else for that.

Once you've got the PR up-to-date with the main branch and the env variable is removed, my team should be able to review this PR next week!

@paulbert
Copy link
Author

@jsnwesson Updated to the main branch last night and removed the env variables. I squashed the commits and rewrote the message since I didn’t follow the commit message guidelines the first time. Let me know if a different commit type than refactor would be more appropriate. Thanks!

@deborahgu
Copy link
Member

@jsnwesson when you do sign off on this one, I'm pretty sure that failing codecov test is just because the removed code and tests change the code:test ratio in the repository, so the percentage report thinks we have a lower code coverage ratio; this is just removals and there's no actual missing tests.

@deborahgu deborahgu added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Dec 18, 2024
@jsnwesson
Copy link
Contributor

Thanks @paulbert ! I use OEP-51 as a reference for my commits, and so I think refactor is correct, although if you can also add a ! to the commit (ie. refactor!), that would make it clear for anyone in the community who has also been using Zendesk that this will be a breaking change for them. Other than that, this looks good to me and I approve it!

Once you change the commit message, I'll merge it to main :D

Deletes the ZendeskFab component and associated mock, removes react-zendesk package, and removes env variables for Zendesk
@paulbert
Copy link
Author

@jsnwesson Thanks! Updated the commit message and rebased it to be up to date.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U waiting for eng review PR is ready for review. Review and merge it, or suggest changes.
Projects
Status: In Progress
Status: In Eng Review
Development

Successfully merging this pull request may close these issues.

Remove Zendesk component from Learner Dashboard
4 participants