fix(FieldFormatters): normalize ^ and $ in regex

Fixes #5075 (review)

specifyweb/frontend/js_src/lib/components/FieldFormatters/__tests__/spec.test.ts

@@ -0,0 +1,23 @@
+import { theories } from '../../../tests/utils';
+import { exportsForTests } from '../spec';
+
+const { trimRegexString, normalizeRegexString } = exportsForTests;
+
+theories(trimRegexString, [
+  [[''], ''],
+  [['[a-z]{3,}.*'], '[a-z]{3,}.*'],
+  [['/^[a-z]{3,}.*$/'], '[a-z]{3,}.*'],
+  [['^\\d{3}$'], '\\d{3}'],
+  [['/^(KUI|KUBI|NHM)$/'], 'KUI|KUBI|NHM'],
+]);
+
+theories(normalizeRegexString, [
+  [[''], '/^$/'],
+  [['[a-z]{3,}.*'], '/^[a-z]{3,}.*$/'],
+  [['/^[a-z]{3,}.*$/'], '/^[a-z]{3,}.*$/'],
+  [['^\\d{3}$'], '/^\\d{3}$/'],
+  [['\\d{3}'], '/^\\d{3}$/'],
+  [['/\\d{3}/'], '/^\\d{3}$/'],
+  [['KUI|KUBI|NHM'], '/^(KUI|KUBI|NHM)$/'],
+  [['(KUI|KUBI)|NHM'], '/^((KUI|KUBI)|NHM)$/'],
+]);

specifyweb/frontend/js_src/lib/components/FieldFormatters/index.ts

@@ -1,5 +1,5 @@
 /**
- * Parse and use Specify 6 UI Formatters
+ * Parse and use field formatters
  */
 
 import type { LocalizedString } from 'typesafe-i18n';
@@ -255,7 +255,16 @@ class RegexPart extends Part {
   public readonly type = 'regex';
 
   public get regex(): LocalizedString {
-    return this.placeholder;
+    let pattern: string = this.placeholder;
+    /*
+     * In UiFormatter.getRegex() we are adding ^ and $ as necessary, so trim
+     * them if they were present here
+     */
+    if (pattern.startsWith('/')) pattern = pattern.slice(1);
+    if (pattern.startsWith('^')) pattern = pattern.slice(1);
+    if (pattern.endsWith('/')) pattern = pattern.slice(0, -1);
+    if (pattern.endsWith('$')) pattern = pattern.slice(0, -1);
+    return pattern as LocalizedString;
   }
 }
 

specifyweb/frontend/js_src/lib/components/FieldFormatters/spec.ts

@@ -123,11 +123,56 @@ const formatterSpec = f.store(() =>
     ),
     parts: pipe(
       syncers.xmlChildren('field'),
-      syncers.map(syncers.object(partSpec()))
+      syncers.map(
+        pipe(
+          syncers.object(partSpec()),
+          syncer(
+            (part) => ({
+              ...part,
+              placeholder:
+                part.type === 'regex'
+                  ? localized(trimRegexString(part.placeholder))
+                  : part.placeholder,
+            }),
+            (part) => ({
+              ...part,
+              placeholder:
+                part.type === 'regex'
+                  ? localized(normalizeRegexString(part.placeholder))
+                  : part.placeholder,
+            })
+          )
+        )
+      )
     ),
   })
 );
 
+/**
+ * Specify 6 expects the regex pattern to start with "/^" and end with "$/"
+ * because it parts each field part individually.
+ * In Specify 7, we construct a combined regex that parts all field parts at
+ * once.
+ * Thus we do not want the "^" and "$" to be part of the pattern as far as
+ * Specify 7 front-end is concerned, but we want it to be part of the pattern
+ * in the .xml to work with Specify 6.
+ */
+function trimRegexString(regexString: string): string {
+  let pattern = regexString;
+  if (pattern.startsWith('/')) pattern = pattern.slice(1);
+  if (pattern.startsWith('^')) pattern = pattern.slice(1);
+  if (pattern.endsWith('/')) pattern = pattern.slice(0, -1);
+  if (pattern.endsWith('$')) pattern = pattern.slice(0, -1);
+  if (pattern.startsWith('(') && pattern.endsWith(')'))
+    pattern = pattern.slice(1, -1);
+  return pattern;
+}
+function normalizeRegexString(regexString: string): string {
+  let pattern: string = trimRegexString(regexString);
+  if (pattern.includes('|')) pattern = `(${pattern})`;
+  return `/^${pattern}$/`;
+}
+
 const partSpec = f.store(() =>
   createXmlSpec({
     type: pipe(
@@ -179,3 +224,5 @@ function parseField(
     return undefined;
   } else return field;
 }
+
+export const exportsForTests = { trimRegexString, normalizeRegexString };

specifyweb/frontend/js_src/lib/localization/utils/scanUsages.ts

@@ -413,6 +413,7 @@ export async function scanUsages(
             ),
             'Value:\n',
             instances.at(-1)?.originalValue ?? valueString,
+            '\n',
           ].join('')
         );
       })

specifyweb/specify/uiformatters.py

@@ -237,7 +237,16 @@ def value_regexp(self) -> str:
 
 class RegexField(Field):
     def value_regexp(self) -> str:
-        return self.value
+        pattern = self.value
+        if pattern.startswith('/'):
+            pattern = pattern[1:]
+        if pattern.startswith('^'):
+            pattern = pattern[1:]
+        if pattern.endswith('/'):
+            pattern = pattern[:-1]
+        if pattern.endswith('$'):
+            pattern = pattern[:-1]
+        return pattern
 
 class AlphaField(Field):
     def value_regexp(self) -> str: