✨ feat(Source facebook-marketing): pick fields from configured json schema properties if present by aldogonzalez8 · Pull Request #41039 · airbytehq/airbyte

Aldo Gonzalez (aldogonzalez8) · 2024-07-08T16:26:44Z

What

We have seen errors from facebook API like this:

    {
      "error": {
        "code": 1,
        "message": "Please reduce the amount of data you're asking for, then retry your request"
      }
    }

ref:

We want to provide users the ability to reduce the requested fields, so Artem Inzhyyants (@artem1205) worked with ticket 2100 and the PR 39522 to "add json_schema from ConfiguredCatalog to Stream" and now in ticket 8496 we will implement the new cdk feature to determine the requested fields for facebook-marketing.

How

When calling fields(), check first configured_json_schema; if provided, use properties keys as fields; if not, fallback in current behavior (use stream schema).

DEMO

Review guide

airbyte-integrations/connectors/source-facebook-marketing/source_facebook_marketing/streams/base_insight_streams.py: add check for self.configured_json_schema
airbyte-integrations/connectors/source-facebook-marketing/source_facebook_marketing/streams/base_streams.py: add check for self.configured_json_schema
airbyte-integrations/connectors/source-facebook-marketing/pyproject.toml: we need new cdk feature that pass configured_catalog selected fields from platform.
The rest is one unit test per base stream updated.

User Impact

Users will now be able to reduce the requested fields simply checking/unchecking fields from stream configuration.

Can this PR be safely reverted and rolled back?

YES 💚
NO ❌

vercel · 2024-07-08T16:26:48Z

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	Jul 10, 2024 4:18pm

…present

…json_schema_is_available_for_fields

Artem Inzhyyants (artem1205)

LGTM!

nit: rename PR to align with Conventional Commits naming (see Notion Page)

…json_schema_is_available_for_fields

Alexandre Girard (girarda)

great work Aldo Gonzalez (@aldogonzalez8) !

Alexandre Girard (girarda) · 2024-07-10T00:51:32Z

