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

Remove additionalProperties from JDBC source connectors #14574

Merged
merged 38 commits into from
Jul 21, 2022
Merged

Remove additionalProperties from JDBC source connectors #14574

merged 38 commits into from
Jul 21, 2022

Conversation

VitaliiMaltsev
Copy link
Contributor

@VitaliiMaltsev VitaliiMaltsev commented Jul 11, 2022 •
edited
Loading

What

As discovered in https://github.com/airbytehq/oncall/issues/289, a spec declaring "additionalProperties": false introduces the risk of accidental breaking changes. Specifically, when removing a property from the spec, existing connector configs will no longer be valid.

To make these upgrades/rollbacks smoother, we need to remove additionalProperties from connectors affected by these changes.

How

Remove additionalProperties: false

Recommended reading order

  1. x.java
  2. y.python

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

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/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

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.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as 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

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.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub and connector version bumped 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

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

@github-actions github-actions bot added the area/connectors Connector related issues label Jul 11, 2022
@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Jul 11, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-bigquery

🕑 connectors/source-bigquery https://github.com/airbytehq/airbyte/actions/runs/2649764436
✅ connectors/source-bigquery https://github.com/airbytehq/airbyte/actions/runs/2649764436
No Python unittests run

Build Passed

Test summary info:

All Passed

@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Jul 11, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-clickhouse

🕑 connectors/source-clickhouse https://github.com/airbytehq/airbyte/actions/runs/2649768744
✅ connectors/source-clickhouse https://github.com/airbytehq/airbyte/actions/runs/2649768744
No Python unittests run

Build Passed

Test summary info:

All Passed

@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Jul 11, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-clickhouse-strict-encrypt

🕑 connectors/source-clickhouse-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2649769815
✅ connectors/source-clickhouse-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2649769815
No Python unittests run

Build Passed

Test summary info:

All Passed

@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Jul 11, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-cockroachdb-strict-encrypt

🕑 connectors/source-cockroachdb-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2649776208
✅ connectors/source-cockroachdb-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2649776208
No Python unittests run

Build Passed

Test summary info:

All Passed

@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Jul 11, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-db2-strict-encrypt

🕑 connectors/source-db2-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2649779121
✅ connectors/source-db2-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2649779121
No Python unittests run

Build Passed

Test summary info:

All Passed

@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Jul 11, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-mssql-strict-encrypt

🕑 connectors/source-mssql-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2649781487
✅ connectors/source-mssql-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2649781487
No Python unittests run

Build Passed

Test summary info:

All Passed

@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Jul 11, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-mssql

🕑 connectors/source-mssql https://github.com/airbytehq/airbyte/actions/runs/2649782709
✅ connectors/source-mssql https://github.com/airbytehq/airbyte/actions/runs/2649782709
No Python unittests run

Build Passed

Test summary info:

All Passed

@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Jul 11, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-mysql-strict-encrypt

🕑 connectors/source-mysql-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2649785001
✅ connectors/source-mysql-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2649785001
No Python unittests run

Build Passed

Test summary info:

All Passed

@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Jul 11, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-mysql

🕑 connectors/source-mysql https://github.com/airbytehq/airbyte/actions/runs/2649786115
✅ connectors/source-mysql https://github.com/airbytehq/airbyte/actions/runs/2649786115
No Python unittests run

Build Passed

Test summary info:

All Passed

@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Jul 11, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-oracle-strict-encrypt

🕑 connectors/source-oracle-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2649787807
❌ connectors/source-oracle-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2649787807
🐛 https://gradle.com/s/yxzagcj5albqc

Build Failed

Test summary info:

Could not find result summary

@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets July 20, 2022 08:01 Inactive
@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets July 20, 2022 08:28 Inactive
@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Jul 20, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-oracle

🕑 connectors/source-oracle https://github.com/airbytehq/airbyte/actions/runs/2704177602
❌ connectors/source-oracle https://github.com/airbytehq/airbyte/actions/runs/2704177602
🐛 https://gradle.com/s/ck4seeokvxqnk

Build Failed

Test summary info:

Could not find result summary

