refactor: Change response types of TOTP adapter to match existing adapters

[dblythy]

Pull Request

• Report security issues confidentially.
• Any contribution is under this license.
• Link this pull request to an issue.

Issue

The TOTP adapter has mixed return types, making it incompatible with strongly typed client SDKS.

There's also an additional issue with the TOTP adapter that is fixed in this PR as well.

Closes: #8660

Approach

Changes the response of enabled: true to status: "enabled"

Tasks

• Add tests
• Add changes to documentation (guides, repository pages, code comments)

[parse-github-assistant]

I will reformat the title to use the proper commit message syntax.

[parse-github-assistant]

Thanks for opening this pull request!

[dblythy]

@cbaker6 let me know if this looks better

[codecov]

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (a9d376b) 94.39% compared to head (4e9dd29) 94.39%.

❗ Current head 4e9dd29 differs from pull request most recent head 80ad75f. Consider uploading reports for the commit 80ad75f to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##            alpha    #8661   +/-   ##
=======================================
  Coverage   94.39%   94.39%           
=======================================
  Files         185      185           
  Lines       14760    14761    +1     
=======================================
+ Hits        13932    13933    +1     
  Misses        828      828           

Impacted Files	Coverage Δ
src/Adapters/Auth/mfa.js	81.73% <100.00%> (+0.16%)	⬆️

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[cbaker6]

@dblythy the updates look good to me

[dblythy]

I’ve just realised I’ve missed one thing

[dblythy]

@cbaker6 I've also adapted the "additional auth data" when logging in,

Previous:

{
  username: 'username',
  password: 'password',
  authData: {
   mfa: totp.generate()
  },
}

New:

{
  username: 'username',
  password: 'password',
  authData: {
   mfa: {
     token: totp.generate()
   }
  },
}

Is this correct?

[mtrezza]

{
  username: 'username',
  password: 'password',
  authData: {
   mfa: {
     token: totp.generate()
   }
  },
}

would be a type structure of:

authData: object<string: object<string: string>>

It would be the same type structure that is in the REST API example:

{
  "authData": {
    "twitter": {
      "id": "12345678",
      "screen_name": "ParseIt",
      "consumer_key": "SaMpLeId3X7eLjjLgWEw",
      "consumer_secret": "SaMpLew55QbMR0vTdtOACfPXa5UdO2THX1JrxZ9s3c",
      "auth_token": "12345678-SaMpLeTuo3m2avZxh5cjJmIrAfx4ZYyamdofM7IjU",
      "auth_token_secret": "SaMpLeEb13SpRzQ4DAIzutEkCE2LBIm2ZQDsP3WUU"
    }
  }
}

So that should be good I'd say. Is any of this a breaking change, or is this PR only affecting code on the pre-release branches?

[dblythy]

Only affects the alpha branch

[mtrezza]

So now both the request and response have a type structure of:

authData: object<string: object<string: string>>

Is that right?

[dblythy]

Correct! Which should allow for easier integration in strongly typed SDKs, such as the SwiftSDK

[mtrezza]

Sounds good, I'll re-run the CI until it passes

[mtrezza]

Is this ready for merge?

[dblythy]

@cbaker6 did you want to have one final review before we merge?

[parse-github-assistant]

The label block:beta cannot be used here.

[parseplatformorg]

🎉 This change has been released in version 6.3.0-alpha.6

[parseplatformorg]

🎉 This change has been released in version 6.4.0-beta.1

[parseplatformorg]

🎉 This change has been released in version 6.4.0-alpha.1

[parseplatformorg]

🎉 This change has been released in version 6.4.0

[REPTILEHAUS]

consumer_secret

@mtrezza I mentioned on the forum also but is it really fine to store any of the *_secret API keys on each user authData ?