Adding String Literal Sanitizers #2530
Conversation
… of wonky values without needing to do regex escapes.
scbedd
added
the
Central-EngSys
| /// <returns>An updated value of the input string, with replacement operations completed if necessary.</returns> | ||
| public static string ReplaceValue(string inputValue, string targetValue, string replacementValue) | ||
| { | ||
| return inputValue.Replace(targetValue, replacementValue); |
There was a problem hiding this comment.
Betting on additional requests making this a bit more complicated, hence the one line abstraction.
…ugh them. added admin tests to check about missing required parameters
|
This pull request is protected by Check Enforcer. What is Check Enforcer?Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass. Why am I getting this message?You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged. What should I do now?If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows: |
) - Fixes #19809 - Part of work towards #18223 The main motivation of this PR was to add support for the new string sanitizers introduced in Azure/azure-sdk-tools#2530. As part of this, I've also tackled some refactoring that will be required for session-level sanitizer support (#18223) where we will be wanting to enable adding sanitizers without access to an instance of the `Recorder` class. While implementing the new sanitizer logic, I refactored the `addSanitizers` method into smaller chunks to make adding additional sanitizers easier. To summarize the changes: * Removed the `Sanitizer` class, instead making the `addSanitizers` function in `sanitizer.ts` take in a `HttpClient` and recording ID as parameter. * Refactored the `addSanitizers` function to call smaller functions for each sanitizer (some of which are a bit FP-style) instead of using if statements + special cases. Hopefully this will make things a bit easier to maintain. * Some other minor refactors (e.g. extracting duplicated `createRecordingRequest` function into a utility). * Add support for the string sanitizers in what I think is the most logical way, but there is a **breaking change**: * When calling `addSanitizers`, instead of specifying `generalRegexSanitizers: [...]` etc., you now specify `generalSanitizers: [...]`. Both regex sanitizers and string sanitizers can be used in this way, for example: ```ts recorder.addSanitizers({ generalSanitizers: [ { regex: true, // Regex matching is enabled by setting the 'regex' option to true. target: ".*regex", value: "sanitized", }, { // Note that `regex` defaults to false and doesn't need to be specified when working with bare strings. // In my experience, this is the most common scenario anyway. target: "Not a regex", value: "sanitized", } ], }); ```
@HarshaNalluru @timovv this takes care of #2504