Skip to content

De-duplicate config parameters #14781

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
Merged
merged 16 commits into from
Jul 21, 2022
Merged

De-duplicate config parameters #14781

merged 16 commits into from
Jul 21, 2022

Conversation

ryankfu
Copy link
Contributor

@ryankfu ryankfu commented Jul 16, 2022 •
edited
Loading

What

De-duplicating and consolidating config parameters to be referenced only from JdbcUtils.java. Currently there are several files that are using constants of the same string so this change will help to move all those constants in a single file accessible by all JDBC connections. Original Github Issue: #14698

How

Refactor most of the JDBC connections to move ssl, jdbc_url, host, post, password, username, schema, schemas, etc config parameters to be placed in JdbcUtils.java

Recommended reading order:

Each of these files have overlapping config parameter constants that are consolidated into JdbcUtils.java

  1. JdbcUtils.java
  2. ClickhouseDestination.java
  3. MariadbColumnstoreDestination.java
  4. MongodbDestinationStrictEncryptAcceptanceTest.java
  5. MongodbDestination.java
  6. MongodbDestinationAcceptanceTest.java
  7. MSSQLDestination.java
  8. MySQLDestination.java
  9. SshMySQLDestinationAcceptanceTest.java
  10. OracleDestination.java
  11. PostgresDestination.java
  12. RedshiftInsertDestination.java
  13. RedshiftStagingS3Destination.java
  14. CockroachDbSource.java
  15. Db2Source.java
  16. Db2SourceAcceptanceTest.java
  17. MongoDbSource.java
  18. MssqlSource.java
  19. RedshiftSource.java

🚨 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.

There are no breaking changes, it is mainly a refactor to keep the diverging constants for JDBC config parameters centralized in one file that can be referenced across Source and Destination connectors

NOTE: there seems to be an inconsistency with the naming of our connectors (e.g. MssqlSource.java vs MSSQLDestination.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/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.

@ryankfu ryankfu requested a review from a team as a code owner July 16, 2022 21:43
@ryankfu ryankfu temporarily deployed to more-secrets July 19, 2022 22:52 Inactive
@ryankfu
Copy link
Contributor Author

ryankfu commented Jul 20, 2022

For all the failed integration tests, tested on the master branch to confirm if these failures were already existing and here are the runs that failed on master branch to showcase the changes in this PR are not the cause of the failures:

@ryankfu ryankfu force-pushed the ryan/deduplicate-config-parameters branch from 80f7919 to c2bf6cd Compare July 20, 2022 18:50
@ryankfu ryankfu temporarily deployed to more-secrets July 20, 2022 18:53 Inactive
@ryankfu
Copy link
Contributor Author

ryankfu commented Jul 20, 2022

Created github issues for each of the failures for GL to take a further look into:

ryankfu added 16 commits July 21, 2022 09:47
@ryankfu
Migrated 'ssl' string to become a constant in JdbcUtils
cc5489a
@ryankfu
Migrated 'database' string to become a constant in JdbcUtils
a1a5324
@ryankfu
Migrated 'username' string to become a constant in JdbcUtils
49ce4eb
@ryankfu
Migrated 'password' string to become a constant in JdbcUtils
82d82fc
@ryankfu
Migrated 'schema' string to become a constant in JdbcUtils and update…
23a6768 
…d corresponding config params
@ryankfu
Migrated 'jdbc_url' string to become a constant in JdbcUtils
67c0ef2
@ryankfu
Migrated 'connection_properties' string to become a constant in JdbcU…
6a325ad 
…tils
@ryankfu
Migrated list of 'host_key' string to become a constant in JdbcUtils
15d88b1
@ryankfu
Migrated list of 'port_key' string to become a constant in JdbcUtils
fad4651
@ryankfu
Migrated 'host_key' string to become a constant in JdbcUtils and upda…
da005ff 
…ted corresponding config params
@ryankfu
Migrated 'port_key' string to become a constant in JdbcUtils
968cfd9
@ryankfu
Migrated 'tls' string to become a constant in JdbcUtils
3325b95
@ryankfu
Migrated 'schemas' string to become a constant in JdbcUtils
6abb95b
@ryankfu
Migrated 'encryption' string to become a constant in JdbcUtils
bbc3117
@ryankfu
Migrated 'jdbc_url_params' string to become a constant in JdbcUtils a…
f77bf0e 
…nd fixed uncaught parenthesis
@ryankfu
Fixed linter issues with comments on AcceptanceTest and failed import…
3fa68e8 
… statement
@ryankfu ryankfu force-pushed the ryan/deduplicate-config-parameters branch from c2bf6cd to 3fa68e8 Compare July 21, 2022 17:39
@ryankfu ryankfu temporarily deployed to more-secrets July 21, 2022 17:41 Inactive
@grishick grishick self-requested a review July 21, 2022 22:55
@ryankfu ryankfu merged commit 063b01f into master Jul 21, 2022
@ryankfu ryankfu deleted the ryan/deduplicate-config-parameters branch July 21, 2022 23:05
@ryankfu ryankfu mentioned this pull request Jul 21, 2022
Closed
@octavia-squidington-iii octavia-squidington-iii mentioned this pull request Jul 23, 2022
Merged
@terencecho terencecho mentioned this pull request Aug 8, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@grishick grishick grishick approved these changes

Assignees
No one assigned
Labels
area/connectors Connector related issues area/platform issues related to the platform area/server connectors/destination/clickhouse connectors/destination/clickhouse-strict-encrypt connectors/destination/jdbc connectors/destination/mariadb-columnstore connectors/destination/mongodb connectors/destination/mongodb-strict-encrypt connectors/destination/mssql connectors/destination/mssql-strict-encrypt connectors/destination/mysql connectors/destination/mysql-strict-encrypt connectors/destination/oracle connectors/destination/oracle-strict-encrypt connectors/destination/postgres connectors/destination/postgres-strict-encrypt connectors/destination/redshift connectors/destination/snowflake connectors/source/clickhouse connectors/source/clickhouse-strict-encrypt connectors/source/cockroachdb connectors/source/cockroachdb-strict-encrypt connectors/source/db2 connectors/source/jdbc connectors/source/mongodb-strict-encrypt connectors/source/mongodb-v2 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/scaffold-java-jdbc connectors/source/snowflake connectors/source/tidb
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ryankfu @grishick @octavia-squidington-iii