fix: secret function

[kobenguyent]

Motivation/Description of the PR

fix: secret function

  type redactedMyObj = { password: CodeceptJS.Secret };
  const myObj: any = secret({ password: 'pass123', pwd: 'hi' }, 'password') as redactedMyObj;
  console.log(myObj.password);

>>> Secret { _secret: 'pass123' }

  type redactedMyObj = { password: CodeceptJS.Secret };
  const myObj: any = secret({ password: 'pass123', pwd: 'hi' }, 'password') as redactedMyObj;
  console.log(myObj);
>>>> { password: Secret { _secret: 'pass123' }, pwd: 'hi' }



await I.sendPostRequest('/auth', secret({ name: 'jon', password: '123456' }, 'password'));
// console log
  Verify a successful call
    I send post request "/auth", {"name":"jon","password":"*****"}
    › [Request] {"baseURL":"https://reqres.in/auth","method":"POST","data":{"name":"jon","password":"*****"},"headers":{}}

Type of change

• 🐛 Bug fix

Checklist:

• Tests have been added
• Documentation has been added (Run npm run docs)
• Lint checking (Run npm run lint)
• Local tests are passed (Run npm test)

[roycollings]

@kobenguyent I think you can solve all of this by just changing the return value in the get handler in secret.js to return fieldsToHide.includes(prop) ? new Secret(obj[prop]) : obj[prop];:

function secretObject(obj, fieldsToHide = []) {
  const handler = {
    get(obj, prop) {
      if (prop === 'toString') {
        return function () {
          const maskedObject = deepClone(obj);
          fieldsToHide.forEach(f => maskedObject[f] = maskStr);
          return JSON.stringify(maskedObject);
        };
      }

      // Just this change ...
      return fieldsToHide.includes(prop) ? new Secret(obj[prop]) : obj[prop];
    },
  };

  return new Proxy(obj, handler);
}

This makes the extracted item a secret - in my local tests this seems to work well (my tests can run login scripts etc.. with this approach):

simple helper fn to demo:

  useMyFunc(secret_string, secret_object, secret_item_from_object) {
    console.log(">>>> types", {
      secret_string: typeof secret_string,
      secret_object: typeof secret_object,
      secret_item_from_object: typeof secret_item_from_object,
    });

    console.log(">>>> values", {
      secret_string,
      secret_item_from_object: secret_item_from_object,
    });
  }

Send the secrets to see what's logged...

    const secret_string = secret("password");
    const secret_object = secret({ a: "pass123", b: "bob" }, "a");

    I.useMyFunc(secret_string, secret_object, secret_object.a);

OUTPUT

    I use my func *****, {"a":"****","b":"bob"}, *****
>>>> types {
  secret_string: 'object',
  secret_object: 'object',
  secret_item_from_object: 'object'
}
>>>> values {
  secret_string: Secret { _secret: 'password' },
  secret_item_from_object: Secret { _secret: 'pass123' }
}

[kobenguyent]

@kobenguyent I think you can solve all of this by just changing the return value in the get handler in secret.js to return fieldsToHide.includes(prop) ? new Secret(obj[prop]) : obj[prop];:

function secretObject(obj, fieldsToHide = []) {
  const handler = {
    get(obj, prop) {
      if (prop === 'toString') {
        return function () {
          const maskedObject = deepClone(obj);
          fieldsToHide.forEach(f => maskedObject[f] = maskStr);
          return JSON.stringify(maskedObject);
        };
      }

      // Just this change ...
      return fieldsToHide.includes(prop) ? new Secret(obj[prop]) : obj[prop];
    },
  };

  return new Proxy(obj, handler);
}

This makes the extracted item a secret - in my local tests this seems to work well (my tests can run login scripts etc.. with this approach):

simple helper fn to demo:

  useMyFunc(secret_string, secret_object, secret_item_from_object) {
    console.log(">>>> types", {
      secret_string: typeof secret_string,
      secret_object: typeof secret_object,
      secret_item_from_object: typeof secret_item_from_object,
    });

    console.log(">>>> values", {
      secret_string,
      secret_item_from_object: secret_item_from_object,
    });
  }

Send the secrets to see what's logged...

    const secret_string = secret("password");
    const secret_object = secret({ a: "pass123", b: "bob" }, "a");

    I.useMyFunc(secret_string, secret_object, secret_object.a);

OUTPUT

    I use my func *****, {"a":"****","b":"bob"}, *****
>>>> types {
  secret_string: 'object',
  secret_object: 'object',
  secret_item_from_object: 'object'
}
>>>> values {
  secret_string: Secret { _secret: 'password' },
  secret_item_from_object: Secret { _secret: 'pass123' }
}

Thanks @roycollings such an elegant fix than mine.

[roycollings]

Couple of non-blockers :)