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

🚨🚨 ✨ Source Google Search Console: adding data_state parameter #26452

Merged
merged 6 commits into from May 26, 2023

Conversation

artusiep
Copy link
Contributor

@artusiep artusiep commented May 23, 2023

What

Adding data_state, which could make data fresher from the google search console API

Issue: #10402

How

Adding a parameter that is set for a whole source.

Note: setting the parameter to data_state to all could result in missing data / malformed data. This may be caused during Incremental Sync as read data could not be final, but state records will be emitted.

Recommended reading order

  1. airbyte-integrations/connectors/source-google-search-console/source_google_search_console/spec.jsona
  2. airbyte-integrations/connectors/source-google-search-console/source_google_search_console/source.py
  3. airbyte-integrations/connectors/source-google-search-console/source_google_search_console/streams.py
  4. airbyte-integrations/connectors/source-google-search-console/unit_tests/unit_test.py

🚨 User Impact 🚨

There should be no user impact on that change as the default value is set of data_stateto final.
This should be a minor change.

Pre-merge Actions

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.

@github-actions
Copy link
Contributor

github-actions bot commented May 23, 2023

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

  • PR name follows PR naming conventions
  • Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan and you've followed all steps in the Breaking Changes Checklist
  • Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • Secrets in the connector's spec are annotated with airbyte_secret
  • All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
  • Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
  • You, or an Airbyter, have run /test successfully on this PR - or on a non-forked branch
  • You've updated the connector's metadata.yaml file (new!)

If the checklist is complete, but the CI check is failing,

  1. Check for hidden checklists in your PR description

  2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

@artusiep artusiep changed the title feat: adding data_state parameter ✨ Source Google Search Console: adding data_state parameter May 23, 2023
@marcosmarxm marcosmarxm added the contributor-program PRs submitted through the contributor program. label May 24, 2023
@sajarin sajarin changed the title ✨ Source Google Search Console: adding data_state parameter 🚨🚨 ✨ Source Google Search Console: adding data_state parameter May 24, 2023
@sajarin sajarin added the breaking-change Don't merge me unless you are ready. label May 24, 2023
@sajarin
Copy link
Contributor

sajarin commented May 24, 2023

/test connector=connectors/source-google-search-console

🕑 connectors/source-google-search-console https://github.com/airbytehq/airbyte/actions/runs/5072285562
✅ connectors/source-google-search-console https://github.com/airbytehq/airbyte/actions/runs/5072285562
Python tests coverage:

Name                                                            Stmts   Miss  Cover
-----------------------------------------------------------------------------------
source_google_search_console/exceptions.py                          2      0   100%
source_google_search_console/__init__.py                            2      0   100%
source_google_search_console/streams.py                           139      8    94%
source_google_search_console/source.py                             93     11    88%
source_google_search_console/service_account_authenticator.py      14      6    57%
-----------------------------------------------------------------------------------
TOTAL                                                             250     25    90%

Build Passed

Test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/connector_acceptance_test/tests/test_core.py:578: The previous and actual discovered catalogs are identical.
================== 40 passed, 1 skipped in 928.41s (0:15:28) ===================

@sajarin sajarin requested a review from lazebnyi May 24, 2023 19:11
@sajarin
Copy link
Contributor

sajarin commented May 24, 2023

@lazebnyi would it be too much trouble to take a quick look at this PR and give your approval if it's okay to merge?

Copy link
Collaborator

@lazebnyi lazebnyi left a comment

Choose a reason for hiding this comment

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

LGTM!

@@ -98,6 +101,10 @@ The Google Search Console Source connector supports the following [ sync modes](
The granularity for the cursor is 1 day, so Incremental Sync in Append mode may result in duplicating the data.
:::

:::note
Parameter `data_state='all'` should not be used with Incremental Sync mode as it may cause data loss.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I believe it would be beneficial to include this information in the field description within the spec file.

@sajarin sajarin merged commit 8932684 into airbytehq:master May 26, 2023
39 of 47 checks passed
marcosmarxm pushed a commit to natalia-miinto/airbyte that referenced this pull request Jun 8, 2023
…bytehq#26452)

* feat: adding  parameter

* bump dockerfile and metadata.yaml

* docs: update google-search-console readme with new changelog

* @lazebnyi code review suggestion applied

---------

Co-authored-by: sajarin <sajarindider@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation breaking-change Don't merge me unless you are ready. community connectors/source/google-search-console contributor-program PRs submitted through the contributor program. reward-100
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants