Skip to content

Commit

Permalink
Correct GraphQL scalars compliance for third-party crates even more (#…
Browse files Browse the repository at this point in the history
…1277)

- rename `ObjectId` scalar to `ObjectID` in `bson::oid::ObjectId` type
- add missing `@specifiedBy` URLs for `chrono` and `time` crates' types

Co-authored-by: Kai Ren <tyranron@gmail.com>
  • Loading branch information
sgoll and tyranron authored Aug 16, 2024
1 parent b3a7ffc commit 681d242
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 7 deletions.
3 changes: 2 additions & 1 deletion book/src/types/scalars.md
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ mod date_scalar {
| [Rust] type | [GraphQL] scalar | [Cargo feature] |
|-----------------------------|-------------------|------------------|
| [`bigdecimal::BigDecimal`] | `BigDecimal` | [`bigdecimal`] |
| [`bson::oid::ObjectId`] | `ObjectId` | [`bson`] |
| [`bson::oid::ObjectId`] | [`ObjectID`] | [`bson`] |
| [`bson::DateTime`] | [`DateTime`] | [`bson`] |
| [`chrono::NaiveDate`] | [`LocalDate`] | [`chrono`] |
| [`chrono::NaiveTime`] | [`LocalTime`] | [`chrono`] |
Expand Down Expand Up @@ -437,6 +437,7 @@ mod date_scalar {
[`LocalDate`]: https://graphql-scalars.dev/docs/scalars/local-date
[`LocalDateTime`]: https://graphql-scalars.dev/docs/scalars/local-date-time
[`LocalTime`]: https://graphql-scalars.dev/docs/scalars/local-time
[`ObjectID`]: https://the-guild.dev/graphql/scalars/docs/scalars/object-id
[`rust_decimal`]: https://docs.rs/rust_decimal
[`ScalarValue`]: https://docs.rs/juniper/0.16.1/juniper/trait.ScalarValue.html
[`serde`]: https://docs.rs/serde
Expand Down
5 changes: 4 additions & 1 deletion juniper/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ All user visible changes to `juniper` crate will be documented in this file. Thi

- Upgraded [`chrono-tz` crate] integration to [0.9 version](https://github.com/chronotope/chrono-tz/releases/tag/v0.9.0). ([#1252])
- Bumped up [MSRV] to 1.75. ([#1272])
- Corrected compliance with newer [graphql-scalars.dev] specs: ([#1275])
- Corrected compliance with newer [graphql-scalars.dev] specs: ([#1275], [#1277])
- Switched `LocalDateTime` scalars to `yyyy-MM-ddTHH:mm:ss` format in types:
- `chrono::NaiveDateTime`.
- `time::PrimitiveDateTime`.
Expand All @@ -29,6 +29,8 @@ All user visible changes to `juniper` crate will be documented in this file. Thi
- `url::Url`.
- Renamed `Uuid` scalar to `UUID` in types:
- `uuid::Uuid`.
- Renamed `ObjectId` scalar to `ObjectID` in types: ([#1277])
- `bson::oid::ObjectId`.

### Added

Expand All @@ -49,6 +51,7 @@ All user visible changes to `juniper` crate will be documented in this file. Thi
[#1272]: /../../pull/1272
[#1274]: /../../pull/1274
[#1275]: /../../pull/1275
[#1277]: /../../pull/1277



Expand Down
13 changes: 9 additions & 4 deletions juniper/src/integrations/bson.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,31 @@
//!
//! | Rust type | Format | GraphQL scalar |
//! |-------------------|-------------------|------------------|
//! | [`oid::ObjectId`] | HEX string | `ObjectId` |
//! | [`oid::ObjectId`] | HEX string | [`ObjectID`][s1] |
//! | [`DateTime`] | [RFC 3339] string | [`DateTime`][s4] |
//!
//! [`DateTime`]: bson::DateTime
//! [`ObjectId`]: bson::oid::ObjectId
//! [`oid::ObjectId`]: bson::oid::ObjectId
//! [RFC 3339]: https://datatracker.ietf.org/doc/html/rfc3339#section-5.6
//! [s1]: https://graphql-scalars.dev/docs/scalars/object-id
//! [s4]: https://graphql-scalars.dev/docs/scalars/date-time

use crate::{graphql_scalar, InputValue, ScalarValue, Value};

/// [BSON ObjectId][0] represented as a HEX string.
///
/// [`ObjectID` scalar][1] compliant.
///
/// See also [`bson::oid::ObjectId`][2] for details.
///
/// [0]: https://www.mongodb.com/docs/manual/reference/bson-types#objectid
/// [1]: https://graphql-scalars.dev/docs/scalars/object-id
/// [2]: https://docs.rs/bson/*/bson/oid/struct.ObjectId.html
#[graphql_scalar(
name = "ObjectID",
with = object_id,
parse_token(String),
specified_by_url = "https://www.mongodb.com/docs/manual/reference/bson-types#objectid",
specified_by_url = "https://graphql-scalars.dev/docs/scalars/object-id",
)]
type ObjectId = bson::oid::ObjectId;

Expand All @@ -38,7 +43,7 @@ mod object_id {
v.as_string_value()
.ok_or_else(|| format!("Expected `String`, found: {v}"))
.and_then(|s| {
ObjectId::parse_str(s).map_err(|e| format!("Failed to parse `ObjectId`: {e}"))
ObjectId::parse_str(s).map_err(|e| format!("Failed to parse `ObjectID`: {e}"))
})
}
}
Expand Down
1 change: 1 addition & 0 deletions juniper/src/integrations/chrono.rs
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@ mod local_date_time {
#[graphql_scalar(
with = date_time,
parse_token(String),
specified_by_url = "https://graphql-scalars.dev/docs/scalars/date-time",
where(
Tz: TimeZone + FromFixedOffset,
Tz::Offset: fmt::Display,
Expand Down
6 changes: 5 additions & 1 deletion juniper/src/integrations/time.rs
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,11 @@ mod local_date {
///
/// [1]: https://graphql-scalars.dev/docs/scalars/local-time
/// [2]: https://docs.rs/time/*/time/struct.Time.html
#[graphql_scalar(with = local_time, parse_token(String))]
#[graphql_scalar(
with = local_time,
parse_token(String),
specified_by_url = "https://graphql-scalars.dev/docs/scalars/local-time",
)]
pub type LocalTime = time::Time;

mod local_time {
Expand Down

0 comments on commit 681d242

Please sign in to comment.