LF-4415 Animals IDs not sorted in order

[Tbrid]

Description

Fix the issue of animals IDs not sorted in ascending order in the inventory page.

Jira link: https://lite-farm.atlassian.net/browse/LF-4415

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• Passes test case
• UI components visually reviewed on desktop view
• UI components visually reviewed on mobile view
• Other (please explain)

Checklist:

• I have commented my code, particularly in hard-to-understand areas
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• The precommit and linting ran successfully
• I have added or updated language tags for text that's part of the UI
• I have added "MISSING" for all new language tags to languages I don't speak
• I have added the GNU General Public License to all new files

[Duncan-Brain]

Hey @Tbrid thanks for doing this one!

I am not quite sure I know what is the expected order... so I will ask some questions on the Jira ticket.

I think the length check works well specifically for the ID##'s but because the names are sometimes chosen as an identifier it is no longer quite alphabetical but based on length for those ones. The Del 6 in my picture must have been randomly sorted based on chance.

I will tag design who might have an opinion too just to get clarification.

[antsgar]

@Tbrid thank you so much for contributing!!

Unfortunately I don't think this portion of the sorting function is correct, and in testing it I'm not getting the right sorting order. On one hand, we shouldn't be using the identification property to sort since that's a string that can be either the name, the identifier or the internal identifier, but in this case we want to sort granularly, one property at the time, so we'll need to pass identifier and internal_identifier and use them to compare. On the other hand, I'm not sure I understand the reasoning behind comparing the length of the strings?

I think this is more or less what the function could look like

return inventory.sort((a, b) => {
    if (a.name && !b.name) {
      return -1;
    }
    if (b.name && !a.name) {
      return 1;
    }
    if (a.identifier && !b.identifier) {
      return -1;
    }
    if (b.identifier && !a.identifier) {
      return 1;
    }
    return (
      (a.name && b.name && a.name.localeCompare(b.name)) ||
      (a.identifier && b.identifier && a.identifier.localeCompare(b.identifier)) ||
      a.internal_identifier - b.internal_identifier
    );
  });

but I haven't tested it thoroughly!
If you have the time, a good idea could be to add some unit tests to verify that it's working properly. Otherwise we can just test it manually and make sure it works with a variety of records.

[Duncan-Brain]

I get that the length check was for the internal_identifier string that includes 'ID###' .

If the identification property is no longer used here (it is just for label display now) then it should be a plain number as Anto described 👍

[SayakaOno]

Thank you for taking care of this!
getComparator function is used for sorting when clicking the "IDENTIFICATION" column title, and I think the same logic needs to be applied there too.