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

[arosiclair]

Action Performed:

Run the app on Android

Expected Result:

No warnings about a require cycle

Actual Result:

A warning for a require cycle occurs.

WARN  Require cycle: src/libs/actions/Session/index.js -> src/libs/Notification/PushNotification/subscribeToReportCommentPushNotifications.js -> src/libs/Notification/PushNotification/backgroundRefresh/index.android.js -> src/libs/actions/App.js -> src/libs/actions/Session/index.js

Workaround:

None

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android / native
• Android / Chrome
• iOS / native
• iOS / Safari
• MacOS / Chrome / Safari
• MacOS / Desktop

Version Number:
Reproducible in staging?:
Reproducible in production?:
If this was caught during regression testing, add the test name, ID and link from TestRail:
Email or phone of affected tester (no customers):
Logs: https://stackoverflow.com/c/expensify/questions/4856
Notes/Photos/Videos: Any additional supporting documentation
Expensify/Expensify Issue URL:
Issue reported by: @arosiclair
Slack conversation:

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01e26d73a28da0cafc
• Upwork Job ID: 1687585347865071616
• Last Price Increase: 2023-08-17
• Automatic offers:
• dukenv0307 | Contributor | 26197726

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~01e26d73a28da0cafc

[melvin-bot]

Triggered auto assignment to @muttmuure (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

[melvin-bot]

Bug0 Triage Checklist (Main S/O)

• This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
• This bug is not a duplicate report (check E/App issues and #expensify-bugs)
  • If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
• This bug is reproducible using the reproduction steps in the OP. S/O
  • If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
  • If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
• This issue is filled out as thoroughly and clearly as possible
  • Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
• I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

[melvin-bot]

Triggered auto assignment to Contributor Plus for review of internal employee PR - @parasharrajat (Internal)

[arosiclair]

@muttmuure no need to try to reproduce this atm. This is a follow up for a console warning from this PR. I'll submit a PR to fix it and get it tested.

[arosiclair]

Holding until that PR is merged

[arosiclair]

My local dev builds have been broken for days and a fix is probably not coming soon enough. I'm going to open this to contributors.

The best fix I saw is to move deep linking functions in src/libs/actions/App.js to it's own module src/libs/actions/DeepLinking.js. This should remove App.js's dependency on Session.js and break the require cycle.

[melvin-bot]

Triggered auto assignment to @strepanier03 (External), see https://stackoverflow.com/c/expensify/questions/8582 for more details.

[melvin-bot]

Current assignee @parasharrajat is eligible for the External assigner, not assigning anyone new.

[dukenv0307]

Proposal

Please re-state the problem that we are trying to solve in this issue.

A warning for a require cycle occurs on Android.
WARN Require cycle: src/libs/actions/Session/index.js -> src/libs/Notification/PushNotification/subscribeToReportCommentPushNotifications.js -> src/libs/Notification/PushNotification/backgroundRefresh/index.android.js -> src/libs/actions/App.js -> src/libs/actions/Session/index.js

What is the root cause of that problem?

It comes from this PR that introduces the backgroundRefresh method, causing the require cycle. It only happens for Android because the backgroundRefresh is only implemented in Android.

What changes do you think we should make in order to solve the problem?

As correctly pointed out by @arosiclair here, we should have another module in actions to store the deep-linking related methods, this will break the require cycle.

We need to:

• Create a new src/libs/actions/DeepLinking.js file
• Move these methods beginDeepLinkRedirect, setUpPoliciesAndNavigate to the DeepLinking.js file
• There're some other methods & variables that depend on the 2 above like beginDeepLinkRedirectAfterTransition, waitForSignOnTransitionToFinish, ... we'll move them to the new file as well.
• Since the purpose of the new DeepLinking.js file is to store the deep link related methods, we can consider moving some other methods like redirectThirdPartyDesktopSignIn to it as well (although not required for this issue)
• Update existing places in the app that use the above methods, to use it from the new file

What alternative solutions did you explore? (Optional)

Another solution is to move this push notification subscriptions logic to inside the src/libs/Notification/PushNotification module, that makes sense since that logic is related to notifications and only uses method from the PushNotification module.

[melvin-bot]

🎯 ⚡️ Woah @parasharrajat / @dukenv0307, great job pushing this forwards! ⚡️

The pull request got merged within 3 working days of assignment, so this job is eligible for a 50% #urgency bonus 🎉

• when @dukenv0307 got assigned: 2023-08-18 13:57:16 Z
• when the PR got merged: 2023-08-22 21:31:44 UTC

On to the next one 🚀

[melvin-bot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 1.3.57-6 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• [No QA] Fix require cycle from subscribeToReportCommentPushNotifications #25544

If no regressions arise, payment will be issued on 2023-09-04. 🎊

After the hold period is over and BZ checklist items are completed, please complete any of the applicable payments for this issue, and check them off once done.

• External issue reporter
• Contributor that fixed the issue
• Contributor+ that helped on the issue and/or PR

For reference, here are some details about the assignees on this issue:

• @parasharrajat does not require payment (Eligible for Manual Requests)
• @dukenv0307 requires payment offer (Contributor)

As a reminder, here are the bonuses/penalties that should be applied for any External issue:

• Merged PR within 3 business days of assignment - 50% bonus
• Merged PR more than 9 business days after assignment - 50% penalty

[melvin-bot]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@parasharrajat] The PR that introduced the bug has been identified. Link to the PR:
• [@parasharrajat] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:
• [@parasharrajat] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:
• [@parasharrajat] Determine if we should create a regression test for this bug.
• [@parasharrajat] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.
• [@muttmuure] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[arosiclair]

This was just a follow up issue for another PR so no need for regression tests and etc. @muttmuure can you handle payment please?

[parasharrajat]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@parasharrajat] The PR that introduced the bug has been identified. Link to the PR: NA
• [@parasharrajat] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment: NA
• [@parasharrajat] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion: NA
• [@parasharrajat] Determine if we should create a regression test for this bug. No
• [@parasharrajat] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.

[melvin-bot]

@arosiclair, @parasharrajat, @muttmuure, @dukenv0307 Whoops! This issue is 2 days overdue. Let's get this updated quick!

[muttmuure]

$1500 - @dukenv0307 - C
$1500 - @parasharrajat - C+

[muttmuure]

@parasharrajat is paid on NewDot, so I think we need @JmillsExpensify to pay it

[melvin-bot]

@arosiclair, @parasharrajat, @muttmuure, @dukenv0307 Uh oh! This issue is overdue by 2 days. Don't forget to update your issues!

[JmillsExpensify]

@muttmuure please close any issues that only lack a NewDot payment. Those payments use a separate process not tied to Github.

[parasharrajat]

Payment requested as per #24174 (comment)

[JmillsExpensify]

$1,500 payment approved for @parasharrajat based on BZ summary.