Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix BlobRef creation for JSON representation #340

Merged
merged 2 commits into from
Jun 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/atproto_client/models/blob_ref.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
class IpldLink(BaseModel):
"""CID representation in JSON."""

model_config = ConfigDict(extra='allow', populate_by_name=True, strict=True)

link: str = Field(alias='$link') #: CID.


Expand Down
73 changes: 71 additions & 2 deletions tests/test_atproto_client/models/tests/test_blob_ref.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from atproto_client.models import get_or_create
from atproto_client.models.blob_ref import BlobRef
from atproto_client.models import get_model_as_dict, get_or_create
from atproto_client.models.blob_ref import BlobRef, IpldLink
from atproto_core.cid import CID


Expand All @@ -19,6 +19,7 @@ def test_blob_ref_from_ipld() -> None:

def test_blob_ref_from_ipld_json() -> None:
plain_cid = 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a'

plain_blob_ref = {
'mimeType': 'text/plain',
'size': 0,
Expand All @@ -29,3 +30,71 @@ def test_blob_ref_from_ipld_json() -> None:

assert isinstance(instance, BlobRef)
assert instance.cid == CID.decode(plain_cid)
assert isinstance(instance.ref, IpldLink)
assert not isinstance(instance.ref, str)

plain_blob_ref2 = get_model_as_dict(instance)
assert plain_blob_ref2 == plain_blob_ref

instance2 = get_or_create(plain_blob_ref2, BlobRef)
assert instance2.cid == CID.decode(plain_cid)
assert isinstance(instance2.ref, IpldLink)
assert not isinstance(instance2.ref, str)

assert instance2 == instance
assert instance2.cid == instance.cid
assert instance2.ref.link == instance.ref.link


def test_blob_ref_to_ipld() -> None:
plain_cid = 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a'
blob_ref = BlobRef(
mime_type='text/plain',
size=0,
ref=plain_cid,
)
assert plain_cid == blob_ref.ref
assert not isinstance(blob_ref.ref, IpldLink)
assert isinstance(blob_ref.ref, str)

# round trip
blob_ref2 = get_or_create(get_model_as_dict(blob_ref), BlobRef)
assert plain_cid == blob_ref2.ref
assert not isinstance(blob_ref2.ref, IpldLink)
assert isinstance(blob_ref2.ref, str)

assert blob_ref2 == blob_ref
assert blob_ref2.ref == blob_ref.ref

# verify RAW ref representation
blob_ref2_raw = get_model_as_dict(blob_ref)
assert isinstance(blob_ref2_raw['ref'], str)
assert plain_cid == blob_ref2_raw['ref']


def test_blob_ref_to_ipld_json() -> None:
plain_cid = 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a'

blob_ref = BlobRef(
mime_type='text/plain',
size=0,
ref=IpldLink(link=plain_cid),
)
assert plain_cid == blob_ref.ref.link
assert isinstance(blob_ref.ref, IpldLink)
assert not isinstance(blob_ref.ref, str)

# round trip
blob_ref2 = get_or_create(get_model_as_dict(blob_ref), BlobRef)
assert plain_cid == blob_ref2.ref.link
assert isinstance(blob_ref2.ref, IpldLink)
assert not isinstance(blob_ref2.ref, str)

assert blob_ref2 == blob_ref
assert blob_ref2.ref == blob_ref.ref
assert blob_ref2.ref.link == blob_ref.ref.link

# verify JSON ref representation
blob_ref2_raw = get_model_as_dict(blob_ref)
assert '$link' in blob_ref2_raw['ref']
assert plain_cid == blob_ref2_raw['ref']['$link']
Loading