Debugging the extension

[marekpiotrowski]

Hi there!

Wasn't sure whether I should start a discussion or create an issue, but as it's probably the "operator's" fault and not yours guys, I thought this place is gonna be more appropriate :D

So, I've pretty much set up the SDK with my application which multiplies two integers. Keyboard is there, all nice and shiny, but I wanted to debug one of the callbacks in the examples (https://github.com/FleksySDK/fleksy/blob/main/keyboardsdk-integrations/keyboard-ios/FleksyKeyboardSDKApp/keyboard/KeyboardViewController.swift) (in fact, any of the functions there: dataCollection, onLayoutChanges, viewDidLoad, the create configuration itself as well) through my app. I can see the "schema" mentioned here - https://docs.fleksy.com/sdk-ios/#debug-the-keyboard:

when it asks which app I want to run, I select mine. Does not stop at any of the breakpoints though :( is it too late (when I open my app and select an input field, default keyboard shows up and only then I switch it to Fleksy's keyboard), or I've not enabled something somewhere? I can debug my application just fine, as well as the accompanying library of mine.

An additional smaller question: is this expression from the examples:

        let panelConfig = PanelConfiguration()
        panelConfig.heightTopBar = 50

supposed to change the bar with suggestions? Tried looking through the reference, but there's no crawler/quick search available anyway so was hard to look for info with only such keyword in mind :(

Additionally, maybe it'd be good to have some template for the issues/discussions as well (okay, maybe for the issues is enough :D) - I've got Xcode 14.2, Mac M1 Pro, simulating iPhone 14 Pro, not sure if that's enough for the environment?

Sorry for bothering and have a great day!

Cheers,
Marek

[xevifar]

Hi Marek,

Thanks for your detailed question.

Debugging the keyboard extension is not always straightforward. From your screenshot I think the last step is to select "SampleKeyboard". Once you select the "SampleKeyboard" it will be in the topbar of the Xcode, next to the "iPhone 14 Pro".
This is how this should look like:

Once the "SampleKeyboard" extension is part of the topbar, you should be able to debug the keyboard as you were doing.

Regarding your second point, the PanelConfiguration(), configures the height of the topbar, where the suggestions are displayed.

Thanks for the tip on the template for issues, which will simplify our work.

Happy to help!
Let us know how this works.

Xevi

[marekpiotrowski]

Hey @xevifar , nice thanks for such a quick response.

Yeah so this is exactly what I've been doing, unfortunately. I did select the extension, then it asks through which app I want to debug:

does not stop at any of the breakpoints though. Let me do some more reading about debugging keyboard extensions in general first though, because it might not be related to Fleksy itself but rather Xcode debugging itself.

Apart from that (or maybe it's somehow related?? maybe an out-dated binary being loaded, not sure...), the heightTopBar does not seem to cooperate :D

Cheers,
Marek

[xevifar]

Hi @marekpiotrowski ,
Sorry for the delay on answering you 🙏🏻

To your first point, it is normal that Xcode asks for the "app" where we want to run the keyboard. Select any of the apps, then open the keyboard and you might start debugging at that point.
Have you managed to do that ?

Regarding the second point:
let panelConfig = PanelConfiguration() panelConfig.enableCustomTopBar = true panelConfig.heightTopBar = 300

There is a boolean that enables / disables the height of the topbar configuration. Could you try with this ?

Cheers!
Xevi

[marekpiotrowski]

hi @xevifar, thanks for getting back to me 🙌

so, debugging wasn't that simple. It was a broader problem of extensions debugging - I tried with out-of-the-box keyboard extension first and debugging hadn't worked either. This answer in particular helped me: https://stackoverflow.com/a/27352955/5430833.
This step was critical:

When iOS Simulator starts, go to Settings > General > Keyboard > Keyboards > Add New Keyboard and select your own and then press in your keyboard command + shift + H to back to the homescreen

One more thing was that the KeyboardViewController.swift file was not added to target (and this is by default when adding keyboard extensions in Xcode it seems):

Eventually, it started working:

As for the suggestions bar height, the problem was that the extension hadn't even been loaded correctly before (as per the description above)! Once it loaded, it seems I didn't need to set enableCustomTopBar:

        let panelConfig = PanelConfiguration()
        panelConfig.heightTopBar = 300
        return KeyboardConfiguration(
            panel: panelConfig,
            capture: nil,//capture,
            style: style,
            appearance: appearance,
            typing: typing,
            specialKeys: nil,
            license: licenseConfig,
            debug: debugConfig
        )

Tbh if I had to set enableCustomTopBar, the interface wouldn't be too intuitive - then instead of a property, setter would be more natural, e.g.:

panelConfig.setHeightTopBar(300)  // here, under the hood, setter would set `enableCustomTopBar` to true, as it's kinda implicit at this point

All in all, huge thank you for your help, everything's resolved! If there's anything else, I'll be opening new discussions :)

Cheers,
Marek

[marekpiotrowski]

So, one of the replies within this discussion could be an answer, but I wasn't sure how to mark it as an actual answer:
#27 (reply in thread)