feature/email-event-filter

[fivetran-joemarkiewicz]

PR Overview

This PR will address the following Issue/Feature: dbt_hubspot feature identified within FR #96

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

This update is only adding a variable to a staging model to filter out specified email events. This variable is true by default and will not filter out records for existing package users. If users want to take advantage of the variable, they may set the hubspot_using_filtered_events variable to false. As such, this is not 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 adds the hubspot_using_filtered_events variable (true by default) to the stg_hubspot__email_event model. When this variable is set to true (default behavior) there is no change to the model as it currently is built. However, if this variable is set to false it will remove the designated filtered email events per the is_filtered_event field. This is crucial for customers leveraging the filtered email event feature within HubSpot and ensure the downstream reports are not factoring in events that do not wish to include.

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 '{hubspot_using_filtered_events: false}'

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 tested this package by performing the following steps:

• Confirmed the filtered_event within the email_event source table is included in our get_email_event_columns macro and is appropriately defined as a boolean datatype. ✅
• Validated that the filtered_event field is aliased as is_filtered_event in the stg_hubspot__email_event staging model ✅
• Confirmed when the variable hubspot_using_filtered_events is explicitly defined as true, there is no change to the behavior of the model ✅
  
• Confirmed when the variable hubspot_using_filtered_events is not defined (default true), there is no change to the behavior of the model ✅
  
• Confirmed when the variable hubspot_using_filtered_events is explicitly defined as false, the where clause is properly included to filter out any filtered events in the model ✅
  
• Finally, validated that the hubspot_using_filtered_events: true has one more record than when hubspot_using_filtered_events: false. After checking the results, it was in fact a record where is_filtered_event was set as true.
  Based on the above steps I feel comfortable that this address the issue identified in the linked FR.

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
• 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-reneeli]

Looks good!