Something went wrong. Try again.
A social knowledge tool for research trails, built on ATProto semble.so
research-tool social-network tools-for-thought atproto
Something went wrong. Try again.
TypeScript
at main
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205import { UpdateUrlCardMetadataUseCase } from '../../application/useCases/commands/UpdateUrlCardMetadataUseCase';import { InMemoryCardRepository } from '../utils/InMemoryCardRepository';import { FakeCardPublisher } from '../utils/FakeCardPublisher';import { FakeEventPublisher } from '../utils/FakeEventPublisher';import { CardBuilder } from '../utils/builders/CardBuilder';import { CardTypeEnum } from '../../domain/value-objects/CardType';import { CuratorId } from '../../domain/value-objects/CuratorId';import { URL } from '../../domain/value-objects/URL';import { UrlMetadata } from '../../domain/value-objects/UrlMetadata';import { UrlType } from '../../domain/value-objects/UrlType';import { PublishedRecordId } from '../../domain/value-objects/PublishedRecordId';import { Card } from '../../domain/Card';import { EventNames } from '../../../../shared/infrastructure/events/EventConfig';
describe('UpdateUrlCardMetadataUseCase', () => { let useCase: UpdateUrlCardMetadataUseCase; let cardRepository: InMemoryCardRepository; let cardPublisher: FakeCardPublisher; let eventPublisher: FakeEventPublisher; let curatorId: CuratorId;
const url = URL.create('https://example.com/paper').unwrap();
const enrichedMetadata = UrlMetadata.create({ url: url.value, title: 'Enriched title', description: 'Enriched description', type: UrlType.RESEARCH, }).unwrap();
beforeEach(() => { cardRepository = InMemoryCardRepository.getInstance(); cardPublisher = new FakeCardPublisher(); eventPublisher = new FakeEventPublisher(); useCase = new UpdateUrlCardMetadataUseCase( cardRepository, cardPublisher, eventPublisher, ); curatorId = CuratorId.create('did:plc:testcurator').unwrap(); });
afterEach(() => { cardRepository.clear(); cardPublisher.clear(); eventPublisher.clear(); });
const createSavedUrlCard = async (publishedUri?: string): Promise<Card> => { const initialMetadata = UrlMetadata.create({ url: url.value, title: 'Fast title', type: UrlType.LINK, }).unwrap();
const card = new CardBuilder() .withCuratorId(curatorId.value) .withUrlCard(url, initialMetadata) .build(); if (card instanceof Error) { throw card; }
const addResult = card.addToLibrary(curatorId); if (addResult.isErr()) { throw addResult.error; }
if (publishedUri) { card.markCardInLibraryAsPublished( curatorId, PublishedRecordId.create({ uri: publishedUri, cid: 'original-cid' }), ); }
card.clearEvents(); await cardRepository.save(card); return card; };
it('updates metadata, republishes to the PDS, and publishes the event', async () => { const card = await createSavedUrlCard( `at://${curatorId.value}/network.cosmik.card/rkey123`, );
const result = await useCase.execute({ cardId: card.cardId.getStringValue(), metadata: enrichedMetadata, });
expect(result.isOk()).toBe(true); expect(result.unwrap().republishedToPds).toBe(true);
const savedCard = ( await cardRepository.findById(card.cardId) ).unwrap() as Card; expect(savedCard.content.urlContent?.metadata?.type).toBe(UrlType.RESEARCH); expect(savedCard.content.urlContent?.metadata?.description).toBe( 'Enriched description', );
const events = eventPublisher.getPublishedEventsOfType( EventNames.URL_CARD_METADATA_UPDATED, ); expect(events).toHaveLength(1); });
it('records the new CID on both the card and the creator membership after republishing', async () => { const card = await createSavedUrlCard( `at://${curatorId.value}/network.cosmik.card/rkey123`, );
const result = await useCase.execute({ cardId: card.cardId.getStringValue(), metadata: enrichedMetadata, });
expect(result.isOk()).toBe(true); expect(result.unwrap().republishedToPds).toBe(true);
const savedCard = ( await cardRepository.findById(card.cardId) ).unwrap() as Card; const newCid = `fake-cid-${card.cardId.getStringValue()}`; expect(savedCard.publishedRecordId?.getValue().cid).toBe(newCid); expect( savedCard.getLibraryInfo(curatorId)?.publishedRecordId?.getValue().cid, ).toBe(newCid); });
it('still updates the DB and publishes the event when the PDS republish fails', async () => { const card = await createSavedUrlCard( `at://${curatorId.value}/network.cosmik.card/rkey123`, ); cardPublisher.setShouldFail(true);
const result = await useCase.execute({ cardId: card.cardId.getStringValue(), metadata: enrichedMetadata, });
expect(result.isOk()).toBe(true); expect(result.unwrap().republishedToPds).toBe(false);
const savedCard = ( await cardRepository.findById(card.cardId) ).unwrap() as Card; expect(savedCard.content.urlContent?.metadata?.type).toBe(UrlType.RESEARCH);
const events = eventPublisher.getPublishedEventsOfType( EventNames.URL_CARD_METADATA_UPDATED, ); expect(events).toHaveLength(1); });
it('skips the PDS for cards that were never published', async () => { const card = await createSavedUrlCard();
const result = await useCase.execute({ cardId: card.cardId.getStringValue(), metadata: enrichedMetadata, });
expect(result.isOk()).toBe(true); expect(result.unwrap().republishedToPds).toBe(false); });
it('skips the PDS for firehose-mirrored Margin records', async () => { const card = await createSavedUrlCard( `at://${curatorId.value}/at.margin.bookmark/rkey123`, );
const result = await useCase.execute({ cardId: card.cardId.getStringValue(), metadata: enrichedMetadata, });
expect(result.isOk()).toBe(true); expect(result.unwrap().republishedToPds).toBe(false); // Metadata still updated in the DB const savedCard = ( await cardRepository.findById(card.cardId) ).unwrap() as Card; expect(savedCard.content.urlContent?.metadata?.type).toBe(UrlType.RESEARCH); });
it('rejects non-URL cards', async () => { const noteCard = new CardBuilder() .withCuratorId(curatorId.value) .withType(CardTypeEnum.NOTE) .build(); if (noteCard instanceof Error) { throw noteCard; } await cardRepository.save(noteCard);
const result = await useCase.execute({ cardId: noteCard.cardId.getStringValue(), metadata: enrichedMetadata, });
expect(result.isErr()).toBe(true); });});