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

Request to export TXml parser as a Util #8137

Open
Vasanthavanan-Devarajan opened this issue Feb 20, 2025 · 2 comments
Open

Request to export TXml parser as a Util #8137

Vasanthavanan-Devarajan opened this issue Feb 20, 2025 · 2 comments
Labels
status: waiting on response Waiting on a response from the reporter(s) of the issue status: will not implement The team chooses not to implement this enhancement

Comments

@Vasanthavanan-Devarajan
Copy link
Contributor

Have you read the FAQ and checked for duplicate open issues?
Yes

Is your feature request related to a problem? Please describe.

Background on Manifest Preprocessing Changes:
With manifestPreprocessor being deprecated, I've migrated to using manifestPreprocessorTXml. However, this introduces a key difference - manifestPreprocessorTXml returns XML nodes instead of XML documents as previously returned by manifestPreprocessor.

Current Challenge:
To parse these XML nodes, the ideal approach would be to use Shaka's existing TXml utilities and functions. However, since these utilities aren't exported, I'm forced to reimplement the same XML parsing logic, which leads to:

  • Duplicate code implementation
  • Additional maintenance overhead

Describe the solution you'd like

Exposing Shaka's internal TXml utilities would allow for consistent and efficient XML parsing for external manifest preprocessing implementations.

Describe alternatives you've considered

NA

Additional context

NA

Are you planning to send a PR to add it?
Yes

@Vasanthavanan-Devarajan Vasanthavanan-Devarajan added the type: enhancement New feature or request label Feb 20, 2025
@avelad
Copy link
Member

avelad commented Feb 20, 2025

This is dangerous, because it forces us to maintain an external API for this module. I don't agree, but I'll let @joeyparrish and @tykus160 have their say.

@shaka-bot shaka-bot added this to the Backlog milestone Feb 20, 2025
@joeyparrish
Copy link
Member

I agree. I don't think we want to export txml itself, because of the requirements of backward compatibility for exported interfaces. @Vasanthavanan-Devarajan, can you give us examples of what you want to do with these interfaces?

@avelad avelad added status: will not implement The team chooses not to implement this enhancement status: waiting on response Waiting on a response from the reporter(s) of the issue and removed type: enhancement New feature or request labels Feb 21, 2025
@avelad avelad removed this from the Backlog milestone Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: waiting on response Waiting on a response from the reporter(s) of the issue status: will not implement The team chooses not to implement this enhancement
Projects
None yet
Development

No branches or pull requests

4 participants