DLP: Added sample for deidentify by redacting matched input values (#3128)

* DLP: Added sample for deidentify by redacting matched input values
Added unit test cases for same

* Resolved linting errors

* Renamed `textToInspect` to `string`
Added `infoTypes` in the transformation configs
Updated test cases

---------

Co-authored-by: Karl Weinmeister <[email protected]>

Author: dinesh-crest

dlp/deIdentifyWithRedaction.js

@@ -0,0 +1,101 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
+
+// sample-metadata:
+//  title: De-identify data: Redacting with matched input values
+//  description: Uses the Data Loss Prevention API to de-identify sensitive data
+//    in a string by redacting matched input values.
+//  usage: node deIdentifyWithRedaction.js my-project string infoTypes
+
+function main(projectId, string, infoTypes) {
+  infoTypes = transformCLI(infoTypes);
+  // [START dlp_deidentify_redact]
+  // Imports the Google Cloud Data Loss Prevention library
+  const DLP = require('@google-cloud/dlp');
+
+  // Instantiates a client
+  const dlp = new DLP.DlpServiceClient();
+
+  // TODO(developer): Replace these variables before running the sample.
+  // const projectId = "your-project-id";
+
+  // The string to deidentify
+  // const string =
+  //   'My name is Alicia Abernathy, and my email address is [email protected].';
+
+  // The infoTypes of information to match
+  // See https://cloud.google.com/dlp/docs/concepts-infotypes for more information
+  // about supported infoTypes.
+  // const infoTypes = [{name: 'EMAIL_ADDRESS'}];
+
+  async function deIdentifyRedaction() {
+    // Construct deidentify configuration
+    const deidentifyConfig = {
+      infoTypeTransformations: {
+        transformations: [
+          {
+            infoTypes: infoTypes,
+            primitiveTransformation: {
+              redactConfig: {},
+            },
+          },
+        ],
+      },
+    };
+
+    // Construct inspect configuration
+    const inspectConfig = {
+      infoTypes: infoTypes,
+    };
+
+    // Construct Item
+    const item = {
+      value: string,
+    };
+
+    // Combine configurations into a request for the service.
+    const request = {
+      parent: `projects/${projectId}/locations/global`,
+      item,
+      deidentifyConfig,
+      inspectConfig,
+    };
+
+    // Send the request and receive response from the service
+    const [response] = await dlp.deidentifyContent(request);
+
+    // Print the results
+    console.log(`Text after redaction: ${response.item.value}`);
+  }
+
+  deIdentifyRedaction();
+  // [END dlp_deidentify_redact]
+}
+
+main(...process.argv.slice(2));
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+
+function transformCLI(infoTypes) {
+  infoTypes = infoTypes
+    ? infoTypes.split(',').map(type => {
+        return {name: type};
+      })
+    : undefined;
+  return infoTypes;
+}

dlp/system-test/deid.test.js

@@ -178,4 +178,36 @@ describe('deid', () => {
     }
     assert.include(output, 'INVALID_ARGUMENT');
   });
+
+  // dlp_deidentify_redact
+  it('should redact the matched input values', () => {
+    const string =
+      'My name is Alicia Abernathy, and my email address is [email protected].';
+    let output;
+    try {
+      output = execSync(
+        `node deIdentifyWithRedaction.js ${projectId} "${string}" EMAIL_ADDRESS`
+      );
+    } catch (err) {
+      output = err.message;
+    }
+    assert.include(
+      output,
+      'My name is Alicia Abernathy, and my email address is .'
+    );
+  });
+
+  it('should handle deidentification errors', () => {
+    let output;
+    const string =
+      'My name is Alicia Abernathy, and my email address is [email protected].';
+    try {
+      output = execSync(
+        `node deIdentifyWithRedaction.js ${projectId} "${string}" BAD_TYPE`
+      );
+    } catch (err) {
+      output = err.message;
+    }
+    assert.include(output, 'INVALID_ARGUMENT');
+  });
 });