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

Encode folder names with special characters

    Details

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

      Description

      Situation: If a folder has special characters it is failing to open.

      Task: Encode folder names.

        Attachments

          Issue Links

            Activity

            nfreese Nowlan Freese created issue -
            nfreese Nowlan Freese made changes -
            Field Original Value New Value
            Epic Link IGBF-1482 [ 17568 ]
            nfreese Nowlan Freese made changes -
            Link This issue relates to IGBF-2275 [ IGBF-2275 ]
            chaitanya Chaitanya Kintali (Inactive) made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            Hide
            chaitanya Chaitanya Kintali (Inactive) added a comment -

            Encoded the folder names, and breadcrumbs across all sections and search API's.

            Pull Request: https://bitbucket.org/nfreese/django-cyversedev/pull-requests/149/igbf-2292/diff

            Nowlan Freese Can you please test this ticket. Moving to Needs Testing

            Show
            chaitanya Chaitanya Kintali (Inactive) added a comment - Encoded the folder names, and breadcrumbs across all sections and search API's. Pull Request: https://bitbucket.org/nfreese/django-cyversedev/pull-requests/149/igbf-2292/diff Nowlan Freese Can you please test this ticket. Moving to Needs Testing
            chaitanya Chaitanya Kintali (Inactive) made changes -
            Assignee Chaitanya Kintali [ chaitanya ] Nowlan Freese [ nfreese ]
            chaitanya Chaitanya Kintali (Inactive) made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            chaitanya Chaitanya Kintali (Inactive) made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            Hide
            nfreese Nowlan Freese added a comment - - edited

            Merged: https://bitbucket.org/nfreese/django-cyversedev/pull-requests/149/igbf-2292/diff

            I can navigate through folders with special characters, and the bread crumbs are working, but I'm seeing lots of odd behavior.

            1) Search bar seems to be broken everywhere ( ? )

            2) The files here - will not load in IGB. The normalName file does not cause an error, but it does not load the file. The file with special characters throws an error in IGB. I'm wondering if the public link being generated is not being encoded correctly? The public link shown in the Manage Link right panel is not encoded either.

            3) The right-panels seem to be working correctly (have not run an analyses), but there's a weird behavior in the metadata. Once a species is selected the dropdown for version shows all of the options and no longer functions as a dropdown. This may not be related to your changes, though, I recently merged in some other changes from Karthik.

            Show
            nfreese Nowlan Freese added a comment - - edited Merged: https://bitbucket.org/nfreese/django-cyversedev/pull-requests/149/igbf-2292/diff I can navigate through folders with special characters, and the bread crumbs are working, but I'm seeing lots of odd behavior. 1) Search bar seems to be broken everywhere ( ? ) 2) The files here - will not load in IGB. The normalName file does not cause an error, but it does not load the file. The file with special characters throws an error in IGB. I'm wondering if the public link being generated is not being encoded correctly? The public link shown in the Manage Link right panel is not encoded either. 3) The right-panels seem to be working correctly (have not run an analyses), but there's a weird behavior in the metadata. Once a species is selected the dropdown for version shows all of the options and no longer functions as a dropdown. This may not be related to your changes, though, I recently merged in some other changes from Karthik.
            nfreese Nowlan Freese made changes -
            Assignee Nowlan Freese [ nfreese ] Chaitanya Kintali [ chaitanya ]
            nfreese Nowlan Freese made changes -
            Status First Level Review in Progress [ 10301 ] To-Do [ 10305 ]
            nfreese Nowlan Freese made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            nfreese Nowlan Freese made changes -
            Sprint Spring 5 : 16 Mar to 27 Mar [ 90 ] Spring 5 : 16 Mar to 27 Mar, Spring 6 : 30 Mar to Apr 10 [ 90, 91 ]
            nfreese Nowlan Freese made changes -
            Rank Ranked higher
            Hide
            chaitanya Chaitanya Kintali (Inactive) added a comment -

            Fixed the Search bar issue.
            Fixed the View in IGB issue, encoding the public file path in the manage link, fixed the dropdown issue in the metadata genome version.

            Commit Link:
            https://bitbucket.org/ckintali/latest-ck-django-cyversedev/commits/735c2ecf6d38ea8ea17a759cf037fafc83e32839

            Show
            chaitanya Chaitanya Kintali (Inactive) added a comment - Fixed the Search bar issue. Fixed the View in IGB issue, encoding the public file path in the manage link, fixed the dropdown issue in the metadata genome version. Commit Link: https://bitbucket.org/ckintali/latest-ck-django-cyversedev/commits/735c2ecf6d38ea8ea17a759cf037fafc83e32839
            nfreese Nowlan Freese made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            nfreese Nowlan Freese made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            nfreese Nowlan Freese made changes -
            Assignee Chaitanya Kintali [ chaitanya ] Nowlan Freese [ nfreese ]
            Hide
            nfreese Nowlan Freese added a comment -

            View in IGB is working.
            Public file path in manage link is working.
            Dropdown for genome version is working.

            Search bar is working with one interesting edge case:

            If you do a search for a file with special characters (stuff_Unable to render embedded object: File (&_ space _stuff.bedGraph) we get an error. If I encode the file name, no results are returned (stuff_) not found.%40%23%24%25%5E%26_%20space%20_stuff.bedGraph). However, if I try the same thing in the discovery environment, it leads to an error. If I try to hit the API directly, it also causes an error. I don't think the Terrain API can handle special characters, so I don't think there is anything we can do about it.

            Closing issue.

            Show
            nfreese Nowlan Freese added a comment - View in IGB is working. Public file path in manage link is working. Dropdown for genome version is working. Search bar is working with one interesting edge case: If you do a search for a file with special characters (stuff_ Unable to render embedded object: File (&_ space _stuff.bedGraph) we get an error. If I encode the file name, no results are returned (stuff_) not found. %40%23%24%25%5E%26_%20space%20_stuff.bedGraph). However, if I try the same thing in the discovery environment, it leads to an error. If I try to hit the API directly, it also causes an error. I don't think the Terrain API can handle special characters, so I don't think there is anything we can do about it. Closing issue.
            nfreese Nowlan Freese made changes -
            Assignee Nowlan Freese [ nfreese ] Chaitanya Kintali [ chaitanya ]
            nfreese Nowlan Freese made changes -
            Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
            nfreese Nowlan Freese made changes -
            Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
            nfreese Nowlan Freese made changes -
            Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
            nfreese Nowlan Freese made changes -
            Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
            nfreese Nowlan Freese made changes -
            Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
            nfreese Nowlan Freese made changes -
            Resolution Done [ 10000 ]
            Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]
            nfreese Nowlan Freese made changes -
            Resolution Done [ 10000 ]
            Status Closed [ 6 ] To-Do [ 10305 ]
            nfreese Nowlan Freese made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            nfreese Nowlan Freese made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            nfreese Nowlan Freese made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            nfreese Nowlan Freese made changes -
            Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
            nfreese Nowlan Freese made changes -
            Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
            nfreese Nowlan Freese made changes -
            Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
            nfreese Nowlan Freese made changes -
            Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
            nfreese Nowlan Freese made changes -
            Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
            nfreese Nowlan Freese made changes -
            Resolution Done [ 10000 ]
            Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]
            Hide
            nfreese Nowlan Freese added a comment - - edited

            Chaitanya Kintali

            I have been testing running analyses on files/folders with special characters and have come across some edge cases.

            In the Discovery Environment:
            Running an analyses on a bam file with NO special characters from a directory with special characters and the output being saved to a directory with NO special characters works.
            Running an analyses on a bam file with special characters from a directory with special characters and the output being saved to a directory with NO special characters does not work.
            Running an analyses on a bam file with NO characters from a directory with special characters and the output being saved to a directory with special characters is not allowed.

            In BioViz Connect because we always save the output to the same directory as the input (assuming in Home), if the folder has special characters, then the analysis will fail. Because the only scenario that works through the DE is when the file has no special characters and the output is saved to a folder with no special characters, there isn't anything we can do to get this to work in BioViz Connect. Effectively it seems like special characters in folders/files will trip up analyses.

            Something to keep in mind if this creates issues in the future.

            Show
            nfreese Nowlan Freese added a comment - - edited Chaitanya Kintali I have been testing running analyses on files/folders with special characters and have come across some edge cases. In the Discovery Environment: Running an analyses on a bam file with NO special characters from a directory with special characters and the output being saved to a directory with NO special characters works. Running an analyses on a bam file with special characters from a directory with special characters and the output being saved to a directory with NO special characters does not work. Running an analyses on a bam file with NO characters from a directory with special characters and the output being saved to a directory with special characters is not allowed. In BioViz Connect because we always save the output to the same directory as the input (assuming in Home), if the folder has special characters, then the analysis will fail. Because the only scenario that works through the DE is when the file has no special characters and the output is saved to a folder with no special characters, there isn't anything we can do to get this to work in BioViz Connect. Effectively it seems like special characters in folders/files will trip up analyses. Something to keep in mind if this creates issues in the future.
            Hide
            chaitanya Chaitanya Kintali (Inactive) added a comment -

            Nowlan Freese,

            Thank you so much for testing and finding out these issues. So considering this above scenario, how would it impact https://jira.transvar.org/browse/IGBF-2304.
            Even though the analyses might fail, the output folder will still be the folder from where the analyses was run ( if the file is in home section). When the user clicks on the failed analyses name he will be redirected to the output folder but he won't be able to see the output file since the analyses was failed. Should we go with this same behavior? or do something like do not redirect the user to the output folder if the analyses fails ?

            Show
            chaitanya Chaitanya Kintali (Inactive) added a comment - Nowlan Freese , Thank you so much for testing and finding out these issues. So considering this above scenario, how would it impact https://jira.transvar.org/browse/IGBF-2304 . Even though the analyses might fail, the output folder will still be the folder from where the analyses was run ( if the file is in home section). When the user clicks on the failed analyses name he will be redirected to the output folder but he won't be able to see the output file since the analyses was failed. Should we go with this same behavior? or do something like do not redirect the user to the output folder if the analyses fails ?
            Hide
            nfreese Nowlan Freese added a comment -

            I think we should be consistent and have the analyses link back the folder from where the analyses was run even if the analyses failed. That way if the analysis fails (for any reason), they will see that it fails in the Analyses log, and can then quickly link back to the folder where the file was run from. It's possible the analyses could fail for other reasons (something wrong with cluster running jobs) and that the user would want to re submit the analyses.

            Show
            nfreese Nowlan Freese added a comment - I think we should be consistent and have the analyses link back the folder from where the analyses was run even if the analyses failed. That way if the analysis fails (for any reason), they will see that it fails in the Analyses log, and can then quickly link back to the folder where the file was run from. It's possible the analyses could fail for other reasons (something wrong with cluster running jobs) and that the user would want to re submit the analyses.

              People

              • Assignee:
                chaitanya Chaitanya Kintali (Inactive)
                Reporter:
                nfreese Nowlan Freese
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: