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

Investigate: Workflow implemented in galaxy bridge page is not working as expected

    Details

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

      Description

      The workflow implemented in the Galaxy Bridge page - with URL https://bioviz.org/galaxy.html - is not working as expected. A re-design of the code may be needed!

      Here is what should happen:

      If a user clicks a "display in IGB ( View )" link for a Galaxy dataset and IGB is not yet running, a message is supposed to appear letting the user know that they need to start IGB to see the data. This works fine if a dataset dbkey is set.

      However, if a dataset is lacking a dbkey and IGB is not running, then another message appears that does not make a lot of sense if IGB is not running. That message says:

      The file you are trying to view does not have a genome version associated with it. Please return to Galaxy and associate a genome version with the file and try again.

      Thus, the business logic of the page appears to be messed up. Here is what ideally should happen whenever a user clicks the "view in IGB" link for a Galaxy History dataset:

      First, the page code should check: Is IGB running?

      • Yes -> go to A
      • No -> go to B

      A: Check: is there a "dbkey" for the dataset?

      • Yes -> go to C
      • No -> go to D

      B: Display a message that tells the user to start IGB and then refresh the page. Upon refresh, do A.

      C: At this point, we know that Galaxy History dataset dbkey value is set and also that IGB is running. Now tell the user to check IGB. IGB should have opened a new empty track for the dataset. They should zoom in on a gene or a group of genes, and click Load Data button to load the Galaxy History dataset's data into the new track.

      D. At this point, we know that Galaxy History dataset dbkey value is NOT set and also that IGB is running. This means that IGB may or may not be showing a genome version appropriate for the dataset to be shown on top of. Tell the user that if they have not already done so, go to IGB and open the genome of corresponding to the Galaxy History dataset they are trying to view. Let them know that once they do that, they can refresh the page to send the data to a new track in IGB.

      Note that we have set up Google Analytics for this page. We are tracking a number of the steps in the workflow, and we need to take this into account when making any changes. Ideally, we would not lose our ability to track any of these key "milestones" when viewing data from Galaxy History data files.

      For this task, please:

      • Attempt to reproduce the bug, e.g., when IGB is not running and you click a "view in IGB" link from a Galaxy History dataset, you see the message from above:

      The file you are trying to view does not have a genome version associated with it. Please return to Galaxy and associate a genome version with the file and try again.

      • Propose a new structure for the underlying code that will correctly guide an astute user through the steps they need to perform in order to view the data from a Galaxy History dataset in IGB.

        Attachments

          Issue Links

            Activity

            ann.loraine Ann Loraine created issue -
            ann.loraine Ann Loraine made changes -
            Field Original Value New Value
            Epic Link IGBF-1880 [ 17970 ]
            ann.loraine Ann Loraine made changes -
            Description The workflow implemented in the Galaxy Bridge page - with URL https://bioviz.org/galaxy.html - is not working as expected. A re-design of the code may be needed!

            Here is what should happen:

            If a user clicks a "view in IGB" link for a Galaxy dataset *and* IGB is not yet running, a message is supposed to appear letting the user know that they need to start IGB to see the data. This works fine if a dataset dbkey is set. It does not work if the dbkey is not set.

            If a dataset is lacking a dbkey and IGB is not running, then another message appears that does not make a lot of sense if IGB is not running. That message says:

            {quote}
            The file you are trying to view does not have a genome version associated with it. Please return to Galaxy and associate a genome version with the file and try again.
            {quote}

            The business logic of the page appears to be messed up. Here is what ideally should happen whenever a user clicks the "view in IGB" link for a Galaxy History dataset:

            First, the page code should check: Is IGB running?
            * Yes -> go to A
            * No -> go to B

            A: Check: is there a "dbkey" for the dataset?
            * Yes -> go to C
            * No -> go to D

            B: Display a message that tells the user to start IGB and then refresh the page. Upon refresh, do A.

            C: At this point, we know that Galaxy History dataset dbkey value is set and also that IGB is running. Now tell the user to check IGB. IGB should have opened a new empty track for the dataset. They should zoom in on a gene or a group of genes, and click Load Data button to load the Galaxy History dataset's data into the new track.

            D. At this point, we know that Galaxy History dataset dbkey value is NOT set and also that IGB is running. This means that IGB may or may not be showing a genome version appropriate for the dataset to be shown on top of. Tell the user that if they have not already done so, go to IGB and open the genome of corresponding to the Galaxy History dataset they are trying to view. Let them know that once they do that, they can refresh the page to send the data to a new track in IGB.

            Note that we have set up Google Analytics for this page. We are tracking a number of the steps in the workflow, and we need to take this into account when making any changes. Ideally, we would not lose our ability to track any of these key "milestones" when viewing data from Galaxy History data files.

            For this task, please:

            * Attempt to reproduce the bug, e.g., when IGB is not running and you click a "view in IGB" link from a Galaxy History dataset, you see the message from above:

            {quote}
            The file you are trying to view does not have a genome version associated with it. Please return to Galaxy and associate a genome version with the file and try again.
            {quote}

            * Propose a new structure for the underlying code that will correctly guide an astute user through the steps they need to perform in order to view the data from a Galaxy History dataset in IGB.
            The workflow implemented in the Galaxy Bridge page - with URL https://bioviz.org/galaxy.html - is not working as expected. A re-design of the code may be needed!

            Here is what should happen:

            If a user clicks a "view in IGB" link for a Galaxy dataset *and* IGB is not yet running, a message is supposed to appear letting the user know that they need to start IGB to see the data. This works fine if a dataset dbkey is set. It does not work if the dbkey is not set.

            If a dataset is lacking a dbkey and IGB is not running, then another message appears that does not make a lot of sense if IGB is not running. That message says:

            {quote}
            The file you are trying to view does not have a genome version associated with it. Please return to Galaxy and associate a genome version with the file and try again.
            {quote}

            Thus, the business logic of the page appears to be messed up. Here is what ideally should happen whenever a user clicks the "view in IGB" link for a Galaxy History dataset:

            First, the page code should check: Is IGB running?
            * Yes -> go to A
            * No -> go to B

            A: Check: is there a "dbkey" for the dataset?
            * Yes -> go to C
            * No -> go to D

            B: Display a message that tells the user to start IGB and then refresh the page. Upon refresh, do A.

            C: At this point, we know that Galaxy History dataset dbkey value is set and also that IGB is running. Now tell the user to check IGB. IGB should have opened a new empty track for the dataset. They should zoom in on a gene or a group of genes, and click Load Data button to load the Galaxy History dataset's data into the new track.

            D. At this point, we know that Galaxy History dataset dbkey value is NOT set and also that IGB is running. This means that IGB may or may not be showing a genome version appropriate for the dataset to be shown on top of. Tell the user that if they have not already done so, go to IGB and open the genome of corresponding to the Galaxy History dataset they are trying to view. Let them know that once they do that, they can refresh the page to send the data to a new track in IGB.

            Note that we have set up Google Analytics for this page. We are tracking a number of the steps in the workflow, and we need to take this into account when making any changes. Ideally, we would not lose our ability to track any of these key "milestones" when viewing data from Galaxy History data files.

            For this task, please:

            * Attempt to reproduce the bug, e.g., when IGB is not running and you click a "view in IGB" link from a Galaxy History dataset, you see the message from above:

            {quote}
            The file you are trying to view does not have a genome version associated with it. Please return to Galaxy and associate a genome version with the file and try again.
            {quote}

            * Propose a new structure for the underlying code that will correctly guide an astute user through the steps they need to perform in order to view the data from a Galaxy History dataset in IGB.
            ann.loraine Ann Loraine made changes -
            Description The workflow implemented in the Galaxy Bridge page - with URL https://bioviz.org/galaxy.html - is not working as expected. A re-design of the code may be needed!

            Here is what should happen:

            If a user clicks a "view in IGB" link for a Galaxy dataset *and* IGB is not yet running, a message is supposed to appear letting the user know that they need to start IGB to see the data. This works fine if a dataset dbkey is set. It does not work if the dbkey is not set.

            If a dataset is lacking a dbkey and IGB is not running, then another message appears that does not make a lot of sense if IGB is not running. That message says:

            {quote}
            The file you are trying to view does not have a genome version associated with it. Please return to Galaxy and associate a genome version with the file and try again.
            {quote}

            Thus, the business logic of the page appears to be messed up. Here is what ideally should happen whenever a user clicks the "view in IGB" link for a Galaxy History dataset:

            First, the page code should check: Is IGB running?
            * Yes -> go to A
            * No -> go to B

            A: Check: is there a "dbkey" for the dataset?
            * Yes -> go to C
            * No -> go to D

            B: Display a message that tells the user to start IGB and then refresh the page. Upon refresh, do A.

            C: At this point, we know that Galaxy History dataset dbkey value is set and also that IGB is running. Now tell the user to check IGB. IGB should have opened a new empty track for the dataset. They should zoom in on a gene or a group of genes, and click Load Data button to load the Galaxy History dataset's data into the new track.

            D. At this point, we know that Galaxy History dataset dbkey value is NOT set and also that IGB is running. This means that IGB may or may not be showing a genome version appropriate for the dataset to be shown on top of. Tell the user that if they have not already done so, go to IGB and open the genome of corresponding to the Galaxy History dataset they are trying to view. Let them know that once they do that, they can refresh the page to send the data to a new track in IGB.

            Note that we have set up Google Analytics for this page. We are tracking a number of the steps in the workflow, and we need to take this into account when making any changes. Ideally, we would not lose our ability to track any of these key "milestones" when viewing data from Galaxy History data files.

            For this task, please:

            * Attempt to reproduce the bug, e.g., when IGB is not running and you click a "view in IGB" link from a Galaxy History dataset, you see the message from above:

            {quote}
            The file you are trying to view does not have a genome version associated with it. Please return to Galaxy and associate a genome version with the file and try again.
            {quote}

            * Propose a new structure for the underlying code that will correctly guide an astute user through the steps they need to perform in order to view the data from a Galaxy History dataset in IGB.
            The workflow implemented in the Galaxy Bridge page - with URL https://bioviz.org/galaxy.html - is not working as expected. A re-design of the code may be needed!

            Here is what should happen:

            If a user clicks a "display in IGB ( View )" link for a Galaxy dataset *and* IGB is not yet running, a message is supposed to appear letting the user know that they need to start IGB to see the data. This works fine if a dataset dbkey is set.

            However, if a dataset is lacking a dbkey and IGB is not running, then another message appears that does not make a lot of sense if IGB is not running. That message says:

            {quote}
            The file you are trying to view does not have a genome version associated with it. Please return to Galaxy and associate a genome version with the file and try again.
            {quote}

            Thus, the business logic of the page appears to be messed up. Here is what ideally should happen whenever a user clicks the "view in IGB" link for a Galaxy History dataset:

            First, the page code should check: Is IGB running?
            * Yes -> go to A
            * No -> go to B

            A: Check: is there a "dbkey" for the dataset?
            * Yes -> go to C
            * No -> go to D

            B: Display a message that tells the user to start IGB and then refresh the page. Upon refresh, do A.

            C: At this point, we know that Galaxy History dataset dbkey value is set and also that IGB is running. Now tell the user to check IGB. IGB should have opened a new empty track for the dataset. They should zoom in on a gene or a group of genes, and click Load Data button to load the Galaxy History dataset's data into the new track.

            D. At this point, we know that Galaxy History dataset dbkey value is NOT set and also that IGB is running. This means that IGB may or may not be showing a genome version appropriate for the dataset to be shown on top of. Tell the user that if they have not already done so, go to IGB and open the genome of corresponding to the Galaxy History dataset they are trying to view. Let them know that once they do that, they can refresh the page to send the data to a new track in IGB.

            Note that we have set up Google Analytics for this page. We are tracking a number of the steps in the workflow, and we need to take this into account when making any changes. Ideally, we would not lose our ability to track any of these key "milestones" when viewing data from Galaxy History data files.

            For this task, please:

            * Attempt to reproduce the bug, e.g., when IGB is not running and you click a "view in IGB" link from a Galaxy History dataset, you see the message from above:

            {quote}
            The file you are trying to view does not have a genome version associated with it. Please return to Galaxy and associate a genome version with the file and try again.
            {quote}

            * Propose a new structure for the underlying code that will correctly guide an astute user through the steps they need to perform in order to view the data from a Galaxy History dataset in IGB.
            nfreese Nowlan Freese made changes -
            Link This issue relates to IGBF-3960 [ IGBF-3960 ]
            nfreese Nowlan Freese made changes -
            Link This issue relates to IGBF-4111 [ IGBF-4111 ]
            nfreese Nowlan Freese made changes -
            Sprint Summer 5 [ 222 ] Summer 4 [ 221 ]
            nfreese Nowlan Freese made changes -
            Rank Ranked lower
            nfreese Nowlan Freese made changes -
            Assignee Nowlan Freese [ nfreese ]
            nfreese Nowlan Freese made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            nfreese Nowlan Freese made changes -
            Status In Progress [ 3 ] To-Do [ 10305 ]
            ann.loraine Ann Loraine made changes -
            Sprint Summer 4 [ 221 ] Summer 4, Summer 5 [ 221, 222 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            nfreese Nowlan Freese made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            nfreese Nowlan Freese made changes -
            Assignee Nowlan Freese [ nfreese ]
            nfreese Nowlan Freese made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            nfreese Nowlan Freese made changes -
            Assignee Ann Loraine [ aloraine ]
            ann.loraine Ann Loraine made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            ann.loraine Ann Loraine made changes -
            Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
            ann.loraine Ann Loraine made changes -
            Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
            ann.loraine Ann Loraine made changes -
            Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
            ann.loraine Ann Loraine made changes -
            Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
            ann.loraine Ann Loraine made changes -
            Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
            ann.loraine Ann Loraine made changes -
            Resolution Done [ 10000 ]
            Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]
            ann.loraine Ann Loraine made changes -
            Assignee Ann Loraine [ aloraine ] Nowlan Freese [ nfreese ]

              People

              • Assignee:
                nfreese Nowlan Freese
                Reporter:
                ann.loraine Ann Loraine
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: