[HOLD for payment 2023-10-02] [$1000] Console error appears when pressing the "Enter" key after zooming in on an image

[kavimuru]

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

---

Action Performed:

1. Open a chat.
2. Add an attachment.
3. Select an image and send it.
4. Open the sent file in preview.
5. Click the zoom-in button.
6. Zoom out
7. Press the Enter key.
8. Check the console errors.

Expected Result:

Pressing the Enter button after zooming in on an image should not trigger any console errors

Actual Result:

Console error "Uncaught TypeError: Cannot read properties of undefined (reading 'offsetX')" occurs when pressing the Enter button after zooming in on an image

Workaround:

Yes - there is no user impact here

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: 1.3.57-2
Reproducible in staging?: y
Reproducible in production?: y
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

screen-recording-2023-08-14-at-102510-pm_9ehB6Ht1.mp4

Recording.1509.mp4

Expensify/Expensify Issue URL:
Issue reported by: @ayazhussain79
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1692035680346459

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~012ae65e5538e04b44
• Upwork Job ID: 1696469543815331840
• Last Price Increase: 2023-09-12
• Automatic offers:
• bernhardoj | Contributor | 26743646

[GItGudRatio]

Proposal

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

Console error appears when pressing the "Enter" key after zooming in on an image.

What is the root cause of that problem?

When we open an image and zoom in on it, the image is focused. When we press enter now, the onKeyPressHandler is triggered in GenericPressable. Since the key is enter, we call the onPressHandler with the event. This in turn triggers the onContainerPress function in ImageView. Now, since the KeyboardEvent does not have a nativeEvent, we try to access the value offsetX on a null value, throwing the error.

App/src/components/ImageView/index.js

Lines 143 to 158 in ed859eb

	if (!isZoomed && !isDragging) {
	const {offsetX, offsetY} = e.nativeEvent;
	// Dividing clicked positions by the zoom scale to get coordinates
	// so that once we zoom we will scroll to the clicked location.
	const delta = getScrollOffset(offsetX / zoomScale, offsetY / zoomScale);
	setZoomDelta(delta);
	}
	if (isZoomed && isDragging && isMouseDown) {
	setIsDragging(false);
	setIsMouseDown(false);
	} else {
	// We first zoom and once its done then we scroll to the location the user clicked.
	setIsZoomed(!isZoomed);
	setIsMouseDown(false);
	}

Since the offsets are calculated only when zooming in, pressing the enter key when already zoomed in does not throw an error.

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

We need to add a conditional such that if !e.nativeEvent or !e.nativeEvent.offsetX or !e.nativeEvent.offsetY, we return from the function.

This is the only occurence of an issue with this root cause.

What alternative solutions did you explore? (Optional)

[melvin-bot]

Triggered auto assignment to @conorpendergrast (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

[bernhardoj]

Proposal

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

Pressing enter after zooming out an image will throw a console error.

What is the root cause of that problem?

When we click the image to zoom in, the image will now become the focused element. When we press Enter once, it will trigger the onPress callback to zoom out the image. Pressing the Enter again will try to zoom in on the image again, however, using Enter to trigger the onPress will give a KeyboardEvent which doesn't have nativeEvent attribute.

App/src/components/ImageView/index.js

Line 144 in c169952

const {offsetX, offsetY} = e.nativeEvent;

So, when we try to destructure the event, it will throw a console error. Both offsetX and offsetY are used to calculate the zoomDelta. The zoomDelta tells how much we should scroll the image horizontally and vertically to focus on the clicked position. See the below video to understand it better.

Screen.Recording.2023-08-26.at.14.49.48.mov

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

In case we press the image with Enter, we can just zoom the image without doing any scrolling.

if (e.nativeEvent) {
    // do the calculation we already have
} else {
    setZoomDelta({offsetX: 0, offsetY: 0});
}

[conorpendergrast]

Reviewed, sounds good, let's fix

[melvin-bot]

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

[melvin-bot]

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