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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
use std::fmt;
use once_cell::sync::Lazy;
use serde::{Serialize, Deserialize, Deserializer, Serializer};
use url::Url;
use crate::Error;
use crate::version::PackageVersion;

#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
#[serde(transparent)]
pub struct Registry(url::Url);

impl Registry {
    fn try_from_segments(segments: &[&str]) -> Option<Self> {
        if segments.is_empty() {
            return None;
        }

        let mut reconstructed: String = segments.join("/");
        if !reconstructed.ends_with('/') {
            reconstructed.push('/');
        }
        let registry_url = url::Url::parse(&reconstructed).ok()?;
        let registry = Registry::from(registry_url);
        Some(registry)
    }
}

static DEFAULT_REGISTRY: Lazy<Registry> = Lazy::new(|| {
    let url = url::Url::parse("https://packages.fluvio.io/v1/").unwrap();
    Registry::from(url)
});

static DEFAULT_GROUP: Lazy<GroupName> = Lazy::new(|| GroupName("fluvio".to_owned()));

impl fmt::Display for Registry {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.0.fmt(f)
    }
}

impl Default for Registry {
    fn default() -> Self {
        DEFAULT_REGISTRY.clone()
    }
}

impl std::str::FromStr for Registry {
    type Err = crate::Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let url = url::Url::parse(s).map_err(Error::FailedToParseRegistry)?;
        Ok(Self(url))
    }
}

impl From<url::Url> for Registry {
    fn from(url: url::Url) -> Self {
        Self(url)
    }
}

impl AsRef<url::Url> for Registry {
    fn as_ref(&self) -> &Url {
        &self.0
    }
}

/// Certain newtypes are just Strings but cannot contain a '/' character.
///
/// This macro is used to derive the deserialization rules for those types.
macro_rules! deserialize_no_slash_string {
    ($mod:ident, $id:ident, $err:expr, $string_name:expr $(,)?) => {
        mod $mod {
            use super::$id;
            use super::Error;
            impl std::str::FromStr for $id {
                type Err = Error;

                fn from_str(s: &str) -> Result<Self, Self::Err> {
                    if s.find('/').is_some() {
                        return Err($err("cannot contain '/'".to_string()));
                    }
                    if s.find(':').is_some() {
                        return Err($err("cannot contain ':'".to_string()));
                    }
                    return Ok(Self(s.to_string()));
                }
            }

            impl $id {
                pub fn as_str(&self) -> &str {
                    &self.0
                }
            }

            impl<'de> serde::Deserialize<'de> for $id {
                fn deserialize<D>(
                    deserializer: D,
                ) -> Result<Self, <D as serde::Deserializer<'de>>::Error>
                where
                    D: serde::Deserializer<'de>,
                {
                    let string = String::deserialize(deserializer)?;

                    // Reject strings that have `/` in them
                    if let Err(e) = string.parse::<$id>() {
                        use serde::de::{Unexpected, Error as DeserializeError};
                        return Err(DeserializeError::invalid_value(
                            Unexpected::Other(&e.to_string()),
                            &&*format!("valid {}", $string_name),
                        ));
                    }

                    Ok(Self(string))
                }
            }
        }
    };
}

#[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd, Serialize)]
#[serde(transparent)]
pub struct GroupName(String);

impl fmt::Display for GroupName {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.0.fmt(f)
    }
}

deserialize_no_slash_string!(group, GroupName, Error::InvalidGroupName, "index group");

#[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd, Serialize)]
#[serde(transparent)]
pub struct PackageName(String);

impl fmt::Display for PackageName {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.0.fmt(f)
    }
}

deserialize_no_slash_string!(
    package_name,
    PackageName,
    Error::InvalidPackageName,
    "package name"
);

pub type WithVersion = PackageVersion;
pub type MaybeVersion = Option<PackageVersion>;

