Issue 470 refine state selection

[alexhuang091]

for #470

1. states are populated by the selected country
2. if
   • no country selected,
   • selected country not found (for exmpale we use United States but the API has states for United States of America so if user select United States, no state will be found
   • if failed to call the API
     original state list will be used.

This change also exposes /occurrences/getStates which need to be configured to expose

[alexhuang091]

I've created a screen capture which can be downloaded

https://www.dropbox.com/s/5ad2kacueblvsc2/%E5%B1%8F%E5%B9%95%E5%BD%95%E5%88%B62021-08-11%20%E4%B8%8A%E5%8D%8811.53.38.mov?dl=0

[nickdos]

Thanks @alexhuang091, that looks really good!

I have one question about the states & territories drop-down (haven't run the PR myself) - when there is no country selected, does it still show every state/territory (same as current implementation)?

[nickdos]

Please add proper Javadoc - /** Foo */ so IDE can display info about method from the controller code, etc...

[alexhuang091]

Hi Nick, Yes when 1. Page initially loaded 2. User selects the first option C select a country C All original states will be populated. (those states get from solr) There's a small issue though, if you select 'Australia' + 'ACT' and submit, you go to biocache-hubs page. Then you navigate back, the country will be restored to Australia, the state list is correctly populated, but the previously selected state is not selected. (extra code needed to remember previous state because states list is constructed dynamically, I don't bother to do it now) Thanks 发件人: Nick dos Remedios ***@***.***> 日期: 星期三, 2021年8月11日 下午12:53 收件人: AtlasOfLivingAustralia/biocache-hubs ***@***.***> 抄送: HUANG, Alex (NCMI, Black Mountain) ***@***.***>, Mention ***@***.***> 主题: Re: [AtlasOfLivingAustralia/biocache-hubs] Issue 470 refine state selection (#476) Thanks @alexhuang091<https://github.com/alexhuang091>, that looks really good! I have one question about the states & territories drop-down (haven't run the PR myself) - when there is no country selected, does it still show every state/territory (same as current implementation)? ― You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#476 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AOWSDI2IFZVOLJ4GSE4UMY3T4HQZRANCNFSM5B5E7WEA>.

[nickdos]

My preference is for a single return statement, when it is practical (you have 2 in this method) - as it makes the code easier to read. E.g.

List<String> getStates(String countryName) {
    List<String> matchingStates = []

    if (countryNameMap?.containsKey(countryName)) {
        def states = getJsonElements("${grailsApplication.config.userdetails.baseUrl}/ws/registration/states.json?country=" + countryNameMap.get(countryName))
        if (states) {
            // only return valid states
            matchingStates = states.findAll { it -> beAValidCountryOrState(it) }.collect { it -> (String)it.get("name") }
        }
    }

    matchingStates
}

Seeing [] as last statement is not ideal as it makes me think this is the "intended" output when its really the "exception" to the output.

[nickdos]

Just checking if this needs to be (exception) caught? What happens if the service throws an error? Does the user (or ALA staff) have anyway to know that its not working or will it silently fail and be an empty list (that you could interpret as "we don't have any states for this country")?

[alexhuang091]

Hi Nick, for frontend, only when request is successful will be state list be re-constructed.
$.getJSON(url, function(data)

1. If not empty, populate it
2. If empty (no matter because originally empty or backend error), populate with the original list.

[alexhuang091]

For the backend.

def getCountryNameMap() {
    def countryUrl = "${grailsApplication.config.userdetails.baseUrl}/ws/registration/countries.json"
    def countries = getJsonElements(countryUrl)

getJsonElements might throw an exception, why it doesn't have a throws in definition
JSONElement getJsonElements(String url, String apiKey = null) {

I should catch it I think. So frontend always get 200, in case of error we return an empty list.