@VitaliiMaltsev VitaliiMaltsev linked an issue Jul 20, 2022 that may be closed by this pull request
Fix integration tests source-cockroachdb Mac OS #13540
Closed
@VitaliiMaltsev
fixed OracleSourceDatatypeTest
6cb34bf
@VitaliiMaltsev
Merge remote-tracking branch 'origin/vmaltsev/14549-remove-additional…
2d2a9e7 
…-properties-source' into vmaltsev/14549-remove-additional-properties-source
@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Jul 20, 2022 •
edited by github-actions bot
Loading

/publish connector=connectors/source-oracle

🕑 Publishing the following connectors:
connectors/source-oracle
https://github.com/airbytehq/airbyte/actions/runs/2705084472


Connector Did it publish? Were definitions generated?
connectors/source-oracle ✅ ✅

if you have connectors that successfully published but failed definition generation, follow step 4 here ▶️

@VitaliiMaltsev VitaliiMaltsev temporarily deployed to more-secrets July 20, 2022 13:33 Inactive
@grishick
Copy link
Contributor

grishick commented Jul 20, 2022 •
edited
Loading

This can be merged after a rebase

@grishick
Copy link
Contributor

@VitaliiMaltsev please file separate issues for fixing the broke integration tests (the ones that are failing on this PR) and then you can merge this PR.

@VitaliiMaltsev VitaliiMaltsev temporarily deployed to more-secrets July 21, 2022 07:57 Inactive
@VitaliiMaltsev
Copy link
Contributor Author

@grishick I published all connectors except clickhouse-source and clickhouse-source-strict-encrypt because integration tests are broken there. The publishing of these connectors will be part of this PR

@VitaliiMaltsev VitaliiMaltsev merged commit df44571 into master Jul 21, 2022
@VitaliiMaltsev VitaliiMaltsev deleted the vmaltsev/14549-remove-additional-properties-source branch July 21, 2022 08:01
This was referenced Jul 21, 2022
Merged
Closed
Closed
mfsiega-airbyte pushed a commit that referenced this pull request Jul 21, 2022
@VitaliiMaltsev @octavia-squidington-iii @mfsiega-airbyte
Remove additionalProperties from JDBC source connectors (#14574)
cfb2493 
* Remove additional properties from JDBC specs

* fixed SnowflakeSourceAuthAcceptanceTest

* fixed OracleStrictEncryptJdbcSourceAcceptanceTest

* fixed Oracle Strict encrypt expected spec

* updated Changelog

* fixed CockroachDbSourceTest

* fixed CockroachDb Tests

* fixed CockroachDb Tests for Linux OS

* bump versions

* bump clickhouse-source-strict-encrypt

* auto-bump connector version [ci skip]

* auto-bump connector version [ci skip]

* auto-bump connector version [ci skip]

* auto-bump connector version [ci skip]

* auto-bump connector version [ci skip]

* fixed dependencies for Clickhouse Source

* auto-bump connector version [ci skip]

* auto-bump connector version [ci skip]

* auto-bump connector version [ci skip]

* fixed OracleSourceDatatypeTest

* auto-bump connector version [ci skip]

* rollback ClickHouse Source changelog

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
@octavia-squidington-iii octavia-squidington-iii mentioned this pull request Jul 23, 2022
Merged
This was referenced Jul 25, 2022
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sashaNeshcheret sashaNeshcheret sashaNeshcheret approved these changes

@alexandr-shegeda alexandr-shegeda alexandr-shegeda approved these changes

@tuliren tuliren tuliren approved these changes

@grishick grishick grishick approved these changes

@etsybaev etsybaev Awaiting requested review from etsybaev

Assignees
No one assigned
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation connectors/source/bigquery connectors/source/clickhouse connectors/source/clickhouse-strict-encrypt connectors/source/cockroachdb connectors/source/cockroachdb-strict-encrypt connectors/source/db2-strict-encrypt connectors/source/db2 connectors/source/jdbc connectors/source/mssql connectors/source/mssql-strict-encrypt connectors/source/mysql connectors/source/mysql-strict-encrypt connectors/source/oracle connectors/source/oracle-strict-encrypt connectors/source/postgres connectors/source/postgres-strict-encrypt connectors/source/redshift connectors/source/snowflake
Projects
None yet
Milestone
No milestone
6 participants
@VitaliiMaltsev @grishick @tuliren @alexandr-shegeda @sashaNeshcheret @octavia-squidington-iii