/// A unique identifier for a package that describes its registry, group,
/// name, and (possibly) version.
///
/// There are two different variations of a PackageId, which have different
/// formatting and parsing rules.
///
/// 1) A `PackageId<WithVersion>` represents a fully-qualified package
/// name that also refers to a specific version of the package. It is
/// rendered (and parsed) as a string in the following form:
///
/// ```text
/// <registry>/<group>/<name>:<version>
/// OR
/// <group>/<name>:<version>
/// OR
/// <name>:<version>
/// ```
///
/// Note that a `PackageId<WithVersion>` has strong guarantees on its
/// `FromStr` implementation (and therefore, it's `parse()` rules). This
/// means that a `PackageId<WithVersion>` is _guaranteed_ to have a version
/// embedded in it, which can be accessed via `.version()`.
///
/// 2) A `PackageId` (i.e. `PackageId<MaybeVersion>`) might or might not contain a
/// version, and will parse a package string that does OR does not have a version
/// in it. This is the type you should use if you don't need a version or if you
/// want to do something different based on whether or not a version is given. An
/// example of this might be installing a specific version of a package if a
/// version is given, or defaulting to the latest version if not given.
///
/// Valid forms that will parse into a `PackageId` include:
///
/// ```text
/// <registry>/<group>/<name>
/// <group>/<name>
/// <name>
/// <registry>/<group>/<name>:<version>
/// <group>/<name>:<version>
/// <name>:<version>
/// ```
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct PackageId<V = MaybeVersion> {
    registry: Option<Registry>,
    group: Option<GroupName>,
    name: PackageName,
    version: V,
}

impl<T> PackageId<T> {
    /// Return the registry of the package specified by this identifier
    pub fn registry(&self) -> &Registry {
        match self.registry.as_ref() {
            Some(registry) => registry,
            None => &DEFAULT_REGISTRY,
        }
    }

    /// Return the group of the package specified by this identifier
    pub fn group(&self) -> &GroupName {
        match self.group.as_ref() {
            Some(group) => group,
            None => &DEFAULT_GROUP,
        }
    }

    /// Return the name of the package specified by this identifier
    pub fn name(&self) -> &PackageName {
        &self.name
    }

    /// A printable representation of this `PackageId`
    ///
    /// This displays the most concise representation of this `PackageId` that is still unique.
    /// For example, if the registry and group name are default values, this will display only
    /// the package name. If the group name is non-standard, it will be printed. If the registry
    /// is non-standard, both the registry and the group name will be printed.
    pub fn pretty(&self) -> impl fmt::Display {
        let prefix = match (self.registry.as_ref(), self.group.as_ref()) {
            (Some(reg), _) => format!("{}{}/", reg, self.group()),
            (None, Some(group)) => format!("{group}/"),
            (None, None) => "".to_string(),
        };
        format!("{}{}", prefix, self.name)
    }

    /// A unique representation of this package, excluding version.
    ///
    /// This is intended to be used for comparing two PackageId's
    /// to see whether they refer to the same package entity, regardless
    /// of version.
    ///
    /// # Example
    ///
    /// ```
    /// # use fluvio_index::{PackageId, MaybeVersion, WithVersion};
    /// let pid1: PackageId<MaybeVersion> = "fluvio/fluvio".parse().unwrap();
    /// let pid2: PackageId<WithVersion> = "https://packages.fluvio.io/v1/fluvio/fluvio:1.2.3".parse().unwrap();
    /// assert_eq!(pid1.uid(), pid2.uid());
    /// ```
    pub fn uid(&self) -> String {
        format!("{}{}/{}", self.registry(), self.group(), self.name)
    }
}

impl PackageId<WithVersion> {
    /// A PackageId<WithVersion> indisputably has a version, no Option required.
    pub fn version(&self) -> &PackageVersion {
        &self.version
    }

    /// Return the inner PackageVersion, consuming the PackageId
    pub fn into_version(self) -> PackageVersion {
        self.version
    }

