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.

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

Fix connector harness performance ci run #31304

Merged
merged 28 commits into from
Oct 13, 2023
Merged

Conversation

xiaohansong
Copy link
Contributor

@xiaohansong xiaohansong commented Oct 11, 2023

What

#29334 Fix connector harness performance ci run

Run result:
https://github.com/airbytehq/airbyte/actions/runs/6501560655/job/17659126699 (Postgres)
https://github.com/airbytehq/airbyte/actions/runs/6498858797 (MySQL)

How

A few bugs fixed:

  • pipx ensurepath cannot update path; thus /root/.local/bin has to be added manually
  • missing env var for GCP_CREDENTIAL
  • Updated secrets for postgres harness on GCP (Not in this PR)
  • Updated catalog to reflect current schema

a few improvements:

  • Make available testing connectors as a choice to avoid unnecessary typos
  • Skip comment part if running from 'Action'
  • Support running on a branch other than master (we need to pull branch and master because airbyte-ci has a step to run git diff)

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?

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:generateScaffolds then checking in your changes
  • Documentation which references the generator is updated as needed
Updating the Python CDK

Airbyter

Before merging:

  • Pull Request description explains what problem it is solving
  • Code change is unit tested
  • Build and my-py check pass
  • Smoke test the change on at least one affected connector
    • On Github: Run this workflow, passing --use-local-cdk --name=source-<connector> as options
    • Locally: airbyte-ci connectors --use-local-cdk --name=source-<connector> test
  • PR is reviewed and approved

After merging:

  • Publish the CDK
    • The CDK does not follow proper semantic versioning. Choose minor if this the change has significant user impact or is a breaking change. Choose patch otherwise.
    • Write a thoughtful changelog message so we know what was updated.
  • Merge the platform PR that was auto-created for updating the Connector Builder's CDK version
    • This step is optional if the change does not affect the connector builder or declarative connectors.

@vercel
Copy link

vercel bot commented Oct 11, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
airbyte-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 13, 2023 9:48pm

@xiaohansong
Copy link
Contributor Author

xiaohansong commented Oct 11, 2023

/connector-performance

Error: Required input 'connector' not provided

@xiaohansong
Copy link
Contributor Author

xiaohansong commented Oct 11, 2023

/connector-performance connector="source/postgres"

Note: The following dataset= values are supported: 1m(default), 10m, 20m,

bottleneck_stream1, bottleneck_stream_randomseed. For destinations only: you can also use stream-numbers=Nto simulate N number of parallel streams. Additionally,sync-mode=incrementalis supported for destinations. For example:dataset=1m stream-numbers=2 sync-mode=incremental`

🏃 source/postgres https://github.com/airbytehq/airbyte/actions/runs/6486513972.

@xiaohansong
Copy link
Contributor Author

/connector-performance connector="connectors/source-postgres"

@octavia-squidington-iii octavia-squidington-iii removed the area/connectors Connector related issues label Oct 12, 2023
@xiaohansong xiaohansong changed the title empty line to create a PR Fix connector harness performance ci run Oct 12, 2023
@xiaohansong xiaohansong requested a review from rodireich October 12, 2023 17:52
@@ -4,7 +4,13 @@ on:
inputs:
connector:
description: "Airbyte Connector"
type: choice
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice!
Can this replace the code down the file that filters for supported connectors - the big ugly if

Copy link
Contributor Author

@xiaohansong xiaohansong Oct 13, 2023

Choose a reason for hiding this comment

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

I think we still need that because we still want to trigger it from comment command

@xiaohansong xiaohansong merged commit bc670da into master Oct 13, 2023
12 of 13 checks passed
@xiaohansong xiaohansong deleted the xiaohan/harness-fix branch October 13, 2023 22:02
@xiaohansong
Copy link
Contributor Author

/connector-performance connector="connectors/source-postgres" dataset="1m"

ariesgun pushed a commit to ariesgun/airbyte that referenced this pull request Oct 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants