Azure / azure-sdk-for-js

This repository is for active development of the Azure SDK for JavaScript (NodeJS & Browser). For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/javascript/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-js.
MIT License
2.07k stars 1.19k forks source link

[Core AMQP] move common duplicate internal code in SB & EH back to core-amqp #12397

Closed ramya-rao-a closed 7 months ago

ramya-rao-a commented 3 years ago

There is quite a bit of common code between Service Bus and Event Hubs which were previously housed in and exported from @azure/core-amqp. But most of these are internal details and need not be exposed to user allowing us to change/break the apis.

As part of v2 for @azure/core-amqp, we are moving such code to Service Bus and Event Hubs packages. This issue is to have a folder to house these changes in a single place and then referenced by Service Bus and Event Hubs packages just like how we have the keyvault-common folder.

Below are the candidates to live in this folder

Update as of 15th July 2021:

Based on the below discussions, we want to continue with having core-amqp as the place to share code. Keeping this issue open to move the duplicate code i.e. the candidates mentioned above back to core-amqp

Code pointers:

chradek commented 3 years ago

I think keeping core-amqp as a package is a better plan than treating it like keyvault-common. I see a couple issues with the keyvault-common approach:

ramya-rao-a commented 3 years ago

Thanks @chradek

@xirzec You had some concerns in following the model of keyvault-common. Can you post them here as well?

xirzec commented 3 years ago

Beyond the issues that Chris mentions (size duplication and the difficulty of doing browser/node versions), there are some dev quality of life things (that can perhaps be mitigated by proper configuration):

  1. Having long, complex import paths that reach into other folders outside the source root.
  2. Because of 1, the output directory structure that TS emits reflects a huge part of the tree, which gets messier to reason about.
ramya-rao-a commented 3 years ago

Based on the above discussions, we want to continue with having core-amqp as the place to share code. Keeping this issue open to move the duplicate code back to core-amqp

github-actions[bot] commented 7 months ago

Hi @ramya-rao-a, we deeply appreciate your input into this project. Regrettably, this issue has remained inactive for over 2 years, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.