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

Improve Public TrackHub toasts messages

    Details

    • Type: Task
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None

      Description

      Situation: The toast messages that appear when clicking "Add Hub to IGB" or "Open in IGB" on bioviz.org/public-trackhubs.html could be improved.

      Task: Improve the Bioviz.org track hub toast messages.

        Attachments

          Issue Links

            Activity

            Hide
            nfreese Nowlan Freese added a comment - - edited

            Here are the current messages as tested with the following versions of IGB:

            IGB is not running:
            Add Hub to IGB - "Could not add to IGB \n Please restart IGB and try again"
            Open in IGB - "IGB is not running: \n Start IGB to open this genome version in IGB."

            Running IGB 9.1.4 (IGB status check does not return version (version added in 9.1.6), no add data source endpoint)
            Add Hub to IGB - "Could not add to IGB \n Please restart IGB and try again"
            Open in IGB - "Opening in IGB \n Establishing connection to IGB..."

            Running IGB 9.1.8 (IGB status check returns version, no add data source endpoint)
            Add Hub to IGB - "Could not add to IGB \n Please restart IGB and try again"
            Open in IGB - "Opening in IGB \n Establishing connection to IGB..."

            Running IGB 9.1.10 (IGB status check returns version, add data source endpoint is available)
            Add Hub to IGB - "Success \n genome is loading in IGB"
            Open in IGB - "Opening in IGB \n Establishing connection to IGB..."

            Show
            nfreese Nowlan Freese added a comment - - edited Here are the current messages as tested with the following versions of IGB: IGB is not running: Add Hub to IGB - "Could not add to IGB \n Please restart IGB and try again" Open in IGB - "IGB is not running: \n Start IGB to open this genome version in IGB." Running IGB 9.1.4 (IGB status check does not return version (version added in 9.1.6), no add data source endpoint) Add Hub to IGB - "Could not add to IGB \n Please restart IGB and try again" Open in IGB - "Opening in IGB \n Establishing connection to IGB..." Running IGB 9.1.8 (IGB status check returns version, no add data source endpoint) Add Hub to IGB - "Could not add to IGB \n Please restart IGB and try again" Open in IGB - "Opening in IGB \n Establishing connection to IGB..." Running IGB 9.1.10 (IGB status check returns version, add data source endpoint is available) Add Hub to IGB - "Success \n genome is loading in IGB" Open in IGB - "Opening in IGB \n Establishing connection to IGB..."
            Hide
            nfreese Nowlan Freese added a comment -

            Alternatives:

            IGB is not running:
            Add Hub to IGB - "IGB is not running \n Please start IGB"
            Open in IGB - "IGB is not running \n Please start IGB"

            Running IGB 9.1.4 (IGB status check does not return version (version added in 9.1.6), no add data source endpoint)
            Add Hub to IGB - "Could not add to IGB \n Please update IGB to latest version"
            Open in IGB - "Success \n Opening genome in IGB"

            Running IGB 9.1.8 (IGB status check returns version, no add data source endpoint)
            Add Hub to IGB - "Could not add to IGB \n Please update IGB to latest version"
            Open in IGB - "Success \n Opening genome in IGB"

            Running IGB 9.1.10 (IGB status check returns version, add data source endpoint is available)
            Add Hub to IGB - "Success \n Adding data source to IGB"
            Open in IGB - "Success \n Opening genome in IGB"

            1. Check the version returned from igbStatusCheck, if no version, assume less than 9.1.10.
            2. How much work would it add to insert the genome name clicked into the toast?
            Show
            nfreese Nowlan Freese added a comment - Alternatives: IGB is not running: Add Hub to IGB - "IGB is not running \n Please start IGB" Open in IGB - "IGB is not running \n Please start IGB" Running IGB 9.1.4 (IGB status check does not return version (version added in 9.1.6), no add data source endpoint) Add Hub to IGB - "Could not add to IGB \n Please update IGB to latest version" Open in IGB - "Success \n Opening genome in IGB" Running IGB 9.1.8 (IGB status check returns version, no add data source endpoint) Add Hub to IGB - "Could not add to IGB \n Please update IGB to latest version" Open in IGB - "Success \n Opening genome in IGB" Running IGB 9.1.10 (IGB status check returns version, add data source endpoint is available) Add Hub to IGB - "Success \n Adding data source to IGB" Open in IGB - "Success \n Opening genome in IGB" Check the version returned from igbStatusCheck, if no version, assume less than 9.1.10. How much work would it add to insert the genome name clicked into the toast?
            Show
            nfreese Nowlan Freese added a comment - - edited Please also change the Quickload URI button to provide the trackhub quickload uri without the igbDataSource endpoint. For example: Replace: http://127.0.0.1:7085/igbDataSource?quickloadurl=https://translate.bioviz.org/api/?hubUrl=https://raw.githubusercontent.com/Kraus-Lab/publichubs/master/breast_cancer_lncrna_pmid_26236012/hub.txt%26filePath=/&quickloadname=Breast%20Cancer%20lncRNA With this: https://translate.bioviz.org/api/?hubUrl=https://raw.githubusercontent.com/Kraus-Lab/publichubs/master/breast_cancer_lncrna_pmid_26236012/hub.txt&filePath=/
            Hide
            karthik Karthik Raveendran added a comment -

            Changes mentioned above has been implemented. See Commit

            Show
            karthik Karthik Raveendran added a comment - Changes mentioned above has been implemented. See Commit
            Hide
            nfreese Nowlan Freese added a comment -

            Messages after commit:

            IGB is not running:
            Add Hub to IGB - "IGB is not running. \n Please start IGB"
            Open in IGB - "IGB is not running: \n Start IGB to open this genome version in IGB."

            Running IGB 9.1.4 (IGB status check does not return version (version added in 9.1.6), no add data source endpoint)
            Add Hub to IGB - "Could not add to IGB \n Please update IGB to latest version"
            Open in IGB - "Opening in IGB \n Establishing connection with IGB..."

            Running IGB 9.1.8 (IGB status check returns version, no add data source endpoint)
            Add Hub to IGB - "Could not add to IGB \n Please update IGB to latest version"
            Open in IGB - "Opening in IGB \n Establishing connection with IGB..."

            Running IGB 9.1.10 (IGB status check returns version, add data source endpoint is available)
            Add Hub to IGB - "Success! \n Adding data source to IGB"
            Open in IGB - "Opening in IGB \n Establishing connection with IGB..."

            Note: To test locally, need to set the BACKEND_DOMAIN to https://translate.bioviz.org in util.js.

            export const BACKEND_DOMAIN = "https://translate.bioviz.org";

            Ready for pull request.

            Show
            nfreese Nowlan Freese added a comment - Messages after commit: IGB is not running: Add Hub to IGB - "IGB is not running. \n Please start IGB" Open in IGB - "IGB is not running: \n Start IGB to open this genome version in IGB." Running IGB 9.1.4 (IGB status check does not return version (version added in 9.1.6), no add data source endpoint) Add Hub to IGB - "Could not add to IGB \n Please update IGB to latest version" Open in IGB - "Opening in IGB \n Establishing connection with IGB..." Running IGB 9.1.8 (IGB status check returns version, no add data source endpoint) Add Hub to IGB - "Could not add to IGB \n Please update IGB to latest version" Open in IGB - "Opening in IGB \n Establishing connection with IGB..." Running IGB 9.1.10 (IGB status check returns version, add data source endpoint is available) Add Hub to IGB - "Success! \n Adding data source to IGB" Open in IGB - "Opening in IGB \n Establishing connection with IGB..." Note: To test locally, need to set the BACKEND_DOMAIN to https://translate.bioviz.org in util.js. export const BACKEND_DOMAIN = "https: //translate.bioviz.org" ; Ready for pull request.
            Show
            karthik Karthik Raveendran added a comment - PR Submitted: https://bitbucket.org/lorainelab/bioviz/pull-requests/103/igbf-3164-fix-toast-message-to-be-precise
            Hide
            ann.loraine Ann Loraine added a comment - - edited

            Merged. Deployed to BioViz main and ready for testing at bioviz.org.

            Show
            ann.loraine Ann Loraine added a comment - - edited Merged. Deployed to BioViz main and ready for testing at bioviz.org.
            Hide
            nfreese Nowlan Freese added a comment -

            Tested on Firefox 103.0.2 on macOS 12.5.1 using latest IGB master.
            Reset preferences to default and removed the .igb folder.

            Toasts appear correctly and the Quickload URI copied button copies the expected URI.

            Note: While testing the Open in IGB link between various versions of IGB, it appears that the latest IGB master opens genomes much slower than previous versions of IGB, such as 9.1.8 release. I have created IGBF-3169 to investigate this discrepancy.

            Closing ticket.

            Show
            nfreese Nowlan Freese added a comment - Tested on Firefox 103.0.2 on macOS 12.5.1 using latest IGB master. Reset preferences to default and removed the .igb folder. Toasts appear correctly and the Quickload URI copied button copies the expected URI. Note: While testing the Open in IGB link between various versions of IGB, it appears that the latest IGB master opens genomes much slower than previous versions of IGB, such as 9.1.8 release. I have created IGBF-3169 to investigate this discrepancy. Closing ticket.

              People

              • Assignee:
                karthik Karthik Raveendran
                Reporter:
                nfreese Nowlan Freese
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: