JwtAuthenticator in no-code builder

[rohrit]

Hi,

I am trying to configure a source that uses JWT authentication. To do so, I followed the steps below

1. Created the source using the UI Builder without any authentication included.
2. Switched to the YAML version using the UI/YAML radio toggle.
3. Added the JWT Authentication section to the YAML specification

authenticator:
    type: JwtAuthenticator
    algorithm: HS256
    secret_key: "{{ config['app_secret'] }}"
    jwt_payload:
      iss: http://foo.com
      sub: "{{ config['app_id'] }}"
      tid: "{{ config['tenant_id'] }}"
    header_prefix: Bearer
    token_duration: 3600
    token_refresh_endpoint: https://foo.com/auth/v2/token
    base64_encode_secret_key: true

4. Observed following error below

Traceback (most recent call last):
  File "/home/airbyte/.pyenv/versions/3.10.14/lib/python3.10/site-packages/airbyte_cdk/sources/declarative/manifest_declarative_source.py", line 192, in _validate_source
    validate(self._source_config, declarative_component_schema)
  File "/home/airbyte/.pyenv/versions/3.10.14/lib/python3.10/site-packages/jsonschema/validators.py", line 934, in validate
    raise error
jsonschema.exceptions.ValidationError: 'JwtAuthenticator' is not one of ['ApiKeyAuthenticator']

Failed validating 'enum' in schema[0]['properties']['type']:
    {'enum': ['ApiKeyAuthenticator'], 'type': 'string'}

On instance['type']:
    'JwtAuthenticator'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/airbyte/.pyenv/versions/3.10.14/lib/python3.10/site-packages/airbyte_cdk/connector_builder/main.py", line 82, in <module>
    print(handle_request(sys.argv[1:]))
  File "/home/airbyte/.pyenv/versions/3.10.14/lib/python3.10/site-packages/airbyte_cdk/connector_builder/main.py", line 76, in handle_request
    source = create_source(config, limits)
  File "/home/airbyte/.pyenv/versions/3.10.14/lib/python3.10/site-packages/airbyte_cdk/connector_builder/connector_builder_handler.py", line 45, in create_source
    return ManifestDeclarativeSource(
  File "/home/airbyte/.pyenv/versions/3.10.14/lib/python3.10/site-packages/airbyte_cdk/sources/declarative/manifest_declarative_source.py", line 68, in __init__
    self._validate_source()
  File "/home/airbyte/.pyenv/versions/3.10.14/lib/python3.10/site-packages/airbyte_cdk/sources/declarative/manifest_declarative_source.py", line 194, in _validate_source
    raise ValidationError("Validation against json schema defined in declarative_component_schema.yaml schema failed") from e
jsonschema.exceptions.ValidationError: Validation against json schema defined in declarative_component_schema.yaml schema failed

Any ideas as to why the error is thrown?

[natikgadzhi]

Hey, thanks for raising this! @pnilan built the JWTAuthenticator itself, but we haven't made the UI for it yet.

If you're editing yaml and it fails validations, it could be either:

• you're pasting the block in the wrong section.
• there's a bug in the actual implementation, or a regression that we didn't catch. That's also likely, I don't think we have any connectors using JWT auth.

To debug this, if you'd like us to take a look:

1. Make a builder connector in Airbyte Cloud. If you're using Airbyte OSS, signup for the cloud trial and make a connector there.
2. Setup your API credentials as testing values. Make sure you're comfortable with me seeing whatever data your API provides for testing purposes. As in, please don't share highly sensitive data and don't break NDAs.
3. Give me your cloud builder project URL. With your explicit ask and consent I can take a look at it, and try to debug it.

I would love to make the UI for it to make things easier, but we just haven't had the capacity yet.

[rohrit]

Hi @natikgadzhi ,

Thank you for your reply! I would not be able to share that particular connector's configuration since it is under NDA.

However, I can share a test configuration which was modelled on the real one. I started with OauthAuthentication for the connector, switched to JwtAuthenticator in the same block and started observing the error. I am pasting the entire YAML spec below in the hope that you can reproduce the issue based on this since it shows up in the builder phase itself. Is this something that would work for you?

version: 5.7.5

type: DeclarativeSource

check:
  type: CheckStream
  stream_names:
    - Test

definitions:
  streams:
    Test:
      type: DeclarativeStream
      name: Test
      retriever:
        type: SimpleRetriever
        requester:
          $ref: "#/definitions/base_requester"
          path: /test
          http_method: GET
        record_selector:
          type: RecordSelector
          extractor:
            type: DpathExtractor
            field_path: []
      schema_loader:
        type: InlineSchemaLoader
        schema:
          $ref: "#/schemas/Test"
  base_requester:
    type: HttpRequester
    url_base: https://www.foo.com
    authenticator:
      type: JwtAuthenticator
      algorithm: HS256
      secret_key: "{{ config['app_secret'] }}"
      jwt_payload:
        iss: http://foo.com
        sub: "{{ config['app_id'] }}"
        tid: "{{ config['tenant_id'] }}"
      header_prefix: Bearer
      token_duration: 3600
      token_refresh_endpoint: https://foo.com/auth/v2/token
      base64_encode_secret_key: true

streams:
  - $ref: "#/definitions/streams/Test"

spec:
  type: Spec
  connection_specification:
    type: object
    $schema: http://json-schema.org/draft-07/schema#
    required:
      - app_id
      - tenant_id
    properties:
      app_id:
        type: string
        title: App ID
        airbyte_secret: false
        order: 0
      tenant_id:
        type: string
        title: Tenant ID
        airbyte_secret: false
        order: 1
    additionalProperties: true

metadata:
  autoImportSchema:
    Test: true
  testedStreams:
    Test:
      streamHash: null
  assist: {}

schemas:
  Test:
    type: object
    $schema: http://json-schema.org/draft-07/schema#
    additionalProperties: true
    properties: {}