feat: regex sampler

This fixes Redocly#152 except in an edge case where both `pattern` and
`maxLength` are used, and the sampler skips over the valid length range.

It introduces a tiny dependency (<10 KB uncompressed) which doesn't
really have any prominent competitors.

package.json

@@ -88,6 +88,7 @@
   },
   "dependencies": {
     "@types/json-schema": "^7.0.7",
-    "json-pointer": "0.6.2"
+    "json-pointer": "0.6.2",
+    "randexp": "^0.5.3"
   }
 }

src/samplers/string.js

@@ -1,8 +1,66 @@
 'use strict';
 
+import RandExp from 'randexp';
+
 import { ensureMinLength, toRFCDateTime, uuid } from '../utils';
 
 const passwordSymbols = 'qwerty!@#$%^123456';
+const MAX_REGEX_SAMPLES = 100;
+
+function sampleRegex(pattern, min, max) {
+  let res;
+  let i = 0;
+  let length;
+  let prevLength;
+
+  // Increase length of the sample until it satisfies the minimum.
+  do {
+    RandExp.prototype.randInt = (from, to) => Math.min(from + i, to);
+    res = new RandExp(pattern).gen();
+    prevLength = length;
+    length = res.length;
+    i++;
+  } while (length < min && i < MAX_REGEX_SAMPLES);
+
+  // Handle case where we went past the maximum.
+  // Example: /\d*\d*foo/, will sample foo, 11foo, 2222foo, etc.
+  //
+  // HACK: RandExp doesn't expose an API to set the value of a specific sample,
+  //       so we'll just fuzz it. If no satisfying string is found,
+  //       we prefer to return a string that is too long than to return a string
+  //       that doesn't fit the regex.
+  if (max && max >= min && res.length > max) {
+    // probability that 2N fair coinflips returns N heads ~ 1 / sqrt(pi * N)
+    // probability that 2N biased coinflips (probabilty 1/2N) returns 1 heads ~ 1 / e
+    // so the fuzz will succeed for any reasonable regex (+, * don't appear more than 30 times)
+    const targetProbability = ((min + max) / 2 - prevLength) / (length - prevLength) 
+
+    for (let j = 0; j < MAX_REGEX_SAMPLES; j++) {
+      RandExp.prototype.randInt = (from, to) => Math.max(
+        from,
+        Math.min(from + i - 2 + (Math.random() < targetProbability ? 1 : 0), to),
+      );
+      const candidate = new RandExp(pattern).gen();
+      if (candidate.length >= min) {
+        if (candidate.length <= max) {
+          return candidate;
+        } else if (candidate.length < res.length) {
+          res = candidate;
+        }
+      }
+    }
+  }
+
+  return res;
+}
+
+function truncateString(str, min, max) {
+  let res = ensureMinLength(str, min);
+  if (max && res.length > max) {
+    res = res.substring(0, max);
+  }
+  return res;
+}
 
 function emailSample() {
   return '[email protected]';
@@ -42,12 +100,10 @@ function timeSample(min, max) {
   return commonDateTimeSample({ min, max, omitTime: false, omitDate: true }).slice(1);
 }
 
-function defaultSample(min, max) {
-  let res = ensureMinLength('string', min);
-  if (max && res.length > max) {
-    res = res.substring(0, max);
-  }
-  return res;
+function defaultSample(min, max, _propertyName, pattern) {
+  return pattern
+    ? sampleRegex(pattern, min, max)
+    : truncateString('string', min, max)
 }
 
 function ipv4Sample() {
@@ -96,8 +152,10 @@ function relativeJsonPointerSample() {
   return '1/relative/json/pointer';
 }
 
-function regexSample() {
-  return '/regex/';
+function regexSample(min, max, _propertyName, pattern) {
+  return pattern
+    ? sampleRegex(pattern, min, max)
+    : truncateString('/regex/', min, max)
 }
 
 const stringFormats = {
@@ -127,5 +185,10 @@ export function sampleString(schema, options, spec, context) {
   let format = schema.format || 'default';
   let sampler = stringFormats[format] || defaultSample;
   let propertyName = context && context.propertyName;
-  return sampler(schema.minLength | 0, schema.maxLength, propertyName);
+  return sampler(
+    schema.minLength || 0,
+    schema.maxLength,
+    propertyName,
+    schema.pattern,
+  );
 }

test/unit/string.spec.js

@@ -130,6 +130,22 @@ describe('sampleString', () => {
     expect(res).to.equal('fb4274c7-4fcd-4035-8958-a680548957ff');
   });
 
+  it('should return valid string for regex with min and max', () => {
+    const regex = 'foo-\\d+\\d+\\d+\\d+\\d+\\d+\\d+\\d+\\d+\\d+-bar'; // 10 reps
+    let schema = {
+      format: 'regex',
+      pattern: regex,
+      minLength: 509,
+      maxLength: 509,
+    };
+    res = sampleString(schema, null, null, {propertyName: 'fooId'});
+    expect(res).to.match(/foo-\d{501}-bar/);
+
+    schema = { ...schema, minLength: 513, maxLength: 513 };
+    res = sampleString(schema, null, null, {propertyName: 'fooId'});
+    expect(res).to.match(/foo-\d{505}-bar/);
+  });
+
   it.each([
     'email',
     // 'idn-email', // unsupported by ajv-formats