Fix unload protect being triggered in locality record sets

[sharadsw]

Fixes #4995

Caused by #4939
The changes in that PR sets the validation blocker more times than it needs to which somehow causes an unload protect to trigger. My guess is it's a timing error.

Checklist

• Self-review the PR after opening it to make sure the changes look good
  and self-explanatory (or properly documented)
• Add automated tests
• Add relevant issue to release milestone

Testing instructions

• Go to a locality record set
• Navigate between records
• Verify unload protect does not trigger

[melton-jason]

As noted in #4995 (comment), the issue only occurred when switching between records (most likely in a record set).
Unload protect would not be triggered on a record if the page was refreshed.

The unload protect is being triggered by the following line in the LatLongUI plugin:

specify7/specifyweb/frontend/js_src/lib/components/FormPlugins/LatLongUi.tsx

Line 113 in bb328a3

resource.set(coordinateTextField, trimmedValue);

.

For example, navigate to https://lsumzmammals9823-edge.test.specifysystems.org/specify/view/locality/1/?recordsetid=478 which has the following values for LatLongUI Plugin related fields:

{
  "lat1text": "30",
  "latitude1": 30,
  "long1text": "-93",
  "longitude1": -93,
  "originallatlongunit": 0,
  "srclatlongunit": 0,
}

Navigate to the next record https://lsumzmammals9823-edge.test.specifysystems.org/specify/view/locality/2/?recordsetid=478
which has the following field values:

{
  "lat1text": "30.837",
  "latitude1": 30.837,
  "long1text": "-91.218",
  "longitude1": -91.218,
  "originallatlongunit": 0,
  "srclatlongunit": 0,
}

The unload protect on the second record is being triggered by in two instances:

• lat1text is being set to 30
• long1text is being set to -93

These values are coming from the previous resource's values for those fields.
(the field values are eventually 'reset' to their expected values).

This is happening because setValidation callback in the useEffect dependency array (linked below) is being updated far more frequently since it was changed in #4939.

specify7/specifyweb/frontend/js_src/lib/components/FormPlugins/LatLongUi.tsx

Line 144 in bb328a3

setValidation,

Before #4939, the setValidation from useResourceValue was only being updated whenever the InFormEditorContext was updated.

specify7/specifyweb/frontend/js_src/lib/hooks/useValidation.tsx

Lines 112 to 114 in bb328a3

	},
	[isInFormEditor]
	);

Now, setValidation from useResourceValue is being updated whenever the resource or field changes.

specify7/specifyweb/frontend/js_src/lib/components/DataModel/saveBlockers.tsx

Lines 105 to 107 in bb328a3

	},
	[resource, field]
	),

This overlaps with:

specify7/specifyweb/frontend/js_src/lib/components/FormPlugins/LatLongUi.tsx

Lines 135 to 138 in bb328a3

	/*
	* Don't update this when resource changes, as that case is handled by the
	* useEffect hooks above
	*/

[emenslin]

Testing instructions

• Go to a locality record set
• Navigate between records
• Verify unload protect does not trigger

Unload protect is no longer triggered

jLmuA7maZD.mp4

---

This locality record set was uploaded through the workbench and it does trigger unload protect, however, it is also doing this in 7.9.5 whereas the other record sets are not. I am going to approve this pr but I wanted to mention it in case it can be fixed here

5BdNuzroUX.mp4

[Areyes42]

Testing instructions

• Go to a locality record set
• Navigate between records
• Verify unload protect does not trigger

---

Looks good, unload protect doesn't get triggered anymore! 👍

Screen.Recording.2024-06-12.at.4.47.38.PM.mov

[combs-a]

Unsure what's going on with this case since it's also present in v7.9.5, but unload protect is being triggered on a few record sets I just made through queries:

12_unloadprotect1.mp4

12_unloadprotect2.mp4

Just commenting for now w/o requesting changes since it might be a separate issue from this since it follows Elizabeth's second case more. I can test more thoroughly when I get in tomorrow.

[maxpatiiuk]

(optional) we could make setValidation here consumer a fieldRef rather than field state, thus not triggering a needless re-render

specify7/specifyweb/frontend/js_src/lib/hooks/useResourceValue.tsx

Line 241 in bb328a3

setValidation: React.useCallback(

[combs-a]

Looking more into this, it seems like the issue I was having before was a separate one ( PR #3959 ) and was able to make a new record set that has the right bug (no unload protect in v7.9.5, but does have it in edge).

13_unloadprotect3.mp4

Testing instructions

• Go to a locality record set
• Navigate between records
• Verify unload protect does not trigger

Looks good! 🎉

[sharadsw]

Created some record sets with WB and queries but I'm not able to reproduce the bug. I think the underlying cause for those is definitely different than the one for this issue. I think you're correct about it being related to #3259