[Woo POS] [Barcodes] Play error sound when a barcode scan fails #15746

staskus · 2025-06-13T09:41:05Z

Description

Added a functionality to play a sound when barcode scanning fails. Using the same sound as on Android:

Created a POS sound player to play POS-related sounds
Added a sound .mp3 into a project
Updated tests

Steps to reproduce

Enable pointOfSaleBarcodeScanningi1
Open POS
Scan a wrong barcode
Confirm that the sound plays

Testing information

Tested on iPad Air M2 18.3 Device

Screenshots

ScreenRecording_06-13-2025.11-24-03_1.MP4

I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

Copilot

Pull Request Overview

This PR adds a failure sound cue when barcode scans fail in the POS system and updates tests and project configuration accordingly.

Introduces PointOfSaleSoundPlayer and PointOfSaleSound for playing .mp3 assets.
Injects a soundPlayer into PointOfSaleAggregateModel and triggers playback on scan errors.
Adds a mock sound player and a new async test to verify failure sound behavior.

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
Classes/POS/Models/PointOfSaleAggregateModel.swift	Inject `soundPlayer` and call `playSound(.barcodeScanFailure)` on barcode scan errors
Classes/POS/Utils/Audio/PointOfSaleSoundPlayer.swift	Implement AVAudio-based sound playback and define the `PointOfSaleSound` type
Tests/POS/Mocks/MockPointOfSaleSoundPlayer.swift	Add a mock conforming to `PointOfSaleSoundPlayerProtocol`
Tests/POS/Mocks/MockPointOfSaleBarcodeScanService.swift	Change mock to a class and allow throwing errors for test scenarios
Tests/POS/Models/PointOfSaleAggregateModelTests.swift	Inject the mock sound player into existing tests and add a new failure test
WooCommerce.xcodeproj/project.pbxproj	Register `PointOfSaleSoundPlayer.swift`, `MockPointOfSaleSoundPlayer.swift`, and `pos_scan_failure.mp3` in build and resource targets

Comments suppressed due to low confidence (3)

WooCommerce/WooCommerceTests/POS/Models/PointOfSaleAggregateModelTests.swift:1262

You’ve added a test for failure playback. Consider also adding a counterpart test to verify that no sound is played when a barcode scan succeeds, ensuring both paths are covered.

struct BarcodeTests {

WooCommerce/Classes/POS/Utils/Audio/PointOfSaleSoundPlayer.swift:2

The file uses DDLogError but doesn’t import the logging framework. Please add the appropriate import CocoaLumberjack (or your chosen logger) at the top so DDLogError resolves correctly.

import AVFoundation

WooCommerce/WooCommerceTests/POS/Models/PointOfSaleAggregateModelTests.swift:28

[nitpick] Most existing tests don’t verify sound behavior; since soundPlayer has a default parameter, you can omit injecting it in tests that don’t need to observe playback. This will reduce test boilerplate and maintenance.

soundPlayer: MockPointOfSaleSoundPlayer())

Copilot · 2025-06-13T09:43:23Z

WooCommerce/Classes/POS/Utils/Audio/PointOfSaleSoundPlayer.swift

