feat: add typings for hooks #3125

bradenmacdonald · 2024-07-08T11:07:30Z

Description

This PR adds typescript types for the various hooks that Paragon provides: useWindowSize, useToggle, useArrowKeyNavigation, useIndexOfLastVisibleChild, and useIsVisible. There should be no changes other than to the typings.

Deploy Preview

https://deploy-preview-3125--paragon-openedx-v22.netlify.app/

Merge Checklist

n/a - doesn't apply to this type of PR.

Post-merge Checklist

Verify your changes were released to NPM at the expected version.
If you'd like, share your contribution in #show-and-tell.
🎉 🙌 Celebrate! Thanks for your contribution.

openedx-webhooks · 2024-07-08T11:07:34Z

Thanks for the pull request, @bradenmacdonald!

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/paragon-working-group. 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.

netlify · 2024-07-08T11:07:46Z

❌ Deploy Preview for paragon-openedx failed.

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`9c10177`
🔍 Latest deploy log	https://app.netlify.com/sites/paragon-openedx/deploys/668bf546222dca0008e0e070

bradenmacdonald · 2024-07-09T09:14:34Z

OK, this is very weird. Without any the other changes, merely renaming useIsVisible.jsx to useIsVisible.tsx totally breaks the build of the Paragon docs site (in dev mode, if I restart it, I cannot access the site). But the error is very obscure.

adamstankiewicz · 2024-08-15T01:09:04Z

src/hooks/tests/useIndexOfLastVisibleChild.test.tsx

