[Feature Enhancement]: Complete Logging Implementation

Open
#18 0 comments 0 reactions 0 assignees View on GitHub

@stoicswe is already working on this.

Since May 24, 2024.

  • #9 by @MasterJ93 — merged
  • #21 by @stoicswe — open

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
swift

Research direction

Read the package areas for ATProtoKit, ATProtoTools, and ATProtoAdmin, then inspect the applyWrites() example in the issue as a guide to the requested logging points. Add logging across all three classes, including session and request failures and outcomes; completion means all three checklist items are covered. A linked pull request was merged, so check its changes and the current code before taking this on.

Written by the indexing model from the issue text.

Description

enhancement good first issue
Summary

No response

Pain points

The current implementation of ATProtoKit lacks a centralized logging mechanism, leading to several challenges, namely that debugging is much more difficult to deal with.

To solve this, SwiftLog will be integrated into the package. Furthermore, two logging backend implementations will be used: one that maps to Apple's unified Logger framework (for Apple platforms) and one that maps to the standard SwiftLog logger.

To be more specific, log events for the methods should be added as appropriate. As an example, take a look at applyWrites():

public func applyWrites(_ repositoryDID: String,
                        shouldValidate: Bool? = true,
                        writes: [ApplyWritesUnion],
                        swapCommit: String?) async throws {

    guard session != nil,
          let accessToken = session?.accessToken else {
        throw ATRequestPrepareError.missingActiveSession
    }

    guard let sessionURL = session?.pdsURL,
          let requestURL = URL(string: "\(sessionURL)/xrpc/com.atproto.repo.applyWrites") else {
        throw ATRequestPrepareError.invalidRequestURL
    }

    let requestBody = RepoApplyWrites(
        repositoryDID: repositoryDID,
        shouldValidate: shouldValidate,
        writes: writes,
        swapCommit: swapCommit
    )

    do {
        let request = APIClientService.createRequest(forRequest: requestURL,
                                                     andMethod: .post,
                                                     acceptValue: nil,
                                                     contentTypeValue: "application/json",
                                                     authorizationValue: "Bearer \(accessToken)")

        try await APIClientService.sendRequest(request,
                                               withEncodingBody: requestBody)
    } catch {
        throw error
    }
}

Various places within the method can have log events, including:

  • Within the first guard statement's else block, stating that session or accessToken doesn't have a value.
  • After the guard statement which would show the value of accessToken (albeit, obfuscated).
  • Within the second guard statement's else block, stating that there's an invalid request URL, followed by a String(describing:) of the request URL.
  • After the guard statement, which would show the value of requestURL.
  • After requestBody, which would show the values of requestBody.
  • After request, which would show the value of request.
  • After the try await code, which would say that the request has been successful.
  • Within the catch block, which gives an error log, followed by displaying the error itself.

This issue will focus on implementing log events to the ATProtoKit, ATProtoTools, and ATProtoAdmin classes. Future updates will deal with the remaining parts of the Swift package.

Considered Alternatives

No response

Is this a breaking change?

Yes

Additional Context
  • Implement log events on all parts of the ATProtoKit class.
  • Implement log events on all parts of the ATProtoAdmin class.
  • Implement log events on all parts of the ATProtoTools class.
Dominant language
Swift
Stars
226
Forks
40
Avg merge
2h 56m
Merged PRs (30d)
3

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from MasterJ93/ATProtoKit

All issues in MasterJ93/ATProtoKit

Similar issues

More Swift issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.