[SSDP 192] Use the schema registry to derive a stream schema in the kafka source #7

albanovito · 2023-06-07T07:28:53Z

##What
Fetch the avro schema from schema registry for each topic and save the schema in the Airbyte Catalog.

##How
In the discovery method call a Schema Registry to fetch the correct schema message with an API Confluent, and after transform it in the Json format and save in the Airbyte Catalog.

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user?

For connector PRs, use this section to explain which type of semantic versioning bump occurs as a result of the changes. Refer to our Semantic Versioning for Connectors guidelines for more information. Breaking changes to connectors must be documented by an Airbyte engineer (PR author, or reviewer for community PRs) by using the Breaking Change Release Playbook.

If there are breaking changes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Actions

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

Community member? Grant edit access to maintainers (instructions)
Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
Connector version is set to 0.0.1
- Dockerfile has version 0.0.1
Documentation updated
- Connector's README.md
- Connector's bootstrap.md. See description and examples
- docs/integrations/<source or destination>/<name>.md including changelog with an entry for the initial version. See changelog example
- docs/integrations/README.md

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.

Updating a connector

Community member or Airbyter

Grant edit access to maintainers (instructions)
Unit & integration tests added

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.

Connector Generator

Issue acceptance criteria met
PR name follows PR naming conventions
If adding a new generator, add it to the list of scaffold modules being tested
The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
Documentation which references the generator is updated as needed

luisvicenteatprima

The tests are pretty comprehensive. But I have two questions;

Have we tested using the schema registry in staging?
Have we tested this with schema registry subjects that have references?

luisvicenteatprima · 2023-06-08T08:12:09Z

...source-kafka/src/main/java/io/airbyte/integrations/source/kafka/format/Avro2JsonConvert.java

+     */
+    private static final Map<String, List<String>> AVRO_TO_JSON_DATA_TYPE_MAPPING = Map.ofEntries(
+            entry("null", List.of("null")),
+            entry("boolean", List.of("boolean", "null")),


Why are they translated to nullable fields? F.i. A boolean field on avro would not accept null as a value unless it's type is [boolean, null] - afaik.

You are right, we can map Avro and Json type one by one, if in Avro there are double options we can set double option in json too.

luisvicenteatprima · 2023-06-08T10:25:45Z

...source-kafka/src/main/java/io/airbyte/integrations/source/kafka/format/Avro2JsonConvert.java

+    }
+
+    public JsonNode convertoToAirbyteJson(String avroSchema) throws Exception {
+        Map<String, Object> mapAvroSchema = mapper.readValue(avroSchema, new TypeReference<>() {


Airbyte provices a helper class that we can use to serialise/deserialise Json - io.airbyte.commons.json.Jsons.

luisvicenteatprima · 2023-06-08T10:27:12Z

...source-kafka/src/main/java/io/airbyte/integrations/source/kafka/format/Avro2JsonConvert.java

+     * @return Map<String, Object> map with Json struct
+     * @throws Exception
+     */
+    public Map<String, Object> convertoToAirbyteJson(Map<String, Object> avroSchema) throws Exception {


For a first version this is fine, but I do wonder if there is a library that provides a AvroSchema class that we could use instead of a Map.

One thing we can do is to extract the different paths to private methods, i.e. one to deal with lists, one with maps (records)

luisvicenteatprima · 2023-06-08T10:29:17Z

...nectors/source-kafka/src/test/java/io/airbyte/integrations/source/kafka/KafkaSourceTest.java

    assertInstanceOf(AvroFormat.class, kafkaFormat);
  }

+//  @Test


Could we remove commented lines?

luisvicenteatprima · 2023-06-08T10:32:28Z

...ctors/source-kafka/src/test/java/io/airbyte/integrations/source/kafka/AvroConverterTest.java

+
+    ObjectMapper mapper = new ObjectMapper();
+
+    String avroSimpleSchema = """


I wonder if we should move all this string literals to resource files to keep the test class a bit tidier.

I agree, it's better. I'll do

albanovito · 2023-06-08T12:54:53Z

The tests are pretty comprehensive. But I have two questions;

Have we tested using the schema registry in staging?

Have we tested this with schema registry subjects that have references?

I used the schema registry in It-Staging environment on Confluent.
I used this topic with both message and schema saved in avro format

luisvicenteatprima · 2023-06-08T13:53:50Z

I don't have permissions for the italian account. But I thought we were going to get rid of that account because it was created just for evaluation purposes. If that schema doesn't have type references, we should do a test with references.

albanovito · 2023-06-08T14:16:45Z

I don't have permissions for the italian account. But I thought we were going to get rid of that account because it was created just for evaluation purposes. If that schema doesn't have type references, we should do a test with references.

Ok, in Italy we have the permission to create topic and token. Can you give me the staging permissions so I can try them?

…rt for state and checkpointing. (#9)

Implement a simply converto to avro in json schema and use it in the discovery method to getch the schema from Confluent Schema Registry

albanovito changed the title ~~[Ssdp 192] Use the schema registry to derive a stream schema in the kafka source~~ [SSDP 192] Use the schema registry to derive a stream schema in the kafka source Jun 7, 2023

albanovito marked this pull request as ready for review June 8, 2023 07:49

albanovito requested a review from a team June 8, 2023 07:50

gpodevijn force-pushed the master branch from cdcc217 to fb15bf5 Compare June 8, 2023 08:10

luisvicenteatprima reviewed Jun 8, 2023

View reviewed changes

gpodevijn force-pushed the master branch from fb15bf5 to 02a592d Compare June 15, 2023 08:49

albanovito force-pushed the SSDP-192/task/use-the-schema-registry-to-derive-a-stream-schema-in-the-kafka-source branch 2 times, most recently from ce55eac to 8c39acb Compare June 21, 2023 07:26

luisvicenteatprima force-pushed the master branch from 67e2903 to aa73cda Compare June 21, 2023 08:25

Refactoring of the source-kafka to simplify testing; and adding suppo…

40a6093

…rt for state and checkpointing. (#9)

luisvicenteatprima force-pushed the master branch from aa73cda to 40a6093 Compare June 21, 2023 08:26

albanovito added 4 commits June 21, 2023 10:58

First commit.

a7bbfad

Implement a simply converto to avro in json schema and use it in the discovery method to getch the schema from Confluent Schema Registry

Fixed bug in Json struct, added javadocs and tests

781f428

added new test and change conversion logic

8ee09e8

fixed type map in Json schema and minor fixes

be7986f

albanovito force-pushed the SSDP-192/task/use-the-schema-registry-to-derive-a-stream-schema-in-the-kafka-source branch from 8c39acb to be7986f Compare June 22, 2023 14:49

albanovito requested review from danielevergara, a team and luisvicenteatprima June 22, 2023 14:57

luisvicenteatprima force-pushed the master branch 3 times, most recently from aae7401 to 069e9af Compare July 4, 2023 10:10

luisvicenteatprima force-pushed the master branch 2 times, most recently from f38d69f to ba32568 Compare July 17, 2023 13:10

danielevergara removed their request for review November 3, 2023 08:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SSDP 192] Use the schema registry to derive a stream schema in the kafka source #7

[SSDP 192] Use the schema registry to derive a stream schema in the kafka source #7

albanovito commented Jun 7, 2023

luisvicenteatprima left a comment

luisvicenteatprima Jun 8, 2023

albanovito Jun 8, 2023

luisvicenteatprima Jun 8, 2023

luisvicenteatprima Jun 8, 2023

luisvicenteatprima Jun 8, 2023

luisvicenteatprima Jun 8, 2023

luisvicenteatprima Jun 8, 2023

albanovito Jun 8, 2023

albanovito commented Jun 8, 2023

luisvicenteatprima commented Jun 8, 2023

albanovito commented Jun 8, 2023


		ObjectMapper mapper = new ObjectMapper();

		String avroSimpleSchema = """

[SSDP 192] Use the schema registry to derive a stream schema in the kafka source #7

Are you sure you want to change the base?

[SSDP 192] Use the schema registry to derive a stream schema in the kafka source #7

Conversation

albanovito commented Jun 7, 2023

Recommended reading order

🚨 User Impact 🚨

Pre-merge Actions

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

luisvicenteatprima left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

albanovito commented Jun 8, 2023

luisvicenteatprima commented Jun 8, 2023

albanovito commented Jun 8, 2023