[$250] iOS Hybrid - Lack of debug mode in the settings - Troubleshoot for IOS Hybrid app

[lanitochka17]

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!

---

Version Number: 9.0.49-0
Reproducible in staging?: Y
Reproducible in production?: Y
If this was caught during regression testing, add the test name, ID and link from TestRail: N/A
Email or phone of affected tester (no customers): [email protected]
Issue reported by: Applause - Internal Team

Issue found when executing PR #50519

Action Performed:

1. Open the Expenisfy Hybrid app
2. Sign into a valid account and access the ND features within the app
3. Go to Account section > Troubleshoot > Scroll down

Expected Result:

User expects to see the Debug option

Actual Result:

No Debug option is shown

Workaround:

Unknown

Platforms:

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

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Add any screenshot/video evidence

Bug6635787_1729028252122.No_Debug_option_in_Troubleshoot_menu_.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~021846335027010160243
• Upwork Job ID: 1846335027010160243
• Last Price Increase: 2024-10-29

Issue Owner

Current Issue Owner: @situchan

[melvin-bot]

Triggered auto assignment to @greg-schroeder (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[lanitochka17]

@greg-schroeder FYI I haven't added the External label as I wasn't 100% sure about this issue. Please take a look and add the label if you agree it's a bug and can be handled by external contributors

[melvin-bot]

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

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @situchan (External)

[layacat]

Proposal

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

Lack of debug mode in the settings - Troubleshoot for IOS Hybrid app

What is the root cause of that problem?

We always return Production for HybridAppModule here:

App/src/libs/Environment/getEnvironment/index.native.ts

Lines 33 to 36 in d77a4fd

	if (NativeModules.HybridAppModule) {
	environment = CONST.ENVIRONMENT.PRODUCTION;
	return;
	}

That's the RCA.

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

We should remove this block of code:

 if (NativeModules.HybridAppModule) { 
     environment = CONST.ENVIRONMENT.PRODUCTION; 
     return; 
 } 

What alternative solutions did you explore? (Optional)

N/A
Reminder: Please use plain English, be brief and avoid jargon. Feel free to use images, charts or pseudo-code if necessary. Do not post large multi-line diffs or write walls of text. Do not create PRs unless you have been hired for this job.

[situchan]

can we allow debug mode in hybrid app?
tagging hybrid app experts: @AndrewGable @staszekscp @mateuuszzzzz

[AndrewGable]

I believe we can, but let's confirm with @staszekscp and @mateuuszzzzz

[situchan]

App/src/libs/Environment/getEnvironment/index.native.ts

Lines 32 to 36 in 04214cd

	// If we don't use Development, and we're in the HybridApp, we should use Production
	if (NativeModules.HybridAppModule) {
	environment = CONST.ENVIRONMENT.PRODUCTION;
	return;
	}

@staszekscp @AndrewGable are we fine to remove this block, which reverts this PR?

[staszekscp]

@situchan We'll have to remove this code in order to fix the issue, but I think we'll have to do one more thing on the OldDot side of things to make it work correctly, I'll come back to you with an update

[staszekscp]

So, I'm back with an update 😄 On the Mobile-Expensify side, we'll have to link a Native Module called EnvironmentChecker, which is an easy fix. Combining it with removal of the code mentioned here should fix iOS.

Nevertheless we'll have a problem with Android. Currently we base our beta check on this line: https://github.com/Expensify/App/blob/main/src/libs/Environment/betaChecker/index.android.ts#L27. We get the latest release tag, and compare it with the version in package.json. If the versions match, we're on production, if the one in package.json is higher, we're on a beta build.

The problem is that the HybridApp's production version is different than the release NewDot version. Eg. currently we're on 9.0.47 on HybridApp, and 9.0.51 on NewDot. We cannot simply swap CONST.GITHUB_RELEASE_URL value to the Mobile-Expensify url, because it's not a public repo, and AFAIK would require additional authentication. Maybe we could create some dummy public repo that would keep that information only for HybridApp version so the only thing we have to do on the NewDot side is to swap a url? Or maybe to have some API endpoint to check the release version?

cc: @Julesssss

[Julesssss]

Thanks for the detailed explanation. I wonder why the debug tool is restricted by version instead of email, internal beta, etc... It seems necessarily complex, and restricts us from debugging prod. Though I suppose with external contributors its better to keep access open rather than locked down...

What if we locked the beta tools behind a hidden menu? For example, 8 taps of the version code could set an Onyx key that unlocks the debug menu.

One bad alternative might be to query the Google Play Store API and provide the Mobile-Expensify version via a backend command, though I recall the API being pretty bad and undocumented...

[staszekscp]

Yep, as far as I know there is no reliable way to check if a specific build is an Android Play Store Beta build 😢 I suppose that's the reason why the whole version checker tool has been implemented. I'd like to keep using this mechanism in order to introduce less changes on the NewDot side - the hidden menu may expose some options to regular users, that we would like to keep unavailable 😄 I'm not familiar with the whole debugging tools code, but we would have to revise it thoroughly first

Maybe we could change the release tag logic on GitHub so it would match only the HybridApp version, since we're going to deprecate NewDot in the nearest future?

[melvin-bot]

📣 It's been a week! Do we have any satisfactory proposals yet? Do we need to adjust the bounty for this issue? 💸

[AndrewGable]

I think we are planning on having them be in sync, but we need to change some processes internally before we can do so.

[staszekscp]

In this case should we wait until it's changed? I suppose we could easily enable debug mode for iOS (since it's based on a TestFlight link, not the version in package.json), and have it disabled for Android until we have releases of both repos in sync

[Julesssss]

It could be a while though. I would vote for simplify access to the HybridApp debug tools in the meantime.

[AndrewGable]

@puneetlath - Do you think we could solve this in a different way than looking at the versioning for the time being? Maybe we can include the debug tools for certain domains using the beta manager?

[Julesssss]

One concern about a beta is that it'll be a barrier that might prevent users/qa from providing logs due to the extra step. Also we'll have to constantly be adding contributors to the beta.

[AndrewGable]

Do you have any ideas for alternative solutions? My thought was we could use Beta manager as an additional way to add SWM + Callstack + Expensify domains to the beta manager for those who use HybridApp. Not necessarily just use beta manager exclusively.

[puneetlath]

Perhaps we can just make it available via the four-finger-tap/cmd+d on production. That way there's still a way to get to it on Android. Or if we ever wanted someone to on production for whatever reason.

[Julesssss]

...For example, 8 taps of the version code could set an Onyx key that unlocks the debug menu.

I think 4 finger tap or unlocking the menu item after x taps are both good simple solutions. I don't think we should care about users accidentally discovering these tools (granted with the open repo, its pretty easy for users to discover if they really wanted to).

[AndrewGable]

Perhaps we can just make it available via the four-finger-tap/cmd+d on production

I like this 👍

[puneetlath]

I agree with that @Julesssss

[staszekscp]

Ok, cool! In that case the implementation will be HybridApp agnostic, and it can be done entirely on standalone NewDot. I suppose this kind of work will require some proposal, and general agreement on the solution, so I'll try to find someone on our side to take care of it! 😄

[Julesssss]

Sounds good @staszekscp, let's open a new issue rather than modifying this one. Let me know when you find someone to work on the task and I'll create one for you.

[blazejkustra]

Hey @Julesssss! I'm going to work on it. Tag me in the issue, and I'll start tomorrow morning 😄

[Julesssss]

Hey @blazejkustra could you comment here and I'll assign you, thanks!

[melvin-bot]

📣 It's been a week! Do we have any satisfactory proposals yet? Do we need to adjust the bounty for this issue? 💸

[greg-schroeder]

Okay I'm a bit confused on this one - who is going to take this one on? Or are we still waiting for a valid proposal?

[Julesssss]

I think we can close this once this issue is completed (its awaiting testing on prod)

[greg-schroeder]

Held til 2024-11-07

[melvin-bot]

@Julesssss, @greg-schroeder, @situchan Whoops! This issue is 2 days overdue. Let's get this updated quick!

[Julesssss]

Still held

[Julesssss]

The linked issue is closed. We didn't end up needing C+ review here.