[Feature Enhancement]: Add a URL-returning overload of `getBlob(from:cid:)`

Đang mở
  • Có gì không ổn?
#337 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
52/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
swift
Lĩnh vực
api, backend-api-design

Hướng nghiên cứu

Start by reading the existing getBlob(from:cid:) implementation and the account PDS endpoint resolution discussed in issue #319. Add a synchronous overload that builds a URL using the resolved PDS endpoint and the supplied DID and CID; done means callers can obtain a URL without downloading the blob as Data. The issue names no relevant test file, so locate tests for getBlob and endpoint resolution before making the change.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement
Summary

getBlob(from:cid:) currently returns Data via an async throws call, which is appropriate for saving or exporting a blob. However, display-oriented APIs such as SwiftUI's AsyncImage and AVPlayer require a URL, not Data. A synchronous URL-building overload with the same name would cover this use case without an additional download.

Pain points

Callers that only need a URL for playback or image loading are forced to either:

  • Download the full blob as Data and convert it to UIImage/NSImage — wasting memory and blocking the async task before display can begin, or
  • Construct the URL manually from the PDS endpoint string, bypassing the typed API.

Concrete cases where a URL is required by the consuming API:

  • SwiftUI AsyncImage(url:) — displays a blob image (thumbnail, avatar stored as blob, etc.) with built-in lazy loading and caching. Accepts URL, not Data.
  • AVPlayer(url:) — streams a video blob for playback. AVPlayer must be initialised with a URL; passing Data is not supported.
Considered Alternatives

Keeping a raw helper that builds the URL from a PDS endpoint string — this works but lives outside the typed API and requires the caller to manage the endpoint separately.

Is this a breaking change?

No

Additional Context

The com.atproto.sync.getBlob lexicon specifies "output": { "encoding": "*/*" } and notes it is implemented by PDS. The URL-returning overload should therefore resolve the account's PDS endpoint rather than hardcoding a relay (see #319).

The new synchronous overload can construct the correct URL from the resolved PDS endpoint and the provided DID/CID query parameters.
Proposed addition:

public func getBlob(from accountDID: String, cid: String) -> URL?

Swift disambiguates the two overloads at the call site: the existing async throws form is chosen when the caller writes try await, and the new synchronous form is chosen when a URL? is expected without await.

Ngôn ngữ chính
Swift
Star
226
Fork
40
Merge trung bình
5 giờ 8 phút
Pull request đã merge (30 ngày)
3

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của MasterJ93/ATProtoKit

Tất cả issue của MasterJ93/ATProtoKit

Issue tương tự

Thêm issue về Swift

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.