feature/freshness-updates (#29)

* feature/freshness-updates

* Update dbt_project.yml

* Update CHANGELOG.md

Co-authored-by: Jamie Rodriguez <65564846+fivetran-jamie@users.noreply.github.com>

---------

Co-authored-by: Jamie Rodriguez <65564846+fivetran-jamie@users.noreply.github.com>

Author: fivetran-joemarkiewicz

.buildkite/pipeline.yml

@@ -3,7 +3,7 @@ steps:
     key: "run-dbt-postgres"
     plugins:
       - docker#v3.13.0:
-          image: "python:3.8"
+          image: "python:3.10.13"
           shell: [ "/bin/bash", "-e", "-c" ]
           environment:
             - "BASH_ENV=/tmp/.bashrc"
@@ -18,7 +18,7 @@ steps:
     key: "run_dbt_snowflake"
     plugins:
       - docker#v3.13.0:
-          image: "python:3.8"
+          image: "python:3.10.13"
           shell: [ "/bin/bash", "-e", "-c" ]
           environment:
             - "BASH_ENV=/tmp/.bashrc"
@@ -35,7 +35,7 @@ steps:
     key: "run_dbt_bigquery"
     plugins:
       - docker#v3.13.0:
-          image: "python:3.8"
+          image: "python:3.10.13"
           shell: [ "/bin/bash", "-e", "-c" ]
           environment:
             - "BASH_ENV=/tmp/.bashrc"
@@ -47,7 +47,7 @@ steps:
     key: "run_dbt_redshift"
     plugins:
       - docker#v3.13.0:
-          image: "python:3.8"
+          image: "python:3.10.13"
           shell: [ "/bin/bash", "-e", "-c" ]
           environment:
             - "BASH_ENV=/tmp/.bashrc"
@@ -62,7 +62,7 @@ steps:
     key: "run_dbt_databricks"
     plugins:
       - docker#v3.13.0:
-          image: "python:3.8"
+          image: "python:3.10.13"
           shell: [ "/bin/bash", "-e", "-c" ]
           environment:
             - "BASH_ENV=/tmp/.bashrc"
@@ -71,4 +71,4 @@ steps:
             - "CI_DATABRICKS_DBT_TOKEN"
             - "CI_DATABRICKS_DBT_CATALOG"
     commands: |
-      bash .buildkite/scripts/run_models.sh databricks
+      bash .buildkite/scripts/run_models.sh databricks

.buildkite/scripts/run_models.sh

@@ -20,5 +20,6 @@ dbt seed --target "$db" --full-refresh
 dbt compile --target "$db"
 dbt run --target "$db" --full-refresh
 dbt test --target "$db"
+dbt source freshness --target "$db" || echo "...Only verifying freshness runs…"
 
 dbt run-operation fivetran_utils.drop_schemas_automation --target "$db"

.gitignore

@@ -3,4 +3,5 @@ target/
 dbt_modules/
 logs/
 .DS_Store
-dbt_packages/
+dbt_packages/
+env/

CHANGELOG.md

@@ -1,13 +1,33 @@
-# dbt_pendo_source version.version
+# dbt_pendo_source v0.6.0
+
+[PR #29](https://github.com/fivetran/dbt_pendo_source/pull/29) includes the following updates:
+
+## Breaking Change for dbt Core < 1.9.6
+> *Note: This is not relevant to Fivetran Quickstart users.*
+
+Migrated `freshness` from a top-level source property to a source `config` in alignment with [recent updates](https://github.com/dbt-labs/dbt-core/issues/11506) from dbt Core. This will resolve the following deprecation warning that users running dbt >= 1.9.6 may have received:
+
+```
+[WARNING]: Deprecated functionality
+Found `freshness` as a top-level property of `pendo` in file
+`models/src_pendo.yml`. The `freshness` top-level property should be moved
+into the `config` of `pendo`.
+```
+
+**IMPORTANT:** Users running dbt Core < 1.9.6 will not be able to utilize freshness tests in this release or any subsequent releases, as older versions of dbt will not recognize freshness as a source `config` and therefore not run the tests.
+
+If you are using dbt Core < 1.9.6 and want to continue running Pendo Source freshness tests, please elect **one** of the following options:
+  1. (Recommended) Upgrade to dbt Core >= 1.9.6
+  2. Do not upgrade your installed version of the `pendo_source` package. Pin your dependency on v0.5.0 in your `packages.yml` file.
+  3. Utilize a dbt [override](https://docs.getdbt.com/reference/resource-properties/overrides) to overwrite the package's `pendo` source and apply freshness via the previous release top-level property route. This will require you to copy and paste the entirety of the previous release `src_pendo.yml` file and add an `overrides: pendo_source` property.
 
 ## Documentation
 - Corrected references to connectors and connections in the README. ([#27](https://github.com/fivetran/dbt_pendo_source/pull/27))
 
-# dbt_pendo_source v0.UPDATE.UPDATE
-
- ## Under the Hood:
+## Under the Hood:
 - Incorporated the new `fivetran_utils.drop_schemas_automation` macro into the end of each Buildkite integration test job.
 - Updated the pull request [templates](/.github).
+- Updates to ensure integration tests use latest version of dbt.
 
 # dbt_pendo_source v0.5.0
 PR [#21](https://github.com/fivetran/dbt_pendo_source/pull/21) includes the following updates:

README.md

@@ -15,7 +15,7 @@
 ## What does this dbt package do?
 - Materializes [Pendo staging tables](https://fivetran.github.io/dbt_pendo_source/#!/overview/pendo_source/models/?g_v=1) which beverage data in the format described by [this ERD](https://fivetran.com/docs/applications/pendo/#schemainformation). These staging tables clean, test, and prepare your Pendo data from [Fivetran's connector](https://fivetran.com/docs/applications/pendo) for analysis by doing the following:
   - Name columns for consistency across all packages and for easier analysis
-  - Adds freshness tests to source data
+  - Adds freshness tests to source data. dbt Core >= 1.9.6 is required to run freshness tests out of the box.
   - Adds column-level testing where applicable. For example, all primary keys are tested for uniqueness and non-null values.
 - Generates a comprehensive data dictionary of your Pendo data through the [dbt docs site](https://fivetran.github.io/dbt_pendo_source/).
 - These tables are designed to work simultaneously with our [Pendo transformation package](https://github.com/fivetran/dbt_pendo).
@@ -39,7 +39,7 @@ If you are **not** using the [Pendo transformation package](https://github.com/f
 ```yaml
 packages:
   - package: fivetran/pendo_source
-    version: [">=0.5.0", "<0.6.0"] # we recommend using ranges to capture non-breaking changes automatically
+    version: [">=0.6.0", "<0.7.0"] # we recommend using ranges to capture non-breaking changes automatically
 ```
 
 ### Step 3: Define database and schema variables

dbt_project.yml

@@ -1,6 +1,6 @@
 config-version: 2
 name: 'pendo_source'
-version: '0.5.0'
+version: '0.6.0'
 require-dbt-version: [">=1.3.0", "<2.0.0"]
 models:
   pendo_source:

integration_tests/ci/sample.profiles.yml

@@ -2,10 +2,6 @@
 # HEY! This file is used in the dbt package integrations tests with Buildkite.
 # You should __NEVER__ check credentials into version control. Thanks for reading :)
 
-config:
-    send_anonymous_usage_stats: False
-    use_colors: True
-
 integration_tests:
   target: redshift
   outputs:
@@ -51,4 +47,4 @@ integration_tests:
       schema: pendo_source_integration_tests_2001
       threads: 2
       token: "{{ env_var('CI_DATABRICKS_DBT_TOKEN') }}"
-      type: databricks
+      type: databricks

integration_tests/dbt_project.yml

@@ -1,7 +1,7 @@
 config-version: 2
 
 name: 'pendo_source_integration_tests'
-version: '0.5.0'
+version: '0.6.0'
 
 profile: 'integration_tests'
 
@@ -75,4 +75,7 @@ seeds:
         last_updated_by_user_id: "{{ 'int64' if target.name == 'bigquery' else 'bigint' }}"
     visitor_history:
       +column_types:
-        id_hash: "{{ 'int64' if target.name == 'bigquery' else 'bigint' }}"
+        id_hash: "{{ 'int64' if target.name == 'bigquery' else 'bigint' }}"
+
+flags:
+  send_anonymous_usage_stats: False

integration_tests/requirements.txt

@@ -4,4 +4,6 @@ dbt-redshift>=1.3.0,<2.0.0
 dbt-postgres>=1.3.0,<2.0.0
 dbt-spark>=1.3.0,<2.0.0
 dbt-spark[PyHive]>=1.3.0,<2.0.0
-dbt-databricks>=1.3.0,<2.0.0
+dbt-databricks>=1.3.0,<2.0.0
+certifi==2025.1.31
+

models/src_pendo.yml

@@ -7,10 +7,11 @@ sources:
 
     loader: fivetran
     loaded_at_field: _fivetran_synced
-      
-    freshness:
-      warn_after: {count: 72, period: hour}
-      error_after: {count: 168, period: hour}
+
+    config:
+      freshness:
+        warn_after: {count: 72, period: hour}
+        error_after: {count: 168, period: hour}
 
 
     tables: