InAppMessagingDisplayMessage shows incorrect type for imageOnly

[fumito-ito]

[REQUIRED] Step 1: Describe your environment

• Xcode version: 12.4
• Firebase SDK version: 7.3.0
• Installation method: Carthage
• Firebase Component: InAppMessaging

[REQUIRED] Step 2: Describe the problem

ImageOnly message shows incorrect message type. It may be a bug of parsing passing data.

Steps to reproduce:

1. add new message as Image Only message at Firebase Console
2. send test message
3. open app with following code

Relevant Code:

class Sample: InAppMessagingDisplay {
    func displayMessage(_ messageForDisplay: InAppMessagingDisplayMessage, displayDelegate: InAppMessagingDisplayDelegate) {
        switch messageForDisplay.type {
        case .banner, .card:
            break
        case .modal:
            print("When set `imageOnly` message at firebase console, message will be received with `modal` type")
        case .imageOnly:
            print("This line will be never called.")
        @unknown default:
            break
        }
    }
}

// at AppDelegate
InAppMessaging.inAppMessaging().messageDisplayComponent = Sample()

[google-oss-bot]

I found a few problems with this issue:

• I couldn't figure out how to label this issue, so I've labeled it for a human to triage. Hang tight.
• This issue does not seem to follow the issue template. Make sure you provide all the required information.

[yakovmanshin]

There’s this issue indeed. I’ve faced it myself, and I think I’ll look into it.

@fumito-ito As a quick fix, you can determine message type by type-casting the messageForDisplay instance, like that:

switch messageForDisplay {
    case let bannerMessage as InAppMessagingBannerDisplay:
        print(bannerMessage)
    case let cardMessage as InAppMessagingCardDisplay:
        print(cardMessage)
    case let imageOnlyMessage as InAppMessagingImageOnlyDisplay:
        print(imageOnlyMessage)
    case let modalMessage as InAppMessagingModalDisplay:
        print(modalMessage)
    default:
        break
}

In fact, that’s the way message type is determined in the original implementation of IAM.

[christibbs]

This is a one-liner fix that will go out with the next release.

Bug is here.

[christibbs]

Thanks for the report @fumito-ito.