Implementing RPDE
Always use a JSON library to generate the output, and never construct the JSON manually.
Language-specific examples of library implementations that also support the removal of nulls, empty strings and empty arrays - as the specification stipulates - are included here.
Several libraries are available that make it really easy to create open opportunity data feeds.
The table below lists the available OpenActive libraries:
Language | Open Opportunity Data Feeds | Dataset Site |
.NET | ||
PHP | ||
Ruby | ||
JavaScript / TypeScript |
When concurrent transactions are used to write to tables that power RPDE feeds, the timestamp and change number update must be done outside of the transaction, with high accuracy timestamp, and a "visible" timestamp column added.
Delayed item interleaving is a race condition that occurs when two concurrent transactions containing "timestamps" or "change numbers" are committed out of order. For example using the Modified Timestamp and ID ordering strategy:
- Transaction 1: Starts at 10:00:01 and updates RPDE item timestamps
- Transaction 2: Starts at 10:00:02 and updates RPDE item timestamps
- Transaction 2: Commits
- Data consumer reads the feed at 10:00:03, and gets the latest items up to 10:00:02
- Transaction 1: Commits
- Items from Transaction 1 appear in the feed with timestamp 10:00:01, but the data consumer has already moved past them
- Transaction 1: Creates change number 001 and updates RPDE item timestamp
- Transaction 2: Creates change number 002 and updates RPDE item timestamp
- Transaction 2: Commits
- Data consumer reads the feed up to 002
- Transaction 1: Commits
- Item from Transaction 1 appears in the feed with change number 001, but the data consumer has already moved past it
In order to prevent this race condition, one solution is to simply separate the more intensive work of the transaction from the atomic timestamp and change number update, filter out recent changes in the feed, and ensure you are using accurate timestamps:
- 1.First commit the transaction, then update the timestamps or change numbers after the transaction has been committed as an atomic operation, outside of a transaction, using
GETDATE()or similar - 2.Ensure the RPDE endpoint filters out all items with a "modified" date after 2 seconds in the past, to delay items appearing in the feed
- 3.If using the Modified Timestamp and ID ordering strategy, use a timestamp column with a high degree of accuracy (e.g.
datetime2in SQL Server).
Updating items in the feed without updating their timestamp/change number immediately does not have any negative effects, as data consumers who are reading the feed will read the updated item earlier than they would otherwise instead of an older version, then read it again after the timestamp/change number is updated as they would normally.
Using the RPDE endpoint filter to delay items appearing is a belt-and-braces measure that ensures that small variances between timestamp and change number update order are accounted for under high database load, by only presenting data to the data consumer after a small delay, when all timestamp/change number updates have commited.
We highly recommend using the OpenActive.NET library for .NET implementations. It includes strongly typed classes for the OpenActive data model including beta properties, and fully compliant serialisation methods too.
Use JSON.NET / Newtonsoft.Json with a
ContractResolver to remove empty strings, and NullValueHandling to remove nulls. Empty list values must be removed by setting them to null in the generating code, aided by the extension ToListOrNullIfEmpty which is useful at the end of LINQ expressions.public class RPDERestUtils
{
public static HttpResponseMessage CreateJSONResponse(RpdePage page, HttpRequestMessage req)
{
var e = JsonConvert.SerializeObject(page,
Newtonsoft.Json.Formatting.None,
new JsonSerializerSettings
{
NullValueHandling = NullValueHandling.Ignore,
ContractResolver = NoEmptyStringsContractResolver.Instance
});
var resp = req.CreateResponse(HttpStatusCode.OK);
resp.Headers.CacheControl = new CacheControlHeaderValue()
{
Public = true,
// Recommended cache settings from:
// https://developer.openactive.io/publishing-data/data-feeds/scaling-feeds
MaxAge = page?.items?.Count > 0 ? TimeSpan.FromHours(1) : TimeSpan.FromSeconds(8)
};
resp.Content = new StringContent(e, Encoding.UTF8, "application/json");
return resp;
}
public class NoEmptyStringsContractResolver : DefaultContractResolver
{
public static readonly NoEmptyStringsContractResolver Instance = new NoEmptyStringsContractResolver();
protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
{
JsonProperty property = base.CreateProperty(member, memberSerialization);
if (property.PropertyType == typeof(string))
{
// Do not include empty strings in JSON output (as per OpenActive Modelling Specification)
property.ShouldSerialize = instance =>
{
return !string.IsNullOrWhiteSpace(instance.GetType().GetRuntimeProperty(member.Name).GetValue(instance, null) as string);
};
}
return property;
}
}
public static List<TSource> ToListOrNullIfEmpty<TSource>(this IEnumerable<TSource> source)
{
if (source != null && source.Count() > 0)
return source.ToList();
else
return null;
}
}
We highly recommend using the OpenActive PHP Models Library for PHP implementations. It includes strongly typed classes for the OpenActive data model including beta properties, and fully compliant serialisation methods too.
The specification requires that no null or empty strings are present in the OpenActive feed. To achieve this, define the RPDE response structure as nested arrays, and recursively unset empty properties before using json_encode to generate the response.
<?php
$testResponseStructure = [
"@context" => "https://openactive.io/",
"@id" => "https://example.com/api/sessions/1402CBP20150217",
"identifier" => "1402CBP20150217",
"@type" => "SessionSeries",
"organizer" => [
"@type" => "Organization",
"name" => "Everyone Active",
"url" => null,
"logo" => [
"type" => "ImageObject",
"url" => "",
],
"email" => null,
"telephone" => "01455 890508",
"sameAs" => [
null,
""
],
],
];
echo json_encode_without_null_or_empty($testResponseStructure);
function json_encode_without_null_or_empty($nestedarr) {
$nestedarr = array_filter_recursive($nestedarr);
return json_encode($nestedarr, JSON_PRETTY_PRINT);
}
function array_filter_recursive($array) {
$clean = [];
foreach ($array as $key => $value) {
// First clean the array, in case it ends up empty
if (is_array($value)) {
$value = array_filter_recursive($value);
// Remove arrays containing only a "type" property
if (count($value) === 1 && isset($value["type"])) {
continue;
}
}
// ignore null values, empty strings, and empty lists
if ($value === null || $value === "" || $value === []) {
continue;
}
$clean[$key] = $value;
}
return $clean;
}
Last modified 8mo ago