@@ -12,7 +12,7 @@ window.ResizeObserver = window.ResizeObserver
  }));

 function TestComponent() {
-  const [containerElementRef, setContainerElementRef] = React.useState(null);
+  const [containerElementRef, setContainerElementRef] = React.useState<HTMLDivElement | null>(null);
  const overflowElementRef = React.useRef(null);


nit/question: should both refs get the same type with HTMLDivElement, given both refs are applied to divs below?

Done: a3fea9e

Note that changing it to useRef instead of useState for consistency seems to make one of the tests fail, so I've just left one as useState and one as useRef for now, but at least they're both HTMLDivElement refs.

adamstankiewicz · 2024-08-15T01:10:00Z

src/hooks/tests/useToggle.test.tsx

@@ -19,7 +20,7 @@ const resetHandlerMocks = () => {
 };

 // eslint-disable-next-line react/prop-types


nit/unrelated suggestion: could opt to disable prop-types rule for *.test.* files so we don't need to have these eslint disable comments throughout test files.

Sure, but I'm gonna leave that out of this PR for now.

adamstankiewicz · 2024-08-15T01:11:22Z

src/hooks/useArrowKeyNavigation.tsx

+function handleEnter(
+  { event, currentIndex, activeElement }: { event: KeyboardEvent, currentIndex: number, activeElement: HTMLElement },
+) {


curious/suggestion: would it improve readability/understandability of these types if these function args and the return data structure were abstracted into an interface? E.g., something like the following:

interface HandleEnterOptions { event: KeyboardEvent; currentIndex: number; activeElement: HTMLElement; } function handleEnter({ event, currentIndex, activeElement }: HandleEnterOptions) { ... }

Similar question for handleArrowKey below

Sure :) a3fea9e

adamstankiewicz · 2024-08-15T01:16:18Z

src/hooks/useIndexOfLastVisibleChild.tsx

+  containerElementRef: Element | null,
+  overflowElementRef: Element | null,


nit/clarification: should these Element be HTMLElement?

Yeah - done in a3fea9e

adamstankiewicz · 2024-08-15T01:17:56Z

src/hooks/useIsVisible.tsx

+  isVisible: boolean,
+  sentinelRef: React.MutableRefObject<HTMLDivElement | null>,
+] => {
+  const sentinelRef = useRef<HTMLDivElement | null>(null);


[clarification] Will this sentinelRef always be applied to a Div element? Might it be used with non-div elements, too?

Good point, changed to HTMLElement a3fea9e

mphilbrick211 · 2024-12-09T22:25:09Z

@bradenmacdonald just checking in to see if this is still in progress!

bradenmacdonald · 2024-12-09T22:29:40Z

@mphilbrick211 Thanks for the reminder. I lost momentum on this but now that I have @adamstankiewicz's feedback I would like to pick it up again soon!

bradenmacdonald · 2024-12-12T18:04:47Z

Update: I tried to move this forward, but I'm blocked on some strange webpack bug where it is confusing useToggle.mdx and useToggle.tsx, returning the MDX content when I import the TypeScript file. I believe the only way to fix it is likely upgrading gatsby.

brian-smith-tcril · 2024-12-13T18:25:42Z

Update: I tried to move this forward, but I'm blocked on some strange webpack bug where it is confusing useToggle.mdx and useToggle.tsx, returning the MDX content when I import the TypeScript file. I believe the only way to fix it is likely upgrading gatsby.

I pulled the branch and got the docs site to build/run locally with a less than ideal workaround. I added Doc to the filenames of all the .mdx files in the hooks directory. Unfortunately that led to the url for those pages also having doc in them (example: http://localhost:8000/components/hooks/usetoggledoc/)

I'll do a little more digging to see if I can come up with a better option.

brian-smith-tcril · 2024-12-13T19:58:28Z

I tried another thing which seems to work (I haven't clicked around all the docs site pages yet)

diff --git a/www/gatsby-config.js b/www/gatsby-config.js
index e3976a0b2c..c0ae5209a2 100644
--- a/www/gatsby-config.js
+++ b/www/gatsby-config.js
@@ -34,6 +34,7 @@ const plugins = [
     },
   },
   'gatsby-plugin-react-helmet',
+  'gatsby-plugin-typescript',
   {
     resolve: 'gatsby-plugin-manifest',
     options: {

…anges

codecov · 2024-12-16T21:58:58Z

Codecov Report

Attention: Patch coverage is 95.34884% with 2 lines in your changes missing coverage. Please review.

Project coverage is 93.43%. Comparing base (5c53137) to head (a3fea9e).
Report is 7 commits behind head on release-22.x.

Files with missing lines	Patch %	Lines
src/hooks/useArrowKeyNavigation.tsx	80.00%	2 Missing ⚠️

Additional details and impacted files

@@               Coverage Diff                @@
##           release-22.x    #3125      +/-   ##
================================================
+ Coverage         93.42%   93.43%   +0.01%     
================================================
  Files               250      251       +1     
  Lines              4515     4522       +7     
  Branches           1017     1057      +40     
================================================
+ Hits               4218     4225       +7     
+ Misses              294      290       -4     
- Partials              3        7       +4

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

netlify · 2024-12-16T22:01:29Z

✅ Deploy Preview for paragon-openedx-v22 ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`a3fea9e`
🔍 Latest deploy log	https://app.netlify.com/sites/paragon-openedx-v22/deploys/6760a4443d05cd0008c96890
😎 Deploy Preview	https://deploy-preview-3125--paragon-openedx-v22.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

bradenmacdonald · 2024-12-16T22:10:04Z

@adamstankiewicz Sorry for the long delay in addressing your review, and thanks SO much to @brian-smith-tcril for helping me figure out the very obscure bug that had me stumped.

This is ready for another review !

brian-smith-tcril

LGTM!

brian-smith-tcril · 2024-12-17T02:04:09Z

www/gatsby-config.js

@@ -34,6 +34,7 @@ const plugins = [
    },
  },
  'gatsby-plugin-react-helmet',
+  'gatsby-plugin-typescript',


Note for reviewers: you may have noticed there are no package.json changes adding this, that is because gatsby-plugin-typescript is already a dependency of gatsby (v4 at least - I assume later versions as well) https://www.npmjs.com/package/gatsby/v/4.14.1?activeTab=dependencies

openedx-semantic-release-bot · 2024-12-18T13:59:26Z

🎉 This PR is included in version 22.13.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

bradenmacdonald requested a review from PKulkoRaccoonGang July 8, 2024 11:08

bradenmacdonald force-pushed the braden/type-hooks branch from f30998a to fbb8045 Compare July 8, 2024 11:17

adamstankiewicz reviewed Aug 15, 2024

View reviewed changes

bradenmacdonald added 3 commits December 11, 2024 12:09

feat: add typings for hooks

6207def

fix: wrong return type specified in www Navbar

0c637e5

fix: useIsVisible() can take any element, not just <div>

a888200

fix: gatsby site wasn't building correctly after some .jsx -> .tsx ch…

23ee64b

…anges

bradenmacdonald force-pushed the braden/type-hooks branch from 9c10177 to 23ee64b Compare December 16, 2024 21:46

bradenmacdonald changed the base branch from master to release-22.x December 16, 2024 21:50

refactor: cleanups suggested by Adam

a3fea9e

bradenmacdonald force-pushed the braden/type-hooks branch from 7b95f95 to a3fea9e Compare December 16, 2024 22:05

brian-smith-tcril approved these changes Dec 17, 2024

View reviewed changes

brian-smith-tcril reviewed Dec 17, 2024

View reviewed changes

adamstankiewicz approved these changes Dec 18, 2024

View reviewed changes

adamstankiewicz merged commit f3b0554 into openedx:release-22.x Dec 18, 2024
10 checks passed

openedx-semantic-release-bot added the released on @22.x label Dec 18, 2024

bradenmacdonald mentioned this pull request Jan 9, 2025

Enable support for React 18, bump Gatsby to v5 #3367

Open

23 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add typings for hooks #3125

feat: add typings for hooks #3125

bradenmacdonald commented Jul 8, 2024 •

edited

Loading

openedx-webhooks commented Jul 8, 2024 •

edited

Loading

netlify bot commented Jul 8, 2024 •

edited

Loading

bradenmacdonald commented Jul 9, 2024

adamstankiewicz Aug 15, 2024

bradenmacdonald Dec 16, 2024

adamstankiewicz Aug 15, 2024

bradenmacdonald Dec 16, 2024

adamstankiewicz Aug 15, 2024

bradenmacdonald Dec 16, 2024

adamstankiewicz Aug 15, 2024

bradenmacdonald Dec 16, 2024

adamstankiewicz Aug 15, 2024

bradenmacdonald Dec 16, 2024

mphilbrick211 commented Dec 9, 2024

bradenmacdonald commented Dec 9, 2024

bradenmacdonald commented Dec 12, 2024

brian-smith-tcril commented Dec 13, 2024

brian-smith-tcril commented Dec 13, 2024

codecov bot commented Dec 16, 2024 •

edited

Loading

netlify bot commented Dec 16, 2024 •

edited

Loading

bradenmacdonald commented Dec 16, 2024

brian-smith-tcril left a comment

brian-smith-tcril Dec 17, 2024

openedx-semantic-release-bot commented Dec 18, 2024

		@@ -19,7 +20,7 @@ const resetHandlerMocks = () => {
		};

		// eslint-disable-next-line react/prop-types

		containerElementRef: Element \| null,
		overflowElementRef: Element \| null,

feat: add typings for hooks #3125

feat: add typings for hooks #3125

Conversation

bradenmacdonald commented Jul 8, 2024 • edited Loading

Description

Deploy Preview

Merge Checklist

Post-merge Checklist

openedx-webhooks commented Jul 8, 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?

netlify bot commented Jul 8, 2024 • edited Loading

❌ Deploy Preview for paragon-openedx failed.

bradenmacdonald commented Jul 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mphilbrick211 commented Dec 9, 2024

bradenmacdonald commented Dec 9, 2024

bradenmacdonald commented Dec 12, 2024

brian-smith-tcril commented Dec 13, 2024

brian-smith-tcril commented Dec 13, 2024

codecov bot commented Dec 16, 2024 • edited Loading

Codecov Report

netlify bot commented Dec 16, 2024 • edited Loading

✅ Deploy Preview for paragon-openedx-v22 ready!

bradenmacdonald commented Dec 16, 2024

brian-smith-tcril left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openedx-semantic-release-bot commented Dec 18, 2024

bradenmacdonald commented Jul 8, 2024 •

edited

Loading

openedx-webhooks commented Jul 8, 2024 •

edited

Loading

netlify bot commented Jul 8, 2024 •

edited

Loading

codecov bot commented Dec 16, 2024 •

edited

Loading

netlify bot commented Dec 16, 2024 •

edited

Loading