Help with Settings Modal

tankerkiller125

I've been working on writing a custom Oauth2 provider extension for Flarum for a couple days now. The extension itself seems to work great when it comes to the authentication and what not but unfortunately, it seems that I can't get the settings modal that you get with say GitHub or twitter to appear. From my understanding, this is a JS problem. The extension git URL can be found here (the extension is a modification of the GitHub extension)

It would be greatly appreciated if anyone could point me in the right direction with this. I might also add that manually adding the settings to the database does work!

luceos

Do you get any errors in your console of your browser? That often helps identifying the underlying issue. Also make sure you generate the latest dist file using gulp.

tankerkiller125

luceos It does not appear to generate any errors in the console. And there are no errors in the IDE either. The only thing I really changed from the GitHub extension is the names.

luceos

I'm taking a look right now. Feel free to chat me op on gitter

TitusPiJean

Hi !

I'm developping a LDAP login extension. So far it "works" by hardcoding all inputs, but I'd like to use the SettingsModal to store parameters.
My problem seems to fit @tankerkiller125's description : the dropdown button to make the SettingsModal appear doesn't show up, with no error on console.

Were you able to debug it with @luceos ?

tankerkiller125

TitusPiJean unfortunately not. And I've spent several hours redoing it and still not working. So I'm not sure what the issue seems to be.

TitusPiJean

tankerkiller125
What a shame ! I will keep you posted if solve it.
Meanwhile, if anyone can have a look at our issues, that would be great ! ?

luceos

I've looked at the repository a few times, but can't really spot the mistake ?

TitusPiJean

luceos Thank you for trying anyway ! ?

TitusPiJean

I might have a lead.

If I shamelessly copy the flarum-ext-auth-github repo into the workbench, rename the folder into flarum-ext-auth-test, and the package name in composer.json into test/test, no SettingsModal appears on the extension tile. However, the extension is still functional (at least the Github login page loads, I have not tested further).

This leads me to ask : are there requirements between the name of the extension and the variables used in JS ?

tankerkiller125

TitusPiJean if you take a closer look you'll find that the settings window is available however under the Github extension. Even with the Github extension disabled. This is because it thinks that it's still attached to the Github one.

TitusPiJean

tankerkiller125
Not in my case, I completely removed the original Github extension ! ?

tankerkiller125

TitusPiJean Ah. Then that is an interesting question.

TitusPiJean

A quick followup : I've circumvented the issue by creating a Settings Pane instead of a Settings Modal. This one appeared as expected.

TitusPiJean

One year later, I have just found out what was the problem.
The initializer cannot be something else than what Flarum's core calls it in the database.

For an extension designated as tituspijean/flarum-ext-auth-ldap in composer, its name is shortened into tituspijean-auth-ldap in the database. It's this last name that has to be used in the JS.

What is the naming convention internally ? Is it vendor- followed by at most the last two words in the extension name ?

luceos

TitusPiJean flarum- and flarum-ext- are removed from the package name. I should have known back then ?

Staszek

TitusPiJean
luceos
Thanks for sharing this. I've just spend a few hours fighting that. It should totally be in the documentation 🙁

TitusPiJean

luceos I guess that can make sense. Is it stated somewhere in the documentation?

luceos

TitusPiJean nope. However compared to back then, it's one of the things Ive become to verify as one of the first things ?