+            DDLogError("Sound file not found: \(sound.name).\(sound.type)")
+            return
+        }
+        do {


[nitpick] Consider stopping or reusing the existing audioPlayer before creating a new instance to avoid overlapping or resource leakage when sounds are played in rapid succession.

Suggested change

do {

do {

if let currentPlayer = audioPlayer {

currentPlayer.stop()

audioPlayer = nil

}

I tried with this suggestion... but it doesn't really seem to make any difference to how it sounds with lots of rapid failures.

The leak comment is worth thinking about, but I don't really see how it would leak.

It probably doesn't hurt to add this, but I'll leave it up to you @staskus

I think a little bit of optimization makes sense here, especially given that if an item is scanned once, it's likely to be scanned multiple times.

Plus, in an extreme case when we scan multiple wrong items in a row fast, it doesn't make sense to stop the previous sound and start another.

wpmobilebot · 2025-06-13T09:50:23Z

📲 You can test the changes from this Pull Request in WooCommerce iOS Prototype by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce iOS Prototype
	Build Number	`30465`
	Version	`PR #15746`
	Bundle ID	`com.automattic.alpha.woocommerce`
	Commit	`5e43402`
	Installation URL	3bkn3h38vjdig

Automatticians: You can use our internal self-serve MC tool to give yourself access to those builds if needed.

wpmobilebot · 2025-06-13T10:18:36Z

Version 22.6 has now entered code-freeze, so the milestone of this PR has been updated to 22.7.

joshheald

Works well. You could integrate the copilot suggestion if you want.

I've added a credit to the licenses section for the sound.

joshheald · 2025-06-13T12:05:36Z

WooCommerce/WooCommerceTests/POS/Models/PointOfSaleAggregateModelTests.swift

+                                                barcodeScanService: MockPointOfSaleBarcodeScanService(),
+                                                soundPlayer: MockPointOfSaleSoundPlayer())


Keeping iOS16 support is so annoying with this...

joshheald · 2025-06-13T12:11:37Z

WooCommerce/Classes/POS/Utils/Audio/PointOfSaleSoundPlayer.swift

+            DDLogError("Sound file not found: \(sound.name).\(sound.type)")
+            return
+        }
+        do {


I tried with this suggestion... but it doesn't really seem to make any difference to how it sounds with lots of rapid failures.

The leak comment is worth thinking about, but I don't really see how it would leak.

It probably doesn't hurt to add this, but I'll leave it up to you @staskus

…-when-a-barcode-scan-fails

- Use a player cache to reuse a player between the plays - Don't restart the sound it the previous one plays - Use MainActor for safety when accessing player's cache

joshheald · 2025-06-17T17:18:02Z

@staskus I noticed today that we noticably block the main thread when we play the sound, especially the very first time. Perhaps there's a way we can pre-load the sound on another thread to avoid that?

Repro:

Type an unknown barcode in the simulator but don't press the button
Start tapping other items as fast as you can
Tap Scan
Observe that when the error sound plays it stutters in adding items.

It's also noticable with a stop in the shimmer effect if you're not tapping items and just watching the screen.

staskus · 2025-06-17T19:11:21Z

@joshheald thanks for reporting, I'll check

staskus added 3 commits June 13, 2025 11:25

Create PointOfSaleSoundPlayer to play sounds on POS

dc2f079

Play barcode scan failure sound

bdf7ca5

Add a test for barcode scan failure sound

b73d4cd

staskus added this to the 22.6 milestone Jun 13, 2025

staskus requested review from Copilot and joshheald June 13, 2025 09:41

staskus added type: task An internally driven task. feature: POS labels Jun 13, 2025

Copilot AI reviewed Jun 13, 2025

View reviewed changes

wpmobilebot modified the milestones: 22.6, 22.7 Jun 13, 2025

Add credit for sound

60d9bcd

joshheald approved these changes Jun 13, 2025

View reviewed changes

joshheald and others added 3 commits June 13, 2025 13:50

Update woo purple in licenses screen

fb6ea6e

Merge branch 'trunk' into woomob-579-woo-posbarcodes-play-error-sound…

12157cb

…-when-a-barcode-scan-fails

Optimize PointOfSaleSoundPlayer

5e43402

- Use a player cache to reuse a player between the plays - Don't restart the sound it the previous one plays - Use MainActor for safety when accessing player's cache

staskus enabled auto-merge June 16, 2025 12:12

staskus merged commit 5a6eac3 into trunk Jun 16, 2025
13 checks passed

staskus deleted the woomob-579-woo-posbarcodes-play-error-sound-when-a-barcode-scan-fails branch June 16, 2025 12:32

staskus mentioned this pull request Jun 17, 2025

[Woo POS] [Barcodes] Don't block a main thread when playing a sound #15770

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Woo POS] [Barcodes] Play error sound when a barcode scan fails #15746

[Woo POS] [Barcodes] Play error sound when a barcode scan fails #15746

Uh oh!

staskus commented Jun 13, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jun 13, 2025

Uh oh!

joshheald Jun 13, 2025

Uh oh!

staskus Jun 16, 2025 •

edited

Loading

Uh oh!

wpmobilebot commented Jun 13, 2025 •

edited

Loading

Uh oh!

wpmobilebot commented Jun 13, 2025

Uh oh!

joshheald left a comment

Uh oh!

joshheald Jun 13, 2025

Uh oh!

joshheald Jun 13, 2025

Uh oh!

Uh oh!

joshheald commented Jun 17, 2025

Uh oh!

staskus commented Jun 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

-        do {
+        do {
+            if let currentPlayer = audioPlayer {
+                currentPlayer.stop()
+                audioPlayer = nil
+            }

		barcodeScanService: MockPointOfSaleBarcodeScanService(),
		soundPlayer: MockPointOfSaleSoundPlayer())

[Woo POS] [Barcodes] Play error sound when a barcode scan fails #15746

[Woo POS] [Barcodes] Play error sound when a barcode scan fails #15746

Uh oh!

Conversation

staskus commented Jun 13, 2025

Description

Steps to reproduce

Testing information

Screenshots

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

joshheald Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

staskus Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wpmobilebot commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wpmobilebot commented Jun 13, 2025

Uh oh!

joshheald left a comment

Choose a reason for hiding this comment

Uh oh!

joshheald Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

joshheald Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

joshheald commented Jun 17, 2025

Uh oh!

staskus commented Jun 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

staskus Jun 16, 2025 •

edited

Loading

wpmobilebot commented Jun 13, 2025 •

edited

Loading