Skip to content

fix: make collection document node order deterministic #113

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

Open
ehennestad wants to merge 1 commit into from
Open

fix: make collection document node order deterministic #113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 27 additions & 1 deletion code/internal/+openminds/+internal/+serializer/JsonLdSerializer.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@
if obj.SerializationConfiguration.PropertyNameSyntax == "compact"
document = obj.addVocabularyMapping(document);
end
document.at_graph = documentList;
document.at_graph = obj.sortDocumentsByIdentifier(documentList);
end

function S = normalizeEmptyProperties(obj, S)
Expand All @@ -263,6 +263,32 @@
end

methods (Static, Access = private)
function documentList = sortDocumentsByIdentifier(documentList)
% sortDocumentsByIdentifier - Order the nodes of a collection document
%
% The nodes otherwise appear in whatever order the collection
% returns them, which depends on the container backing the
% collection and therefore on the MATLAB release: dictionary
% preserves insertion order, while containers.Map returns values
% sorted by key. A @graph is an unordered set, so an explicit
% order is imposed to make the document identical on every
% release.
%
% This applies only to the collection document. Documents
% emitted separately are not reordered, because stores pair them
% with their instances by position.

identifiers = strings(1, numel(documentList));
for i = 1:numel(documentList)
if isfield(documentList{i}, 'at_id')
identifiers(i) = documentList{i}.at_id;
end
end

[~, sortOrder] = sort(identifiers);
documentList = documentList(sortOrder);
end

function allStructs = sortKeys(allStructs)
% sortKeys - Sorts the keys of the given structs based on a predefined order.
%
Expand Down
Loading