bugfix/search-term-passthrough

[fivetran-joemarkiewicz]

PR Overview

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

This PR will result in the following new package version: v0.2.2

This is only moving the placement of a passthrough metric. This will not cause a breaking change.

Please detail what change(s) this PR introduces and any additional information that should be known during the review of this PR:

This PR moved the apple_search_ads__search_term_passthrough_metrics within the get_search_term_report_columns macro to be within the return call of the macro. Previously, this variable was located outside of the macro call and resulted in the passthrough metrics not being carried through to the staging model. As such, you would see error messages like the following since the revenue metric was not properly persisted downstream.

This adjustment in the PR ensures the metrics are properly carried downstream when the macro is called.

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
• dbt run –vars (see vars below)

vars:
  apple_search_ads__using_search_terms: true
  apple_search_ads__search_term_passthrough_metrics:
    - name: conversions
      alias: conversion_total

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.

I was able to recreate the issue by using the variables in the above step and found that the error highlighted above was shown when using the latest version of the package. However, when using the branch from this PR the conversion_total field persisted.

Additionally, I was able to confirm that running the branch without the variable populated ensured the models succeeded as expected and see no passthrough metrics in the final output.

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?

🍎 🏷️

[fivetran-avinash]

All clear!