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

Fix bookmark file name appearance in IGB

    Details

    • Story Points:
      2
    • Sprint:
      Fall 5 2021 Oct 11 - Oct 22, Fall 6 2021 Oct 25 - Nov 5, Fall 7 2021 Nov 8 - Nov 24

      Description

      Situation: When a file from BioViz Connect is loaded in IGB without a species or genome version value, IGB uses logic in the loadUnknownData method of BookmarkUnibrowControlServlet.java to load the data. However, loadUnknownData fails to use the provided sym name.

      Task: Fix IGB so that the provided sym name is used when necessary.

        Attachments

        1. screenshot-1.png
          screenshot-1.png
          130 kB
        2. screenshot-2.png
          screenshot-2.png
          203 kB
        3. screenshot-3.png
          screenshot-3.png
          205 kB

          Issue Links

            Activity

            nfreese Nowlan Freese created issue -
            nfreese Nowlan Freese made changes -
            Field Original Value New Value
            Epic Link IGBF-1765 [ 17855 ]
            nfreese Nowlan Freese made changes -
            Link This issue relates to IGBF-2975 [ IGBF-2975 ]
            nfreese Nowlan Freese made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            Hide
            nfreese Nowlan Freese added a comment -

            Some notes that are also mentioned in IGBF-2975:

            Sym name is an optional field and may not always be present.
            Galaxy and BioViz Connect both use the same method when no genome is set in the bookmark (loadUnknownData).

            Show
            nfreese Nowlan Freese added a comment - Some notes that are also mentioned in IGBF-2975 : Sym name is an optional field and may not always be present. Galaxy and BioViz Connect both use the same method when no genome is set in the bookmark (loadUnknownData).
            Hide
            nfreese Nowlan Freese added a comment -

            I made changes to BookmarkUnibrowControlServlet.java in the loadUnknownData method. Previously, the url was being passed as the name of the track instead of the sym name. Now either the sym name or the file name (if no sym name) will be used.

            Moving to needs 1st level review.

            Commit:https://bitbucket.org/nfreese/nowlanfork-igb/commits/7e845cad7d5750023145d847a155805e733b4798
            Downloads: https://bitbucket.org/nfreese/nowlanfork-igb/downloads/

            Show
            nfreese Nowlan Freese added a comment - I made changes to BookmarkUnibrowControlServlet.java in the loadUnknownData method. Previously, the url was being passed as the name of the track instead of the sym name. Now either the sym name or the file name (if no sym name) will be used. Moving to needs 1st level review. Commit: https://bitbucket.org/nfreese/nowlanfork-igb/commits/7e845cad7d5750023145d847a155805e733b4798 Downloads: https://bitbucket.org/nfreese/nowlanfork-igb/downloads/
            Hide
            nfreese Nowlan Freese added a comment - - edited

            To test:

            Download my branch installer for IGBF-2983 and install IGB
            In IGB,
            Click here to load a bookmark from cyverse that includes the genome version and a sym name. The genome should be automatically selected and the track name and name under available data should be diseaseDa2d.bed.

            Remove the file from IGB.

            Next, click here to load a bookmark from cyverse that does not include the genome version but does include a sym name. The genome should not change, but the track name and name under available data should be diseaseDa2d.bed. The full URL should not be visible under Available Data.

            Show
            nfreese Nowlan Freese added a comment - - edited To test: Download my branch installer for IGBF-2983 and install IGB In IGB, Click here to load a bookmark from cyverse that includes the genome version and a sym name. The genome should be automatically selected and the track name and name under available data should be diseaseDa2d.bed. Remove the file from IGB. Next, click here to load a bookmark from cyverse that does not include the genome version but does include a sym name. The genome should not change, but the track name and name under available data should be diseaseDa2d.bed. The full URL should not be visible under Available Data.
            nfreese Nowlan Freese made changes -
            Assignee Nowlan Freese [ nfreese ]
            nfreese Nowlan Freese made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            Hide
            ann.loraine Ann Loraine added a comment -

            Before merging this, can we test all the different aspects of how the bookmarks code is used?

            Show
            ann.loraine Ann Loraine added a comment - Before merging this, can we test all the different aspects of how the bookmarks code is used?
            Hide
            ann.loraine Ann Loraine added a comment - - edited

            Perform functional testing using the below protocols prior to submitting PR:

            Also, test "View in IGB" functionality of eFP-Seq browser. For information on how to operate the "View in IGB" functionality of eFP-Seq browser, read article available from https://pubmed.ncbi.nlm.nih.gov/31350781.

            Show
            ann.loraine Ann Loraine added a comment - - edited Perform functional testing using the below protocols prior to submitting PR: https://wiki.transvar.org/display/ITD/Bookmarks (testing protocol) https://wiki.transvar.org/display/ITD/Galaxy (testing protocol) Also, test "View in IGB" functionality of eFP-Seq browser. For information on how to operate the "View in IGB" functionality of eFP-Seq browser, read article available from https://pubmed.ncbi.nlm.nih.gov/31350781 .
            ann.loraine Ann Loraine made changes -
            Link This issue is blocked by IGBF-2988 [ IGBF-2988 ]
            ann.loraine Ann Loraine made changes -
            Issue Type Task [ 3 ] Improvement [ 4 ]
            ann.loraine Ann Loraine made changes -
            Link This issue relates to IGBF-2988 [ IGBF-2988 ]
            ann.loraine Ann Loraine made changes -
            Link This issue is blocked by IGBF-2988 [ IGBF-2988 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            omarne Omkar Marne (Inactive) made changes -
            Assignee Omkar Marne [ omarne ]
            omarne Omkar Marne (Inactive) made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            omarne Omkar Marne (Inactive) made changes -
            Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
            omarne Omkar Marne (Inactive) made changes -
            Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
            omarne Omkar Marne (Inactive) made changes -
            Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
            omarne Omkar Marne (Inactive) made changes -
            Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
            omarne Omkar Marne (Inactive) made changes -
            Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
            omarne Omkar Marne (Inactive) made changes -
            Status Post-merge Testing In Progress [ 10003 ] To-Do [ 10305 ]
            omarne Omkar Marne (Inactive) made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            omarne Omkar Marne (Inactive) made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            omarne Omkar Marne (Inactive) made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            ann.loraine Ann Loraine made changes -
            Sprint Fall 5 2021 Oct 11 - Oct 22 [ 131 ] Fall 5 2021 Oct 11 - Oct 22, Fall 6 2021 Oct 25 - Nov 5 [ 131, 132 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            omarne Omkar Marne (Inactive) made changes -
            Attachment screenshot-1.png [ 16821 ]
            Hide
            omarne Omkar Marne (Inactive) added a comment - - edited

            Test results:

            • I followed https://wiki.transvar.org/display/ITD/Bookmarks testing protocol. I am able to perform all the testing steps for bookmarks in IGB.
            • For https://wiki.transvar.org/display/ITD/Galaxy testing protocol, the 'View in IGB' link under files in "Open Galaxy files in Integrated Genome Browser" is not working for chrome and Microsoft Edge browser even when IGB was running but It's working with Firefox. I was able to perform rest of the steps. Please check 'screenshot-1' for the error in chrome. ( This issue is unrelated to this ticket, its related to 2987. Dr. Freese is working to fix it.)
            Show
            omarne Omkar Marne (Inactive) added a comment - - edited Test results: I followed https://wiki.transvar.org/display/ITD/Bookmarks testing protocol. I am able to perform all the testing steps for bookmarks in IGB. For https://wiki.transvar.org/display/ITD/Galaxy testing protocol, the 'View in IGB' link under files in "Open Galaxy files in Integrated Genome Browser" is not working for chrome and Microsoft Edge browser even when IGB was running but It's working with Firefox. I was able to perform rest of the steps. Please check 'screenshot-1' for the error in chrome. ( This issue is unrelated to this ticket, its related to 2987. Dr. Freese is working to fix it.)
            Hide
            nfreese Nowlan Freese added a comment -
            Show
            nfreese Nowlan Freese added a comment - Can also test BioViz Connect: https://wiki.transvar.org/display/ITD/BioViz+Connect
            Hide
            omarne Omkar Marne (Inactive) added a comment -

            Final Test results:

            • I am able to perform all the testing steps for bookmarks in IGB.
            • For https://wiki.transvar.org/display/ITD/Galaxy testing protocol, the 'View in IGB' link under files in "Open Galaxy files in Integrated Genome Browser" is not working for chrome and Microsoft Edge browser even when IGB was running but It's working with Firefox. I was able to perform rest of the steps. Please check 'screenshot-1' for the error in chrome. ( This issue is unrelated to this ticket, its related to 2987. Dr. Freese is working to fix it.)
            • Changes made by Dr. Freese to BookmarkUnibrowControlServlet.java in the loadUnknownData method are working as expected. Now either the sym name or the file name (if no sym name) is getting used.
            • Functional testing for https://wiki.transvar.org/display/ITD/BioViz+Connect is also working fine. I am able to perform all the steps.
            Show
            omarne Omkar Marne (Inactive) added a comment - Final Test results: I am able to perform all the testing steps for bookmarks in IGB. For https://wiki.transvar.org/display/ITD/Galaxy testing protocol, the 'View in IGB' link under files in "Open Galaxy files in Integrated Genome Browser" is not working for chrome and Microsoft Edge browser even when IGB was running but It's working with Firefox. I was able to perform rest of the steps. Please check 'screenshot-1' for the error in chrome. ( This issue is unrelated to this ticket, its related to 2987. Dr. Freese is working to fix it.) Changes made by Dr. Freese to BookmarkUnibrowControlServlet.java in the loadUnknownData method are working as expected. Now either the sym name or the file name (if no sym name) is getting used. Functional testing for https://wiki.transvar.org/display/ITD/BioViz+Connect is also working fine. I am able to perform all the steps.
            omarne Omkar Marne (Inactive) made changes -
            Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
            omarne Omkar Marne (Inactive) made changes -
            Assignee Omkar Marne [ omarne ] Nowlan Freese [ nfreese ]
            Show
            nfreese Nowlan Freese added a comment - Pull request: https://bitbucket.org/lorainelab/integrated-genome-browser/pull-requests/890/igbf-2983-sym-name-or-file-name-used-in
            nfreese Nowlan Freese made changes -
            Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
            nfreese Nowlan Freese made changes -
            Assignee Nowlan Freese [ nfreese ]
            ann.loraine Ann Loraine made changes -
            Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
            ann.loraine Ann Loraine made changes -
            Assignee Ann Loraine [ aloraine ]
            ann.loraine Ann Loraine made changes -
            Sprint Fall 5 2021 Oct 11 - Oct 22, Fall 6 2021 Oct 25 - Nov 5 [ 131, 132 ] Fall 5 2021 Oct 11 - Oct 22, Fall 6 2021 Oct 25 - Nov 5, Fall 7 2021 Nov 8 - Nov 19 [ 131, 132, 133 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            ann.loraine Ann Loraine made changes -
            Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
            ann.loraine Ann Loraine made changes -
            Assignee Ann Loraine [ aloraine ]
            Hide
            ann.loraine Ann Loraine added a comment -

            Merged and ready for testing using master branch installer(s) from bitbucket repository Downloads folder.

            Show
            ann.loraine Ann Loraine added a comment - Merged and ready for testing using master branch installer(s) from bitbucket repository Downloads folder.
            omarne Omkar Marne (Inactive) made changes -
            Assignee Omkar Marne [ omarne ]
            omarne Omkar Marne (Inactive) made changes -
            Attachment screenshot-2.png [ 16958 ]
            omarne Omkar Marne (Inactive) made changes -
            Attachment screenshot-3.png [ 16959 ]
            Hide
            omarne Omkar Marne (Inactive) added a comment - - edited

            Test results on master branch :

            • After clicking the given link the genome got automatically selected and the track name and name under available data was diseaseDa2d.bed. Please see screenshot 2.
            • After removing the file and clicking the link again, the genome did not change, but the track name and name under available data was diseaseDa2d.bed. Please see screenshot 3.
            Show
            omarne Omkar Marne (Inactive) added a comment - - edited Test results on master branch : After clicking the given link the genome got automatically selected and the track name and name under available data was diseaseDa2d.bed. Please see screenshot 2. After removing the file and clicking the link again, the genome did not change, but the track name and name under available data was diseaseDa2d.bed. Please see screenshot 3.
            Hide
            ann.loraine Ann Loraine added a comment - - edited

            A couple of questions with the above comments. Please address:

            • Screenshot 2 does not include the title bar. Please always include the title bar as it shows the IGB version and genome. (Genome is also shown in the Current Genome tab)
            • The Available Data section is different in the two screenshots. I thought the point of this change was to remove the URL components so that you don't see so many folders, by ensuring that the "sym name" fields is respected regardless of whether a genome version is indicated?
            • I was confused as to what "sym name" is being passed in the test bookmarks. Is it the same as the file name?
            Show
            ann.loraine Ann Loraine added a comment - - edited A couple of questions with the above comments. Please address: Screenshot 2 does not include the title bar. Please always include the title bar as it shows the IGB version and genome. (Genome is also shown in the Current Genome tab) The Available Data section is different in the two screenshots. I thought the point of this change was to remove the URL components so that you don't see so many folders, by ensuring that the "sym name" fields is respected regardless of whether a genome version is indicated? I was confused as to what "sym name" is being passed in the test bookmarks. Is it the same as the file name?
            omarne Omkar Marne (Inactive) made changes -
            Attachment screenshot-2.png [ 16958 ]
            omarne Omkar Marne (Inactive) made changes -
            Attachment screenshot-2.png [ 16960 ]
            Hide
            nfreese Nowlan Freese added a comment - - edited

            Here are two new links to try (copy and paste them into web browser). The sym names have been changed so that they are different than the file names.

            http://127.0.0.1:7085/IGBControl?
            version=A_lyrata_Apr_2011&
            cyverse_data=true&
            sym_col_0=0x00FF00&
            sym_bg_0=0xFF0000&
            sym_name_0=exampleSymName1.bed&
            query_url=https://data.cyverse.org/dav-anon/iplant/home/kraveend91/diseaseDa2d.bed&
            feature_url_0=https://data.cyverse.org/dav-anon/iplant/home/kraveend91/diseaseDa2d.bed&
            sym_method_0=https://data.cyverse.org/dav-anon/iplant/home/kraveend91/diseaseDa2d.bed&
            loadresidues=false&
            server_url=cyverse

            http://127.0.0.1:7085/IGBControl?version=?&
            cyverse_data=true&
            sym_col_0=0x00FF00&
            sym_bg_0=0xFF0000&
            sym_name_0=exampleSymName2.bed&
            query_url=https://data.cyverse.org/dav-anon/iplant/home/kraveend91/diseaseDa2d.bed&
            feature_url_0=https://data.cyverse.org/dav-anon/iplant/home/kraveend91/diseaseDa2d.bed&
            sym_method_0=https://data.cyverse.org/dav-anon/iplant/home/kraveend91/diseaseDa2d.bed&
            loadresidues=false&
            server_url=cyverse

            Show
            nfreese Nowlan Freese added a comment - - edited Here are two new links to try (copy and paste them into web browser). The sym names have been changed so that they are different than the file names. http://127.0.0.1:7085/IGBControl? version=A_lyrata_Apr_2011& cyverse_data=true& sym_col_0=0x00FF00& sym_bg_0=0xFF0000& sym_name_0=exampleSymName1.bed& query_url= https://data.cyverse.org/dav-anon/iplant/home/kraveend91/diseaseDa2d.bed& feature_url_0= https://data.cyverse.org/dav-anon/iplant/home/kraveend91/diseaseDa2d.bed& sym_method_0= https://data.cyverse.org/dav-anon/iplant/home/kraveend91/diseaseDa2d.bed& loadresidues=false& server_url=cyverse http://127.0.0.1:7085/IGBControl?version=?& cyverse_data=true& sym_col_0=0x00FF00& sym_bg_0=0xFF0000& sym_name_0=exampleSymName2.bed& query_url= https://data.cyverse.org/dav-anon/iplant/home/kraveend91/diseaseDa2d.bed& feature_url_0= https://data.cyverse.org/dav-anon/iplant/home/kraveend91/diseaseDa2d.bed& sym_method_0= https://data.cyverse.org/dav-anon/iplant/home/kraveend91/diseaseDa2d.bed& loadresidues=false& server_url=cyverse
            omarne Omkar Marne (Inactive) made changes -
            Attachment screenshot-2.png [ 16960 ]
            omarne Omkar Marne (Inactive) made changes -
            Attachment screenshot-3.png [ 16959 ]
            omarne Omkar Marne (Inactive) made changes -
            Attachment screenshot-3.png [ 16961 ]
            omarne Omkar Marne (Inactive) made changes -
            Attachment screenshot-2.png [ 16962 ]
            omarne Omkar Marne (Inactive) made changes -
            Attachment screenshot-2.png [ 16962 ]
            omarne Omkar Marne (Inactive) made changes -
            Attachment screenshot-2.png [ 16963 ]
            Hide
            omarne Omkar Marne (Inactive) added a comment -

            Final Test results on the latest master branch.

            • After clicking the given link the genome got automatically selected and the track name and name under available data was diseaseDa2d.bed. Please check the sym name in the screenshot 2. The symname is exampleSymName1.bed.
            • After removing the file and clicking the link again, the genome did not change, the file name is same which is diseaseDa2d.bed. The symname is exampleSymName2.bed The full URL is not visible in the available data. Please see screenshot 3.

            Dr. Freese and I also tested on galaxy and bioviz connect, the results are good.

            Closing the ticket.

            Show
            omarne Omkar Marne (Inactive) added a comment - Final Test results on the latest master branch. After clicking the given link the genome got automatically selected and the track name and name under available data was diseaseDa2d.bed. Please check the sym name in the screenshot 2. The symname is exampleSymName1.bed. After removing the file and clicking the link again, the genome did not change, the file name is same which is diseaseDa2d.bed. The symname is exampleSymName2.bed The full URL is not visible in the available data. Please see screenshot 3. Dr. Freese and I also tested on galaxy and bioviz connect, the results are good. Closing the ticket.
            omarne Omkar Marne (Inactive) made changes -
            Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
            omarne Omkar Marne (Inactive) made changes -
            Resolution Done [ 10000 ]
            Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]
            nfreese Nowlan Freese made changes -
            Assignee Omkar Marne [ omarne ] Nowlan Freese [ nfreese ]
            nfreese Nowlan Freese made changes -
            Fix Version/s 9.1.10 Major Release [ 10700 ]

              People

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

                Dates

                • Created:
                  Updated:
                  Resolved: