Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add optional spec field to source and destination definitions #7254

Merged
merged 1 commit into from
Oct 22, 2021
Merged

add optional spec field to source and destination definitions #7254

merged 1 commit into from
Oct 22, 2021

Conversation

lmossman
Copy link
Contributor

@lmossman lmossman commented Oct 21, 2021 •
edited
Loading

What

Addresses issue #7134.
Adds an optional spec field to the StandardSourceDefinition and StandardDestinationDefinition classes in order to allow specs to be stored directly in the database, which in turn will allow us to remove the need to call spec on a connector every time we need the spec, after further changes are made in later PRs.

How

Adds the optional spec field to the source and destination definition JSON schemas, and instantiates this new field in a unit test.

Recommended reading order

  1. airbyte-config/models/src/main/resources/types/StandardDestinationDefinition.yaml
  2. airbyte-config/models/src/main/resources/types/StandardSourceDefinition.yaml
  3. airbyte-server/src/test/java/io/airbyte/server/ConfigDumpImporterTest.java

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • 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.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/SUMMARY.md
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions
  • Connector added to connector index like described here

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
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • 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.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions
  • Connector version bumped like described here

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
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here

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.

lmossman
lmossman commented Oct 21, 2021
View reviewed changes
airbyte-server/src/test/java/io/airbyte/server/ConfigDumpImporterTest.java
@@ -85,7 +85,8 @@ public void setup() throws IOException, JsonValidationException, ConfigNotFoundE
.withDockerRepository("test")
.withDocumentationUrl("http://doc")
.withIcon("hello")
.withDockerImageTag("dev");
.withDockerImageTag("dev")
.withSpec(new ConnectorSpecification());
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wasn't sure which unit test was best to update for this change; I chose this one since it was already instantiating other optional fields in the source and destination definitions.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems reasonable to me!

@lmossman lmossman requested a review from cgardens October 21, 2021 19:44
cgardens
cgardens approved these changes Oct 22, 2021
View reviewed changes
Copy link
Contributor

@cgardens cgardens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great! looks good.

airbyte-server/src/test/java/io/airbyte/server/ConfigDumpImporterTest.java
@@ -85,7 +85,8 @@ public void setup() throws IOException, JsonValidationException, ConfigNotFoundE
.withDockerRepository("test")
.withDocumentationUrl("http://doc")
.withIcon("hello")
.withDockerImageTag("dev");
.withDockerImageTag("dev")
.withSpec(new ConnectorSpecification());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems reasonable to me!

@lmossman lmossman merged commit 077b90e into master Oct 22, 2021
@lmossman lmossman deleted the lmossman/add-spec-to-definitions branch October 22, 2021 21:49
@jrhizor jrhizor mentioned this pull request Oct 25, 2021
Merged
@lmossman lmossman mentioned this pull request Oct 25, 2021
Closed
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
@lmossman @schlattk
add optional spec field to source and destination definitions (airbyt…
8138f7e 
…ehq#7254)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cgardens cgardens cgardens approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lmossman @cgardens