[1.9.latest] Support reading package 'name' in package-lock.yml, but do not write (#11662)

* Cherry pick changes from 04f579a

* Rm 'name' from written lock file

* Add test + changie

* Smaller diff

* Fixup whitespace to pass code quality check

---------

Co-authored-by: Quigley Malcolm <[email protected]>
Co-authored-by: Quigley Malcolm <[email protected]>

Author: jtcohen6

.changes/unreleased/Under the Hood-20250528-121400.yaml

@@ -0,0 +1,6 @@
+kind: Under the Hood
+body: Support reading 'name' in package-lock.yml for forward-compatibility
+time: 2025-05-28T12:14:00.774495+02:00
+custom:
+    Author: jtcohen6
+    Issue: "11661"

core/dbt/contracts/project.py

@@ -42,13 +42,21 @@ class Quoting(dbtClassMixin, Mergeable):
 
 @dataclass
 class Package(dbtClassMixin):
-    pass
+
+    # Exclude {'name': None} from to_dict result to avoid changing sha1_hash result
+    # when user has not changed their 'packages' configuration.
+    def __post_serialize__(self, data, context: Optional[Dict]):
+        if "name" in data.keys() and data["name"] is None:
+            data.pop("name")
+            return data
+        return data
 
 
 @dataclass
 class LocalPackage(Package):
     local: str
     unrendered: Dict[str, Any] = field(default_factory=dict)
+    name: Optional[str] = None
 
 
 # `float` also allows `int`, according to PEP484 (and jsonschema!)
@@ -69,6 +77,7 @@ class GitPackage(Package):
     warn_unpinned: Optional[bool] = field(default=None, metadata={"alias": "warn-unpinned"})
     subdirectory: Optional[str] = None
     unrendered: Dict[str, Any] = field(default_factory=dict)
+    name: Optional[str] = None
 
     def get_revisions(self) -> List[str]:
         if self.revision is None:
@@ -85,6 +94,7 @@ class PrivatePackage(Package):
     warn_unpinned: Optional[bool] = field(default=None, metadata={"alias": "warn-unpinned"})
     subdirectory: Optional[str] = None
     unrendered: Dict[str, Any] = field(default_factory=dict)
+    name: Optional[str] = None
 
 
 @dataclass
@@ -93,6 +103,7 @@ class RegistryPackage(Package):
     version: Union[RawVersion, List[RawVersion]]
     install_prerelease: Optional[bool] = False
     unrendered: Dict[str, Any] = field(default_factory=dict)
+    name: Optional[str] = None
 
     def get_versions(self) -> List[str]:
         if isinstance(self.version, list):

core/dbt/task/deps.py

@@ -190,6 +190,7 @@ def lock(self) -> None:
         # package-lock.yml includes both the stated packages in packages.yml along with dependent packages
         for package in resolved_deps:
             packages_installed["packages"].append(package.to_dict())
+
         packages_installed[PACKAGE_LOCK_HASH_KEY] = _create_sha1_hash(
             self.project.packages.packages
         )
@@ -204,7 +205,7 @@ def run(self) -> None:
         if self.args.add_package:
             self.add()
 
-        # Check lock file exist and generated by the same pacakges.yml
+        # Check lock file exist and generated by the same packages.yml
         # or dependencies.yml.
         lock_file_path = f"{self.project.project_root}/{PACKAGE_LOCK_FILE_NAME}"
         if not system.path_exists(lock_file_path):

tests/functional/dependencies/test_dependency_options.py

@@ -100,3 +100,17 @@ def test_deps_upgrade(self, clean_start, mocker):
         patched_lock = mocker.patch("dbt.task.deps.DepsTask.lock")
         run_dbt(["deps", "--upgrade"])
         assert patched_lock.call_count == 1
+
+    def test_deps_read_fwd_compatible(self, clean_start, mocker):
+        package_lock_content = """packages:
+  - name: fivetran_utils
+    package: fivetran/fivetran_utils
+    version: 0.4.7
+  - name: dbt_utils
+    package: dbt-labs/dbt_utils
+    version: 1.3.0
+sha1_hash: 71304bca2138cf8004070b3573a1e17183c0c1a8\n
+"""
+        with open("package-lock.yml", "w") as fp:
+            fp.write(package_lock_content)
+        run_dbt(["deps"])