Fixed code factor quality issues

[pingu2k4]

Changes

• Fixed code factor quality issues

Issue

• Resolves [Task] Fix code quality issues from code factor #546

Categorise the PR

• feature
• bug
• docs
• security
• meta
• patch
• minor
• major

Description by Korbit AI

What change is being made?

Refactor JSON converters to improve code clarity, encapsulation, and quality, and update corresponding tests.

Why are these changes being made?

The changes are made to resolve code quality issues identified by CodeFactor, focusing on enhancing readability and maintainability by introducing helper methods to break down complex logic into smaller, easier-to-understand components. This refactor also aims to encapsulate related functionalities and ensure concise error handling. Tests have been updated to reflect these changes to maintain integrity and verification of behaviors.

Is this description stale? Ask me to generate a new description by commenting /korbit-generate-pr-description

[github-actions]

Package	Line Rate	Branch Rate	Complexity	Health
PinguApps.Appwrite.Client	100%	100%	136	✔
PinguApps.Appwrite.Server	100%	100%	150	✔
PinguApps.Appwrite.Shared	100%	100%	1328	✔
Summary	100% (3652 / 3653)	100% (647 / 649)	1614	✔

[github-actions]

Test Results

3 650 tests   - 2   3 650 ✅  - 2   26s ⏱️ -1s
    3 suites ±0       0 💤 ±0 
    3 files   ±0       0 ❌ ±0 

Results for commit 5c5a167. ± Comparison against base commit 9301dbe.

This pull request removes 342 and adds 340 tests. Note that renamed tests count towards both.

PinguApps.Appwrite.Server.Tests.Clients.Users.UsersClientTests ‑ CreateUserJwt_ShouldReturnSuccess_WhenApiCallSucceeds(request: CreateUserJwtRequest { Duration = 1800, SessionId = "6758be8e0023e3172d4a", UserId = "6758be8e0023e58fb1bf", ValidationContext = None })
PinguApps.Appwrite.Server.Tests.Clients.Users.UsersClientTests ‑ CreateUserJwt_ShouldReturnSuccess_WhenApiCallSucceeds(request: CreateUserJwtRequest { Duration = null, SessionId = null, UserId = "6758be8e0023d3662ff7", ValidationContext = None })
PinguApps.Appwrite.Server.Tests.Clients.Users.UsersClientTests ‑ ListUserLogs_ShouldReturnSuccess_WhenApiCallSucceeds(request: ListUserLogsRequest { Queries = null, UserId = "6758be8e0023f3f18b28", ValidationContext = None })
PinguApps.Appwrite.Server.Tests.Clients.Users.UsersClientTests ‑ ListUserLogs_ShouldReturnSuccess_WhenApiCallSucceeds(request: ListUserLogsRequest { Queries = null, UserId = "6758be8e0023f9e66898", ValidationContext = None })
PinguApps.Appwrite.Server.Tests.Clients.Users.UsersClientTests ‑ ListUserTargets_ShouldReturnSuccess_WhenApiCallSucceeds(request: ListUserTargetsRequest { Queries = null, UserId = "6758be8e0023f17f87dc", ValidationContext = None })
PinguApps.Appwrite.Server.Tests.Clients.Users.UsersClientTests ‑ ListUserTargets_ShouldReturnSuccess_WhenApiCallSucceeds(request: ListUserTargetsRequest { Queries = null, UserId = "6758be8e0023f698443d", ValidationContext = None })
PinguApps.Appwrite.Server.Tests.Clients.Users.UsersClientTests ‑ UpdateUserLabels_ShouldReturnSuccess_WhenApiCallSucceeds(request: UpdateUserLabelsRequest { Labels = ["label1", "label2"], UserId = "6758be8e0023fa6ebd41", ValidationContext = None })
PinguApps.Appwrite.Server.Tests.Clients.Users.UsersClientTests ‑ UpdateUserLabels_ShouldReturnSuccess_WhenApiCallSucceeds(request: UpdateUserLabelsRequest { Labels = ["label3", "label4"], UserId = "6758be8e0023f9052e00", ValidationContext = None })
PinguApps.Appwrite.Shared.Tests.Converters.DocumentGenericConverterTests ‑ Read_MissingCreatedAt_ThrowsJsonException
PinguApps.Appwrite.Shared.Tests.Converters.DocumentGenericConverterTests ‑ Read_MissingUpdatedAt_ThrowsJsonException
…

