Page MenuHomePhabricator

[web] [refactor] 30+ diff squash, remove prop drill of setModal
ClosedPublic

Authored by benschac on Feb 23 2022, 12:31 PM.
Tags
None
Referenced Files
F3248668: D3271.diff
Fri, Nov 15, 10:31 AM
Unknown Object (File)
Wed, Nov 13, 12:33 PM
Unknown Object (File)
Sat, Nov 2, 6:36 AM
Unknown Object (File)
Sat, Nov 2, 6:36 AM
Unknown Object (File)
Sat, Nov 2, 6:36 AM
Unknown Object (File)
Sat, Nov 2, 6:36 AM
Unknown Object (File)
Sat, Nov 2, 6:36 AM
Unknown Object (File)
Sat, Nov 2, 6:36 AM

Details

Summary

squash 30 diff refactor into one diff. Refactor setModal to context

Test Plan

n/a this doesn't do anything yet.

Diff Detail

Repository
rCOMM Comm
Branch
copy-modalthatsworking
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes
ashoat requested changes to this revision.Feb 24 2022, 1:02 PM

Lots of issues here. Two high-level buckets:

  1. In many places, you didn't pay attention to code conventions. Please always look for existing conventions in what you're doing.
  2. For a huge diff like this to work, it has to have a very specific scope. You stuffed way too many unrelated changes into this diff. Those all need to be factored out.
web/chat/chat-thread-list-see-more-sidebars.react.js
23

You should always be as specific as possible in a dep list. Rather than specifying modalContext here, you should specify modalContext.setModal. That way onClick will only be redefined if modalContext.setModal changes, rather than being redefined whenever modalContext changes

web/media/multimedia-modal.react.js
70

Instead of extracting uri specifically, please do what every out ConnectedComponent does and spread every prop. That way we won't have to update this code when a new prop is introduced

web/media/multimedia.react.js
20–27

Can we make all of these $ReadOnly?

120–126

See comment above. In general, when doing something new you should look to see how it's done in the codebase. If you had looked at any ConnectedComponent, you would see we're spreading all props instead of individually pulling each of them out...

In an ideal world this isn't a comment I need to leave, it's just something you learn by reading code.

web/modals/account/log-in-first-modal.react.js
13

You're converting a class component into a function component.

In general, each diff should have a concrete, specific purpose. This is extra important for these huge diffs. Huge diffs should be dead simple. As soon as you sneak changes like this in, you ruin the simplicity and make it hard to review.

Please pull this refactor out of this diff. If you feel like that the class-to-function refactor is necessary to make the setModal refactor easier, that's fine – you can just pull the class-to-function refactor into its own preceding diff.

16–21

By attempting this refactor here, you are asking for trouble. Class-to-function refactor should be trivial, but you're still new to a lot of this stuff. So your class-to-function refactor diff is going to end up needing revisions, which because you've bundled it all together into this unrelated diff, are going to end up blocking this diff.

Concretely, here you are introducing a callback that gets recreated on every render. We've talked repeatedly over the past several days about React.useCallback, why it exists, its purpose, etc. Here it seems clear you still don't understand its purpose.

onClickLogIn needs to be wrapped in a React.useCallback.

web/modals/chat/invalid-upload.react.js
9

Yeah that makes sense, but it should not be in the same diff. A huge diff like this can only exist if it is immaculately well-scoped. Please factor this change out into a separate (probably preceding) diff

web/modals/chat/sidebar-list-modal.react.js
21–28

Please avoid defining threadInfo twice.

The core problem here is that you aren't spending time figuring out the right convention for doing something.

When you're righting code like this, you should know that we're already doing something similar in the codebase. You must've encountered this already when reading code, but even if you haven't – you should know that this isn't the first time somebody is writing BaseProps/Props.

So you should start by finding an existing implementation, and trying to follow what the existing convention is.

This comment is the same high-level comment as the one about using object-spread in the ConnectedComponent. Your job isn't just to find something that works – it's to maintain the consistency of the codebase; to learn and implement best practices/conventions.

150

Once again, please don't do this... use object spread so the next person to add a prop to this component doesn't have to also edit this line

