Debug your app with Shopify App Bridge

The development version of Shopify App Bridge adds a validation system that throws informative, Typescript-like errors.

Creating a Toast with the following options is invalid:

If you tried to create a Toast with the example above, then the development version of App Bridge would throw the following error:

As you can see, the Toast action set expects the duration option to be an integer, but the value in the example is a string.

Without the development version’s validation system, Shopify App Bridge will not throw errors for invalid options.

If you’re importing Shopify App Bridge by using ES modules, then add NODE_ENV=development to your build tooling configuration.

You can also use the development version without modifying your NODE_ENV variable by importing createApp from the development subdirectory:

If you’re loading Shopify App Bridge from a CDN like Unpkg, or consuming the UMD build from NPM, then append .development to the file name:

• Original URL — https://unpkg.com/@shopify/app-bridge@2/umd/index.js

• Development URL — https://unpkg.com/@shopify/app-bridge@2/umd/index.development.js

1. Follow the instructions to install Redux DevTools in your browser. The following examples are based on using Google Chrome, but similar steps apply for Firefox.
2. Open your app in a development store.
3. Open the Redux DevTools.

From the Inspector tab in Redux DevTools, select the App Bridge instance. You should see a list of all dispatched App Bridge actions on the left-hand side.

Click on an action in the list to get more information about that action.

After you select an action, click the Action tab to get more information about the action's payload.

After you select an action, click the State tab to see the state of the Shopify App Bridge data store after the action was dispatched. Your app state is contained in the appBridge.store property. You can click (pin) next to appBridge.store to bookmark this property so you can quickly review the state. The information shown here is identical to what you get when calling app.getState locally on your app.

After you select an action, click the Diff tab to see the difference between your app state after the action was dispatched. In the following example, a LOADING::CLEAR action was dispatched to set the loading state to false:

In Redux DevTools, click the clock icon to open the playback controller. This lets you step backward and forward through actions, and replay them in sequence.

Redux DevTools allows you to manually dispatch actions directly on the store.

Click the keyboard icon to open the dispatcher. This lets you quickly debug without using any code. Each action must contain the following properties: type, group, and version. The payload property is optional, depending on the action being dispatched.

Shopify App Bridge automatically fills out the required values for you when dispatching actions through an app. When using the DevTools to dispatch, you must supply the required values yourself.

Here is an example of a show Toast action:

You can paste the above directly inside the dispatcher and press Dispatch to submit the action:

Requirements:

1. A Mac running MacOS

2. An iOS device plugged into the Mac

By default, MacOS includes the Console app in your Utilities folder. To open the app:

1. Open a new Finder window
2. Navigate to Applications > Utilities
3. Double-click on Console.

You can also open the Console app by activating Spotlight and searching for "Console".

A few steps are required to have your debug messages show up in the Console app.

1. Select your iOS device on the left hand panel.
2. Enter App Bridge Debugging in the search box on the top panel.

All console messages from your App Bridge application will be shown in the list. If you want to see more information, such as the full payload of the message, tapping on the list item will bring up all additional information on the bottom panel.

To debug an App Bridge app on an Android device, you'll need the following resources:

• An Android device
• A Partner development store
• A desktop computer with the Google Chrome browser installed

1. On the Shopify mobile app, log in to a Partner development store.
2. Connect to the Android device to the desktop computer.
3. In Google Chrome on desktop, open chrome://inspect. The embedded app's WebView should be in the list of devices.
4. Click Inspect for the WebView of your embedded app.

The debugging is enabled by default when you log in to a partner development store in Shopify POS. You can open chrome://inspect to inspect the WebView.