[No QA] Fix require cycle from subscribeToReportCommentPushNotifications #25544

dukenv0307 · 2023-08-20T15:47:10Z

Details

We fix require cycle from subscribeToReportCommentPushNotifications because of backgroundRefresh on Android

Fixed Issues

$ #24174
PROPOSAL: #24174 (comment)

Tests

Run the app on
Verify that no warning about a require cycle

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Run the app on
Verify that no warning about a require cycle

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screencast.from.20-08-2023.22.50.47.webm

Mobile Web - Chrome

Record_2023-08-20-22-53-42.mp4

Mobile Web - Safari

Screen.Recording.2023-08-20.at.23.01.48.mov

Desktop

Screen.Recording.2023-08-20.at.23.08.10.mov

iOS

Screen.Recording.2023-08-20.at.23.00.52.mov

Android

untitled.webm

melvin-bot · 2023-08-21T01:17:44Z

@parasharrajat Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

parasharrajat · 2023-08-21T05:34:59Z

@dukenv0307 Can you please explain to me your changes and why it has to be different from the proposal?

parasharrajat · 2023-08-21T05:55:09Z

src/libs/Notification/PushNotification/index.native.js

+Onyx.connect({
+    key: ONYXKEYS.NVP_PRIVATE_PUSH_NOTIFICATION_ID,
+    callback: (notificationID) => {
+        if (notificationID) {
+            register(notificationID);
+
+            // Prevent issue where report linking fails after users switch accounts without closing the app
+            init();
+            subscribeToReportCommentPushNotifications();
+        } else {
+            deregister();
+            clearNotifications();
+        }
+    },
+});


I know that push notifications are only native things but platform files should have the same signatures. This event is a side-effect of this file.

IMO, it will be better to move this into its own file rather than moving the listeners in PushNotificationListener.

@dukenv0307 Do you think we can follow this suggestion?

When we move this code to PushNotification, because in this we call subscribeToReportCommentPushNotifications function and ỉn subscribeToReportCommentPushNotifications we also import method from PushNotification, the app has a new require cycle. So I need to move some methods to PushNotificationListener

@parasharrajat Do you think about my comment here?

We have two solution here

Move subscribeToReportCommentPushNotifications into index.native.js

As I mentioned above

I see but I am thinking that we create a new action file that only had the subscription to this. Shouldn't this work? This file will import pushNotfication and the subscribeToReportCommentPushNotifications but PushNotification file will not import this file.

we will import that in Expensify.js

We will just import it and then do nothing, right?

Cool, let me try to implement this.

@parasharrajat I just updated and tested. We already have the same lib UnreadIndicatorUpdater imported in Expensify.js

dukenv0307 · 2023-08-21T06:56:41Z

@parasharrajat When we move this code to PushNotification, because in this we call subscribeToReportCommentPushNotifications function and ỉn subscribeToReportCommentPushNotifications we also import method from PushNotification, the app has a new require cycle. So I need to move some methods to PushNotificationListener

parasharrajat · 2023-08-21T15:14:57Z

tests/actions/SessionTest.js

-
-    test('Push notifications are subscribed after signing in', () => TestHelper.signInWithTestUser().then(() => expect(PushNotification.register).toBeCalled()));
-
-    test('Push notifications are unsubscribed after signing out', () =>
-        TestHelper.signInWithTestUser()
-            .then(TestHelper.signOutTestUser)
-            .then(() => expect(PushNotification.deregister).toBeCalled()));


We should revert this file.

@parasharrajat Because we remove the push notification code from Session so this test will fail. But I logged in deregister and register function when I signed in and signed out and it work as well

@parasharrajat I just revert this file and you can see the jest test fail as I mentioned. Do you think we should create a new test or remove this test.

parasharrajat · 2023-08-21T16:59:18Z

We should fix this test and make sure it is working.

dukenv0307 · 2023-08-21T17:09:23Z

I have logged in register and deregister function when I signed in and signed out. Both functions are called but don't know why the test fails.

parasharrajat · 2023-08-21T18:40:53Z

Because we move that subscription out of the session lib and now it won't be loaded in the SessionTest. You will have to import that lib here I think.

dukenv0307 · 2023-08-21T19:06:46Z

We should import it in SessionTest or session lib?

dukenv0307 · 2023-08-22T04:46:53Z

@parasharrajat All checks passed with your suggestion.

parasharrajat · 2023-08-22T14:27:12Z

Screenshots

🔲 iOS / native

Screen.Recording.2023-08-23.at.2.17.03.AM.mov

🔲 iOS / Safari

Screen.Recording.2023-08-22.at.9.26.51.PM.mov

🔲 MacOS / Desktop

Screen.Recording.2023-08-22.at.10.50.24.PM.mov

🔲 MacOS / Chrome

Screen.Recording.2023-08-22.at.8.06.20.PM.mov

🔲 Android / Chrome

Screen.Recording.2023-08-23.at.2.06.26.AM.mov

🔲 Android / native

Screen.Recording.2023-08-22.at.10.04.04.PM.mov

parasharrajat

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

🎀 👀 🎀 C+ reviewed

OSBotify · 2023-08-22T21:35:47Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

roryabraham · 2023-08-24T03:03:21Z

