feat: implement toString() for data classes #4

inuEbisu · 2025-08-15T09:47:29Z

No description provided.

Copilot

Pull Request Overview

This PR implements custom toString() methods for data classes across the FIDO2 library to improve debugging and logging capabilities. The implementation provides structured, multi-line string representations that include all relevant fields with proper formatting for binary data.

Adds consistent toString() implementations using StringBuffer for formatted output
Includes hex encoding for binary data fields using the convert package
Handles optional fields with conditional formatting

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
lib/src/ctap2/requests/make_credential.dart	Adds toString() methods for MakeCredentialRequest and MakeCredentialResponse classes
lib/src/ctap2/requests/get_assertion.dart	Adds toString() methods for GetAssertionRequest and GetAssertionResponse classes
lib/src/ctap2/requests/credential_mgmt.dart	Adds toString() methods for CredentialManagementRequest and CredentialManagementResponse classes
lib/src/ctap2/requests/client_pin.dart	Adds toString() methods for ClientPinRequest and ClientPinResponse classes
lib/src/ctap2/pin.dart	Adds toString() method for EncapsulateResult class and updates imports
lib/src/ctap2/entities/credential_entities.dart	Updates toString() methods for credential entity classes with improved formatting
lib/src/ctap2/entities/authenticator_info.dart	Adds comprehensive toString() method for AuthenticatorInfo class
lib/src/ctap2/credmgmt.dart	Adds toString() methods for credential management helper classes
lib/src/ctap.dart	Adds toString() methods for CtapResponse and updates CtapError toString()
lib/src/cose.dart	Adds toString() methods for COSE key classes with hex-encoded coordinate display

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-08-16T08:36:59Z

lib/src/ctap2/pin.dart

+    final buffer = StringBuffer();
+    buffer.writeln('EncapsulateResult(');
+    buffer.writeln('  coseKey: $coseKey,');
+    buffer.writeln('  sharedSecret: ${hex.encode(sharedSecret)}');


Missing comma after the last field. For consistency with other toString() implementations in this PR, add a comma after 'sharedSecret'.

Suggested change

buffer.writeln(' sharedSecret: ${hex.encode(sharedSecret)}');

buffer.writeln(' sharedSecret: ${hex.encode(sharedSecret)},');

Copilot · 2025-08-16T08:37:00Z

lib/src/ctap2/entities/credential_entities.dart

-    return 'PublicKeyCredentialRpEntity(id: $id)';
+    final buffer = StringBuffer();
+    buffer.writeln('PublicKeyCredentialRpEntity(');
+    buffer.writeln('  id: $id');


Missing comma after the last field. For consistency with other toString() implementations in this PR, add a comma after 'id'.

Suggested change

buffer.writeln(' id: $id');

buffer.writeln(' id: $id,');

Copilot · 2025-08-16T08:37:00Z

lib/src/ctap2/entities/credential_entities.dart

+    buffer.writeln('PublicKeyCredentialUserEntity(');
+    buffer.writeln('  id: ${hex.encode(id)},');
+    buffer.writeln('  name: $name,');
+    buffer.writeln('  displayName: $displayName');


Missing comma after the last field. For consistency with other toString() implementations in this PR, add a comma after 'displayName'.

Suggested change

buffer.writeln(' displayName: $displayName');

buffer.writeln(' displayName: $displayName,');

Copilot · 2025-08-16T08:37:00Z

lib/src/ctap2/entities/credential_entities.dart

+    buffer.writeln('PublicKeyCredentialDescriptor(');
+    buffer.writeln('  type: $type,');
+    buffer.writeln('  id: ${hex.encode(id)},');
+    if (transports != null) buffer.writeln('  transports: $transports,');


The 'id' field has a trailing comma but should not have one since it's always the last field before the conditional 'transports' field. Remove the comma or restructure to maintain consistency.

Suggested change

if (transports != null) buffer.writeln(' transports: $transports,');

if (transports != null) {

buffer.writeln(' id: ${hex.encode(id)},');

buffer.writeln(' transports: $transports,');

} else {

buffer.writeln(' id: ${hex.encode(id)}');

}

Copilot · 2025-08-16T08:37:00Z

lib/src/ctap2/credmgmt.dart

+    buffer.writeln(
+        '  existingResidentCredentialsCount: $existingResidentCredentialsCount,');
+    buffer.writeln(
+        '  maxPossibleRemainingResidentCredentialsCount: $maxPossibleRemainingResidentCredentialsCount');


Missing comma after the last field. For consistency with other toString() implementations in this PR, add a comma after 'maxPossibleRemainingResidentCredentialsCount'.

Suggested change

' maxPossibleRemainingResidentCredentialsCount: $maxPossibleRemainingResidentCredentialsCount');

' maxPossibleRemainingResidentCredentialsCount: $maxPossibleRemainingResidentCredentialsCount,');

Copilot · 2025-08-16T08:37:01Z

lib/src/ctap.dart

+    final buffer = StringBuffer();
+    buffer.writeln('CtapError(');
+    buffer.writeln('  status: ${status.value},');
+    buffer.writeln('  name: ${status.name}');


