Improve CollectionRelationship uploads in the WorkBench

specifyweb/businessrules/uniqueness_rules.py

@@ -71,6 +71,9 @@ def check_unique(instance):
     'Collectionobject': {
         'catalognumber': ['collection'],
         },
+    'Collectionrelationship' : {
+        'rightside' : ['collectionreltype']
+    },
     'Collector': {
         'agent': ['collectingevent'],
         },

specifyweb/frontend/js_src/lib/components/DataModel/schemaOverrides.ts

@@ -110,6 +110,12 @@ const globalFieldOverrides: {
   Attachment: {
     tableID: 'optional',
   },
+  CollectionRelationship: {
+    collectionRelType: 'required',
+  },
+  CollectionRelType: {
+    name: 'required',
+  },
   Taxon: {
     parent: 'required',
     isAccepted: 'readOnly',

specifyweb/frontend/js_src/lib/components/FormFields/QueryComboBox.tsx

@@ -162,7 +162,7 @@ export function QueryComboBox({
           typeof resource.getDependentResource(field.name) === 'object')
           ? resource
               .rgetPromise<string, AnySchema>(field.name)
-              .then((resource) =>
+              .then(async (resource) =>
                 resource === undefined || resource === null
                   ? {
                       label: '' as LocalizedString,

specifyweb/frontend/js_src/lib/components/FormMeta/index.tsx

@@ -18,6 +18,7 @@ import { PrintOnSave } from '../FormFields/Checkbox';
 import type { ViewDescription } from '../FormParse';
 import { SubViewContext } from '../Forms/SubView';
 import { isTreeResource } from '../InitialContext/treeRanks';
+import { interactionTables } from '../Interactions/config';
 import { Dialog } from '../Molecules/Dialog';
 import {
   ProtectedAction,
@@ -33,7 +34,6 @@ import { QueryTreeUsages } from './QueryTreeUsages';
 import { ReadOnlyMode } from './ReadOnlyMode';
 import { ShareRecord } from './ShareRecord';
 import { SubViewMeta } from './SubViewMeta';
-import { interactionTables } from '../Interactions/config';
 
 /**
  * Form preferences host context aware user preferences and other meta-actions.

specifyweb/frontend/js_src/lib/components/FormParse/webOnlyViews.ts

@@ -57,6 +57,18 @@ export const webOnlyViews = f.store(() =>
         'spReports',
       ])
     ),
+    CollectionRelType: autoGenerateViewDefinition(
+      schema.models.CollectionRelType,
+      'form',
+      'edit',
+      ['name', 'leftSideCollection', 'rightSideCollection', 'remarks']
+    ),
+    CollectionRelationship: autoGenerateViewDefinition(
+      schema.models.CollectionRelationship,
+      'form',
+      'edit',
+      ['collectionRelType', 'leftSide', 'rightSide']
+    ),
     [spAppResourceView]: autoGenerateViewDefinition(
       schema.models.SpAppResource,
       'form',

specifyweb/frontend/js_src/lib/components/FormSliders/RecordSet.tsx

@@ -359,7 +359,7 @@ function RecordSet<SCHEMA extends AnySchema>({
                           }).then(({ totalCount }) => totalCount !== 0),
                     })
                   )
-                ).then((results) => {
+                ).then(async (results) => {
                   const [nonDuplicates, duplicates] = split(
                     results,
                     ({ isDuplicate }) => isDuplicate

specifyweb/frontend/js_src/lib/components/PickLists/definitions.ts

@@ -202,6 +202,12 @@ export const getFrontEndPickLists = f.store<{
         .set('tableName', 'preptype')
         .set('fieldName', 'name'),
     },
+    CollectionRelType: {
+      name: definePicklist('_CollectionRelType', [])
+        .set('type', PickListTypes.FIELDS)
+        .set('tableName', 'collectionreltype')
+        .set('fieldName', 'name'),
+    },
     SpAppResource: {
       mimeType: definePicklist(
         '_MimeType',

specifyweb/frontend/js_src/lib/components/Preferences/CollectionDefinitions.tsx

@@ -6,7 +6,8 @@ import type { RA } from '../../utils/types';
 import { ensure } from '../../utils/types';
 import { error } from '../Errors/assert';
 import type { StatLayout } from '../Statistics/types';
-import { GenericPreferences, defineItem } from './types';
+import type { GenericPreferences } from './types';
+import { defineItem } from './types';
 
 export const collectionPreferenceDefinitions = {
   statistics: {

specifyweb/frontend/js_src/lib/components/Preferences/Editor.tsx

@@ -1,11 +1,11 @@
 import React from 'react';
 
+import { useLiveState } from '../../hooks/useLiveState';
+import type { AppResourceTab } from '../AppResources/TabDefinitions';
 import { PreferencesContent } from '../Preferences';
 import { BasePreferences } from '../Preferences/BasePreferences';
 import { userPreferenceDefinitions } from '../Preferences/UserDefinitions';
 import { userPreferences } from '../Preferences/userPreferences';
-import { AppResourceTab } from '../AppResources/TabDefinitions';
-import { useLiveState } from '../../hooks/useLiveState';
 
 export const UserPreferencesEditor: AppResourceTab = function ({
   isReadOnly,

specifyweb/frontend/js_src/lib/components/Preferences/Renderers.tsx

@@ -31,9 +31,9 @@ import { rawMenuItemsPromise } from '../Header/menuItemDefinitions';
 import { useMenuItems, useUserTools } from '../Header/menuItemProcessing';
 import { AttachmentPicker } from '../Molecules/AttachmentPicker';
 import { AutoComplete } from '../Molecules/AutoComplete';
-import { userPreferences } from './userPreferences';
 import { ListEdit } from '../Toolbar/QueryTablesEdit';
-import { PreferenceItem, PreferenceItemComponent } from './types';
+import type { PreferenceItem, PreferenceItemComponent } from './types';
+import { userPreferences } from './userPreferences';
 
 export const ColorPickerPreferenceItem: PreferenceItemComponent<string> =
   function ColorPickerPreferenceItem({

specifyweb/frontend/js_src/lib/components/Security/User.tsx

@@ -468,7 +468,7 @@ function UserView({
                       status: Http.NO_CONTENT,
                     })
                 )
-                  .then(({ data, status }) =>
+                  .then(async ({ data, status }) =>
                     status === Http.BAD_REQUEST
                       ? setState({
                           type: 'SettingAgents',
@@ -515,7 +515,7 @@ function UserView({
                         })
                       : true
                   )
-                  .then((canContinue) =>
+                  .then(async (canContinue) =>
                     canContinue === true
                       ? Promise.all([
                           typeof password === 'string' && password !== ''

specifyweb/frontend/js_src/lib/components/WbPlanView/__tests__/automapper.test.ts

@@ -3,8 +3,8 @@ import { theories } from '../../../tests/utils';
 import type { RA } from '../../../utils/types';
 import type { AutoMapperResults } from '../autoMapper';
 import {
-  AutoMapper as AutoMapperConstructor,
   type AutoMapperConstructorParameters,
+  AutoMapper as AutoMapperConstructor,
   circularTables,
 } from '../autoMapper';
 

specifyweb/workbench/upload/scoping.py

@@ -1,4 +1,4 @@
-from typing import Dict, Any, Union, Callable
+from typing import Dict, Any, Optional, Tuple, Callable, Union
 
 from specifyweb.specify.datamodel import datamodel, Table, Relationship
 from specifyweb.specify.load_datamodel import DoesNotExistError
@@ -7,11 +7,38 @@
 from specifyweb.stored_queries.format import get_date_format
 
 from .uploadable import Uploadable, ScopedUploadable
-from .upload_table import UploadTable, ScopedUploadTable, OneToOneTable, ScopedOneToOneTable
+from .upload_table import UploadTable, DeferredScopeUploadTable, ScopedUploadTable, OneToOneTable, ScopedOneToOneTable
 from .tomany import ToManyRecord, ScopedToManyRecord
 from .treerecord import TreeRecord, ScopedTreeRecord
 from .column_options import ColumnOptions, ExtendedColumnOptions
 
+""" There are cases in which the scoping of records should be dependent on another record/column in a WorkBench dataset.
+
+The DEFERRED_SCOPING dictonary defines the information needed to extract the correct scope to upload/validate a record into.
+
+The structure of DEFERRED_SCOPING is as following:
+    The keys are tuples containing the django table name and a relationship that should be scoped. 
+
+    The values are tuples containing the table name, field to filter on, and value to pull from that field to use as the collection for the 
+    tableName.fieldName in the associated key of DEFERRED_SCOPING
+
+    For example, consider the following the deferred scoping information:
+        ("Collectionrelationship", "rightside"): ('collectionreltype', 'name', 'rightsidecollection')
+
+    This information describes the following process to be performed: 
+
+    'when uploading the rightside of a Collection Relationship, get the Collection Rel Type in the database from the dataset by 
+    filtering Collection Rel Types in the database by name. Then, set the collection of the Collectionrelationship rightside equal to the Collection Rel Type's 
+    rightSideCollection' 
+
+    See .upload_plan_schema.py for how this is used
+
+"""
+DEFERRED_SCOPING: Dict[Tuple[str, str], Tuple[str, str, str]] = {
+    ("Collectionrelationship", "rightside"): ('collectionreltype', 'name', 'rightsidecollection'),
+    ("Collectionrelationship", "leftside"): ('collectionreltype', 'name', 'leftsidecollection'),
+    }
+
 def scoping_relationships(collection, table: Table) -> Dict[str, int]:
     extra_static: Dict[str, int] = {}
 
@@ -80,11 +107,14 @@ def extend_columnoptions(colopts: ColumnOptions, collection, tablename: str, fie
         dateformat=get_date_format(),
     )
 
-
-def apply_scoping_to_uploadtable(ut: UploadTable, collection) -> ScopedUploadTable:
+def apply_scoping_to_uploadtable(ut: Union[UploadTable, DeferredScopeUploadTable], collection) -> ScopedUploadTable:
     table = datamodel.get_table_strict(ut.name)
 
     adjust_to_ones = to_one_adjustments(collection, table)
+
+    if ut.overrideScope is not None and isinstance(ut.overrideScope['collection'], int):
+        collection = getattr(models, "Collection").objects.filter(id=ut.overrideScope['collection']).get()
+
 
     return ScopedUploadTable(
         name=ut.name,

specifyweb/workbench/upload/tests/example_plan.py

@@ -140,6 +140,7 @@ def with_scoping(collection) -> ScopedUploadTable:
         wbcols = {
             'catalognumber' : parse_column_options("BMSM No."),
         },
+        overrideScope=None,
         static = {},
         toMany = {
             'determinations': [
@@ -160,6 +161,7 @@ def with_scoping(collection) -> ScopedUploadTable:
                                 'middleinitial': parse_column_options('Determiner 1 Middle Initial'),
                                 'lastname': parse_column_options('Determiner 1 Last Name'),
                             },
+                            overrideScope=None,
                             static = {'agenttype': 1},
                             toOne = {},
                             toMany = {},
@@ -188,6 +190,7 @@ def with_scoping(collection) -> ScopedUploadTable:
                     'startdate' : parse_column_options('Start Date Collected'),
                     'stationfieldnumber' : parse_column_options('Station No.'),
                 },
+                overrideScope=None,
                 static = {},
                 toOne = {
                     'locality': UploadTable(
@@ -197,6 +200,7 @@ def with_scoping(collection) -> ScopedUploadTable:
                             'latitude1': parse_column_options('Latitude1'),
                             'longitude1': parse_column_options('Longitude1'),
                         },
+                        overrideScope=None,
                         static = {'srclatlongunit': 0},
                         toOne = {
                             'geography': TreeRecord(
@@ -227,6 +231,7 @@ def with_scoping(collection) -> ScopedUploadTable:
                                         'middleinitial' : parse_column_options('Collector 1 Middle Initial'),
                                         'lastname'      : parse_column_options('Collector 1 Last Name'),
                                     },
+                                    overrideScope=None,
                                     static = {'agenttype': 1},
                                     toOne = {},
                                     toMany = {},
@@ -246,6 +251,7 @@ def with_scoping(collection) -> ScopedUploadTable:
                                         'middleinitial' : parse_column_options('Collector 2 Middle Initial'),
                                         'lastname'      : parse_column_options('Collector 2 Last name'),
                                     },
+                                    overrideScope=None,
                                     static = {'agenttype': 1},
                                     toOne = {},
                                     toMany = {},

specifyweb/workbench/upload/tests/testdisambiguation.py

@@ -31,6 +31,7 @@ def test_disambiguation(self) -> None:
         plan = UploadTable(
             name='Referencework',
             wbcols={'title': parse_column_options('title')},
+            overrideScope=None,
             static={'referenceworktype': 0},
             toOne={},
             toMany={'authors': [
@@ -43,6 +44,7 @@ def test_disambiguation(self) -> None:
                         wbcols={
                             'lastname': parse_column_options('author1')
                         },
+                        overrideScope=None,
                         static={},
                         toOne={},
                         toMany={}
@@ -56,6 +58,7 @@ def test_disambiguation(self) -> None:
                         wbcols={
                             'lastname': parse_column_options('author2')
                         },
+                        overrideScope=None,
                         static={},
                         toOne={},
                         toMany={}