Custom providers no longer work

[StrixOSG]

Initial checklist

• I understand this is a bug report and questions should be posted in the Community Forum
• I searched issues and couldn’t find anything (or linked relevant results below)

Link to runnable example

No response

Steps to reproduce

With Companion version > 4.3.0, starting in 4.4.0:

Add a custom provider as documented:

customProviders: {
  myProvider: {
    config: {
      authorize_url: 'my_provider_auth_url',
      access_url: 'my_provider_access_url',
      oauth: 2,
      key: 'my_provider_key',
      secret: 'my_provider_secret',
      scope: ['custom_scope']
    },
    module: MyProviderModule
  },
}

The MyProviderModule based on the example and docs then implements list and download at the minimum, and has static version = 2 and authProvider = 'myProvider'.

Expected behavior

This should be enough to have a working Custom provider on the Companion side and works as of Companion v4.3.0

Actual behavior

In Companion v4.4.0 and above this no longer works and instead complains of null Provider does not support OAuth. I believe this to be a regression or bug with #4330. If you add static authProvider = 'myProvider' it is closer to working, but still fails. This should not be needed either, as it looks like the code for connect and those oAuth callbacks do not need the provider to be an "OAuthProvider". Unless #4330 actually does have breaking changes and there needs to be more work done to update documentation on how Custom Providers should be implemented.

Edit:
I should add that when you do make it static authProvider = 'myProvider'. Then you just get misconfigured provider when trying to auth client side. If you add in another variable that's the same along with it authProvider = 'myProvider' that's non-static then you get Cannot read properties of undefined (reading 'credentialsURL')

[mifi]

If you add in another variable that's the same along with it authProvider = 'myProvider' that's non-static then you get Cannot read properties of undefined (reading 'credentialsURL')

I will fix this bug.

It seems that authProvider in Provider classes has been static for years:

uppy/packages/@uppy/companion/src/server/provider/box/index.js

Line 24 in 970ac8d

static get authProvider () {

So I think that could mean that the documentation was always wrong and we should update it to make sure people use static. I guess the fact that authProvider (without static) used to work was a bug (?)

I should add that when you do make it static authProvider = 'myProvider'. Then you just get misconfigured provider when trying to auth client side.

What do you mean exactly by this? Is a misconfigured provider an error message you're getting? I can't find any reference to that error anywhere in the code.

[StrixOSG]

Thanks! This may fix the issues, but it is an error message I get. I believe this is where it's referenced in the code: https://github.com/transloadit/uppy-server/blob/58948e83de26246903390ea1c1a7271a12091437/src/uppy.js#L171

[mifi]

have you remembered to configure your custom provider's grant config? Looking at your code, this doesn't seem to be a valid configuration:

      authorize_url: 'my_provider_auth_url',
      access_url: 'my_provider_access_url',
      oauth: 2,
      key: 'my_provider_key',
      secret: 'my_provider_secret',
      scope: ['custom_scope']

[StrixOSG]

It's possible that I could be missing something, but I think this is how the documentation states to set it up, and it is working correctly with the code you have there for me with the previous companion version. I don't have anything else other than the code I have posted and it works

[mifi]

Ok, gotcha. companion uses grant to handle authentication so i thought maybe it was grant throwing the error. will have to do some more digging

[netdown]

@mifi I have also experienced the misconfigured provider error with the latest version. It seems that besides the static authProvider property, the instance must also be populated with an authProvider property.

static get authProvider() { return 'myprovider' }
constructor(options) { this.authProvider = MyProvider.authProvider }

[StrixOSG]

Thanks for this upcoming fix! I can confirm that @netdown's solution worked for me. In my case I didn't need the constructor, but my code is as follows and appears to be working now for Uppy Companion v4.10.1:

    authProvider = MyCustomProvider.authProvider;
    static get authProvider() { return 'myCustomProvider' };