    /// Convert to a `PackageId<WithVersion>` preserving the inner `Version`
    pub fn into_maybe_versioned(self) -> PackageId<MaybeVersion> {
        PackageId {
            name: self.name,
            group: self.group,
            registry: self.registry,
            version: Some(self.version),
        }
    }

    /// Convert to a `PackageId<WithVersion>`, dropping the inner `Version`
    pub fn into_unversioned(self) -> PackageId<MaybeVersion> {
        PackageId {
            name: self.name,
            group: self.group,
            registry: self.registry,
            version: None,
        }
    }
}

impl PackageId<MaybeVersion> {
    /// Create a new PackageId with no version info.
    pub(crate) fn new_unversioned(name: PackageName, group: GroupName) -> Self {
        PackageId {
            registry: None,
            group: Some(group),
            name,
            version: None,
        }
    }

    /// Add a Version to any PackageId to create a PackageId<WithVersion>
    pub fn into_versioned(self, version: PackageVersion) -> PackageId<WithVersion> {
        PackageId {
            registry: self.registry,
            name: self.name,
            group: self.group,
            version,
        }
    }
}

impl PackageId<MaybeVersion> {
    pub fn maybe_version(&self) -> Option<&PackageVersion> {
        self.version.as_ref()
    }
}

impl std::str::FromStr for PackageId<WithVersion> {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let mut segments: Vec<&str> = s.split('/').collect();
        let name_version_segment = segments.pop().unwrap();
        let name_version_segments: Vec<&str> = name_version_segment.split(':').collect();
        let (name_string, version_string) = match &name_version_segments[..] {
            [name_string, version_string] => (name_string, version_string),
            _ => return Err(Error::InvalidNameVersionSegment),
        };

        let version = version_string.parse::<PackageVersion>()?;
        let name: PackageName = name_string.parse()?;

        let maybe_group_segment = segments.pop();
        let group: Option<GroupName> = match maybe_group_segment {
            None | Some("fluvio") => None,
            Some(group_string) => Some(group_string.parse()?),
        };

        let registry = Registry::try_from_segments(&segments);

        let package_id = PackageId {
            registry,
            group,
            name,
            version,
        };

        Ok(package_id)
    }
}

impl std::str::FromStr for PackageId<MaybeVersion> {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let mut segments: Vec<&str> = s.split('/').collect();
        let name_version_segment = segments.pop().unwrap();
        let name_version_segments: Vec<&str> = name_version_segment.split(':').collect();
        let (name_string, version_string) = match &name_version_segments[..] {
            [name_string] => (name_string, None),
            [name_string, version_string] => (name_string, Some(version_string)),
            _ => return Err(Error::InvalidNameVersionSegment),
        };

        let name: PackageName = name_string.parse()?;
        let version = match version_string {
            Some(version_string) => Some(version_string.parse::<PackageVersion>()?),
            None => None,
        };

        let maybe_group_string = segments.pop();
        let group: Option<GroupName> = match maybe_group_string {
            None | Some("fluvio") => None,
            Some(group_string) => Some(group_string.parse()?),
        };
        let registry = Registry::try_from_segments(&segments);

        let package_id = PackageId {
            registry,
            group,
            name,
            version,
        };

        Ok(package_id)
    }
}

impl fmt::Display for PackageId<WithVersion> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let registry = self.registry.as_ref().map(|it| it.0.as_str()).unwrap_or("");
        write!(
            f,
            "{registry}{group}/{name}:{version}",
            registry = registry,
            group = self.group(),
            name = self.name,
            version = self.version,
        )
    }
}

impl fmt::Display for PackageId<MaybeVersion> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let registry = self.registry.as_ref().map(|it| it.0.as_str()).unwrap_or("");
        let version = self
            .version
            .as_ref()
            .map(|it| format!(":{it}"))
            .unwrap_or_default();
        write!(
            f,
            "{registry}{group}/{name}{version}",
            registry = registry,
            group = self.group(),
            name = self.name.as_str(),
            version = version,
        )
    }
}

