AttributeError: 'AuthenticatorConverterRegistry' object has no attribute 'get_security_schemes_legacy'

[mattcarp12]

I have a custom authenticator that works, but I am trying to get the swagger docs to work as well but I keep getting the above exception.

Here is my custom authenticator:

class CustomAuthenticator(authenticators.Authenticator):
    def authenticate(self):
        if current_user and current_user.is_authenticated:
            pass
        elif current_app.config["AUTH_OFF"]:
            try:
                login_user(default_user)
            except AttributeError:
                raise ValueError("Trying to log into user that doesn't exist!")

This part I took directly from the flask_rebar docs:

class SwaggerAuthConverter(AuthenticatorConverter):
    AUTHENTICATOR_TYPE = CustomAuthenticator

    def get_security_schemes(self, obj, context):
        return {
            obj.name: {sw.type_: sw.api_key, sw.in_: sw.header, sw.name: obj.header}
        }

    def get_security_requirements(self, obj, context):
        return [{obj.name: []}]


custom_auth_registry = AuthenticatorConverterRegistry()
custom_auth_registry.register_type(SwaggerAuthConverter())

Finally, this is where I set up the app:

rebar = Rebar()
swagger_generator = SwaggerV2Generator(authenticator_converter_registry=custom_auth_registry)
registry = rebar.create_handler_registry(swagger_generator=swagger_generator)
registry.set_default_authenticator(CustomAuthenticator)

Here is the full backtrace:

127.0.0.1 - - [04/Nov/2021 09:33:13] "GET /swagger HTTP/1.0" 500 -
Traceback (most recent call last):
  File "/home/canopy/canopy/venv/lib/python3.6/site-packages/flask/app.py", line 2464, in __call__
    return self.wsgi_app(environ, start_response)
  File "/home/canopy/canopy/venv/lib/python3.6/site-packages/flask/app.py", line 2450, in wsgi_app
    response = self.handle_exception(e)
  File "/home/canopy/canopy/venv/lib/python3.6/site-packages/flask/app.py", line 1867, in handle_exception
    reraise(exc_type, exc_value, tb)
  File "/home/canopy/canopy/venv/lib/python3.6/site-packages/flask/_compat.py", line 39, in reraise
    raise value
  File "/home/canopy/canopy/venv/lib/python3.6/site-packages/flask/app.py", line 2447, in wsgi_app
    response = self.full_dispatch_request()
  File "/home/canopy/canopy/venv/lib/python3.6/site-packages/flask/app.py", line 1952, in full_dispatch_request
    rv = self.handle_user_exception(e)
  File "/home/canopy/canopy/venv/lib/python3.6/site-packages/flask/app.py", line 1822, in handle_user_exception
    return handler(e)
  File "/home/canopy/canopy/venv/lib/python3.6/site-packages/flask_rebar/rebar.py", line 831, in handle_generic_error
    raise error
  File "/home/canopy/canopy/venv/lib/python3.6/site-packages/flask/app.py", line 1950, in full_dispatch_request
    rv = self.dispatch_request()
  File "/home/canopy/canopy/venv/lib/python3.6/site-packages/flask/app.py", line 1936, in dispatch_request
    return self.view_functions[rule.endpoint](**req.view_args)
  File "/home/canopy/canopy/venv/lib/python3.6/site-packages/flask_rebar/rebar.py", line 612, in get_swagger
    registry=self, host=request.host_url.rstrip("/")
  File "/home/canopy/canopy/venv/lib/python3.6/site-packages/flask_rebar/swagger_generation/swagger_generator_v2.py", line 100, in generate_swagger
    return self.generate(registry=registry, host=host)
  File "/home/canopy/canopy/venv/lib/python3.6/site-packages/flask_rebar/swagger_generation/swagger_generator_v2.py", line 131, in generate
    self.authenticator_converter.get_security_schemes(authenticator)
  File "/home/canopy/canopy/venv/lib/python3.6/site-packages/flask_rebar/swagger_generation/authenticator_to_swagger.py", line 168, in get_security_schemes
    return self.get_security_schemes_legacy(registry=authenticator)
AttributeError: 'AuthenticatorConverterRegistry' object has no attribute 'get_security_schemes_legacy'

[barakalon]

This certainly looks like a bug.

I'm not sure what get_security_schemes_legacy is.

https://github.com/plangrid/flask-rebar/blob/master/flask_rebar/swagger_generation/authenticator_to_swagger.py#L166

I'm not sure how that was ever supposed to work. @airstandley - do you know what's going on here?

[airstandley]

Seems like a bug to me. It was original a legacy method marked for deprecation

flask-rebar/flask_rebar/swagger_generation/authenticator_to_swagger.py

Line 203 in 69d378c

def get_security_schemes_legacy(self, registry):

[airstandley]

Definitely a bug. We missed removing those lines in #216 😭

[airstandley]

🤔 I think this might also be an instance vs class issue.
@mattcarp12 Do you still get an error with

rebar = Rebar()
swagger_generator = SwaggerV2Generator(authenticator_converter_registry=custom_auth_registry)
registry = rebar.create_handler_registry(swagger_generator=swagger_generator)
registry.set_default_authenticator(CustomAuthenticator())

[mattcarp12]

@airstandley Thank you for your help with this.

I did get your above code to work. However I needed to add name and header attributes to my CustomAuthenticator class, since I am inheriting from the base class that does not include those.