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 Facebook pages: updated all empty objects in Page and Post streams #8267

Merged
merged 7 commits into from
Dec 2, 2021

Conversation

midavadim
Copy link
Contributor

@midavadim midavadim commented Nov 26, 2021

What

Source Facebook pages: updated all empty objects in Page and Post streams #8267

Issue: #7673
Source Facebook Pages Invalid JSON schema

How

added schema generation based on FB git .

Recommended reading order

  1. airbyte-integrations/connectors/source-facebook-pages/tools/schema_gen.sh
  2. airbyte-integrations/connectors/source-facebook-pages/tools/schema_gen.py
  3. airbyte-integrations/connectors/source-facebook-pages/source_facebook_pages/schemas

🚨 User Impact 🚨

Schema changes means that customer will need to refresh scehmas for all existing connections

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

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
  • 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
  • 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
  • After the new connector version is published, connector version bumped in the seed directory 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

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.

…with references to sub nodes, fixed fields for page stream, added TypeTransformer because some attributes should be explicitly converted to strings. Added schema generation tool
@CLAassistant
Copy link

CLAassistant commented Nov 26, 2021

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the area/connectors Connector related issues label Nov 26, 2021
@bazarnov
Copy link
Collaborator

bazarnov commented Nov 26, 2021

@midavadim
Please fix the conflicts on the branch, as well as try to pass the CI SAT tests for the connector, before review.

@midavadim midavadim linked an issue Nov 26, 2021 that may be closed by this pull request
…book-fix-schemas

# Conflicts:
#	airbyte-integrations/connectors/source-facebook-pages/source_facebook_pages/metrics.py
#	airbyte-integrations/connectors/source-facebook-pages/source_facebook_pages/schemas/page.json
@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Nov 26, 2021
@midavadim midavadim temporarily deployed to more-secrets November 26, 2021 15:37 Inactive
@midavadim
Copy link
Contributor Author

midavadim commented Nov 26, 2021

/test connector=connectors/source-facebook-pages

🕑 connectors/source-facebook-pages https://github.com/airbytehq/airbyte/actions/runs/1508267528
❌ connectors/source-facebook-pages https://github.com/airbytehq/airbyte/actions/runs/1508267528
🐛 https://gradle.com/s/ml7mqgeou5egi

@jrhizor jrhizor temporarily deployed to more-secrets November 26, 2021 16:19 Inactive
@midavadim midavadim temporarily deployed to more-secrets November 26, 2021 16:51 Inactive
@midavadim
Copy link
Contributor Author

midavadim commented Nov 26, 2021

/test connector=connectors/source-facebook-pages

🕑 connectors/source-facebook-pages https://github.com/airbytehq/airbyte/actions/runs/1508360143
✅ connectors/source-facebook-pages https://github.com/airbytehq/airbyte/actions/runs/1508360143
Python tests coverage:

	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                                 Stmts   Miss  Cover
	 ------------------------------------------------------------------------
	 source_acceptance_test/__init__.py                       2      0   100%
	 source_acceptance_test/base.py                          10      4    60%
	 source_acceptance_test/config.py                        75      8    89%
	 source_acceptance_test/conftest.py                     108    108     0%
	 source_acceptance_test/plugin.py                        47     47     0%
	 source_acceptance_test/tests/__init__.py                 4      0   100%
	 source_acceptance_test/tests/test_core.py              200     94    53%
	 source_acceptance_test/tests/test_full_refresh.py       38     27    29%
	 source_acceptance_test/tests/test_incremental.py        69     38    45%
	 source_acceptance_test/utils/__init__.py                 6      0   100%
	 source_acceptance_test/utils/asserts.py                 37      2    95%
	 source_acceptance_test/utils/common.py                  41     24    41%
	 source_acceptance_test/utils/compare.py                 62     25    60%
	 source_acceptance_test/utils/connector_runner.py        82     49    40%
	 source_acceptance_test/utils/json_schema_helper.py     115     14    88%
	 ------------------------------------------------------------------------
	 TOTAL                                                  896    440    51%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                Stmts   Miss  Cover
	 -------------------------------------------------------
	 source_facebook_pages/__init__.py       2      0   100%
	 source_facebook_pages/metrics.py        4      0   100%
	 source_facebook_pages/source.py        29     17    41%
	 source_facebook_pages/streams.py       74     34    54%
	 -------------------------------------------------------
	 TOTAL                                 109     51    53%

@jrhizor jrhizor temporarily deployed to more-secrets November 26, 2021 16:54 Inactive
Copy link
Contributor

@antixar antixar left a comment

Choose a reason for hiding this comment

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

Could you add a shot draft of schemas' parsing to a bootstrap.md ?

Copy link
Contributor

@ChristopheDuong ChristopheDuong left a comment

Choose a reason for hiding this comment

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

It would be nice to put in the description of the PR the link to the parent/related issue #7673 instead of linking to the PR itself

@midavadim midavadim temporarily deployed to more-secrets December 2, 2021 18:04 Inactive
@midavadim
Copy link
Contributor Author

midavadim commented Dec 2, 2021

/test connector=connectors/source-facebook-pages

