Merge pull request #1958 from RedisInsight/be/bugfix/RI-4390-fix_redis_glob

vlad-dargel · web-flow · commit 38aa64c4405b · 2023-04-18T09:04:09.000+01:00
#RI-4390 fix glob pattern to match redis glob-style
diff --git a/redisinsight/api/src/modules/browser/services/hash-business/hash-business.service.ts b/redisinsight/api/src/modules/browser/services/hash-business/hash-business.service.ts
@@ -6,8 +6,9 @@ import {
   NotFoundException,
 } from '@nestjs/common';
 import { chunk, flatMap, isNull } from 'lodash';
-import * as isGlob from 'is-glob';
-import { catchAclError, catchTransactionError, unescapeGlob } from 'src/utils';
+import {
+  catchAclError, catchTransactionError, isRedisGlob, unescapeRedisGlob,
+} from 'src/utils';
 import ERROR_MESSAGES from 'src/constants/error-messages';
 import { RedisErrorCodes } from 'src/constants';
 import config from 'src/utils/config';
@@ -105,8 +106,8 @@ export class HashBusinessService {
           new NotFoundException(ERROR_MESSAGES.KEY_NOT_EXIST),
         );
       }
-      if (dto.match && !isGlob(dto.match, { strict: false })) {
-        const field = unescapeGlob(dto.match);
+      if (dto.match && !isRedisGlob(dto.match)) {
+        const field = unescapeRedisGlob(dto.match);
         result.nextCursor = 0;
         const value = await this.browserTool.execCommand(
           clientMetadata,
diff --git a/redisinsight/api/src/modules/browser/services/keys-business/scanner/strategies/cluster.strategy.ts b/redisinsight/api/src/modules/browser/services/keys-business/scanner/strategies/cluster.strategy.ts
@@ -1,7 +1,6 @@
 import { toNumber, omit, isNull } from 'lodash';
-import * as isGlob from 'is-glob';
 import config from 'src/utils/config';
-import { unescapeGlob } from 'src/utils';
+import { isRedisGlob, unescapeRedisGlob } from 'src/utils';
 import {
   BrowserToolClusterService,
 } from 'src/modules/browser/services/browser-tool-cluster/browser-tool-cluster.service';
@@ -46,8 +45,8 @@ export class ClusterStrategy extends AbstractStrategy {
     const settings = await this.settingsService.getAppSettings('1');
     await this.calculateNodesTotalKeys(nodes);
 
-    if (!isGlob(match, { strict: false })) {
-      const keyName = Buffer.from(unescapeGlob(match));
+    if (!isRedisGlob(match)) {
+      const keyName = Buffer.from(unescapeRedisGlob(match));
       nodes.forEach((node) => {
         // eslint-disable-next-line no-param-reassign
         node.cursor = 0;
diff --git a/redisinsight/api/src/modules/browser/services/keys-business/scanner/strategies/standalone.strategy.ts b/redisinsight/api/src/modules/browser/services/keys-business/scanner/strategies/standalone.strategy.ts
@@ -1,7 +1,6 @@
-import * as isGlob from 'is-glob';
 import { isNull } from 'lodash';
 import config from 'src/utils/config';
-import { unescapeGlob } from 'src/utils';
+import { isRedisGlob, unescapeRedisGlob } from 'src/utils';
 import {
   GetKeyInfoResponse,
   GetKeysWithDetailsResponse,
@@ -47,8 +46,8 @@ export class StandaloneStrategy extends AbstractStrategy {
 
     node.total = await getTotal(client);
 
-    if (!isGlob(match, { strict: false })) {
-      const keyName = Buffer.from(unescapeGlob(match));
+    if (!isRedisGlob(match)) {
+      const keyName = Buffer.from(unescapeRedisGlob(match));
       node.cursor = 0;
       node.scanned = isNull(node.total) ? 1 : node.total;
       node.keys = await this.getKeysInfo(client, [keyName]);
diff --git a/redisinsight/api/src/modules/browser/services/set-business/set-business.service.ts b/redisinsight/api/src/modules/browser/services/set-business/set-business.service.ts
@@ -5,11 +5,12 @@ import {
   Logger,
   NotFoundException,
 } from '@nestjs/common';
-import * as isGlob from 'is-glob';
 import { RedisErrorCodes } from 'src/constants';
 import ERROR_MESSAGES from 'src/constants/error-messages';
 import config from 'src/utils/config';
-import { catchAclError, catchTransactionError, unescapeGlob } from 'src/utils';
+import {
+  catchAclError, catchTransactionError, isRedisGlob, unescapeRedisGlob,
+} from 'src/utils';
 import { ReplyError } from 'src/models';
 import { ClientMetadata } from 'src/common/models';
 import {
@@ -101,8 +102,8 @@ export class SetBusinessService {
           new NotFoundException(ERROR_MESSAGES.KEY_NOT_EXIST),
         );
       }
-      if (dto.match && !isGlob(dto.match, { strict: false })) {
-        const member = unescapeGlob(dto.match);
+      if (dto.match && !isRedisGlob(dto.match)) {
+        const member = unescapeRedisGlob(dto.match);
         result.nextCursor = 0;
         const memberIsExist = await this.browserTool.execCommand(
           clientMetadata,
diff --git a/redisinsight/api/src/modules/browser/services/z-set-business/z-set-business.service.ts b/redisinsight/api/src/modules/browser/services/z-set-business/z-set-business.service.ts
@@ -6,9 +6,10 @@ import {
   NotFoundException,
 } from '@nestjs/common';
 import { isNull, isNaN } from 'lodash';
-import * as isGlob from 'is-glob';
 import config from 'src/utils/config';
-import { catchAclError, catchTransactionError, unescapeGlob } from 'src/utils';
+import {
+  catchAclError, catchTransactionError, isRedisGlob, unescapeRedisGlob,
+} from 'src/utils';
 import {
   AddMembersToZSetDto,
   CreateZSetWithExpireDto,
@@ -269,8 +270,8 @@ export class ZSetBusinessService {
           new NotFoundException(ERROR_MESSAGES.KEY_NOT_EXIST),
         );
       }
-      if (dto.match && !isGlob(dto.match, { strict: false })) {
-        const member = unescapeGlob(dto.match);
+      if (dto.match && !isRedisGlob(dto.match)) {
+        const member = unescapeRedisGlob(dto.match);
         result.nextCursor = 0;
         const score = await this.browserTool.execCommand(
           clientMetadata,
diff --git a/redisinsight/api/src/utils/glob-pattern-helper.spec.ts b/redisinsight/api/src/utils/glob-pattern-helper.spec.ts
@@ -1,4 +1,4 @@
-import { unescapeGlob } from 'src/utils/glob-pattern-helper';
+import { unescapeGlob, isRedisGlob } from 'src/utils/glob-pattern-helper';
 
 const unescapeGlobTests = [
   { input: 'h?llo', output: 'h?llo' },
@@ -30,3 +30,41 @@ describe('unescapeGlob', () => {
     });
   });
 });
+
+describe('isRedisGlob', () => {
+  const testCases: [string, boolean][] = [
+    ['?ello', true],
+    ['??llo', true],
+    ['\\?\\?llo', false],
+    ['\\??llo', true],
+    ['?\\?llo', true],
+    ['\\\\\\\\?\\?llo', true],
+    ['h?llo', true],
+    ['h\\?llo', false],
+    ['h\\\\?llo', true],
+    ['h\\\\\\?llo', false],
+    ['h????llo', true],
+    ['h\\????llo', true],
+    ['h????ll?o', true],
+    ['h*llo', true],
+    ['h**llo', true],
+    ['h***ll*o', true],
+    ['\\*ello', false],
+    ['\\\\*ello', true],
+    ['\\\\\\*ello', false],
+    ['h[ae]llo', true],
+    ['h[^e]llo', true],
+    ['h[a-b]llo', true],
+    ['h[a-b\\]llo', false],
+    ['h[a-b\\\\]llo', true],
+    ['h\\[a-b\\\\]llo', false],
+    ['h\\\\[a-b\\\\]llo', true],
+    ['h\\\\[a-b\\]llo', false],
+  ];
+
+  testCases.forEach((tc) => {
+    it(`should return ${tc[1]} for input: ${tc[0]}`, () => {
+      expect(isRedisGlob(tc[0])).toEqual(tc[1]);
+    });
+  });
+});
diff --git a/redisinsight/api/src/utils/glob-pattern-helper.ts b/redisinsight/api/src/utils/glob-pattern-helper.ts
@@ -11,3 +11,76 @@ export const unescapeGlob = (value: string): string => {
 
   return result.replace(/\\{2}/g, '\\');
 };
+
+const REDIS_GLOB_SPEC_CHAR = ['?', '*', '[', ']'];
+export const unescapeRedisGlob = (value: string): string => {
+  let result = value;
+
+  REDIS_GLOB_SPEC_CHAR.forEach((char: string) => {
+    const regex = new RegExp('\\'.repeat(3) + char, 'g');
+    result = result.replace(regex, char);
+  });
+
+  return result.replace(/\\{2}/g, '\\');
+};
+
+/**
+ * Determines if any character on specific position is escaped
+ * @param str
+ * @param pos
+ */
+export const isEscaped = (str: string, pos: number) => {
+  let currPos = pos;
+  while (currPos > 0 && str[currPos - 1] === '\\') {
+    currPos -= 1;
+  }
+
+  const escCount = pos - currPos;
+
+  return escCount && (escCount % 2) > 0;
+};
+
+/**
+ * Find first position of unescaped char
+ * @param char
+ * @param str
+ * @param startPosition
+ */
+const findUnescapedCharPosition = (char: string, str: string, startPosition = 0) => {
+  let pos = str.indexOf(char, startPosition);
+  while (pos >= 0) {
+    if (!isEscaped(str, pos)) {
+      return pos;
+    }
+
+    pos = str.indexOf(char, pos + 1);
+  }
+
+  return pos;
+};
+
+/**
+ * Check if string has at least one unescaped char or sequence of unescaped chars in proper order
+ * Supported only 1-char and 2-chars conditions for now
+ * @param char
+ * @param str
+ * @param startPosition
+ */
+const hasUnescapedChar = (char: string, str: string, startPosition = 0) => {
+  if (char.length === 1) {
+    return findUnescapedCharPosition(char, str, startPosition) >= 0;
+  }
+
+  if (char.length === 2) {
+    const firstCharPos = findUnescapedCharPosition(char[0], str, startPosition);
+    if (firstCharPos >= 0) {
+      return findUnescapedCharPosition(char[1], str, firstCharPos) >= 0;
+    }
+  }
+
+  return false;
+};
+
+export const isRedisGlob = (str: string) => hasUnescapedChar('?', str)
+    || hasUnescapedChar('*', str)
+    || hasUnescapedChar('[]', str);