web/modals/modal.react.js
13
  1. As discussed yesterday, please undo this naming change
  2. Even if we agreed on this naming change, it should not be in this diff. This diff has one purpose, and it is wayyyy too huge/unwieldly for you to even consider stuffing unrelated changes in there
89

Please don't do this – use object spread

web/root.js
25

We agreed that this shouldn't go here! Why is it back here now?

web/sidebar/community-picker.react.js
16

Be maximally specific in your dep list

This revision now requires changes to proceed.Feb 24 2022, 1:02 PM
web/app.react.js
233 ↗(On Diff #9926)

I decided to just wrap the app in a provider, and not use the React.memo higher-order component here since it's wrapped in ConnectedApp

Generally wanted to keep the diff as small as possible.

web/chat/chat-thread-list-see-more-sidebars.react.js
23

updated

web/media/multimedia-modal.react.js
70

updated. Moving forward I'll pay more attention to the convention of spreading props in ConnectedComponent

web/media/multimedia.react.js
20–27

I'm assuming you mean, adding + to each key, and you're not saying to

type Props = $ReadOnly<{}>;

Grepping around the (web) codebase i don't see any examples of what you're suggesting:

Image 2022-02-25 at 8.17.15 AM.jpg (770×2 px, 331 KB)

120–126

updated

web/modals/chat/sidebar-list-modal.react.js
21–28

It was an oversight.

I've seen BaseProps spread into Props in the codebase.

You're right I should spend a bit more time reviewing my code and looking for similar patterns in the codebase.

Just for the record. grepped through the codebase and confirmed.

Image 2022-02-25 at 9.37.06 AM.jpg (1×1 px, 282 KB)

web/root.js
25

It was an oversight. I fixed it in my previous stack but forgot to remove it when squashing my diffs.

I need to do a bit more self-review before asking for review.

web/calendar/day.react.js
48 ↗(On Diff #9926)

I changed all instances on clearModal on the Modal component that you commented on.

re-reading my diff, I think this makes sense.

self review

web/calendar/day.react.js
48 ↗(On Diff #9926)

this should go, clear modal isnt' used in the component

web/media/multimedia-modal.react.js
69 ↗(On Diff #9926)

I should change clearModal back to onClose here too. This Modal doesn't use the <Modal /> component which was the only component I reverted.

If we're going to revert the <Modal /> component we should revert this one too.

web/modals/account/log-in-modal.react.js
64 ↗(On Diff #9926)

clearModal was used here last time, so I didn't change the props from clearModal to onClose

web/modals/chat/invalid-upload.react.js
23 ↗(On Diff #9926)

I should still get rid of this clearModal and use the context.

web/modals/threads/thread-settings-modal.react.js
489 ↗(On Diff #9926)

I shouldn't change these either.

594 ↗(On Diff #9926)

any component with Modal in it's name should probably stick with onClose in it's prop like it did before. Going to revert this.

web/sidebar/community-picker.react.js
14 ↗(On Diff #9926)

if setModal is a constant, do we even need to wrap this in a useCallback hook?

web/sidebar/community-picker.react.js
14 ↗(On Diff #9926)

nvm, if we didn't have this useCallback we'd be creating a new anonymous function on each render.

web/modals/chat/invalid-upload.react.js
27 ↗(On Diff #9927)

This component was using a clearModal already and I thought less is more, rather than changing it to an onClose.

Also, the clearModal isn't a part of an API that a developer would use when using this component.

ashoat requested changes to this revision.Feb 25 2022, 12:56 PM

Didn't have time for a full review

web/modals/account/log-in-first-modal.react.js
38–40 ↗(On Diff #9927)

Everywhere else in this diff, you delete functions named clearModal and replace them with modalContext.clearModal.

This appears to be the only place you left the clearModal function in place. What's the reason for this inconsistency?

web/modals/chat/invalid-upload.react.js
27 ↗(On Diff #9927)

Not sure what you mean

web/modals/modal.react.js
88 ↗(On Diff #9927)
  1. Please add a newline here
  2. The exported component's onClose property is completely useful, because it always get overwritten by the useModalContext hook
    • Please don't have useless props in your components
    • Are you 100% sure that every single use of Modal's onClose prop just assigns modalContext.clearModal? Are there are any modals that do other stuff when they are closed? It seems really risky to be rolling this huge change into this unrelated diff. If you feel strongly about this change, can you factor it out into its own diff? Otherwise, please just undo the change
This revision now requires changes to proceed.Feb 25 2022, 12:56 PM
web/modals/account/log-in-first-modal.react.js
38–40 ↗(On Diff #9927)

I missed it. This was one of the two "revert back to class components" and I was thinking just do less here. But, if I'm removing them everywhere in the code base I should do it here too.

web/modals/chat/invalid-upload.react.js
27 ↗(On Diff #9927)

The convention so far has been any <ThingModal /> will take a onClose prop.

But since this component isn't taking a users onClose I thought just leaving the prop as clearModal was the right move.

web/modals/modal.react.js
88 ↗(On Diff #9927)
  1. Done
  2. This was an oversight. I should have been a bit more rigorous. I was using a similar pattern passing the context to other modal components and didn't think that I was overwriting the entire prop making it useless.
web/modals/chat/invalid-upload.react.js
27 ↗(On Diff #9927)

Correction: But since this component isn't taking a users onClose I thought just leaving the prop as clearModal was the right move.

Ment to say: This component doesn't have a public interface to pass an onClose function so I thought leaving this prop as clearModal was okay.

ashoat requested changes to this revision.Feb 28 2022, 7:02 AM

Ton of issues here... I didn't have time to get through it before my meetings started this morning.

@benschac, it shouldn't take a full review from me for these issues to be spotted, much less three reviews from me. You should be able to spot these issues independently. Until you're able to do that, every time we consider giving you some refactor work we'll have to weigh that it will substantially slow down your ability to make progress on product work, and that's a really hard tradeoff for me to make :(

web/media/multimedia-modal.react.js
69 ↗(On Diff #9947)

Let's rename this to clearModal, to match every single other usage. We want Modal's prop to be called onClose, but for every case where we are simply pulling out clearModal from ModalContext, let's be consistent about naming

web/media/multimedia.react.js
27 ↗(On Diff #9947)

Why is this prop optional?

web/modals/account/user-settings-modal.react.js
435 ↗(On Diff #9947)

This prop does not appear to be used

web/modals/chat/sidebar-list-modal.react.js
36–38 ↗(On Diff #9947)

Why are we still defining this here

This revision now requires changes to proceed.Feb 28 2022, 7:02 AM

Going to do another round of self review before asking for additional review.

web/media/multimedia-modal.react.js
69 ↗(On Diff #9947)

Sounds good. I'm going to take another look at this diff and make sure everything is consistent.

web/media/multimedia.react.js
27 ↗(On Diff #9947)

Shouldn't have been! I didn't use BaseProps when defining the ConnectedMultimedaContainer.

web/modals/chat/sidebar-list-modal.react.js
36–38 ↗(On Diff #9947)

yeah, this whole ConnectedSidebarListModal didn't need to happen either.

Should have just used the context.

web/media/multimedia-modal.react.js
69 ↗(On Diff #9947)

Just grepped through all clearModal= prop definitions plus the onClose= prop definitions and we're following the rule:

Let's rename this to clearModal, to match every single other usage. We want Modal's prop to be called onClose, but for every case where we are simply pulling out clearModal from ModalContext, let's be consistent about naming

ashoat requested changes to this revision.Mar 1 2022, 9:51 AM

Did a full review this time and only found one issue.

web/modals/modal.react.js
88–90 ↗(On Diff #10001)
  1. What's the point of declaring this component?
  2. You are providing the children prop twice. There's no need to do that... <Modal {...props} /> is enough to forward the children prop
web/modals/modal.react.js
88–90 ↗(On Diff #10001)
  1. initially, it was for using the context. Now that it's not being used we don't need it.
  2. I'm just used to passing in children props this way. But, that makes sense.

Nice!! Let's get this in

This revision is now accepted and ready to land.Mar 1 2022, 10:48 AM