🕑 connectors/source-facebook-pages https://github.com/airbytehq/airbyte/actions/runs/1531929968
✅ connectors/source-facebook-pages https://github.com/airbytehq/airbyte/actions/runs/1531929968
Python tests coverage:

	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                                 Stmts   Miss  Cover
	 ------------------------------------------------------------------------
	 source_acceptance_test/__init__.py                       2      0   100%
	 source_acceptance_test/base.py                          10      4    60%
	 source_acceptance_test/config.py                        75      8    89%
	 source_acceptance_test/conftest.py                     108    108     0%
	 source_acceptance_test/plugin.py                        47     47     0%
	 source_acceptance_test/tests/__init__.py                 4      0   100%
	 source_acceptance_test/tests/test_core.py              200     94    53%
	 source_acceptance_test/tests/test_full_refresh.py       38     27    29%
	 source_acceptance_test/tests/test_incremental.py        69     38    45%
	 source_acceptance_test/utils/__init__.py                 6      0   100%
	 source_acceptance_test/utils/asserts.py                 37      2    95%
	 source_acceptance_test/utils/common.py                  41     24    41%
	 source_acceptance_test/utils/compare.py                 62     25    60%
	 source_acceptance_test/utils/connector_runner.py        82     49    40%
	 source_acceptance_test/utils/json_schema_helper.py     115     14    88%
	 ------------------------------------------------------------------------
	 TOTAL                                                  896    440    51%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                Stmts   Miss  Cover
	 -------------------------------------------------------
	 source_facebook_pages/__init__.py       2      0   100%
	 source_facebook_pages/metrics.py        4      0   100%
	 source_facebook_pages/source.py        29     17    41%
	 source_facebook_pages/streams.py       74     34    54%
	 -------------------------------------------------------
	 TOTAL                                 109     51    53%

@jrhizor jrhizor temporarily deployed to more-secrets December 2, 2021 18:23 Inactive
@midavadim midavadim temporarily deployed to more-secrets December 2, 2021 18:48 Inactive
@midavadim
Copy link
Contributor Author

midavadim commented Dec 2, 2021

/publish connector=connectors/source-facebook-pages

🕑 connectors/source-facebook-pages https://github.com/airbytehq/airbyte/actions/runs/1532030147
✅ connectors/source-facebook-pages https://github.com/airbytehq/airbyte/actions/runs/1532030147

@jrhizor jrhizor temporarily deployed to more-secrets December 2, 2021 18:51 Inactive
@midavadim
Copy link
Contributor Author

midavadim commented Dec 2, 2021

/test connector=connectors/source-facebook-pages

🕑 connectors/source-facebook-pages https://github.com/airbytehq/airbyte/actions/runs/1532061964
✅ connectors/source-facebook-pages https://github.com/airbytehq/airbyte/actions/runs/1532061964
Python tests coverage:

	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                                 Stmts   Miss  Cover
	 ------------------------------------------------------------------------
	 source_acceptance_test/__init__.py                       2      0   100%
	 source_acceptance_test/base.py                          10      4    60%
	 source_acceptance_test/config.py                        75      8    89%
	 source_acceptance_test/conftest.py                     108    108     0%
	 source_acceptance_test/plugin.py                        47     47     0%
	 source_acceptance_test/tests/__init__.py                 4      0   100%
	 source_acceptance_test/tests/test_core.py              200     94    53%
	 source_acceptance_test/tests/test_full_refresh.py       38     27    29%
	 source_acceptance_test/tests/test_incremental.py        69     38    45%
	 source_acceptance_test/utils/__init__.py                 6      0   100%
	 source_acceptance_test/utils/asserts.py                 37      2    95%
	 source_acceptance_test/utils/common.py                  41     24    41%
	 source_acceptance_test/utils/compare.py                 62     25    60%
	 source_acceptance_test/utils/connector_runner.py        82     49    40%
	 source_acceptance_test/utils/json_schema_helper.py     115     14    88%
	 ------------------------------------------------------------------------
	 TOTAL                                                  896    440    51%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                Stmts   Miss  Cover
	 -------------------------------------------------------
	 source_facebook_pages/__init__.py       2      0   100%
	 source_facebook_pages/metrics.py        4      0   100%
	 source_facebook_pages/source.py        29     17    41%
	 source_facebook_pages/streams.py       74     34    54%
	 -------------------------------------------------------
	 TOTAL                                 109     51    53%

@jrhizor jrhizor temporarily deployed to more-secrets December 2, 2021 19:00 Inactive
@midavadim midavadim merged commit 5ce8339 into master Dec 2, 2021
@midavadim midavadim deleted the midavadim/7673-facebook-fix-schemas branch December 2, 2021 19:09
@jrhizor
Copy link
Contributor

jrhizor commented Dec 2, 2021

Please remember to update the seed spec which causes build failures like https://github.com/airbytehq/airbyte/runs/4399670905?check_suite_focus=true

From the PR template:

Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
…treams (airbytehq#8267)

* updated part of non-defined object properties

* Updates schema for Page and Post streams, empty objects are replaced with references to sub nodes, fixed fields for page stream, added TypeTransformer because some attributes should be explicitly converted to strings. Added schema generation tool

* updated docs

* fixed format issues

* enhanced schemas - added datatime format, float is saved as number

* updated source version
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 connectors/source/facebook-pages connectors/sources-api
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Source Facebook Pages Invalid JSON schema
7 participants