impl<'de> Deserialize<'de> for PackageId<WithVersion> {
    fn deserialize<D>(deserializer: D) -> Result<Self, <D as Deserializer<'de>>::Error>
    where
        D: Deserializer<'de>,
    {
        let string = String::deserialize(deserializer)?;
        let package_id = match string.parse::<PackageId<WithVersion>>() {
            Ok(pid) => pid,
            Err(e) => {
                use serde::de::{Unexpected, Error as DeserializeError};
                return Err(DeserializeError::invalid_value(
                    Unexpected::Other("Invalid PackageId"),
                    &&*format!("A PackageId, <registry>/<group>/<name>:<version>, where <registry> is optional: {e}"),
                ));
            }
        };
        Ok(package_id)
    }
}

impl<'de> Deserialize<'de> for PackageId<MaybeVersion> {
    fn deserialize<D>(deserializer: D) -> Result<Self, <D as Deserializer<'de>>::Error>
    where
        D: Deserializer<'de>,
    {
        let string = String::deserialize(deserializer)?;
        let package_id = match string.parse::<PackageId<MaybeVersion>>() {
            Ok(pid) => pid,
            Err(e) => {
                use serde::de::{Unexpected, Error as DeserializeError};
                return Err(DeserializeError::invalid_value(
                    Unexpected::Other("Invalid PackageId"),
                    &&*format!("A PackageId, <registry>/<group>/<name>:<version>, where <registry> is optional: {e}"),
                ));
            }
        };
        Ok(package_id)
    }
}

impl Serialize for PackageId<WithVersion> {
    fn serialize<S>(&self, serializer: S) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
    where
        S: Serializer,
    {
        self.to_string().serialize(serializer)
    }
}

impl Serialize for PackageId<MaybeVersion> {
    fn serialize<S>(&self, serializer: S) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
    where
        S: Serializer,
    {
        self.to_string().serialize(serializer)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::package_id::{Registry, PackageId};
    use semver::Version;

    #[test]
    fn test_deserialize_group() {
        let group: GroupName = "fluvio.io".parse().unwrap();

        #[derive(Debug, Deserialize, Serialize)]
        struct JsonGroup {
            group: GroupName,
        }

        let json_group = JsonGroup {
            group: group.clone(),
        };
        let group_string = serde_json::to_string(&json_group).unwrap();

        let read_json_group: JsonGroup = serde_json::from_str(&group_string).unwrap();
        let read_group = read_json_group.group;
        assert_eq!(group, read_group);

        assert!("fluvio/io".parse::<GroupName>().is_err());

        let bad_json_group = JsonGroup {
            group: GroupName("fluvio/io".to_string()),
        };
        let bad_group_string = serde_json::to_string(&bad_json_group).unwrap();
        let read_bad_group_result = serde_json::from_str::<JsonGroup>(&bad_group_string);
        assert!(read_bad_group_result.is_err());
    }

    #[test]
    fn test_parse_package_id_default_registry() {
        let package_id: PackageId<WithVersion> = "fluvio.io/fluvio:0.6.0".parse().unwrap();
        assert_eq!(package_id.registry(), &Registry::default());
        assert_eq!(package_id.group().as_str(), "fluvio.io");
        assert_eq!(package_id.name().as_str(), "fluvio");
        assert_eq!(
            package_id.version(),
            &PackageVersion::Semver(Version::parse("0.6.0").unwrap())
        );
    }

    #[test]
    fn test_parse_package_id_custom_registry() {
        let registry_url = "https://other.registry.io/v2/";
        let package_id: PackageId<WithVersion> = format!("{registry_url}/fluvio.io/fluvio:0.6.0")
            .parse()
            .unwrap();
        assert_eq!(package_id.registry(), &registry_url.parse().unwrap());
        assert_eq!(package_id.group().as_str(), "fluvio.io");
        assert_eq!(package_id.name().as_str(), "fluvio");
        assert_eq!(
            package_id.version(),
            &PackageVersion::Semver(Version::parse("0.6.0").unwrap())
        );
    }

    #[test]
    fn test_parse_package_id_default_group() {
        let package_id: PackageId<WithVersion> = "fluvio-cloud:0.1.4".parse().unwrap();
        assert_eq!(package_id.registry(), &Registry::default());
        assert_eq!(package_id.group().as_str(), "fluvio");
        assert_eq!(package_id.name().as_str(), "fluvio-cloud");
        assert_eq!(
            package_id.version(),
            &PackageVersion::Semver(Version::parse("0.1.4").unwrap())
        );
    }

    #[test]
    fn test_parse_package_id_default_group_maybe_version() {
        let package_id: PackageId = "fluvio-cloud".parse().unwrap();
        let package_id: PackageId<MaybeVersion> = package_id;
        assert_eq!(package_id.registry(), &Registry::default());
        assert_eq!(package_id.group().as_str(), "fluvio");
        assert_eq!(package_id.name().as_str(), "fluvio-cloud");
        assert!(package_id.maybe_version().is_none());
    }

    #[test]
    fn test_package_id_display() {
        let package_id_with_version = "fluvio/fluvio:1.2.3-alpha"
            .parse::<PackageId<WithVersion>>()
            .unwrap();
        assert_eq!(
            "fluvio/fluvio:1.2.3-alpha",
            format!("{package_id_with_version}")
        );

        let package_id_maybe_with_version: PackageId<MaybeVersion> =
            "fluvio/fluvio:3.4.5-beta".parse().unwrap();
        assert_eq!(
            "fluvio/fluvio:3.4.5-beta",
            format!("{package_id_maybe_with_version}")
        );

        let package_id_maybe_without_version =
            PackageId::new_unversioned("fluvio".parse().unwrap(), "fluvio".parse().unwrap());
        assert_eq!(
            "fluvio/fluvio",
            format!("{package_id_maybe_without_version}")
        );
    }

    #[test]
    fn test_pretty_no_group() {
        let package_id: PackageId = "fluvio:1.2.3".parse().unwrap();
        let pretty = format!("{}", package_id.pretty());
        assert_eq!(pretty, "fluvio");
    }

    #[test]
    fn test_pretty_group() {
        let package_id: PackageId = "fluvio/fluvio:1.2.3".parse().unwrap();
        let pretty = format!("{}", package_id.pretty());
        assert_eq!(pretty, "fluvio");
    }

    #[test]
    fn test_pretty_maybe_id_no_group() {
        let package_id: PackageId<MaybeVersion> = "fluvio".parse().unwrap();
        let pretty = format!("{}", package_id.pretty());
        assert_eq!(pretty, "fluvio");
    }

    #[test]
    fn test_pretty_maybe_id_group() {
        let package_id: PackageId<MaybeVersion> = "fluvio/fluvio".parse().unwrap();
        let pretty = format!("{}", package_id.pretty());
        assert_eq!(pretty, "fluvio");
    }

    #[test]
    fn test_serialize_package_id_unversioned() {
        let package_id_without_version =
            PackageId::new_unversioned("fluvio".parse().unwrap(), "fluvio".parse().unwrap());

        let json = serde_json::to_string(&package_id_without_version).unwrap();
        assert_eq!(json, r#""fluvio/fluvio""#);
    }

    #[test]
    fn test_serialize_package_id_versioned() {
        let package_id_with_version = "fluvio/fluvio:1.2.3"
            .parse::<PackageId<WithVersion>>()
            .unwrap();
        let json = serde_json::to_string(&package_id_with_version).unwrap();
        assert_eq!(json, r#""fluvio/fluvio:1.2.3""#);
    }
}