martin 1.16.0

Blazing fast and lightweight tile server with PostGIS, MBTiles, and PMTiles support
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
use std::sync::Arc;

use actix_web::error::{ErrorBadRequest, ErrorNotFound};
use dashmap::DashMap;
use martin_core::tiles::catalog::{CatalogSourceEntry, TileCatalog};
use martin_core::tiles::{BoxedSource, Source};
use martin_tile_utils::TileInfo;
use tracing::{debug, info};

use crate::config::file::ResolvedProcess;

/// Maximum number of comma-separated source ids accepted in a single
/// composite tile request (`/{source_ids}/{z}/{x}/{y}`).
const MAX_SOURCE_IDS_PER_REQUEST: usize = 128;

/// Result of resolving multiple sources for a composite tile request.
pub struct ResolvedSources {
    pub sources: Vec<(BoxedSource, ResolvedProcess)>,
    pub use_url_query: bool,
    pub info: TileInfo,
}

/// Errors from registering a tile source alias.
#[derive(Debug, thiserror::Error)]
pub enum TileAliasError {
    /// The alias name cannot be requested.
    #[error(
        "Tile source alias {0:?} is invalid: alias names must be non-empty and must not contain commas"
    )]
    InvalidAliasName(String),

    /// The alias lists no sources.
    #[error("Tile source alias {0:?} does not reference any tile sources")]
    EmptyAlias(String),

    /// The alias references more sources than a single request may use.
    #[error(
        "Tile source alias {alias:?} references {requested} tile sources, but at most {max} are allowed"
    )]
    TooManySourcesInAlias {
        /// Alias name.
        alias: String,
        /// Referenced source count.
        requested: usize,
        /// Allowed maximum.
        max: usize,
    },

    /// The alias references another alias instead of a tile source.
    #[error(
        "Tile source alias {alias:?} references {source_id:?}, which is itself an alias; aliases may only reference tile sources"
    )]
    AliasWithinAlias {
        /// Alias name.
        alias: String,
        /// The referenced alias.
        source_id: String,
    },

    /// The alias references a tile source that is not registered.
    #[error("Tile source alias {alias:?} references unknown tile source {source_id:?}")]
    AliasSourceNotFound {
        /// Alias name.
        alias: String,
        /// The referenced tile source.
        source_id: String,
    },
}

/// Thread-safe registry of tile sources indexed by ID.
///
/// Uses a [`DashMap`] for concurrent access without explicit locking.
/// Each source is paired with its resolved [`ResolvedProcess`].
#[derive(Default, Clone)]
pub struct TileSources {
    sources: Arc<DashMap<String, (BoxedSource, ResolvedProcess)>>,
    /// Map of alias name to the tile source ids it combines.
    aliases: Arc<DashMap<String, Vec<String>>>,
}

impl TileSources {
    /// Creates a new registry from flattened source collections.
    ///
    /// All sources receive the default [`ResolvedProcess`].
    #[must_use]
    pub fn new(sources: Vec<Vec<BoxedSource>>) -> Self {
        Self::new_with_process(
            sources
                .into_iter()
                .map(|group| {
                    group
                        .into_iter()
                        .map(|src| (src, ResolvedProcess::default()))
                        .collect()
                })
                .collect(),
        )
    }

    /// Creates a new registry from sources paired with their resolved process configs.
    #[must_use]
    pub fn new_with_process(sources: Vec<Vec<(BoxedSource, ResolvedProcess)>>) -> Self {
        Self {
            sources: Arc::new(
                sources
                    .into_iter()
                    .flatten()
                    .map(|(src, pc)| (src.get_id().to_owned(), (src, pc)))
                    .collect(),
            ),
            aliases: Arc::default(),
        }
    }

    /// Creates a registry backed by existing shared maps.
    #[must_use]
    pub(crate) fn from_maps(
        sources: Arc<DashMap<String, (BoxedSource, ResolvedProcess)>>,
        aliases: Arc<DashMap<String, Vec<String>>>,
    ) -> Self {
        Self { sources, aliases }
    }

    /// Returns a catalog of all sources and aliases with their metadata.
    ///
    /// An alias is listed under its own name with the format its member sources serve.
    #[must_use]
    pub fn get_catalog(&self) -> TileCatalog {
        let mut catalog: TileCatalog = self
            .sources
            .iter()
            .map(|v| {
                let (src, pc) = v.value();
                let mut entry = src.get_catalog_entry();
                let info = pc.advertised_tile_info(src.get_tile_info());
                info.format
                    .content_type()
                    .clone_into(&mut entry.content_type);
                entry.content_encoding = info.encoding.compression().map(str::to_owned);
                (v.key().clone(), entry)
            })
            .collect();
        for alias in self.aliases.iter() {
            let Some(member) = alias.value().iter().find_map(|id| self.sources.get(id)) else {
                continue;
            };
            let (src, pc) = member.value();
            let info = pc.advertised_tile_info(src.get_tile_info());
            let entry = CatalogSourceEntry {
                content_type: info.format.content_type().to_owned(),
                content_encoding: info.encoding.compression().map(str::to_owned),
                ..CatalogSourceEntry::default()
            };
            catalog.insert(alias.key().clone(), entry);
        }
        catalog
    }

    /// Returns all source IDs.
    #[must_use]
    pub fn source_names(&self) -> Vec<String> {
        self.sources.iter().map(|v| v.key().clone()).collect()
    }

    /// Registers a named combination of tile sources that serves like a single source.
    ///
    /// Every member must name a registered tile source, not another alias.
    /// An alias may share the name of a source it references.
    /// Requests for such a name serve the alias.
    pub fn add_alias(&self, name: String, sources: Vec<String>) -> Result<(), TileAliasError> {
        if name.is_empty() || name.contains(',') {
            return Err(TileAliasError::InvalidAliasName(name));
        }
        if sources.is_empty() {
            return Err(TileAliasError::EmptyAlias(name));
        }
        if sources.len() > MAX_SOURCE_IDS_PER_REQUEST {
            return Err(TileAliasError::TooManySourcesInAlias {
                alias: name,
                requested: sources.len(),
                max: MAX_SOURCE_IDS_PER_REQUEST,
            });
        }
        for source in &sources {
            if self.aliases.contains_key(source) {
                return Err(TileAliasError::AliasWithinAlias {
                    alias: name,
                    source_id: source.clone(),
                });
            }
            if !self.sources.contains_key(source) {
                return Err(TileAliasError::AliasSourceNotFound {
                    alias: name,
                    source_id: source.clone(),
                });
            }
        }
        if self.sources.contains_key(&name) {
            info!(
                source.alias = %name,
                "Tile source alias shadows a tile source of the same name; requests for it will serve the alias"
            );
        }
        info!(
            source.alias = %name,
            source.ids = %sources.join(", "),
            "Configured tile source alias"
        );
        self.aliases.insert(name, sources);
        Ok(())
    }

    /// Splits a request id list and replaces every alias with its member sources, in order.
    #[must_use]
    pub fn expand_ids(&self, source_ids: &str) -> Vec<String> {
        let mut expanded = Vec::new();
        for id in source_ids.split(',') {
            if let Some(alias) = self.aliases.get(id) {
                expanded.extend(alias.value().iter().cloned());
            } else {
                expanded.push(id.to_owned());
            }
        }
        expanded
    }

    /// Gets a source and its process config by ID, returning 404 error if not found.
    pub fn get_source(&self, id: &str) -> actix_web::Result<(BoxedSource, ResolvedProcess)> {
        Ok(self
            .sources
            .get(id)
            .ok_or_else(|| ErrorNotFound(format!("Source {id} does not exist")))?
            .value()
            .clone())
    }

    /// Gets multiple sources for composite tiles, ensuring format compatibility.
    ///
    /// Parses comma-separated source IDs, replaces aliases with their member sources,
    /// and validates all sources have matching format/encoding.
    /// Optionally filters by zoom level support.
    ///
    #[hotpath::measure]
    pub fn get_sources(
        &self,
        source_ids: &str,
        zoom: Option<u8>,
    ) -> actix_web::Result<ResolvedSources> {
        let ids: Vec<&str> = source_ids.split(',').collect();
        if ids.len() > MAX_SOURCE_IDS_PER_REQUEST {
            return Err(ErrorBadRequest(format!(
                "Requested {} source ids, but at most {MAX_SOURCE_IDS_PER_REQUEST} are allowed per request",
                ids.len()
            )));
        }

        let mut sources = Vec::new();
        let mut info: Option<TileInfo> = None;
        let mut use_url_query = false;

        for id in ids {
            if let Some(alias) = self.aliases.get(id) {
                for member in alias.value() {
                    self.collect_source(member, zoom, &mut sources, &mut info, &mut use_url_query)?;
                }
            } else {
                self.collect_source(id, zoom, &mut sources, &mut info, &mut use_url_query)?;
            }
        }

        Ok(ResolvedSources {
            sources,
            use_url_query,
            info: info.expect("at least one source must be present"),
        })
    }

