Earl.Crawler.Persistence 0.0.0-alpha.0.111

Earl Persistence Layer

The "Earl Persistence Layer" refers to a suite of APIs that enable the results of a crawl to be persisted to a backing storage mechanism.

Out-of-the-box, and by design, Earl does not collect the results of a crawl. Rather, Earl provides an Events API that leaves it up to the consumer of the IEarlCrawler contract to handle the CrawlUrlResultEvent in order to consume CrawlUrlResults.

At the lowest level of the Crawler API, this is done by specifying an ICrawlerEvents implementation for the CrawlerOptions.Events provided to the IEarlCrawler. However, more commonly used, is likely the On<TEvent>(this ICrawlerOptionsBuilder builder, CrawlerEventHandler<TEvent> handler) extension method:

var options = CrawlerOptionsBuilder.CreateDefault()
    .On<CrawlUrlResultEvent>(
        async ( CrawlUrlResultEvent e, CancellationToken cancellation ) =>
        {
            // handle the event...
        }
    )
    .Build();

await crawler.CrawlAsync( new Uri(...), options );

The Earl Persistence Layer provides an API around such an event handler in order to ease with saving the results of a crawl. The entry point of the Persistence API is the PersistTo(this ICrawlerOptionsBuilder builder, Action<ICrawlerPersistenceOptionsBuilder> configure) extension method. This extension method exposes an ICrawlerPersistenceOptionsBuilder, which serves as an extension point for persistence implementations to offer a fluent syntax for configuration of the backing storage mechanism.

For example, the JSON Persistence API provides the ToJson(this ICrawlerPersistenceOptionsBuilder builder, Action<ICrawlerJsonPersistenceOptionsBuilder> configure) extension method to configure the persistence of crawl results to JSON files:

var options = CrawlerOptionsBuilder.CreateDefault()
    .PersistTo(
        persist => persist.ToJson( json => json.Destination(...) )
    )
    .Build();

await crawler.CrawlAsync( new Uri(...), options );

Behind the Scenes

The "Persistence Layer" can be described by the following Types, respectively defined in Earl.Crawler.Persistence.Abstractions:

• ICrawlerPersistence - "Describes a service that can persist a CrawlUrlResult."
• ICrawlerPersistenceDescriptor - "Describes a type that describes a crawler persistence mechanism."
• ICrawlerPersistenceFactory - "Describes a service that can create an instance of an ICrawlerPersistence for a given ICrawlerPersistenceDescriptor."
• ICrawlerPersistenceInvoker - "Describes a service that can invoke the ICrawlerPersistence.PersistAsync(CrawlUrlResult, CancellationToken) operation for a given configuration of CrawlerPersistenceOptions."

When the CrawlUrlResultEvent is emitted, the ICrawlerPersistenceInvoker is resolved from the event's service provider and invoked to persist the result. The default invoker, CrawlerPersistenceInvoker, uses the ICrawlerPersistenceFactory to create ICrawlerPersistence instances for each of the CrawlerPersistenceOptions.Descriptors passed to the invoker. The default factory implementation, CrawlerPersistenceFactory, resolves a CrawlerPersistenceFactory<TDescriptor> implementation from the current service provider for the type of ICrawlerPersistenceDescriptor passed to the factory. The typed factory is in turn used to create an instance of ICrawlerPersistence to persist the result.

See PersistTo(this ICrawlerOptionsBuilder builder, Action<ICrawlerPersistenceOptionsBuilder> configure).