Uploaded image for project: 'IGB'
  1. IGB
  2. IGBF-2001

Rename the edit app page variables with meaningful names

    Details

    • Type: Improvement
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
    • Story Points:
      1
    • Sprint:
      Fall 2019 Sprint 2, Fall 2019 Sprint 3, Fall 4 : 30 Sep to 11 Oct, Fall 5 : 14 Oct to 25 Oct

      Description

      Rename icon to logo
      Rename license_text to license_URL
      Rename website to website_URL
      Rename tutorial to tutorial_URL
      Rename coderepo to code_repository_URL
      Rename contact to contact_email
      Rename repository to repository_XML

      See:

      apps/models.py

        Attachments

          Activity

          Hide
          noor91zahara Noor Zahara (Inactive) added a comment - - edited
          Show
          noor91zahara Noor Zahara (Inactive) added a comment - - edited Code changes can be found https://bitbucket.org/rpatil14/appstore_refactoring/branch/IGBF-2001#diff
          Hide
          ann.loraine Ann Loraine added a comment -

          Merged to master branch in team repository. Please test after refactoring issues are merged.

          Show
          ann.loraine Ann Loraine added a comment - Merged to master branch in team repository. Please test after refactoring issues are merged.
          Hide
          noor91zahara Noor Zahara (Inactive) added a comment -

          Bug related to repository.xml generation is fixed in the below code

          https://bitbucket.org/nzahara/appstore-local/branch/IGBF-2001-1#diff

          Show
          noor91zahara Noor Zahara (Inactive) added a comment - Bug related to repository.xml generation is fixed in the below code https://bitbucket.org/nzahara/appstore-local/branch/IGBF-2001-1#diff
          Hide
          sameer Sameer Shanbhag (Inactive) added a comment -

          Code Seems Fine. Can be Moved to Testing.

          Show
          sameer Sameer Shanbhag (Inactive) added a comment - Code Seems Fine. Can be Moved to Testing.
          Hide
          noor91zahara Noor Zahara (Inactive) added a comment -

          PR Raised -https://bitbucket.org/lorainelab/appstore/pull-requests/112

          The change is required as we are no more creating repository.xml file in app-store instead we are getting it from the jar being uploaded.

          Show
          noor91zahara Noor Zahara (Inactive) added a comment - PR Raised - https://bitbucket.org/lorainelab/appstore/pull-requests/112 The change is required as we are no more creating repository.xml file in app-store instead we are getting it from the jar being uploaded.
          Hide
          ann.loraine Ann Loraine added a comment -

          Merged to master and ready for deployment on a dev appstore for testing.

          Show
          ann.loraine Ann Loraine added a comment - Merged to master and ready for deployment on a dev appstore for testing.
          Hide
          rpatil14 Riddhi Jagdish Patil (Inactive) added a comment - - edited

          Testing steps:
          Issue - The tooltip text on logo need to change from "Click here to choose another icon" to "Click here to choose another logo"
          Steps to reproduce -
          Click on any released app from app store home page -> Editor Actions -> Edit this page -> Hover on the logo space to view the tooltip

          Issue - The logo image is not updating
          Steps to reproduce -
          Click on any released app from app store home page -> Editor Actions -> Edit this page -> Select another logo and save . Old logo reappears

          Issue - Malformed url for license, website, tutorial and code repo is accepted by the app store and when clicked on it causes page not found error. Need to display proper user-friendly error message instead of django error
          Steps to reproduce -
          Click on any released app from app store home page -> Editor Actions -> Edit this page -> Add any url as malformed -> Save.

          cc.[~aloraine], Noor Zahara

          Show
          rpatil14 Riddhi Jagdish Patil (Inactive) added a comment - - edited Testing steps: Issue - The tooltip text on logo need to change from "Click here to choose another icon" to "Click here to choose another logo" Steps to reproduce - Click on any released app from app store home page -> Editor Actions -> Edit this page -> Hover on the logo space to view the tooltip Issue - The logo image is not updating Steps to reproduce - Click on any released app from app store home page -> Editor Actions -> Edit this page -> Select another logo and save . Old logo reappears Issue - Malformed url for license, website, tutorial and code repo is accepted by the app store and when clicked on it causes page not found error. Need to display proper user-friendly error message instead of django error Steps to reproduce - Click on any released app from app store home page -> Editor Actions -> Edit this page -> Add any url as malformed -> Save. cc. [~aloraine] , Noor Zahara
          Hide
          noor91zahara Noor Zahara (Inactive) added a comment -

          [~aloraine]

          Code changes can be found : https://bitbucket.org/nzahara/appstore-local/branch/IGBF-2001-2#diff

          Issue - The logo image is not updating : This is due to caching issue on S3 bucket. The images are getting updated after sometime.
          Mostly due to the below parameter

          AWS_S3_OBJECT_PARAMETERS =

          { 'CacheControl': 'max-age=86400', }

          Need to reduce the cache expiry time / set this to no_cache

          Show
          noor91zahara Noor Zahara (Inactive) added a comment - [~aloraine] Code changes can be found : https://bitbucket.org/nzahara/appstore-local/branch/IGBF-2001-2#diff Issue - The logo image is not updating : This is due to caching issue on S3 bucket. The images are getting updated after sometime. Mostly due to the below parameter AWS_S3_OBJECT_PARAMETERS = { 'CacheControl': 'max-age=86400', } Need to reduce the cache expiry time / set this to no_cache
          Hide
          ann.loraine Ann Loraine added a comment -

          OK

          Show
          ann.loraine Ann Loraine added a comment - OK
          Hide
          noor91zahara Noor Zahara (Inactive) added a comment -

          [~aloraine] - Should I make the value of cachecontrol to no-cache? Would this be a good idea?

          Show
          noor91zahara Noor Zahara (Inactive) added a comment - [~aloraine] - Should I make the value of cachecontrol to no-cache? Would this be a good idea?
          Hide
          ann.loraine Ann Loraine added a comment -

          Not sure. Please investigate pros and cons of doing that.

          Show
          ann.loraine Ann Loraine added a comment - Not sure. Please investigate pros and cons of doing that.
          Hide
          noor91zahara Noor Zahara (Inactive) added a comment -

          The reason cache control is set is so that for each request, the hit does not go to S3 but instead can take the response from the browser.

          Cons - Whenever the same file is replaced, it takes time to get updated i.e till the cache expires which is not good unless we are invalidating the cache.

          In our use case, the frequency of a user updating the logo is quite less and hence we could set the cache control to no-cache.

          Show
          noor91zahara Noor Zahara (Inactive) added a comment - The reason cache control is set is so that for each request, the hit does not go to S3 but instead can take the response from the browser. Cons - Whenever the same file is replaced, it takes time to get updated i.e till the cache expires which is not good unless we are invalidating the cache. In our use case, the frequency of a user updating the logo is quite less and hence we could set the cache control to no-cache.
          Hide
          ann.loraine Ann Loraine added a comment -

          Please change to "no-cache" for now and submit PR.
          To save costs later on – if we need to – we will revisit.
          I will make a ticket for same.

          Show
          ann.loraine Ann Loraine added a comment - Please change to "no-cache" for now and submit PR. To save costs later on – if we need to – we will revisit. I will make a ticket for same.
          Show
          noor91zahara Noor Zahara (Inactive) added a comment - PR Created - https://bitbucket.org/lorainelab/appstore/pull-requests/127/igbf-2001-2
          Hide
          ann.loraine Ann Loraine added a comment -

          Merged and deployed to https://dev-appstore-2.bioviz.org

          Show
          ann.loraine Ann Loraine added a comment - Merged and deployed to https://dev-appstore-2.bioviz.org
          Hide
          rpatil14 Riddhi Jagdish Patil (Inactive) added a comment -

          Tested successfully below scenarios:
          1) Click on any released app from app store home page -> Editor Actions -> Edit this page -> Hover on the logo space to view the tooltip
          2) Click on any released app from app store home page -> Editor Actions -> Edit this page -> Add any url as malformed -> Save. Error is thrown with invalid URL
          Issues found:
          1) Upload logo with say .png format, then replace the logo with say .jpg format. The logo gets updated on the App page but the old logo is not deleted from the S3 bucket as the extension of the two files is different. The old logo should be deleted from S3 irrespective of the file format.
          cc. [~aloraine]

          Show
          rpatil14 Riddhi Jagdish Patil (Inactive) added a comment - Tested successfully below scenarios: 1) Click on any released app from app store home page -> Editor Actions -> Edit this page -> Hover on the logo space to view the tooltip 2) Click on any released app from app store home page -> Editor Actions -> Edit this page -> Add any url as malformed -> Save. Error is thrown with invalid URL Issues found: 1) Upload logo with say .png format, then replace the logo with say .jpg format. The logo gets updated on the App page but the old logo is not deleted from the S3 bucket as the extension of the two files is different. The old logo should be deleted from S3 irrespective of the file format. cc. [~aloraine]
          Show
          noor91zahara Noor Zahara (Inactive) added a comment - Code changes - https://bitbucket.org/nzahara/appstore-local/branch/IGBF-2001-2#diff
          Hide
          ann.loraine Ann Loraine added a comment -

          Please submit PR. We will deploy onto dev-apptore-2 for testing. Noor Zahara

          Show
          ann.loraine Ann Loraine added a comment - Please submit PR. We will deploy onto dev-apptore-2 for testing. Noor Zahara
          Show
          noor91zahara Noor Zahara (Inactive) added a comment - PR Submitted - https://bitbucket.org/lorainelab/appstore/pull-requests/137/igbf-2001-delete-logo-image-from-s3-before/diff
          Hide
          ann.loraine Ann Loraine added a comment -

          Merged and deployed to dev-appstore-2-bioviz.org.

          Please review changes and let us know if any further fixes need to be made.
          Riddhi Jagdish Patil

          Show
          ann.loraine Ann Loraine added a comment - Merged and deployed to dev-appstore-2-bioviz.org. Please review changes and let us know if any further fixes need to be made. Riddhi Jagdish Patil
          Hide
          rpatil14 Riddhi Jagdish Patil (Inactive) added a comment -

          Tested successfully below scenarios:
          1) Click on any released app from app store home page -> Editor Actions -> Edit this page -> Hover on the logo space to view the tooltip
          2) Click on any released app from app store home page -> Editor Actions -> Edit this page -> Add any url as malformed -> Save. Error is thrown with invalid URL
          3) Upload logo with say .png format, then replace the logo with say .jpg format. The logo gets updated on the App page and the old logo is deleted from the S3 bucket even though the extension of the two files is different. Also, replace logo with different logo of same extension works as expected and deletes the old logo from S3 bucket.
          cc. [~aloraine], [~nzahara]

          Show
          rpatil14 Riddhi Jagdish Patil (Inactive) added a comment - Tested successfully below scenarios: 1) Click on any released app from app store home page -> Editor Actions -> Edit this page -> Hover on the logo space to view the tooltip 2) Click on any released app from app store home page -> Editor Actions -> Edit this page -> Add any url as malformed -> Save. Error is thrown with invalid URL 3) Upload logo with say .png format, then replace the logo with say .jpg format. The logo gets updated on the App page and the old logo is deleted from the S3 bucket even though the extension of the two files is different. Also, replace logo with different logo of same extension works as expected and deletes the old logo from S3 bucket. cc. [~aloraine] , [~nzahara]

            People

            • Assignee:
              noor91zahara Noor Zahara (Inactive)
              Reporter:
              rpatil14 Riddhi Jagdish Patil (Inactive)
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: