refactor: Remove errorRedactor

[danielbankhead]

It simply does not work well with the open-ended GaxiosOptions & Response types and is pretty unmaintainable. Instead, customers should use a proper data loss prevention (DLP) product for this [example [infotypes]].

It has been marked as an @experimental API and thus is not breaking if removed.

gaxios/README.md

Lines 191 to 204 in 56b1410

	/**
	* An experimental, customizable error redactor.
	*
	* Set `false` to disable.
	*
	* @remarks
	*
	* This does not replace the requirement for an active Data Loss Prevention (DLP) provider. For DLP suggestions, see:
	* - https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data#dlp_deidentify_replace_infotype-nodejs
	* - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets
	*
	* @experimental
	*/
	errorRedactor?: typeof defaultErrorRedactor | false;

gaxios/src/common.ts

Lines 248 to 259 in 56b1410

	/**
	* An experimental error redactor.
	*
	* @remarks
	*
	* This does not replace the requirement for an active Data Loss Prevention (DLP) provider. For DLP suggestions, see:
	* - https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data#dlp_deidentify_replace_infotype-nodejs
	* - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets
	*
	* @experimental
	*/
	errorRedactor?: typeof defaultErrorRedactor | false;

gaxios/src/common.ts

Lines 392 to 489 in 56b1410

	export function defaultErrorRedactor<T = any>(data: {
	config?: RedactableGaxiosOptions;
	response?: RedactableGaxiosResponse<T>;
	}) {
	const REDACT =
	'<<REDACTED> - See `errorRedactor` option in `gaxios` for configuration>.';
	function redactHeaders(headers?: Headers) {
	if (!headers) return;
	for (const key of Object.keys(headers)) {
	// any casing of `Authentication`
	if (/^authentication$/i.test(key)) {
	headers[key] = REDACT;
	}
	// any casing of `Authorization`
	if (/^authorization$/i.test(key)) {
	headers[key] = REDACT;
	}
	// anything containing secret, such as 'client secret'
	if (/secret/i.test(key)) {
	headers[key] = REDACT;
	}
	}
	}
	function redactString(obj: GaxiosOptions, key: keyof GaxiosOptions) {
	if (
	typeof obj === 'object' &&
	obj !== null &&
	typeof obj[key] === 'string'
	) {
	const text = obj[key];
	if (
	/grant_type=/i.test(text) ||
	/assertion=/i.test(text) ||
	/secret/i.test(text)
	) {
	obj[key] = REDACT;
	}
	}
	}
	function redactObject<T extends GaxiosOptions['data']>(obj: T) {
	if (typeof obj === 'object' && obj !== null) {
	if ('grant_type' in obj) {
	obj['grant_type'] = REDACT;
	}
	if ('assertion' in obj) {
	obj['assertion'] = REDACT;
	}
	if ('client_secret' in obj) {
	obj['client_secret'] = REDACT;
	}
	}
	}
	if (data.config) {
	redactHeaders(data.config.headers);
	redactString(data.config, 'data');
	redactObject(data.config.data);
	redactString(data.config, 'body');
	redactObject(data.config.body);
	try {
	const url = new URL('', data.config.url);
	if (url.searchParams.has('token')) {
	url.searchParams.set('token', REDACT);
	}
	if (url.searchParams.has('client_secret')) {
	url.searchParams.set('client_secret', REDACT);
	}
	data.config.url = url.toString();
	} catch {
	// ignore error - no need to parse an invalid URL
	}
	}
	if (data.response) {
	defaultErrorRedactor({config: data.response.config});
	redactHeaders(data.response.headers);
	redactString(data.response, 'data');
	redactObject(data.response.data);
	}
	return data;
	}

An internal bug is blocking this feature request - await it's resolution first.

[udayarctempus]

Do you know when this get released? We are getting the following error, seems related to this

TypeError: Cannot read properties of undefined (reading 'config')
at Object.defaultErrorRedactor [as errorRedactor] (/opt/tempus/code/node_modules/gaxios/build/src/common.js:160:14)
at TransformOperationExecutor.transform (/opt/tempus/code/node_modules/class-transformer/cjs/TransformOperationExecutor.js:192:51)
at TransformOperationExecutor.transform (/opt/tempus/code/node_modules/class-transformer/cjs/TransformOperationExecutor.js:291:43)
at TransformOperationExecutor.transform (/opt/tempus/code/node_modules/class-transformer/cjs/TransformOperationExecutor.js:291:43)
at TransformOperationExecutor.transform (/opt/tempus/code/node_modules/class-transformer/cjs/TransformOperationExecutor.js:291:43)
at ClassTransformer.instanceToPlain (/opt/tempus/code/node_modules/class-transformer/cjs/ClassTransformer.js:13:25)