Merge pull request #4816 from specify/issue-4815

Do not define busRules if not present in 6
specify · Apr 26, 2024 · 7971012 · 7971012
2 parents 0b1ec8b + 1942d4b
commit 7971012
Show file tree

Hide file tree

Showing 5 changed files with 130 additions and 19 deletions.
diff --git a/...yweb/frontend/js_src/lib/components/FormEditor/__tests__/__snapshots__/index.test.ts.snap b/...yweb/frontend/js_src/lib/components/FormEditor/__tests__/__snapshots__/index.test.ts.snap
@@ -31,6 +31,7 @@ exports[`Can edit a form definition 1`] = `
           },
         ],
       },
+      "businessRules": "edu.ku.brc.specify.datamodel.busrules.AccessionBusRules",
       "description": "The Accession form.",
       "legacyResourceLabels": false,
       "legacyUseBusinessRules": true,

diff --git a/specifyweb/frontend/js_src/lib/components/FormEditor/__tests__/createView.test.ts b/specifyweb/frontend/js_src/lib/components/FormEditor/__tests__/createView.test.ts
@@ -84,6 +84,9 @@ const viewSets = (): ViewSets =>
       {
         name: localized('CollectionObjectAttachment'),
         description: 'The Collection Object-Attachment View.',
+        businessRules: localized(
+          'edu.ku.brc.specify.datamodel.busrules.AttachmentBusRules'
+        ),
         legacyIsInternal: undefined,
         legacyIsExternal: undefined,
         legacyTable: undefined,
@@ -360,6 +363,8 @@ test('Create new view definition', () =>
           ],
         },
         description: 'The Collection Object-Attachment View.',
+        businessRules:
+          'edu.ku.brc.specify.datamodel.busrules.AttachmentBusRules',
         legacyResourceLabels: false,
         legacyUseBusinessRules: true,
         name: 'CollectionObjectAttachment',
@@ -414,6 +419,8 @@ test('Create new view definition', () =>
           ],
         },
         description: '',
+        businessRules:
+          'edu.ku.brc.specify.datamodel.busrules.AttachmentBusRules',
         legacyUseBusinessRules: true,
         name: 'CollectionObjectAttachment_2',
         table: '[table CollectionObjectAttachment]',
@@ -558,6 +565,8 @@ test('Add new view definition based on existing', () =>
           ],
         },
         description: 'The Collection Object-Attachment View.',
+        businessRules:
+          'edu.ku.brc.specify.datamodel.busrules.AttachmentBusRules',
         legacyResourceLabels: false,
         legacyUseBusinessRules: true,
         name: 'CollectionObjectAttachment',
@@ -608,6 +617,8 @@ test('Add new view definition based on existing', () =>
           ],
         },
         description: 'The Collection Object-Attachment View.',
+        businessRules:
+          'edu.ku.brc.specify.datamodel.busrules.AttachmentBusRules',
         legacyResourceLabels: false,
         legacyUseBusinessRules: true,
         name: 'A',

diff --git a/specifyweb/frontend/js_src/lib/components/FormEditor/createView.ts b/specifyweb/frontend/js_src/lib/components/FormEditor/createView.ts
@@ -10,6 +10,7 @@ import { getLogContext, setLogContext } from '../Errors/logContext';
 import type { ViewDefinition } from '../FormParse';
 import { fromSimpleXmlNode } from '../Syncer/fromSimpleXmlNode';
 import { createSimpleXmlNode } from '../Syncer/xmlToJson';
+import { getBusinessRuleClassFromTable } from './helpers';
 import type { ViewSets } from './spec';
 import { parseFormView } from './spec';
 
@@ -91,6 +92,7 @@ function createNewView(
     title: localized(table.name),
     description: '',
     table,
+    businessRules: localized(getBusinessRuleClassFromTable(table.name)),
     legacyTable: undefined,
     altViews,
     legacyIsInternal: undefined,

diff --git a/specifyweb/frontend/js_src/lib/components/FormEditor/helpers.ts b/specifyweb/frontend/js_src/lib/components/FormEditor/helpers.ts
@@ -0,0 +1,104 @@
+import type { RR } from '../../utils/types';
+import type { Tables } from '../DataModel/types';
+
+export const tablesWithBusRulesIn6 = new Set([
+  'AccessionAgentBusRules',
+  'AccessionAuthorizationBusRules',
+  'AccessionBusRules',
+  'AddressBusRules',
+  'AgentBusRules',
+  'AppraisalBusRules',
+  'AttachmentBusRules',
+  'AttachmentOwnerBaseBusRules',
+  'AttachmentReferenceBaseBusRules',
+  'AuthorBusRules',
+  'BaseTreeBusRules',
+  'BioStratBusRules',
+  'BorrowBusRules',
+  'CatalogNumberingSchemeBusRules',
+  'CatAutoNumberingSchemeBusRules',
+  'CollectingEventAttributeBusRules',
+  'CollectingEventAuthorizationBusRules',
+  'CollectingEventBusRules',
+  'CollectingTripAuthorizationBusRules',
+  'CollectingTripBusRules',
+  'CollectionBusRules',
+  'CollectionObjectBusRules',
+  'CollectionSetupBusRules',
+  'CollectorBusRules',
+  'ConservDescriptionBusRules',
+  'ConservEventBusRules',
+  'ContainerBusRules',
+  'DataTypeBusRules',
+  'DeaccessionAgentBusRules',
+  'DeaccessionBusRules',
+  'DeterminationBusRules',
+  'DeterminerBusRules',
+  'DisciplineBusRules',
+  'DisposalAgentBusRules',
+  'DisposalBusRules',
+  'DisposalPreparationBusRules',
+  'DivisionBusRules',
+  'DNASequenceBusRules',
+  'DNASequencingRunBusRules',
+  'ExchangeInBusRules',
+  'ExchangeOutBusRules',
+  'ExchangeOutPrepBusRules',
+  'ExtractorBusRules',
+  'FieldNotebookBusRules',
+  'FieldNotebookPageBusRules',
+  'FieldNotebookPageSetBusRules',
+  'FundingAgentBusRules',
+  'GeoCoordDetailBusRules',
+  'GeographyBusRules',
+  'GeologicTimePeriodBusRules',
+  'GiftBusRules',
+  'GiftPreparationBusRules',
+  'GroupPersonBusRules',
+  'InfoRequestBusRules',
+  'InstitutionBusRules',
+  'JournalBusRules',
+  'LithoStratBusRules',
+  'LoanBusRules',
+  'LoanGiftShipmentBusRules',
+  'LoanPreparationBusRules',
+  'LoanReturnPreparationBusRules',
+  'LocalityBusRules',
+  'LocalityDetailBusRules',
+  'PaleoContextBusRules',
+  'PcrPersonBusRules',
+  'PermitBusRules',
+  'PickListBusRules',
+  'PreparationBusRules',
+  'PrepTypeBusRules',
+  'ReferenceWorkBusRules',
+  'RepositoryAgreementBusRules',
+  'ShipmentBusRules',
+  'SpecifyUserBusRules',
+  'StorageBusRules',
+  'TableSearchResults',
+  'TaxonBusRules',
+  'TreatmentEventBusRules',
+  'TreeableSearchQueryBuilder',
+  'TreeDefBusRules',
+]);
+
+/**
+ * Most of the time business rules class name can be inferred from table name.
+ * Exceptions:
+ */
+export const businessRulesOverride: Partial<RR<keyof Tables, string>> = {
+  Shipment: 'LoanGiftShipment',
+  CollectionObjectAttachment: 'Attachment',
+};
+
+export const getBusinessRuleClassFromTable = (
+  tableName: keyof Tables
+): string =>
+  businessRulesOverride[tableName] === undefined
+    ? tablesWithBusRulesIn6.has(`${tableName}BusRules`)
+      ? `edu.ku.brc.specify.datamodel.busrules.${tableName}BusRules`
+      : ''
+    : `edu.ku.brc.specify.datamodel.busrules.${businessRulesOverride[
+        tableName
+      ]!}BusRules`;
diff --git a/specifyweb/frontend/js_src/lib/components/FormEditor/spec.ts b/specifyweb/frontend/js_src/lib/components/FormEditor/spec.ts
@@ -1,9 +1,8 @@
 import { f } from '../../utils/functools';
-import type { RA, RR } from '../../utils/types';
+import type { RA } from '../../utils/types';
 import { defined, localized } from '../../utils/types';
 import { getUniqueName } from '../../utils/uniquifyName';
 import { strictParseXml } from '../AppResources/parseXml';
-import type { Tables } from '../DataModel/types';
 import type { ViewDefinition } from '../FormParse';
 import type { SpecToJson } from '../Syncer';
 import { pipe, syncer } from '../Syncer';
@@ -19,6 +18,7 @@ import {
   getOriginalSyncerInput,
   setOriginalSyncerInput,
 } from '../Syncer/xmlUtils';
+import { getBusinessRuleClassFromTable } from './helpers';
 
 export const viewSetsSpec = f.store(() =>
   createXmlSpec({
@@ -53,21 +53,22 @@ const resolvedViewSpec = () =>
   pipe(
     syncers.object(viewSpec()),
     syncer(
-      ({ businessRules: _, table, ...node }) => ({
+      ({ table, ...node }) => ({
         ...node,
         table: table.parsed,
         legacyTable: table.bad,
       }),
-      ({ table, legacyTable, ...node }) => ({
+      ({ table, legacyTable, businessRules, ...node }) => ({
         ...node,
         table: { parsed: table, bad: legacyTable },
-        businessRules: localized(
-          typeof table === 'object'
-            ? `edu.ku.brc.specify.datamodel.busrules.${
-                businessRules[table.name] ?? table.name
-              }BusRules`
-            : ''
-        ),
+        businessRules:
+          f.trim(businessRules ?? '') === ''
+            ? localized(
+                typeof table === 'object'
+                  ? getBusinessRuleClassFromTable(table.name)
+                  : ''
+              )
+            : businessRules,
       })
     )
   );
@@ -99,14 +100,6 @@ export function parseFormView(definition: ViewDefinition) {
   };
 }
 
-/**
- * Most of the time business rules class name can be inferred from table name.
- * Exceptions:
- */
-const businessRules: Partial<RR<keyof Tables, string>> = {
-  Shipment: 'LoanGiftShipment',
-};
-
 const viewSpec = f.store(() =>
   createXmlSpec({
     name: syncers.xmlAttribute('name', 'required'),