[FC-0059] refactor: convert files to ts and improve typings/tests #1181

rpenido · 2024-07-25T19:43:25Z

Description

This PR is a minor refactor to convert some files to typescript and improve the tests related to the useContentTagsCount hook.

Testing instructions

Open the course outline and check if the tag count is showing correctly
Open the unit outline and check if the tag count is showing correctly
Read through the tests and check if all cases are covered

Private ref: FAL-3769

openedx-webhooks · 2024-07-25T19:43:30Z

Thanks for the pull request, @rpenido!

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 @openedx/2u-tnl. 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.

rpenido · 2024-07-25T19:58:57Z

src/course-outline/card-header/CardHeader.jsx

@@ -142,7 +142,7 @@ const CardHeader = ({
          {(isVertical || isSequential) && (
            <CardStatus status={status} showDiscussionsEnabledBadge={showDiscussionsEnabledBadge} />
          )}
-          { getConfig().ENABLE_TAGGING_TAXONOMY_PAGES === 'true' && contentTagCount > 0 && (
+          { getConfig().ENABLE_TAGGING_TAXONOMY_PAGES === 'true' && !!contentTagCount && (


contentTag can be undefined if the api call throws an error

codecov · 2024-07-25T20:20:36Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.89%. Comparing base (649863d) to head (f506e3b).
Report is 5 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1181      +/-   ##
==========================================
+ Coverage   92.82%   92.89%   +0.06%     
==========================================
  Files         747      750       +3     
  Lines       13372    13474     +102     
  Branches     2856     2929      +73     
==========================================
+ Hits        12413    12517     +104     
+ Misses        924      922       -2     
  Partials       35       35

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

rpenido · 2024-07-26T13:32:53Z

src/generic/data/apiHooks.test.js

-import { useContentTagsCount } from './apiHooks';
-
-jest.mock('@tanstack/react-query', () => ({
-  useQuery: jest.fn(),


We were mocking the hook here, not testing much.

rpenido · 2024-07-26T13:33:45Z

src/generic/data/apiHooks.test.tsx

+
+  it('should return success response', async () => {
+    const courseId = 'course-v1:edX+TestX+Test_Course';
+    axiosMock.onGet(getTagsCountApiUrl(courseId)).reply(200, { [courseId]: 10 });


Testing mocking axios now (testing the hook and api function)

rpenido · 2024-07-31T18:56:09Z

src/generic/data/api.ts

 */
-export async function getCourseRerun(courseId) {
+export async function getCourseRerun(courseId: string): Promise<unknown> {


For now, we are using unknown. If/when we migrate the code that uses this, we could create a type for the API return.

yusuf-musleh

👍 @rpenido LGTM, great work! Small nit/question.

I tested this: I followed testing instructions and read through the tests
I read through the code
~~I checked for accessibility issues~~
~~Includes documentation~~

src/generic/data/apiHooks.test.tsx

rpenido · 2024-08-02T14:52:59Z

Hi @bradenmacdonald! Could you review this?
It is a minor flyby refactor while implementing the copy to clipboard feature.

bradenmacdonald

Nice, thanks!

openedx-webhooks · 2024-08-02T16:26:13Z

@rpenido 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 25, 2024

rpenido force-pushed the rpenido/fal-3769-convert-files-to-ts-improve-typings-and-tests branch 2 times, most recently from f1a33ba to bdd6c3b Compare July 25, 2024 19:52

rpenido commented Jul 25, 2024

View reviewed changes

rpenido force-pushed the rpenido/fal-3769-convert-files-to-ts-improve-typings-and-tests branch from bdd6c3b to 9c93799 Compare July 25, 2024 20:07

rpenido commented Jul 26, 2024

View reviewed changes

rpenido force-pushed the rpenido/fal-3769-convert-files-to-ts-improve-typings-and-tests branch 2 times, most recently from 0d566f5 to 306aff2 Compare July 26, 2024 14:09

refactor: convert files to ts and improve typings/tests

b604b6f

rpenido force-pushed the rpenido/fal-3769-convert-files-to-ts-improve-typings-and-tests branch from 306aff2 to b604b6f Compare July 26, 2024 14:30

fix: set return type to unkown for future fix

f506e3b

rpenido changed the title ~~refactor: convert files to ts and improve typings/tests~~ refactor: convert files to ts and improve typings/tests [FC-0059] Jul 31, 2024

rpenido changed the title ~~refactor: convert files to ts and improve typings/tests [FC-0059]~~ [FC-0059] refactor: convert files to ts and improve typings/tests Jul 31, 2024

rpenido commented Jul 31, 2024

View reviewed changes

rpenido marked this pull request as ready for review July 31, 2024 18:56

rpenido requested a review from a team as a code owner July 31, 2024 18:56

yusuf-musleh approved these changes Aug 1, 2024

View reviewed changes

src/generic/data/apiHooks.test.tsx Show resolved Hide resolved

rpenido requested a review from bradenmacdonald August 2, 2024 14:53

bradenmacdonald approved these changes Aug 2, 2024

View reviewed changes

bradenmacdonald merged commit 680b5ff into openedx:master Aug 2, 2024
7 checks passed

bradenmacdonald deleted the rpenido/fal-3769-convert-files-to-ts-improve-typings-and-tests branch August 2, 2024 16:26

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Aug 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FC-0059] refactor: convert files to ts and improve typings/tests #1181

[FC-0059] refactor: convert files to ts and improve typings/tests #1181

rpenido commented Jul 25, 2024 •

edited

Loading

openedx-webhooks commented Jul 25, 2024 •

edited

Loading

rpenido Jul 25, 2024

codecov bot commented Jul 25, 2024 •

edited

Loading

rpenido Jul 26, 2024

rpenido Jul 26, 2024

rpenido Jul 31, 2024

yusuf-musleh left a comment

rpenido commented Aug 2, 2024

bradenmacdonald left a comment

openedx-webhooks commented Aug 2, 2024

[FC-0059] refactor: convert files to ts and improve typings/tests #1181

[FC-0059] refactor: convert files to ts and improve typings/tests #1181

Conversation

rpenido commented Jul 25, 2024 • edited Loading

Description

Testing instructions

openedx-webhooks commented Jul 25, 2024 • edited Loading

What's next?

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

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

Who will review my changes?

Where can I find more information?

When can I expect my changes to be merged?

rpenido Jul 25, 2024

Choose a reason for hiding this comment

codecov bot commented Jul 25, 2024 • edited Loading

Codecov Report

rpenido Jul 26, 2024

Choose a reason for hiding this comment

rpenido Jul 26, 2024

Choose a reason for hiding this comment

rpenido Jul 31, 2024

Choose a reason for hiding this comment

yusuf-musleh left a comment

Choose a reason for hiding this comment

rpenido commented Aug 2, 2024

bradenmacdonald left a comment

Choose a reason for hiding this comment

openedx-webhooks commented Aug 2, 2024

rpenido commented Jul 25, 2024 •

edited

Loading

openedx-webhooks commented Jul 25, 2024 •

edited

Loading

codecov bot commented Jul 25, 2024 •

edited

Loading