Nuwan, Have you incorporated all the code review recommendations? If not, please mention which items have been left out and by when the pending items can be completed.
Thanks Azeez On Wed, Mar 24, 2010 at 9:01 PM, Nuwan Bandara <[email protected]> wrote: > Hi, > > The suggestions came up in the code review are being impleneted to the > dashboard code. However major code level changes will not be added to the > branched code, but will be added to the trunk, once we align our development > back with the trunk. (i.e. Throwing axis fault from the BE and handle it > accordingly from the FE), Other suggestions such as logging the exception > stack-traces etc, will be immediately implemented in to the code. > > The presentation slides, which we have used is attached. > > Thanks & Regards > /Nuwan > > > On Wed, Mar 24, 2010 at 8:47 PM, Tyrell Perera <[email protected]> wrote: > >> >> >> On Wed, Mar 24, 2010 at 5:39 PM, Ruchira Wageesha <[email protected]>wrote: >> >>> >>> 1. Need proper documentation for creating and configuring >>> dashboard.xml >>> 2. Structure of dashboard.xml should be easily >>> understandable/readable >>> - Using JSON format for dashboard.xml would not be appropriate, a >>> proper xml structure should be there >>> - Anyway, using JSON for gadgets and xml for the layout might be >>> appropriate >>> 3. Get rid of common bundle >>> 4. Need to check whether debug is enabled before logging >>> 5. Exceptions should be properly handled >>> - Should be able to quickly identify any error with stacktrace >>> and logs >>> - Logging message should be added to the exception >>> - Exceptions shouldn't be swallowed, if not in any case, should >>> be properly commented the reason >>> - Throwing AxisFault with an error code/message and handing it >>> accordingly >>> 6. Need to think about distributed nature >>> - Availability of resources should be checked properly before >>> using them. >>> - i.e. we should check whether the registry is available and >>> failure conditions should be handled >>> 7. Add a mothod into carbon utils to get backend http port >>> 8. Proper coding to avoid unnessasary memory usage. >>> - e.g. defining error message separatly and passing it into the >>> debug() method >>> 9. Using readable variable names >>> - e.g. boolean variable names should start with is, "isNewUser" >>> 10. Using primitive data types where possible as object initiation >>> wastes more resources >>> 11. Remove unnecessary paranthesis >>> 12. Extract repetitive codes and use methods instead >>> - both in Java and Javascript >>> 13. Remove redundant varialbes >>> 14. Comments should be added >>> - At Java class declaration(describing the class) >>> - In Javascripts codes >>> 15. Proper coding convension should be followed across the >>> plaltform for Javascripts >>> 16. Get rid of using CDATA in gadgets as it is difficult to validate >>> the JS code >>> - Separate JS code into files and use references to those files >>> instead >>> >>> Correction to #16: NOT CDATA removal. But writing the Javascript code in >> files and adding as minimum as possible code between the gadget's CDATA >> tags. This is a best practice to be followed by all gadget authors. >> >> The advantage of this is that you get all the IDE help necessary within a >> .js file (code completion, warnings etc.), which you won't get inside a .xml >> file. >> >> Tyrell >> >> >> >>> >>> *Proposed Features* >>> >>> - User specific gadget repo (i.e. giving users a registry space to >>> store gadgets) and gadget sharing >>> >>> >>> _______________________________________________ >>> Carbon-dev mailing list >>> [email protected] >>> https://mail.wso2.org/cgi-bin/mailman/listinfo/carbon-dev >>> >>> >> >> >> -- >> Tyrell Perera >> Technical Lead and Product Manager - WSO2 Mashup Server, WSO2 Gadget >> Server >> >> WSO2, Inc.; http://www.wso2.com/ >> "Lean Enterprise Middleware" >> >> http://www.linkedin.com/in/tyrell >> http://tyrellperera.blogspot.com >> http://twitter.com/tyrellperera >> >> _______________________________________________ >> Carbon-dev mailing list >> [email protected] >> https://mail.wso2.org/cgi-bin/mailman/listinfo/carbon-dev >> >> > > > -- > Nuwan Bandara > > WSO2 Inc. | http://www.wso2.com > email: [email protected] > mob: +94 772 907 484 > blog: http://www.nuwanbando.com > > _______________________________________________ > Carbon-dev mailing list > [email protected] > https://mail.wso2.org/cgi-bin/mailman/listinfo/carbon-dev > > -- Afkham Azeez Senior Software Architect & Product Manager, WSO2 WSAS; WSO2, Inc.; http://wso2.com, Lean . Enterprise . Middleware Member; Apache Software Foundation; http://www.apache.org/ email: [email protected] cell: +94 77 3320919 blog: http://blog.afkham.org twitter: http://twitter.com/afkham_azeez linked-in: http://lk.linkedin.com/in/afkhamazeez
_______________________________________________ Carbon-dev mailing list [email protected] https://mail.wso2.org/cgi-bin/mailman/listinfo/carbon-dev
