feat(stringvalidator): client provided regex

packages/concerto-core/api.txt

@@ -2,7 +2,7 @@ class AstModelManager extends BaseModelManager {
    + void constructor(object?) 
 }
 class BaseModelManager {
-   + void constructor(object?,boolean?,processFile?) 
+   + void constructor(object?,boolean?,Object?,processFile?) 
    + boolean isModelManager() 
    + boolean isVersionedNamespacesStrict() 
    + Object accept(Object,Object) 
@@ -244,7 +244,7 @@ class ModelLoader {
    + ModelManager[] loadModelManagerFromModelFiles(object[],string[],object,boolean?,boolean?,number?) 
 }
 class ModelManager extends BaseModelManager {
-   + void constructor(object?,boolean?) 
+   + void constructor(object?,boolean?,Object?) 
    + ModelFile addCTOModel(string,string?,boolean?) throws IllegalModelException
 }
    + object getRootModel() 

packages/concerto-core/changelog.txt

@@ -23,6 +23,10 @@
 #
 # Note that the latest public API is documented using JSDocs and is available in api.txt.
 #
+
+Version 3.0.0 {b0c9b0951c58e3deeed8fbccf2dfd052} 2022-08-16
+- Allow client-provided RegExp engine to ModelManager
+
 Version 2.3.0 {774980a857090905fe276b6e94f1dbb1} 2022-07-21
 - Versioned namespaces
 

packages/concerto-core/lib/basemodelmanager.js

@@ -75,6 +75,7 @@ class BaseModelManager {
      * @constructor
      * @param {object} [options] - ModelManager options, also passed to Serializer
      * @param {boolean} [options.versionedNamespacesStrict] - require versioned namespaces and imports
+     * @param {Object} [options.regExp] - An alternative regular expression engine.
      * @param {*} [processFile] - how to obtain a concerto AST from an input to the model manager
      */
     constructor(options, processFile) {
@@ -84,6 +85,7 @@ class BaseModelManager {
         this.serializer = new Serializer(this.factory, this, options);
         this.decoratorFactories = [];
         this.versionedNamespacesStrict = !!options?.versionedNamespacesStrict;
+        this.options = options;
         this.addRootModel();
     }
 

packages/concerto-core/lib/introspect/stringvalidator.js

@@ -14,7 +14,6 @@
 
 'use strict';
 
-const { RE2 } = require('re2-wasm');
 const Validator = require('./validator');
 
 // Types needed for TypeScript generation.
@@ -37,16 +36,14 @@ class StringValidator extends Validator{
      * Create a StringValidator.
      * @param {Field} field - the field this validator is attached to
      * @param {Object} validator - The validation string. This must be a regex
-     * expression.
      *
      * @throws {IllegalModelException}
      */
     constructor(field, validator) {
         super(field, validator);
         try {
-            // RE2 must always be run in unicode mode, it's safe to add 'u' even if it already exists
-            const flags = validator.flags ? validator.flags + 'u' : 'u';
-            this.regex = new RE2(validator.pattern, flags);
+            const CustomRegExp = field?.parent?.getModelFile()?.getModelManager()?.options?.regExp || RegExp;
+            this.regex = new CustomRegExp(validator.pattern, validator.flags);
         }
         catch(exception) {
             this.reportError(field.getName(), exception.message);

packages/concerto-core/lib/modelmanager.js

@@ -58,6 +58,7 @@ class ModelManager extends BaseModelManager {
      * @constructor
      * @param {object} [options] - ModelManager options, also passed to Serializer
      * @param {boolean} [options.versionedNamespacesStrict] - require versioned namespaces and imports
+     * @param {Object} [options.regExp] - An alternative regular expression engine.
      */
     constructor(options) {
         super(options, ctoProcessFile(options));

packages/concerto-core/package.json

@@ -64,6 +64,7 @@
     "typescript": "4.6.3",
     "webpack": "5.64.2",
     "webpack-cli": "4.9.1",
+    "xregexp": "5.1.1",
     "yargs": "17.3.1"
   },
   "dependencies": {
@@ -74,7 +75,6 @@
     "debug": "4.3.1",
     "lorem-ipsum": "2.0.3",
     "randexp": "0.5.3",
-    "re2-wasm": "1.0.2",
     "semver": "7.3.5",
     "slash": "3.0.0",
     "urijs": "1.19.11",

packages/concerto-core/test/introspect/stringvalidator.js

@@ -21,6 +21,8 @@ require('chai').should();
 const sinon = require('sinon');
 const NumberValidator = require('../../lib/introspect/numbervalidator');
 
+const XRegExp = require('xregexp');
+
 describe('StringValidator', () => {
 
     let mockField;
@@ -44,7 +46,7 @@ describe('StringValidator', () => {
 
         it('should ignore a null string', () => {
             let v = new StringValidator(mockField, { pattern: '^[A-z][A-z][0-9]{7}' });
-            v.getRegex().toString().should.equal('/^[A-z][A-z][0-9]{7}/u');
+            v.getRegex().toString().should.equal('/^[A-z][A-z][0-9]{7}/');
             v.validate('id', null);
         });
 
@@ -87,6 +89,22 @@ describe('StringValidator', () => {
 
     });
 
+    describe('#validate with custom RegEx engine', () => {
+        const options = {
+            regExp: XRegExp
+        };
+        it('should ignore a null string', () => {
+            let v = new StringValidator(mockField, { pattern: '^[A-z][A-z][0-9]{7}' }, options);
+            v.getRegex().toString().should.equal('/^[A-z][A-z][0-9]{7}/');
+            v.validate('id', null);
+        });
+
+        it('should validate a string', () => {
+            let v = new StringValidator(mockField, { pattern: '^[\\p{Letter}\\p{Number}]{7}', flags: 'u' }, options);
+            v.validate('id', 'AB1234567');
+        });
+    });
+
     describe('#compatibleWith', () => {
         it('should return false for a number validator', () => {
             const other = new NumberValidator(mockField, { lower: -1, upper: 1 });

packages/concerto-core/test/modelmanager.js

@@ -15,6 +15,7 @@
 'use strict';
 
 const fs = require('fs');
+const XRegExp = require('xregexp');
 
 const FileDownloader = require('@accordproject/concerto-util').FileDownloader;
 const AssetDeclaration = require('../lib/introspect/assetdeclaration');
@@ -27,6 +28,7 @@ const ModelFile = require('../lib/introspect/modelfile');
 const ModelManager = require('../lib/modelmanager');
 const ParticipantDeclaration = require('../lib/introspect/participantdeclaration');
 const Serializer = require('../lib/serializer');
+const Concerto = require('../lib/concerto');
 const TypeNotFoundException = require('../lib/typenotfoundexception');
 const Util = require('./composer/composermodelutility');
 const COMPOSER_MODEL = require('./composer/composermodel');
@@ -186,6 +188,25 @@ describe('ModelManager', () => {
             JSON.stringify(ast).should.not.contain('location');
         });
 
+        it('should add a model file with alternative RegExp option', () => {
+            XRegExp.install('astral');
+            const regExp = XRegExp;
+            const modelManagerWithOptions = new ModelManager({ regExp });
+            Util.addComposerModel(modelManagerWithOptions);
+
+            modelManagerWithOptions.addCTOModel(`namespace org.acme
+        concept Bar {
+            o String foo regex=/\\p{S}/
+        }`, 'internal.cto', true);
+
+            const bar = {
+                $class : 'org.acme.Bar',
+                foo : '😊'
+            };
+            const concerto = new Concerto(modelManagerWithOptions);
+            concerto.validate(bar);
+        });
+
         it('should return error for duplicate namespaces for a string', () => {
             modelManager.addCTOModel(modelBase);
             let mf1 = sinon.createStubInstance(ModelFile);