feat/add-redact-feature-on-regex-plugin #1292
Conversation
|
DescriptionSummary By MatterAI
🔄 What ChangedThe Regex Match plugin ( 🔍 Impact of the ChangeThis feature significantly expands the plugin's utility, enabling robust data privacy and content modification capabilities. It allows for the masking of sensitive information, transforming the plugin into a more powerful tool for data governance. The performance optimization for regex handling ensures efficient processing, especially with large inputs. 📁 Total Files Changed
🧪 Test AddedN/A 🔒Security VulnerabilitiesThe MotivationTo enhance data privacy and allow for masking of sensitive information identified by regex patterns. Type of Change
How Has This Been Tested?
Screenshots (if applicable)N/A Checklist
Related IssuesN/A Tip Quality Recommendations
Tanka Poem ♫
Sequence DiagramsequenceDiagram
participant PH as PluginHandler
participant C as Context
participant ET as EventType
participant T as Text
PH->>C: getCurrentContentPart(context, eventType)
C-->>PH: {content, textArray}
alt Missing regexPattern or text
PH-->>PH: throw Error('Missing regex pattern')
else
PH->>PH: Create RegExp(regexPattern, redact ? 'g' : '')
loop For each text in textArray
PH->>PH: Reset regex.lastIndex = 0 (if redact)
PH->>T: text.match(regex)
T-->>PH: matches
alt Matches found AND redact is true
PH->>PH: Reset regex.lastIndex = 0
PH->>T: text.replace(regex, redactText)
T-->>PH: redactedText
PH->>PH: Add redactedText to mappedTextArray
else No matches or no redaction
PH->>PH: Add null to mappedTextArray
end
end
PH->>C: getText(context, eventType)
C-->>PH: textToMatch
alt Redact is true
PH->>PH: Reset regex.lastIndex = 0
end
PH->>T: regex.exec(textToMatch)
T-->>PH: singleMatch
PH-->>PH: Prepare data object (regexPattern, hasMatches, singleMatch, textExcerpt)
end
alt Error Occurred
PH-->>PH: Catch error (e)
PH->>C: getText(context, eventType)
C-->>PH: textExcerpt
PH-->>PH: Prepare error data object (explanation, regexPattern, not, textExcerpt)
end
|
![matter-code-review[bot]](https://avatars.githubusercontent.com/in/474549?s=60&v=4){kind=small}
plugins/default/regexMatch.ts
Outdated
| const regex = new RegExp(regexPattern, redact ? 'g' : ''); | ||
|
|
||
| // Check for matches across all text | ||
| let hasMatches = false; | ||
| const mappedTextArray: Array<string | null> = []; | ||
|
|
||
| textArray.forEach((text) => { | ||
| if (!text) { | ||
| mappedTextArray.push(null); | ||
| return; | ||
| } | ||
|
|
||
| // Check if pattern exists in text | ||
| const localRegex = new RegExp(regexPattern, 'g'); | ||
| const matches = text.match(localRegex); |
There was a problem hiding this comment.
🐛 Bug Fix
Issue: Creating redundant RegExp objects - regex is created but never used, while localRegex is recreated in every loop iteration
Fix: Reuse the main regex object and avoid unnecessary object creation
Impact: Reduces memory allocation and improves performance in loops
| const regex = new RegExp(regexPattern, redact ? 'g' : ''); | |
| // Check for matches across all text | |
| let hasMatches = false; | |
| const mappedTextArray: Array<string | null> = []; | |
| textArray.forEach((text) => { | |
| if (!text) { | |
| mappedTextArray.push(null); | |
| return; | |
| } | |
| // Check if pattern exists in text | |
| const localRegex = new RegExp(regexPattern, 'g'); | |
| const matches = text.match(localRegex); | |
| const regex = new RegExp(regexPattern, redact ? 'g' : ''); | |
| // Check for matches across all text | |
| let hasMatches = false; | |
| const mappedTextArray: Array<string | null> = []; | |
| textArray.forEach((text) => { | |
| if (!text) { | |
| mappedTextArray.push(null); | |
| return; | |
| } | |
| // Check if pattern exists in text | |
| const matches = text.match(regex); |
plugins/default/regexMatch.ts
Outdated
| if (redact) { | ||
| const redactedText = text.replace(localRegex, redactText); | ||
| mappedTextArray.push(redactedText); |
There was a problem hiding this comment.
🐛 Bug Fix
Issue: Using localRegex variable that no longer exists after the previous fix
Fix: Use the main regex object for replacement
Impact: Fixes reference error and maintains consistent regex behavior
| if (redact) { | |
| const redactedText = text.replace(localRegex, redactText); | |
| mappedTextArray.push(redactedText); | |
| if (redact) { | |
| const redactedText = text.replace(regex, redactText); | |
| mappedTextArray.push(redactedText); | |
| } else { |
| transformed = true; | ||
| } | ||
|
|
||
| verdict = not ? hasMatches : !shouldBlock; |
There was a problem hiding this comment.
🐛 Bug Fix
Issue: Logic error in verdict calculation - when not=true and hasMatches=true, should return false (blocked), but !shouldBlock returns true
Fix: Correct the boolean logic for the not parameter
Impact: Fixes inverted logic that would allow matches when they should be blocked
| verdict = not ? hasMatches : !shouldBlock; | |
| verdict = not ? !hasMatches : !shouldBlock; |
plugins/default/regexMatch.ts
Outdated
| // For backward compatibility, also get single text for matchDetails | ||
| const textToMatch = getText(context, eventType); | ||
| const singleMatch = new RegExp(regexPattern).exec(textToMatch); |
There was a problem hiding this comment.
⚡️ Performance Improvement
Issue: Creating new RegExp object for single match when regex already exists
Fix: Reuse existing regex object with reset lastIndex for global patterns
Impact: Eliminates unnecessary RegExp construction
| // For backward compatibility, also get single text for matchDetails | |
| const textToMatch = getText(context, eventType); | |
| const singleMatch = new RegExp(regexPattern).exec(textToMatch); | |
| // For backward compatibility, also get single text for matchDetails | |
| const textToMatch = getText(context, eventType); | |
| regex.lastIndex = 0; // Reset for global regex | |
| const singleMatch = regex.exec(textToMatch); |
plugins/default/regexMatch.ts
Outdated
| textExcerpt: | ||
| textToMatch.length > 100 | ||
| textToMatch?.length > 100 | ||
| ? textToMatch.slice(0, 100) + '...' | ||
| : textToMatch, |
There was a problem hiding this comment.
🐛 Bug Fix
Issue: Potential null pointer exception when textToMatch is null/undefined
Fix: Add null check before accessing length property
Impact: Prevents runtime crash when text content is missing
| textExcerpt: | |
| textToMatch.length > 100 | |
| textToMatch?.length > 100 | |
| ? textToMatch.slice(0, 100) + '...' | |
| : textToMatch, | |
| textExcerpt: | |
| textToMatch && textToMatch.length > 100 | |
| ? textToMatch.slice(0, 100) + '...' | |
| : textToMatch, |
|
Important PR Review SkippedPR review skipped as per the configuration setting. Run a manually review by commenting /matter review 💡Tips to use Matter AICommand List
|
Description
This PR enhances the Regex Match plugin by adding an optional redaction feature.
Developers can now configure the plugin to not only detect regex matches but also redact matching text with a replacement string (default:
[REDACTED]).Motivation
Type of Change
How Has This Been Tested?
Screenshots (if applicable)
No UI impact – plugin configuration extended with
redactandredactTextparameters.Checklist
Related Issues
Fixes and closes #1291