swh-graph 11.4.1

Compressed in-memory representation of the Software Heritage archive graph
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

// Copyright (C) 2024-2025  The Software Heritage developers
// See the AUTHORS file at the top-level directory of this distribution
// License: GNU General Public License version 3, or any later version
// See top-level LICENSE file for more information

//! Serialization and deserialization of (small) graphs using [`serde`]

use std::path::PathBuf;

use serde::de::*;
use serde::ser::*;
use serde::*;
use webgraph::graphs::vec_graph::LabeledVecGraph;

use crate::graph::*;
use crate::properties;
use crate::{SwhGraphProperties, SWHID};

#[derive(Serialize, Deserialize)]
struct SerializedGraph<Contents, LabelNames, Persons, Strings, Timestamps> {
    swhids: Vec<SWHID>,
    contents: Contents,
    label_names: LabelNames,
    persons: Persons,
    strings: Strings,
    timestamps: Timestamps,
    /// `node_id -> (node_id, vec![label])`
    arcs: Vec<Vec<(usize, Vec<u64>)>>,
}

/// Serializes a (small) graph using [`serde`] instead of the normal serialization
pub fn serialize_with_labels_and_maps<
    S: Serializer,
    G: SwhLabeledForwardGraph + SwhGraphWithProperties,
>(
    serializer: S,
    graph: &G,
) -> Result<S::Ok, S::Error>
where
    <G as SwhGraphWithProperties>::Maps: properties::Maps,
    <G as SwhGraphWithProperties>::Contents: serde::Serialize,
    <G as SwhGraphWithProperties>::LabelNames: serde::Serialize,
    <G as SwhGraphWithProperties>::Persons: serde::Serialize,
    <G as SwhGraphWithProperties>::Strings: serde::Serialize,
    <G as SwhGraphWithProperties>::Timestamps: serde::Serialize,
{
    SerializedGraph {
        swhids: (0..graph.num_nodes())
            .map(|node| graph.properties().swhid(node))
            .collect(),
        contents: &graph.properties().contents,
        label_names: &graph.properties().label_names,
        persons: &graph.properties().persons,
        strings: &graph.properties().strings,
        timestamps: &graph.properties().timestamps,
        arcs: (0..graph.num_nodes())
            .map(|node| {
                graph
                    .untyped_labeled_successors(node)
                    .into_iter()
                    .map(|(succ, labels)| (succ, labels.into_iter().map(|label| label.0).collect()))
                    .collect()
            })
            .collect(),
    }
    .serialize(serializer)
}

#[allow(clippy::type_complexity)]
/// Deserializes a (small) graph using [`serde`] instead of the normal deserialization, and
/// returns a fully in-memory graph, as if built by
/// [`GraphBuilder`](crate::graph_builder::GraphBuilder)
///
/// The `path` is not read, but is used to set the return value of [`SwhBidirectionalGraph::path`].
pub fn deserialize_with_labels_and_maps<
    'de,
    D: Deserializer<'de>,
    TIMESTAMPS: properties::MaybeTimestamps + Deserialize<'de>,
    PERSONS: properties::MaybePersons + Deserialize<'de>,
    CONTENTS: properties::MaybeContents + Deserialize<'de>,
    STRINGS: properties::MaybeStrings + Deserialize<'de>,
    LABELNAMES: properties::MaybeLabelNames + Deserialize<'de>,
>(
    deserializer: D,
    path: PathBuf,
) -> Result<
    SwhBidirectionalGraph<
        SwhGraphProperties<properties::VecMaps, TIMESTAMPS, PERSONS, CONTENTS, STRINGS, LABELNAMES>,
        LabeledVecGraph<Vec<u64>>,
        LabeledVecGraph<Vec<u64>>,
    >,
    /* XXX: I'd like to return this instead:
    SwhBidirectionalGraph<
        SwhGraphProperties<
            impl properties::Maps + Send + Sync + 'static,
            TIMESTAMPS,
            PERSONS,
            CONTENTS,
            STRINGS,
            LABELNAMES,
        >,
        impl UnderlyingGraph + Send + Sync + 'static,
        impl UnderlyingGraph + Send + Sync + 'static,
    >,
    but it makes this function pretty hard to use, as return-position impls capture D's lifetime
    despite + 'static. See https://github.com/rust-lang/rust/issues/132364
    */
    D::Error,
> {
    let graph: SerializedGraph<_, _, _, _, _> = SerializedGraph::deserialize(deserializer)?;
    let forward_arcs: Vec<((NodeId, NodeId), Vec<u64>)> = graph
        .arcs
        .iter()
        .enumerate()
        .flat_map(|(src, arcs)| {
            arcs.iter()
                .map(move |(dst, labels)| ((src, *dst), labels.clone()))
        })
        .collect();
    let backward_arcs: Vec<((NodeId, NodeId), Vec<u64>)> = graph
        .arcs
        .iter()
        .enumerate()
        .flat_map(|(src, arcs)| {
            arcs.iter()
                .map(move |(dst, labels)| ((*dst, src), labels.clone()))
        })
        .collect();
    Ok(SwhBidirectionalGraph::from_underlying_graphs(
        path,
        LabeledVecGraph::from_arcs(forward_arcs),
        LabeledVecGraph::from_arcs(backward_arcs),
    )
    .init_properties()
    .load_properties(move |properties| {
        Ok(properties
            .with_maps(properties::VecMaps::new(graph.swhids))
            .expect("Could not join maps")
            .with_contents(graph.contents)
            .expect("Could not join VecContents")
            .with_label_names(graph.label_names)
            .expect("Could not join maps")
            .with_persons(graph.persons)
            .expect("Could not join persons")
            .with_strings(graph.strings)
            .expect("Could not join strings")
            .with_timestamps(graph.timestamps)
            .expect("Could not join timestamps"))
    })
    .expect("Could not load properties"))
}