+    @HttpMocker()
+    def test_request_fields_from_json_schema_in_configured_catalog(self, http_mocker: HttpMocker) -> None:
+        """
+        The purpose of this test is to check that the request fields are the same provided in json_request_schema inside configured catalog


Alexandre Girard (girarda) · 2024-07-10T00:53:27Z


 | Version | Date       | Pull Request                                             | Subject                                                                                                                                                                                                                                                                                           |
 |:--------|:-----------|:---------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 3.3.9 | 2024-07-08 | [41039](https://github.com/airbytehq/airbyte/pull/41039) | Pick request fields from configured json schema properties if present  |


Aldo Gonzalez (@aldogonzalez8) Artem Inzhyyants (@artem1205) can you also update the docs with instructions for the end-users on how to handle the Please reduce the amount of data you're asking for, then retry your request error?

Alexandre Girard (@girarda) Artem Inzhyyants (@artem1205) I have just updated the documentation. Do you feel comfortable with these instructions and wording?

looks good thank you!

…ields

coderabbitai · 2024-07-10T10:43:45Z

Important

Review skipped

Auto reviews are limited to specific labels.

Labels to auto review (1)

coderabbit-ai-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

…json_schema_is_available_for_fields

…lds requested to facebook graph api

Aldo Gonzalez (aldogonzalez8) · 2024-07-10T14:44:41Z

LGTM!

nit: rename PR to align with Conventional Commits naming (see Notion Page)

Thanks, updated.

…chema properties if present (#41039)

Aldo Gonzalez (aldogonzalez8) self-assigned this Jul 8, 2024

Octavia Squidington III (octavia-squidington-iii) added area/connectors Connector related issues connectors/source/facebook-marketing labels Jul 8, 2024

Aldo Gonzalez (aldogonzalez8) changed the title ~~✨ Source Instagram: pick configured json schema properties ad fields if present~~ ✨ Source Facebook: pick configured json schema properties ad fields if present Jul 8, 2024

Source Facebook: pick configured json schema properties ad fields if …

2a17e19

…present

Aldo Gonzalez (aldogonzalez8) force-pushed the aldogonzalez8/check_if_configured_catalog_json_schema_is_available_for_fields branch from 8aa9862 to 2a17e19 Compare July 8, 2024 16:28

Aldo Gonzalez (aldogonzalez8) changed the title ~~✨ Source Facebook: pick configured json schema properties ad fields if present~~ ✨ Source facebook-marketing: pick configured json schema properties ad fields if present Jul 8, 2024

Merge branch 'master' into aldogonzalez8/check_if_configured_catalog_…

ccaed41

…json_schema_is_available_for_fields

vercel Bot deployed to Preview July 8, 2024 17:21 View deployment

Aldo Gonzalez (aldogonzalez8) changed the title ~~✨ Source facebook-marketing: pick configured json schema properties ad fields if present~~ ✨ Source facebook-marketing: pick fields from configured json schema properties if present Jul 8, 2024

Source facebook-marketing: update release information

7f7d882

Octavia Squidington III (octavia-squidington-iii) added the area/documentation Improvements or additions to documentation label Jul 8, 2024

vercel Bot deployed to Preview July 8, 2024 17:36 View deployment

Aldo Gonzalez (aldogonzalez8) requested a review from a team July 8, 2024 19:19

Merge branch 'master' into aldogonzalez8/check_if_configured_catalog_…

6ad2815

…json_schema_is_available_for_fields

vercel Bot deployed to Preview July 8, 2024 20:51 View deployment

Merge branch 'master' into aldogonzalez8/check_if_configured_catalog_…

93636bc

…json_schema_is_available_for_fields

vercel Bot deployed to Preview July 8, 2024 22:39 View deployment

Merge branch 'master' into aldogonzalez8/check_if_configured_catalog_…

22ffa0f

…json_schema_is_available_for_fields

vercel Bot deployed to Preview July 9, 2024 09:58 View deployment

Artem Inzhyyants (artem1205) approved these changes Jul 9, 2024

View reviewed changes

Merge branch 'master' into aldogonzalez8/check_if_configured_catalog_…

299ea71

…json_schema_is_available_for_fields

vercel Bot deployed to Preview July 9, 2024 11:22 View deployment

Baz (bazarnov) approved these changes Jul 9, 2024

View reviewed changes

Alexandre Girard (girarda) approved these changes Jul 10, 2024

View reviewed changes

Alexandre Girard (girarda) reviewed Jul 10, 2024

View reviewed changes

Aldo Gonzalez (aldogonzalez8) added 2 commits July 10, 2024 04:37

Source facebook-marketing: merge from master

cc40cc9

Source facebook-marketing: fix problem with brekadowns leaking into f…

ee6bccc

…ields

Source facebook-marketing: fix docummentation dates and python format

9878d3e

vercel Bot deployed to Preview July 10, 2024 11:20 View deployment

Aldo Gonzalez (aldogonzalez8) and others added 3 commits July 10, 2024 05:27

Source facebook-marketing: add cache annotation to fields method

c950d2d

Source facebook-marketing: update release informaton

c506f35

Merge branch 'master' into aldogonzalez8/check_if_configured_catalog_…

3358b61

…json_schema_is_available_for_fields

vercel Bot deployed to Preview July 10, 2024 12:00 View deployment

Source facebook-marketing: add docummentation about the reduce of fie…

a5f0a65

…lds requested to facebook graph api

Aldo Gonzalez (aldogonzalez8) changed the title ~~✨ Source facebook-marketing: pick fields from configured json schema properties if present~~ ✨ feat(Source facebook-marketing): pick fields from configured json schema properties if present Jul 10, 2024

vercel Bot deployed to Preview July 10, 2024 13:29 View deployment

Aldo Gonzalez (aldogonzalez8) added 2 commits July 10, 2024 08:34

Source facebook-marketing: merge from master

59dc435

Source facebook-marketing: update release information

8ea92e8

Source facebook-marketing: update doc

f1009d2

vercel Bot deployed to Preview July 10, 2024 16:18 View deployment

Aldo Gonzalez (aldogonzalez8) merged commit ce296a8 into master Jul 10, 2024

Aldo Gonzalez (aldogonzalez8) deleted the aldogonzalez8/check_if_configured_catalog_json_schema_is_available_for_fields branch July 10, 2024 22:28

Xiaohan Song (xiaohansong) pushed a commit that referenced this pull request Jul 12, 2024

✨ feat(Source facebook-marketing): pick fields from configured json s…

8bac2c1

…chema properties if present (#41039)

Aldo Gonzalez (aldogonzalez8) mentioned this pull request Jul 12, 2024

🐛 bug(Airbyte CDK): clean invalid fields from configured catalog #41678

Merged

1 of 2 tasks

Anatolii Yatsuk (tolik0) mentioned this pull request Mar 10, 2026

feat(source-marketo): add dynamic schema discovery for custom fields on Leads, Programs, and Segmentations streams #74136

Merged

1 task done

Navigation Menu

✨ feat(Source facebook-marketing): pick fields from configured json schema properties if present - #41039

✨ feat(Source facebook-marketing): pick fields from configured json schema properties if present#41039
Aldo Gonzalez (aldogonzalez8) merged 17 commits into
masterfrom
aldogonzalez8/check_if_configured_catalog_json_schema_is_available_for_fields

Aldo Gonzalez (aldogonzalez8) commented Jul 8, 2024 •

edited

Loading

Uh oh!

vercel Bot commented Jul 8, 2024 •

edited

Loading

Uh oh!

Artem Inzhyyants (artem1205) left a comment •

edited

Loading

Uh oh!

Alexandre Girard (girarda) left a comment

Uh oh!

Uh oh!

Alexandre Girard (girarda) Jul 10, 2024

Uh oh!

Alexandre Girard (girarda) Jul 10, 2024

Uh oh!

Aldo Gonzalez (aldogonzalez8) Jul 10, 2024 •

edited

Loading

Uh oh!

Alexandre Girard (girarda) Jul 10, 2024

Uh oh!

coderabbitai Bot commented Jul 10, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Aldo Gonzalez (aldogonzalez8) commented Jul 10, 2024

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

Aldo Gonzalez (aldogonzalez8) commented Jul 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

How

Review guide

User Impact

Can this PR be safely reverted and rolled back?

Uh oh!

vercel Bot commented Jul 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Artem Inzhyyants (artem1205) left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Alexandre Girard (girarda) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Alexandre Girard (girarda) Jul 10, 2024

Choose a reason for hiding this comment

Uh oh!

Alexandre Girard (girarda) Jul 10, 2024

Choose a reason for hiding this comment

Uh oh!

Aldo Gonzalez (aldogonzalez8) Jul 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Alexandre Girard (girarda) Jul 10, 2024

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot commented Jul 10, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Aldo Gonzalez (aldogonzalez8) commented Jul 10, 2024

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Aldo Gonzalez (aldogonzalez8) commented Jul 8, 2024 •

edited

Loading

vercel Bot commented Jul 8, 2024 •

edited

Loading

Artem Inzhyyants (artem1205) left a comment •

edited

Loading

Aldo Gonzalez (aldogonzalez8) Jul 10, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)