search

infor-design / enterprise-wc

Enterprise-grade web component library for the Infor Design System
Apache License 2.0
27 stars 26 forks source link

General: Deliver source map for debugging purposes on prod #2503

Open vonnyw opened 2 months ago

vonnyw commented 2 months ago

Is your feature request related to a problem or use case? Please describe. Developers need to be able to debug web component code for triaging, therefore it's imperative that source map is delivered in the web component package.

Additional context And what application do you work on? Landmark

Created ISO-10801

tmcconechy commented 1 month ago

Did a quick test on what a few libs do:

d3 - doesnt include in prod (but includes a min and non min file) vaadin - doesnt even minifiy they are expecting you to bundle the files how you want bootstrap - includes source maps lightning/salesforce - https://www.npmjs.com/package/lwc/v/7.0.5 - doesnt even minifiy they are expecting you to bundle the files how you want mui - doesnt even minifiy they are expecting you to bundle the files how you want stencil - doesnt even minifiy they are expecting you to bundle the files how you want

tmcconechy commented 1 month ago

https://github.com/infor-design/enterprise/issues/6489 is related this was mentioned as not from ISO

tmcconechy commented 1 week ago

@vonnyw

ISO doesn’t have hard guidance on source maps at this point. In general the guidance would be to deploy into production > only what is absolutely needed for production to function properly. This is kind of an interesting case as the maps aren’t > required for functionality and do present the potential for some level of data leakage depending on what is included. Would there be an option to make the source maps available out of band (accessible via oxford access or something similar)?

What do you think? https://inforwiki.atlassian.net/browse/ISO-10801

vonnyw commented 1 week ago

@tmcconechy the requirement is for us to be able to debug any production issue and step through the lines of codes, perhaps there could be a flag to make the source maps available on demand?

tmcconechy commented 1 week ago

Based on what he is saying about it being leakage of data of sorts. Maybe what we can do is..

a) Provide a second debug package with this Info and you include and you make the flag so it can be turned on in production or.. b) We just include it in ours since its on you to protect the production app. So you dont serve the .map files with the source code. And can turn it on with a flag.

Both require more work on your side than ours. Might want to lean more to a) as no one will know to do this if we do b)

tmcconechy commented 1 week ago

So From the calls

1) Why is it a concern in enterprise-wc and not enterprise (they are there for years) 2) There is no data in the maps / just component operation code 3) Have to be logged in anyways 4) How often do we debug prod? Maybe some support people... 5) Was very hard with a lot of breakpoints 6) releases already have the https://github.com/infor-design/enterprise/releases/tag/4.90.8

Maybe can ask in the channel?