I think this PR can safely be [No QA] (I'm also not sure that warnings about require cycles would show up on staging anyways). Going to mark it as such and check it off on the checklist.

OSBotify · 2023-08-24T03:35:46Z

🚀 Deployed to staging by https://github.com/arosiclair in version: 1.3.57-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-08-28T18:52:50Z

🚀 Deployed to staging by https://github.com/arosiclair in version: 1.3.58-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-08-29T00:07:27Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.57-6 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2023-08-30T01:21:53Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.58-5 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

dukenv0307 added 4 commits August 18, 2023 15:30

fix: 24174

9f743b3

Merge branch 'main' into fix/24174

058ce44

fix require cycle

2ac2590

remove test pushnotification in session test

f26ca2d

dukenv0307 marked this pull request as ready for review August 21, 2023 01:17

dukenv0307 requested a review from a team as a code owner August 21, 2023 01:17

melvin-bot bot removed the request for review from a team August 21, 2023 01:17

melvin-bot bot requested a review from parasharrajat August 21, 2023 01:17

parasharrajat reviewed Aug 21, 2023

View reviewed changes

refactor file lib notification

b8925d9

parasharrajat reviewed Aug 21, 2023

View reviewed changes

revert unit test

e08d186

dukenv0307 force-pushed the fix/24174 branch from fc8cd51 to e08d186 Compare August 21, 2023 16:24

pradeepmdk mentioned this pull request Aug 22, 2023

Android Dev - Console warning on open App #25641

Closed

6 tasks

dukenv0307 added 3 commits August 22, 2023 10:27

fix test

a4ec934

Merge branch 'main' into fix/24174

a25ee72

Merge branch 'main' into fix/24174

7ad62e1

parasharrajat approved these changes Aug 22, 2023

View reviewed changes

melvin-bot bot requested a review from arosiclair August 22, 2023 18:24

arosiclair approved these changes Aug 22, 2023

View reviewed changes

arosiclair merged commit 0f97b68 into Expensify:main Aug 22, 2023

OSBotify mentioned this pull request Aug 24, 2023

Deploy Checklist: New Expensify 2023-08-24 #25813

Closed

73 tasks

roryabraham changed the title ~~Fix require cycle from subscribeToReportCommentPushNotifications~~ [No QA] Fix require cycle from subscribeToReportCommentPushNotifications Aug 24, 2023

OSBotify mentioned this pull request Aug 28, 2023

Deploy Checklist: New Expensify 2023-08-28 #26113

Closed

melvin-bot bot mentioned this pull request Aug 28, 2023

[HOLD for payment 2023-09-04] [$1000] Fix require cycle from subscribeToReportCommentPushNotifications #24174

Closed

6 tasks

arosiclair mentioned this pull request Jan 30, 2024

[TS migration] Migrate 'Expensify.js' file to TypeScript #35296

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Fix require cycle from subscribeToReportCommentPushNotifications #25544

[No QA] Fix require cycle from subscribeToReportCommentPushNotifications #25544

dukenv0307 commented Aug 20, 2023 •

edited

Loading

melvin-bot bot commented Aug 21, 2023

parasharrajat commented Aug 21, 2023 •

edited

Loading

parasharrajat Aug 21, 2023

parasharrajat Aug 21, 2023

dukenv0307 Aug 21, 2023 •

edited

Loading

dukenv0307 Aug 21, 2023

parasharrajat Aug 21, 2023 •

edited

Loading

parasharrajat Aug 21, 2023

dukenv0307 Aug 21, 2023

parasharrajat Aug 21, 2023

dukenv0307 Aug 21, 2023

dukenv0307 Aug 21, 2023

dukenv0307 commented Aug 21, 2023 •

edited

Loading

parasharrajat Aug 21, 2023

dukenv0307 Aug 21, 2023

dukenv0307 Aug 21, 2023

parasharrajat commented Aug 21, 2023

dukenv0307 commented Aug 21, 2023

parasharrajat commented Aug 21, 2023

dukenv0307 commented Aug 21, 2023

dukenv0307 commented Aug 22, 2023 •

edited

Loading

parasharrajat commented Aug 22, 2023 •

edited

Loading

parasharrajat left a comment

OSBotify commented Aug 22, 2023

roryabraham commented Aug 24, 2023

OSBotify commented Aug 24, 2023

OSBotify commented Aug 28, 2023

OSBotify commented Aug 29, 2023

OSBotify commented Aug 30, 2023

[No QA] Fix require cycle from subscribeToReportCommentPushNotifications #25544

[No QA] Fix require cycle from subscribeToReportCommentPushNotifications #25544

Conversation

dukenv0307 commented Aug 20, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 21, 2023

parasharrajat commented Aug 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dukenv0307 Aug 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

parasharrajat Aug 21, 2023 • edited Loading

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

dukenv0307 commented Aug 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

parasharrajat commented Aug 21, 2023

dukenv0307 commented Aug 21, 2023

parasharrajat commented Aug 21, 2023

dukenv0307 commented Aug 21, 2023

dukenv0307 commented Aug 22, 2023 • edited Loading

parasharrajat commented Aug 22, 2023 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

OSBotify commented Aug 22, 2023

roryabraham commented Aug 24, 2023

OSBotify commented Aug 24, 2023

OSBotify commented Aug 28, 2023

OSBotify commented Aug 29, 2023

OSBotify commented Aug 30, 2023

dukenv0307 commented Aug 20, 2023 •

edited

Loading

parasharrajat commented Aug 21, 2023 •

edited

Loading

dukenv0307 Aug 21, 2023 •

edited

Loading

parasharrajat Aug 21, 2023 •

edited

Loading

dukenv0307 commented Aug 21, 2023 •

edited

Loading

dukenv0307 commented Aug 22, 2023 •

edited

Loading

parasharrajat commented Aug 22, 2023 •

edited

Loading