janivihervas/contentful-go

Simple Contentful SDK for Go for fetching data

contentful-go's Issues

OpenCensus support: tracing

Create traces using trace.StartSpan

Add cache capability

It would be used in search function: https://github.com/janivihervas/contentful-go/blob/master/search.go#L128

Interface could look something like this:

type CacheEntry struct {
	URL string
	JSON []byte
	ETag string
}

type Cache interface {
	Get(ctx context.Context, url string) (CacheEntry, error)
	Save(ctx context.Context, entry CacheEntry) error
}

Request handling:
If an entry is in cache, supply the etag in If-None-Match header

Response handling:
If cache implementation is not supplied to constructor, response with non-200 status code would still fail. If cache is supplied, 200 status code would Save the result and 304 status code would serve it from cache.

Requires a new extensible constructor function to prevent breaking changes.

Requires a cache pruning functionality, as Contentful web hooks only specify the entry id that was modified, and cache keys will in most cases be search queries instead of searching by id

Add documentation and examples for using context for retries

Respond to cancelling a context before the timeout

Use select in here to allow the context to be manually cancelled

Document external urls

Document the external urls that the SDK will use, so they can be allowed explicitly in strict environments like Istio

Document OpenCensus usage

Allow to supply a custom http.Client

Implementation is using http.DefaultClient. Implement a functionality to provide a custom http.Client to provide e.g. OpenCensus capability.

In order to keep backwards-compatibility, either export the client field or set it with a method like

cms := contentful.New(...)
cms.WithHttpClient(&http.Client{...})

Pagination

Fetch the next pages -if any- and put them in the same response.

Contentful Delivery API docs: https://www.contentful.com/developers/docs/references/content-delivery-api/#/introduction/collection-resources-and-pagination

Write tests for OpenCensus tracing

OpenCensus support: metrics

Investigate if there is a need for custom metrics and if so, implement and export default view.Views and stats

Write tests for cancelling context

• Contentful takes long time to respond
• Cancelled while waiting for rate limit resetting