    /// Adds one source to a composite resolution, checking its format against the others.
    fn collect_source(
        &self,
        id: &str,
        zoom: Option<u8>,
        sources: &mut Vec<(BoxedSource, ResolvedProcess)>,
        info: &mut Option<TileInfo>,
        use_url_query: &mut bool,
    ) -> actix_web::Result<()> {
        let (src, pc) = self.get_source(id)?;
        let src_inf = pc.advertised_tile_info(src.get_tile_info());
        *use_url_query |= src.support_url_query();

        // make sure all sources have the same format and encoding
        // TODO: support multiple encodings of the same format
        match *info {
            Some(inf) if inf == src_inf => {}
            Some(inf) => {
                return Err(ErrorNotFound(format!(
                    "Cannot merge sources with {inf} with {src_inf}"
                )));
            }
            None => *info = Some(src_inf),
        }

        // TODO: Use chained-if-let once available
        if match zoom {
            Some(zoom) if Self::check_zoom(&*src, id, zoom) => true,
            None => true,
            _ => false,
        } {
            sources.push((src, pc));
        }
        Ok(())
    }

    /// Validates zoom level support for a source
    #[must_use]
    pub fn check_zoom(src: &dyn Source, id: &str, zoom: u8) -> bool {
        let is_valid = src.is_valid_zoom(zoom);
        if !is_valid {
            let tilejson = src.get_tilejson();
            debug!(
                source.id = id,
                requested.zoom = zoom,
                source.minzoom = ?tilejson.minzoom,
                source.maxzoom = ?tilejson.maxzoom,
                "Requested zoom not supported by source",
            );
        }
        is_valid
    }

    /// Returns if any source benefits from concurrent scraping by martin-cp
    #[must_use]
    pub fn benefits_from_concurrent_scraping(&self) -> bool {
        self.sources
            .iter()
            .any(|s| s.value().0.benefits_from_concurrent_scraping())
    }
}

#[cfg(test)]
mod tests {
    use tilejson::tilejson;

    use super::*;
    use crate::srv::tiles::tests::TestSource;

    fn sources_with_one_valid() -> TileSources {
        TileSources::new(vec![vec![Box::new(TestSource {
            id: "valid",
            tj: tilejson! { tiles: vec![] },
            data: vec![1, 2, 3],
            format: martin_tile_utils::Format::Mvt,
        })]])
    }

    #[test]
    fn too_many_source_ids_are_rejected() {
        let sources = sources_with_one_valid();
        let ids = vec!["valid"; MAX_SOURCE_IDS_PER_REQUEST + 1].join(",");
        assert!(sources.get_sources(&ids, None).is_err());
    }

    #[test]
    fn exactly_max_source_ids_is_not_rejected_by_the_count_check() {
        let sources = sources_with_one_valid();
        let ids = vec!["valid"; MAX_SOURCE_IDS_PER_REQUEST].join(",");
        let resolved = sources.get_sources(&ids, None).unwrap();
        assert_eq!(resolved.sources.len(), MAX_SOURCE_IDS_PER_REQUEST);
    }

    #[test]
    fn an_alias_expands_to_its_member_sources_in_order() {
        let sources = sources_with_one_valid();
        sources
            .add_alias(
                "both".to_owned(),
                vec!["valid".to_owned(), "valid".to_owned()],
            )
            .unwrap();
        assert_eq!(
            sources.expand_ids("both,valid"),
            ["valid", "valid", "valid"]
        );
        let resolved = sources.get_sources("both,valid", None).unwrap();
        assert_eq!(resolved.sources.len(), 3);
    }

    #[test]
    fn an_alias_must_name_registered_sources_and_never_another_alias() {
        let sources = sources_with_one_valid();
        assert!(matches!(
            sources.add_alias("cities".to_owned(), vec!["missing".to_owned()]),
            Err(TileAliasError::AliasSourceNotFound { .. })
        ));
        sources
            .add_alias("cities".to_owned(), vec!["valid".to_owned()])
            .unwrap();
        assert!(matches!(
            sources.add_alias("nested".to_owned(), vec!["cities".to_owned()]),
            Err(TileAliasError::AliasWithinAlias { .. })
        ));
    }
}