New bundle is added at a random place

[pranavjain]

Implementation

• Prevent a worksheet row from having a null sort key when rows are created using the cli
  • Note: cl commands should always add bundles to the end of the worksheet
• Check for null sort keys when we initially fetch a worksheet and fix them on the spot if needed
• Code documentation
• Write tests if needed
• QA
  • Ensure that source editing is not impacted
  • Test large worksheets that have lots of rows with null sort keys
  • Test a worksheet with a mixture of bundles created in web and bundles created in CLI
  • Remove test console logs

Background

The bundle should be added at the same place where the user has selected. Currently, it is getting placed at random places in the worksheet.

Screen.Recording.2022-02-07.at.1.02.48.PM.mov

[pranavjain]

Estimate: 02/14

[pranavjain]

@jzwang43 Is there any update on this one?

[jzwang43]

I have narrowed it down to after_sort_key and getAfterSortKey function. The after_sort_key determines where the new run should be inserted. Still working on figuring out why this after_sort_key is incorrect.

[jzwang43]

looks like sometimes sort key is set to null for some rows:

This is returned from the backend. could it be some issue with the backend? The api is rest/interpret/worksheet/

@epicfaace @pranavjain do you have any insights on this?

[epicfaace]

@jzwang43 Can you please send me the worksheet link?

[jzwang43]

@jzwang43 Can you please send me the worksheet link?

@epicfaace try 0x411c4f80346b4732a1aacb8402ec4d04 on codalab.worksheets.org. It's also pretty easy to reproduce locally.

[epicfaace]

I'm not sure why this is happening -- would take more time to debug

[epicfaace]

I'm not prioritizing working on this atm, but let me know if I should

[epicfaace]

@jzwang43 is this something maybe you'd be able to debug? I'm not very familiar with the sort key logic, if you have bandwidth could you take some time and step through the code to figure out what's happening?

[leilenah]

Investigation

• view affected is worksheet view
• the user should be able to select and determine where the bundle is to be added
• likely an issue with after_sort_key and getAfterSortKey function
  • The after_sort_key determines where the new run should be inserted
• sometimes sort key is set to null for some rows
  • potentially could be an issue with the way the backend is sending data over
  • we could adjust that, or re-sort on the frontend, TBD

[leilenah]

Unable to Repro

@pranavjain @epicfaace I am unable to reproduce this bug. Are either of you able to repro on your end? I'm wondering if this was fixed with some other issue.

Screen Recording

Screen.Recording.2022-06-23.at.11.10.25.AM.mov

[leilenah]

@percyliang do you happen to know if this was resolved with a different issue? Are you able to repro on your end?

[jzwang43]

You might have to create bundles through CLI and open the same worksheet on web to reproduce.

…

On Fri, Jun 24, 2022 at 4:51 PM Leilenah Mamea ***@***.***> wrote: @percyliang <https://github.com/percyliang> do you happen to know if this was resolved with a different issue? Are you able to repro on your end? — Reply to this email directly, view it on GitHub <#3989 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AHEBT6TIZU6BFFUCO2RNCSLVQZCYNANCNFSM5NYSM3FA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[leilenah]

@jzwang43 I just attempted that flow and am still unable to repro. Are you able to point me to a worksheet on production where this is happening?

[leilenah]

Removing myself from this issue for now, as I am unable to repro it. If anyone is able to repro or if a user reports this issue, feel free to re-assign me.

[epicfaace]

@jzwang43 Can you please send me the worksheet link?

@epicfaace try 0x411c4f80346b4732a1aacb8402ec4d04 on codalab.worksheets.org. It's also pretty easy to reproduce locally.

@leilenah did you try this worksheet?

If you can't reproduce, please close this issue.

[leilenah]

@epicfaace I don't have access to modify that worksheet. Are you able to grant me access?

[epicfaace]

@leilenah Try logging in as the codalab admin user? https://github.com/codalab/deployment/blob/main/ansible/roles/credentials/vars/main.yml#L3-L4

[pranavjain]

@leilenah, I was able to repro it. Please select a bundle on your bottom sheet before clicking on the run button. This new bundle should be added below the selected one, but it goes to a random place.

[leilenah]

@pranavjain @epicfaace below is a screen recording of me trying to repro the issue on worksheet 0x411c4f80346b4732a1aacb8402ec4d04 while logged in as the codalab admin user. I am still unable to repro (even with Pranav's latest instructions).

I'm going to close this issue for now. Please let me know if anyone comes across this issue again.

Screen Recording

Screen.Recording.2022-07-03.at.6.53.31.PM.mov

[jzwang43]

@leilenah
only the last two items in the worksheet have issues, try clicking on one of the last two items. You will see the new run show up above them instead of below

[jzwang43]

@leilenah The reason why this happens is that the items have sort-key as "null", check out my previous pull request for this issue and the conversations for more context.

https://worksheets.codalab.org/rest/interpret/worksheet/0x411c4f80346b4732a1aacb8402ec4d04?brief=1

This is the API request for the worksheet items and then search for sort_key and you will see the nulls.

[leilenah]

@jzwang43 here's an updated screen recording of me only creating runs below the last two items. It looks like they appear in the correct place. Am I missing a step? Or perhaps am I misunderstanding where the bundles should end up in the UI?

Browser Used: Chrome
Worksheet Used: https://worksheets.codalab.org/worksheets/0x411c4f80346b4732a1aacb8402ec4d04

Screen.Recording.2022-07-04.at.11.44.08.AM.mov

[jzwang43]

@leilenah Hi, when you were trying to reproduce, there were no null sort_keys in the worksheet for some reason.
Sort keys were created by creating run bundles via CLI.

I created several null sort key items at the bottom, you can try again to reproduce, or manually create null sort_keys items by running cl run "xxxxx" in the command line on the web UI.

Screen.Recording.2022-07-04.at.12.51.38.PM.mov

[leilenah]

Ah, thanks for the additional context @jzwang43.