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.

Sign up for GitHub

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 JSON serialization of storage format string #47

Merged
merged 3 commits into from
Jun 18, 2021
Merged

Fix JSON serialization of storage format string #47

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5d95dab
Use more explicit serialization/deserialization for storage format st…
sebastianburckhardt Jun 1, 2021
08437db
include settings for deserialization also.
sebastianburckhardt Jun 1, 2021
be92112
Merge branch 'main' into pr/storage-format-serialization-bug
sebastianburckhardt Jun 14, 2021
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
42 changes: 34 additions & 8 deletions src/DurableTask.Netherite/StorageProviders/Faster/AzureBlobs/BlobManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,37 +101,63 @@ partial class BlobManager : ICheckpointManager, ILogCommitManager
(numPartitions <= 16) ? 21 : // 2MB
20, // 1MB
};


// increment this after changes of the storage representation that break compatibility
const int StorageFormatVersion = 1;

public static string GetStorageFormat(NetheriteOrchestrationServiceSettings settings)
{
return JsonConvert.SerializeObject(new
return JsonConvert.SerializeObject(new StorageFormatSettings()
{
UseAlternateObjectStore = settings.UseAlternateObjectStore,
UsePSFQueries = settings.UsePSFQueries,
FormatVersion = StorageFormatVersion,
},
Formatting.None);
serializerSettings);
}

[JsonObject]
class StorageFormatSettings
{
// this must stay the same
[JsonProperty("FormatVersion")]
public int FormatVersion { get; set; }

// the following can be changed between versions

[JsonProperty("UseAlternateObjectStore", DefaultValueHandling=DefaultValueHandling.Ignore)]
public bool? UseAlternateObjectStore { get; set; }

[JsonProperty("UsePSFQueries", DefaultValueHandling = DefaultValueHandling.Ignore)]
public bool? UsePSFQueries { get; set; }
}

static readonly JsonSerializerSettings serializerSettings = new JsonSerializerSettings()
{
TypeNameHandling = TypeNameHandling.None,
MissingMemberHandling = MissingMemberHandling.Ignore,
CheckAdditionalContent = false,
Formatting = Formatting.None,
};


public static void CheckStorageFormat(string format, NetheriteOrchestrationServiceSettings settings)
{
try
{
JObject json = JsonConvert.DeserializeObject<JObject>(format);
var taskhubFormat = JsonConvert.DeserializeObject<StorageFormatSettings>(format, serializerSettings);

if ((bool)json["UseAlternateObjectStore"] != settings.UseAlternateObjectStore)
if (taskhubFormat.UseAlternateObjectStore != settings.UseAlternateObjectStore)
{
throw new InvalidOperationException("The Netherite configuration setting 'UseAlternateObjectStore' is incompatible with the existing taskhub.");
}
if ((bool)json["UsePSFQueries"] != settings.UsePSFQueries)
if (taskhubFormat.UsePSFQueries != settings.UsePSFQueries)
{
throw new InvalidOperationException("The Netherite configuration setting 'UsePSFQueries' is incompatible with the existing taskhub.");
}
if ((int)json["FormatVersion"] != StorageFormatVersion)
if (taskhubFormat.FormatVersion != StorageFormatVersion)
{
throw new InvalidOperationException("The current storage format version is incompatible with the existing taskhub.");
throw new InvalidOperationException($"The current storage format version (={StorageFormatVersion}) is incompatible with the existing taskhub (={taskhubFormat.FormatVersion}).");
}
}
catch(Exception e)
Expand Down