{"action":"opened","issue":{"url":"https://api.github.com/repos/vlead/outreach-portal-3.0/issues/39","repository_url":"https://api.github.com/repos/vlead/outreach-portal-3.0","labels_url":"https://api.github.com/repos/vlead/outreach-portal-3.0/issues/39/labels{/name}","comments_url":"https://api.github.com/repos/vlead/outreach-portal-3.0/issues/39/comments","events_url":"https://api.github.com/repos/vlead/outreach-portal-3.0/issues/39/events","html_url":"https://github.com/vlead/outreach-portal-3.0/issues/39","id":171336603,"number":39,"title":"Outreach Portal Review on Aug, 11th 2016","user":{"login":"madhavipuliraju","id":7077897,"avatar_url":"https://avatars.githubusercontent.com/u/7077897?v=3","gravatar_id":"","url":"https://api.github.com/users/madhavipuliraju","html_url":"https://github.com/madhavipuliraju","followers_url":"https://api.github.com/users/madhavipuliraju/followers","following_url":"https://api.github.com/users/madhavipuliraju/following{/other_user}","gists_url":"https://api.github.com/users/madhavipuliraju/gists{/gist_id}","starred_url":"https://api.github.com/users/madhavipuliraju/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/madhavipuliraju/subscriptions","organizations_url":"https://api.github.com/users/madhavipuliraju/orgs","repos_url":"https://api.github.com/users/madhavipuliraju/repos","events_url":"https://api.github.com/users/madhavipuliraju/events{/privacy}","received_events_url":"https://api.github.com/users/madhavipuliraju/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2016-08-16T06:42:54Z","updated_at":"2016-08-16T06:42:54Z","closed_at":null,"body":"Objective of Review: Highlight Architecture, Design and Performance issues.\r\n\r\n1) Update the documentation on how to generate a Python Project.  \r\n    It will be added and tested in the new Outreach Portal.\r\n     Example: how to generate build folder, setting up of database, how to use flask applications etc.\r\n\r\n2) Current Implementation returns all users in the system. \r\n      Example: 500 users. Then, it is very memory, CPU and network intensive activity to return all users.\r\n      A pagination technique need to be implemented.\r\n\r\nNote: This is applicable wherever the Web Application returns a large set of objects to Browser. \r\n\r\n3) Currently closing the login sessions are not happening. Session management is to be designed / redesigned.\r\n\r\n4) Memory profiling is needed. The Application should keep the objects limited copies, use of cache etc is recommended.\r\n\r\n5) The Application may experience issues with \"synchronization\". \r\n\r\n6) Develop and Test the App with \"Gunicorn\" right from the beginning. Adding an event loop later will be a challenge.\r\n\r\n7) Logging and Tracing is missing in the code.\r\n\r\n8) Recommended to follow Python 3.x compliance. Currently it is using Python 2.x \r\n\r\n9) Currently the table / field names are in .py files. Suggested to use a config file describing the schema.\r\n\r\n10) Functional grouping of APIs are needed. \r\nFor example: There are 3 API's (X, Y and Z). In some cases, it will be needed to call X->Y->Z as a transaction. A practical example is User registration... Add E-Mail, Add Name, Add Role... etc. The call must return only upon X->Y->Z. \r\nCurrently a client can call any API. Suggested to abstract the flow into higher level APIs.\r\n\r\n11) There are several hard coded strings present in the code. Suggest to use a \"string table\". It will help in unicode string conversions.\r\n\r\n12) File upload is to be tested thoroughly. Suggested to use AWS SDK and put the files in S3 buckets. The Web Application is not full equipped to handle load of file uploads.\r\n\r\n13) It is suggested to develop a simple event / notification framework. It will be helpful particularly to send useful reminders, alerts etc.\r\n\r\n14) Handling user account transactions such as \"forgot password\", \"reset password\", notifying any activity is to be developed. Current is using 3rd party service (like Persona). \r\n\r\n15) There is a code to schedule a workshop, postpone a workshop etc. Suggested to use a RFC 5545 (iCal). Or integrate with Google Calendar Service.\r\n\r\n16) Handling media files (photos) is to be re-looked into. \r\n      For example: generating thumbnails, lower resolution images may be considered. A workshop organizer uploads a photo of 1MB. Showing it on the browser as is will consume more network, memory resources. It has to be resized and encoded to a minimum.\r\n\r\nEach issue will be created separately from the above listed issues.\r\n"}}
{"actor":{"display_login":"madhavipuliraju"}}