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

BREAKING: Break dependency of ebean-dao on metadata-models. #1895

Merged
merged 1 commit into from
Sep 28, 2020
Merged

Conversation

jplaisted
Copy link
Contributor

@jplaisted jplaisted commented Sep 25, 2020

The coupling was between the static path extractor API. This broken by making a new UrnPathExtractor interface, and adding an overload of EbeanLocalDAO's constructor to accept one (no breaking constructor change). The old constructors default to an EmptyPathExtractor, which does nothing (which is a breaking behavioral change, see below).

BREAKING: DatasetUrnPathExtractor was deleted. No one should've been depending on this directly. However, downstreams that were relying on it being there at runtime (dataset GMS) need to copy DatasetUrnPathExtractor and create their EbeanLocalDAO with one. Note that this is a little dangerous becasue it is a runtime behavioral change only. Potential impact is that SCSI suddenly stops working as intended.

SYNC=metadata-models_101.0.0

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable)

The coupling was between the static path extractor API. This broken by making a new `UrnPathExtractor` interface, and adding an overload of `EbeanLocalDAO`'s constructor to accept one (no breaking constructor change). The old constructors default to an `EmptyPathExtractor`, which does nothing (which is a breaking behavioral change, see below).

BREAKING: `DatasetUrnPathExtractor` was deleted. No one should've been depending on this directly. However, downstreams that were relying on it being there at runtime (dataset GMS) need to copy `DatasetUrnPathExtractor` and create their `EbeanLocalDAO` with one. Note that this is a little dangerous becasue it is a runtime behavioral change only. Potential impact is that SCSI suddenly stops working as intended.

SYNC=metadata-models_101.0.0
@mars-lan
Copy link
Contributor

We have a commit message convention for breaking changes: https://github.com/linkedin/datahub/blob/master/docs/CONTRIBUTING.md#footer

@jplaisted jplaisted changed the title [BREAKING] Break dependency of ebean-dao on metadata-models. BREAKING: Break dependency of ebean-dao on metadata-models. Sep 25, 2020
@jplaisted jplaisted merged commit 2f86cd6 into datahub-project:master Sep 28, 2020
@jplaisted jplaisted deleted the 101 branch February 26, 2021 22:21
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.

2 participants