PinguApps.Appwrite.Server.Tests.Clients.Users.UsersClientTests ‑ CreateUserJwt_ShouldReturnSuccess_WhenApiCallSucceeds(request: CreateUserJwtRequest { Duration = 1800, SessionId = "6758e31d00312117dd5f", UserId = "6758e31d00312ac1322b", ValidationContext = None })
PinguApps.Appwrite.Server.Tests.Clients.Users.UsersClientTests ‑ CreateUserJwt_ShouldReturnSuccess_WhenApiCallSucceeds(request: CreateUserJwtRequest { Duration = null, SessionId = null, UserId = "6758e31d0031177457d7", ValidationContext = None })
PinguApps.Appwrite.Server.Tests.Clients.Users.UsersClientTests ‑ ListUserLogs_ShouldReturnSuccess_WhenApiCallSucceeds(request: ListUserLogsRequest { Queries = null, UserId = "6758e31d0031213a5380", ValidationContext = None })
PinguApps.Appwrite.Server.Tests.Clients.Users.UsersClientTests ‑ ListUserLogs_ShouldReturnSuccess_WhenApiCallSucceeds(request: ListUserLogsRequest { Queries = null, UserId = "6758e31d00312aba99a0", ValidationContext = None })
PinguApps.Appwrite.Server.Tests.Clients.Users.UsersClientTests ‑ ListUserTargets_ShouldReturnSuccess_WhenApiCallSucceeds(request: ListUserTargetsRequest { Queries = null, UserId = "6758e31d00312005dc79", ValidationContext = None })
PinguApps.Appwrite.Server.Tests.Clients.Users.UsersClientTests ‑ ListUserTargets_ShouldReturnSuccess_WhenApiCallSucceeds(request: ListUserTargetsRequest { Queries = null, UserId = "6758e31d003127946663", ValidationContext = None })
PinguApps.Appwrite.Server.Tests.Clients.Users.UsersClientTests ‑ UpdateUserLabels_ShouldReturnSuccess_WhenApiCallSucceeds(request: UpdateUserLabelsRequest { Labels = ["label1", "label2"], UserId = "6758e31d003139395890", ValidationContext = None })
PinguApps.Appwrite.Server.Tests.Clients.Users.UsersClientTests ‑ UpdateUserLabels_ShouldReturnSuccess_WhenApiCallSucceeds(request: UpdateUserLabelsRequest { Labels = ["label3", "label4"], UserId = "6758e31d00313e78cb7c", ValidationContext = None })
PinguApps.Appwrite.Shared.Tests.Requests.Account.CreatePushTargetRequestTests ‑ IsValid_WithInvalidData_ReturnsFalse(request: CreatePushTargetRequest { Identifier = "", ProviderId = "provider123", TargetId = "6758e316000966fa8844", ValidationContext = None })
PinguApps.Appwrite.Shared.Tests.Requests.Account.CreatePushTargetRequestTests ‑ IsValid_WithInvalidData_ReturnsFalse(request: CreatePushTargetRequest { Identifier = null, ProviderId = "provider123", TargetId = "6758e316000964fa08e0", ValidationContext = None })
…

[korbit-ai]

Review Summary by Korbit AI

Code Health Comments

• Enhance ValidateRequiredFields to log missing fields before exceptions for improved debugging clarity.

Suppressed issues based on your team's Korbit activity

​

This issue	Is similar to	Because
lines 40:43: Consider logging the error before throwing the JsonException. This will help in troubleshooting and provide more context about where the error occurred. You could use a logging framework or a simple Console.WriteLine() for this purpose.	Log exceptions before returning an exception response.	Similar issues were not addressed in the past
line 93: It would be beneficial to log the unknown role format before throwing the exception. This can provide valuable information for troubleshooting and improving the system's robustness.	Log exceptions before returning an exception response.	Similar issues were not addressed in the past
line 38: It's a good practice to log the exception before throwing it. This can provide valuable context for debugging. Consider adding a log statement to capture the invalid input value along with the exception message.	Log exceptions before returning an exception response.	Similar issues were not addressed in the past

When you react to issues (for example, an upvote or downvote) or you fix them, Korbit will tune future reviews based on these signals.

Files scanned

​

File Path	Reviewed
src/PinguApps.Appwrite.Shared/Converters/AttributeJsonConverter.cs	✅
src/PinguApps.Appwrite.Shared/Converters/PermissionJsonConverter.cs	✅
src/PinguApps.Appwrite.Shared/Converters/DocumentGenericConverter.cs	✅

Explore our documentation to understand the languages and file types we support and the files we ignore.

Need a new review? Comment /korbit-review on this PR and I'll review your latest changes.

Korbit Guide: Usage and Customization

Interacting with Korbit

• You can manually ask Korbit to review your PR using the /korbit-review command in a comment at the root of your PR.
• You can ask Korbit to generate a new PR description using the /korbit-generate-pr-description command in any comment on your PR.
• Too many Korbit comments? I can resolve all my comment threads if you use the /korbit-resolve command in any comment on your PR.
• Chat with Korbit on issues we post by tagging @korbit-ai in your reply.
• Help train Korbit to improve your reviews by giving a 👍 or 👎 on the comments Korbit posts.

Customizing Korbit

• Check out our docs on how you can make Korbit work best for you and your team.
• Customize Korbit for your organization through the Korbit Console.

Current Korbit Configuration

General Settings

​

Setting	Value
Review Schedule	Automatic excluding drafts
Max Issue Count	10
Automatic PR Descriptions	✅

Issue Categories

​

Category	Enabled
Naming	✅
Database Operations	✅
Documentation	✅
Logging	✅
Error Handling	✅
Systems and Environment	✅
Objects and Data Structures	✅
Readability and Maintainability	✅
Asynchronous Processing	✅
Design Patterns	✅
Third-Party Libraries	✅
Performance	✅
Security	✅
Functionality	✅

Feedback and Support

• Tell us what you think of Korbit
• Schedule a call with our team
• Email us @ [email protected]