Missing comma after the last field. For consistency with other toString() implementations in this PR, add a comma after 'name'.

Suggested change

buffer.writeln(' name: ${status.name}');

buffer.writeln(' name: ${status.name},');

Copilot · 2025-08-16T08:37:01Z

lib/src/cose.dart

+    final buffer = StringBuffer();
+    buffer.writeln('CoseKey(');
+    buffer.writeln('  algorithm: $alg,');
+    buffer.writeln('  params: ${Map<int, dynamic>.from(this)}');


Missing comma after the last field. For consistency with other toString() implementations in this PR, add a comma after 'params'.

Suggested change

buffer.writeln(' params: ${Map<int, dynamic>.from(this)}');

buffer.writeln(' params: ${Map<int, dynamic>.from(this)},');

Copilot · 2025-08-16T08:37:01Z

lib/src/cose.dart

+    final buffer = StringBuffer();
+    buffer.writeln('UnsupportedKey(');
+    buffer.writeln('  algorithm: $alg,');
+    buffer.writeln('  params: ${Map<int, dynamic>.from(this)}');


Missing comma after the last field. For consistency with other toString() implementations in this PR, add a comma after 'params'.

Suggested change

buffer.writeln(' params: ${Map<int, dynamic>.from(this)}');

buffer.writeln(' params: ${Map<int, dynamic>.from(this)},');

Copilot · 2025-08-16T08:37:02Z

lib/src/cose.dart

+    buffer.writeln('ES256(');
+    buffer.writeln('  algorithm: $algorithm,');
+    buffer.writeln('  x: ${x != null ? hex.encode(x) : null},');
+    buffer.writeln('  y: ${y != null ? hex.encode(y) : null}');


Missing comma after the last field. For consistency with other toString() implementations in this PR, add a comma after 'y'.

Suggested change

buffer.writeln(' y: ${y != null ? hex.encode(y) : null}');

buffer.writeln(' y: ${y != null ? hex.encode(y) : null},');

Copilot · 2025-08-16T08:37:02Z

lib/src/cose.dart

+    buffer.writeln('EcdhEsHkdf256(');
+    buffer.writeln('  algorithm: $algorithm,');
+    buffer.writeln('  x: ${x != null ? hex.encode(x) : null},');
+    buffer.writeln('  y: ${y != null ? hex.encode(y) : null}');


Missing comma after the last field. For consistency with other toString() implementations in this PR, add a comma after 'y'.

Suggested change

buffer.writeln(' y: ${y != null ? hex.encode(y) : null}');

buffer.writeln(' y: ${y != null ? hex.encode(y) : null},');

Harry-Chen · 2025-08-16T08:39:11Z

As we have discussed before, it would be more elegant and clean to use the native serialization of Dart to convert the data classes from/to JSON. @dangfan What's your opinion on this?

dangfan · 2025-08-16T09:11:32Z

As we have discussed before, it would be more elegant and clean to use the native serialization of Dart to convert the data classes from/to JSON. @dangfan What's your opinion on this?

I agree. Shall we finish the server part first and then work on this?

…sses

inuEbisu · 2025-08-31T04:56:51Z

Given our earlier discussion to prefer JSON-based serialization over handcrafted toString, this PR (manual toString) has become obsolete. I’ve implemented the json_serializable-based toJson plus a unified toString via mixin on top of main. Rebasing this branch onto main now causes extensive conflicts due to parallel changes. So I would like to close this PR and open a fresh one from main that reflects the JSON approach for a cleaner review. :D

feat: implement toString() for data classes

dbc9838

Harry-Chen requested a review from Copilot August 16, 2025 08:35

Copilot AI reviewed Aug 16, 2025

View reviewed changes

fix: add missing commas in toString() method outputs for multiple cla…

6b115cc

…sses

inuEbisu closed this Aug 31, 2025

	buffer.writeln(' sharedSecret: ${hex.encode(sharedSecret)}');
	buffer.writeln(' sharedSecret: ${hex.encode(sharedSecret)},');

	buffer.writeln(' displayName: $displayName');
	buffer.writeln(' displayName: $displayName,');

	' maxPossibleRemainingResidentCredentialsCount: $maxPossibleRemainingResidentCredentialsCount');
	' maxPossibleRemainingResidentCredentialsCount: $maxPossibleRemainingResidentCredentialsCount,');

	buffer.writeln(' name: ${status.name}');
	buffer.writeln(' name: ${status.name},');

	buffer.writeln(' params: ${Map<int, dynamic>.from(this)}');
	buffer.writeln(' params: ${Map<int, dynamic>.from(this)},');

	buffer.writeln(' y: ${y != null ? hex.encode(y) : null}');
	buffer.writeln(' y: ${y != null ? hex.encode(y) : null},');

feat: implement toString() for data classes #4

feat: implement toString() for data classes #4

Uh oh!

Conversation

inuEbisu commented Aug 15, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 16, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 16, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 16, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 16, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 16, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 16, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 16, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 16, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 16, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 16, 2025

Choose a reason for hiding this comment

Uh oh!

Harry-Chen commented Aug 16, 2025

Uh oh!

dangfan commented Aug 16, 2025

Uh oh!

inuEbisu commented Aug 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants