amundsen icon indicating copy to clipboard operation
amundsen copied to clipboard

[databuilder] Typo in new SearchMetadatatoElasticasearchTask

Open akaul opened this issue 3 years ago • 4 comments
trafficstars

Expected Behavior

While migrating to New Amundsen Search, I observed a typo in the class name for SearchMetadatatoElasticasearchTask.

Current Behavior

The current behavior doesn't impact any end-to-end databuilder behavior at the moment.

Possible Solution

Without the typo, the task name should be SearchMetadatatoElasticsearchTask or alternatively SearchMetadataToElasticsearchTask.

Steps to Reproduce

https://github.com/amundsen-io/amundsen/blob/main/databuilder/databuilder/task/search/search_metadata_to_elasticsearch_task.py#L28 has a reference to the classname.

Screenshots (if appropriate)

Context

As the task name is used in configuration keys, this could break end users using the library with a lot of name changes further down the line adoption of new Amundsen search grows.

 $ git grep 'SearchMetadatatoElasticasearchTask' | wc -l
      15

Publishing a new release with the typo fixed and instructions in the README updated might alleviate this.

Your Environment

  • Amunsen version used: amundsen-databuilder 6.8.0
  • Data warehouse stores: N/A
  • Deployment (k8s or native): N/A
  • Link to your fork or repository: N/A

akaul avatar Jun 07 '22 00:06 akaul

Thanks for opening your first issue here!

boring-cyborg[bot] avatar Jun 07 '22 00:06 boring-cyborg[bot]

Happy to open up a PR with the changes to fix the typo, but I wanted to report the issue first after going through the Contribution Guidelines.

akaul avatar Jun 07 '22 00:06 akaul

Is there any impact besides that the name contains a typo? A fix for this typo would be backwards incompatible.

dkunitsk avatar Jun 13 '22 01:06 dkunitsk

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

stale[bot] avatar Jun 29 '22 09:06 stale[bot]

This issue has been automatically closed for inactivity. If you still wish to make these changes, please open a new pull request or reopen this one.

stale[bot] avatar Aug 13 '22 03:08 stale[bot]