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

Bugfix/unique test search term report #18

Merged
merged 8 commits into from
Jul 11, 2023

Conversation

fivetran-reneeli
Copy link
Contributor

@fivetran-reneeli fivetran-reneeli commented Jul 3, 2023

PR Overview

This PR will address the following Issue/Feature:
#16

This PR will result in the following new package version:

v0.2.2

Please detail what change(s) this PR introduces and any additional information that should be known during the review of this PR:
Adds new fields to the unique test for the apple_search_ads__search_term_report model:

        - keyword_id
        - ad_group_id
        - campaign_id
        - organization_id
        - match_type

In addition to the existing search_term_text and date_day

PR Checklist

Basic Validation

Please acknowledge that you have successfully performed the following commands locally:

  • dbt compile
  • dbt run –full-refresh
  • dbt run
  • dbt test
  • [ n/a] dbt run –vars (if applicable)

Before marking this PR as "ready for review" the following have been applied:

  • The appropriate issue has been linked and tagged
  • You are assigned to the corresponding issue and this PR
  • BuildKite integration tests are passing

Detailed Validation

Please acknowledge that the following validation checks have been performed prior to marking this PR as "ready for review":

  • You have validated these changes and assure this PR will address the respective Issue/Feature.
  • You are reasonably confident these changes will not impact any other components of this package or any dependent packages.
  • You have provided details below around the validation steps performed to gain confidence in these changes.

dbt test passes. Again our internal data used for development is light and therefore didn't catch this issue before, but the customer who contributed this PR has confirmed that the fields they added now allows the unique test to pass.

Standard Updates

Please acknowledge that your PR contains the following standard updates:

  • Package versioning has been appropriately indexed in the following locations:
    • indexed within dbt_project.yml
    • indexed within integration_tests/dbt_project.yml
  • CHANGELOG has individual entries for each respective change in this PR
  • [ n/a] README updates have been applied (if applicable)
  • [n/a ] DECISIONLOG updates have been updated (if applicable)
  • [n/a ] Appropriate yml documentation has been added (if applicable)

dbt Docs

Please acknowledge that after the above were all completed the below were applied to your branch:

  • [] docs were regenerated (unless this PR does not include any code or yml updates)

If you had to summarize this PR in an emoji, which would it be?

💃

yuna-tang and others added 4 commits June 30, 2023 11:00
…lumns, we can run multiple keyword_id,ad_group_id and campaign_id for the same search_term_text & date_day
bugfix: add additional columns for unique column combination test for apple_search_ads__search_term_report
@fivetran-reneeli fivetran-reneeli self-assigned this Jul 3, 2023
@fivetran-reneeli
Copy link
Contributor Author

Thank you @yuna-tang for contributing this PR! We will be reviewing this and including this update to the package.

Additional changes:

  • upgraded integration test version
  • updated CHANGELOG
  • Also added match_type and organization_id to the unique test to mirror what we did in the ad reporting rollup package.

Copy link
Collaborator

@fivetran-joemarkiewicz fivetran-joemarkiewicz left a comment

Choose a reason for hiding this comment

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

@fivetran-reneeli thanks for working through this PR and incorporating the customers changes from the accompanying PR!

I do have a few comments in the review that I would like your eyes on to respond or make updates. Additionally, a few other comments I had can be found below:

  • It looks like the docs have not been generated. After making any necessary updates (especially if one is made for the fields to test), be sure to regen the docs.
  • Small note on the PR submission form. If a checklist item does not pertain to the PR you are working on, can you update the checkbox to be [n/a]. This way it does not show as an empty checkbox.

CHANGELOG.md Outdated Show resolved Hide resolved
dbt_apple_search_ads Outdated Show resolved Hide resolved
Comment on lines +238 to +243
- match_type
- date_day
- keyword_id
- ad_group_id
- campaign_id
- organization_id
Copy link
Collaborator

Choose a reason for hiding this comment

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

I noticed you added the organization_id and match_type fields to the uniqueness test, which the customer didn't have in their initial PR. My instinct would be to include only the fields we are marking as keys from the ERD of Apple Search Ads. Was there additional information that informed you to add the above two fields?

image

Copy link
Collaborator

Choose a reason for hiding this comment

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

If the above is updated we should also remember to update the CHANGELOG.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes organization_id and match_type were added to keep standard to what we use to test in the ad reporting package. I think it makes sense to go based off what's in the ERD (pending us being notified what fivetran_id is hashed from) though.

But do you think there's any downside to adding those fields as well?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't foresee there being any downside with including them. Especially if we already test on these fields uniqueness in the downstream ad reporting model. I am comfortable keeping the test with how you have it in this PR.

@fivetran-reneeli
Copy link
Contributor Author

Updated PR and will wait to regen docs when everything is finalized.

@fivetran-joemarkiewicz ready for re-review

Copy link
Collaborator

@fivetran-joemarkiewicz fivetran-joemarkiewicz left a comment

Choose a reason for hiding this comment

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

@fivetran-reneeli these changes look good to go! Just be sure to regenerate the docs before kicking off the release review process.

Comment on lines +238 to +243
- match_type
- date_day
- keyword_id
- ad_group_id
- campaign_id
- organization_id
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't foresee there being any downside with including them. Especially if we already test on these fields uniqueness in the downstream ad reporting model. I am comfortable keeping the test with how you have it in this PR.

@yuna-tang
Copy link
Contributor

@fivetran-reneeli , I noticed the release version for dbt_apple_search_ads will be v0.2.1. Do you know which version of fivetran/ad_reporting will include this change?

@fivetran-reneeli fivetran-reneeli merged commit fcda5ca into main Jul 11, 2023
@fivetran-reneeli
Copy link
Contributor Author

fivetran-reneeli commented Jul 11, 2023

Hi @yuna-tang , it should automatically pull this latest version given the ad reporting parameters currently are [">=0.2.0", "<0.3.0"]!

Note that we moved this to v0.2.2 because I made an accidental release on v0.2.1, but same effect should apply! This has been merged to main so will be closing this out

@fivetran-reneeli fivetran-reneeli deleted the bugfix/unique_test_search_term_report branch July 11, 2023 16:34
@yuna-tang
Copy link
Contributor

@fivetran-reneeli Thank you for the confirmation, we are currently using the below ad_reporting package.

  • package: fivetran/ad_reporting
    version: [">=1.3.0", "<1.4.0"]

When I look into the package.yml, it also has the same range. I assume 1.3.0 ad_reporting will also reflect the latest change.

  • package: fivetran/apple_search_ads
    version: [">=0.2.0", "<0.3.0"]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants