Correct GraphQL scalars compliance for third-party crates (#1275)

- switch `LocalDateTime` scalars to `yyyy-MM-ddTHH:mm:ss` format in `chrono::NaiveDateTime` and `time::PrimitiveDateTime` types - switch from `Date` scalar to `LocalDate` scalar in `chrono::NaiveDate` and `time::Date` types - switch from `UtcDateTime` scalar to `DateTime` scalar in `bson::DateTime` type - correct `TimeZone` scalar in `chrono_tz::Tz` type - rename `Url` scalar to `URL` in `url::Url` type - rename `Uuid` scalar to `UUID` in `uuid::Uuid` type
graphql-rust · Aug 15, 2024 · b3a7ffc · b3a7ffc
1 parent 2756260
commit b3a7ffc
Show file tree

Hide file tree

Showing 12 changed files with 538 additions and 192 deletions.
diff --git a/book/src/types/scalars.md b/book/src/types/scalars.md
@@ -385,35 +385,35 @@ mod date_scalar {
 
 [Juniper] provides out-of-the-box [GraphQL scalar][0] implementations for some very common [Rust] crates. The types from these crates will be usable in your schemas automatically after enabling the correspondent self-titled [Cargo feature].
 
-| [Rust] type                 | [GraphQL] scalar | [Cargo feature]  |
-|-----------------------------|------------------|------------------|
-| [`BigDecimal`]              | `BigDecimal`     | [`bigdecimal`]   |
-| [`bson::oid::ObjectId`]     | `ObjectId`       | [`bson`]         |
-| [`bson::DateTime`]          | `UtcDateTime`    | [`bson`]         |
-| [`chrono::NaiveDate`]       | [`Date`]         | [`chrono`]       |
-| [`chrono::NaiveTime`]       | [`LocalTime`]    | [`chrono`]       |
-| [`chrono::NaiveDateTime`]   | `LocalDateTime`  | [`chrono`]       |
-| [`chrono::DateTime`]        | [`DateTime`]     | [`chrono`]       |
-| [`chrono_tz::Tz`]           | `TimeZone`       | [`chrono-tz`]    |
-| [`Decimal`]                 | `Decimal`        | [`rust_decimal`] |
-| [`jiff::civil::Date`]       | [`LocalDate`]    | [`jiff`]         |
-| [`jiff::civil::Time`]       | [`LocalTime`]    | [`jiff`]         |
-| [`jiff::civil::DateTime`]   | `LocalDateTime`  | [`jiff`]         |
-| [`jiff::Timestamp`]         | [`DateTime`]     | [`jiff`]         |
-| [`jiff::Span`]              | [`Duration`]     | [`jiff`]         |
-| [`time::Date`]              | [`Date`]         | [`time`]         |
-| [`time::Time`]              | [`LocalTime`]    | [`time`]         |
-| [`time::PrimitiveDateTime`] | `LocalDateTime`  | [`time`]         |
-| [`time::OffsetDateTime`]    | [`DateTime`]     | [`time`]         |
-| [`time::UtcOffset`]         | [`UtcOffset`]    | [`time`]         |
-| [`Url`]                     | `Url`            | [`url`]          |
-| [`Uuid`]                    | `Uuid`           | [`uuid`]         |
+| [Rust] type                 | [GraphQL] scalar  | [Cargo feature]  |
+|-----------------------------|-------------------|------------------|
+| [`bigdecimal::BigDecimal`]  | `BigDecimal`      | [`bigdecimal`]   |
+| [`bson::oid::ObjectId`]     | `ObjectId`        | [`bson`]         |
+| [`bson::DateTime`]          | [`DateTime`]      | [`bson`]         |
+| [`chrono::NaiveDate`]       | [`LocalDate`]     | [`chrono`]       |
+| [`chrono::NaiveTime`]       | [`LocalTime`]     | [`chrono`]       |
+| [`chrono::NaiveDateTime`]   | [`LocalDateTime`] | [`chrono`]       |
+| [`chrono::DateTime`]        | [`DateTime`]      | [`chrono`]       |
+| [`chrono_tz::Tz`]           | [`TimeZone`]      | [`chrono-tz`]    |
+| [`rust_decimal::Decimal`]   | `Decimal`         | [`rust_decimal`] |
+| [`jiff::civil::Date`]       | [`LocalDate`]     | [`jiff`]         |
+| [`jiff::civil::Time`]       | [`LocalTime`]     | [`jiff`]         |
+| [`jiff::civil::DateTime`]   | [`LocalDateTime`] | [`jiff`]         |
+| [`jiff::Timestamp`]         | [`DateTime`]      | [`jiff`]         |
+| [`jiff::Span`]              | [`Duration`]      | [`jiff`]         |
+| [`time::Date`]              | [`LocalDate`]     | [`time`]         |
+| [`time::Time`]              | [`LocalTime`]     | [`time`]         |
+| [`time::PrimitiveDateTime`] | [`LocalDateTime`] | [`time`]         |
+| [`time::OffsetDateTime`]    | [`DateTime`]      | [`time`]         |
+| [`time::UtcOffset`]         | [`UtcOffset`]     | [`time`]         |
+| [`url::Url`]                | [`URL`]           | [`url`]          |
+| [`uuid::Uuid`]              | [`UUID`]          | [`uuid`]         |
 
 
 
 
 [`bigdecimal`]: https://docs.rs/bigdecimal
-[`BigDecimal`]: https://docs.rs/bigdecimal/latest/bigdecimal/struct.BigDecimal.html
+[`bigdecimal::BigDecimal`]: https://docs.rs/bigdecimal/latest/bigdecimal/struct.BigDecimal.html
 [`bson`]: https://docs.rs/bson
 [`bson::DateTime`]: https://docs.rs/bson/latest/bson/struct.DateTime.html
 [`bson::oid::ObjectId`]: https://docs.rs/bson/latest/bson/oid/struct.ObjectId.html
@@ -424,7 +424,6 @@ mod date_scalar {
 [`chrono::NaiveTime`]: https://docs.rs/chrono/latest/chrono/naive/struct.NaiveTime.html
 [`chrono-tz`]: https://docs.rs/chrono-tz
 [`chrono_tz::Tz`]: https://docs.rs/chrono-tz/latest/chrono_tz/enum.Tz.html
-[`Date`]: https://graphql-scalars.dev/docs/scalars/date
 [`DateTime`]: https://graphql-scalars.dev/docs/scalars/date-time
 [`Decimal`]: https://docs.rs/rust_decimal/latest/rust_decimal/struct.Decimal.html
 [`Duration`]: https://graphql-scalars.dev/docs/scalars/duration
@@ -436,6 +435,7 @@ mod date_scalar {
 [`jiff::Span`]: https://docs.rs/jiff/latest/jiff/struct.Span.html
 [`jiff::Timestamp`]: https://docs.rs/jiff/latest/jiff/struct.Timestamp.html
 [`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
 [`rust_decimal`]: https://docs.rs/rust_decimal
 [`ScalarValue`]: https://docs.rs/juniper/0.16.1/juniper/trait.ScalarValue.html
@@ -446,11 +446,14 @@ mod date_scalar {
 [`time::Time`]: https://docs.rs/time/latest/time/struct.Time.html
 [`time::UtcOffset`]: https://docs.rs/time/latest/time/struct.UtcOffset.html
 [`time::OffsetDateTime`]: https://docs.rs/time/latest/time/struct.OffsetDateTime.html
+[`TimeZone`]: https://graphql-scalars.dev/docs/scalars/time-zone
 [`url`]: https://docs.rs/url
-[`Url`]: https://docs.rs/url/latest/url/struct.Url.html
+[`url::Url`]: https://docs.rs/url/latest/url/struct.Url.html
+[`URL`]: https://graphql-scalars.dev/docs/scalars/url
 [`UtcOffset`]: https://graphql-scalars.dev/docs/scalars/utc-offset
 [`uuid`]: https://docs.rs/uuid
-[`Uuid`]: https://docs.rs/uuid/latest/uuid/struct.Uuid.html
+[`uuid::Uuid`]: https://docs.rs/uuid/latest/uuid/struct.Uuid.html
+[`UUID`]: https://graphql-scalars.dev/docs/scalars/uuid
 [Cargo feature]: https://doc.rust-lang.org/cargo/reference/features.html
 [GraphQL]: https://graphql.org
 [Juniper]: https://docs.rs/juniper

diff --git a/juniper/CHANGELOG.md b/juniper/CHANGELOG.md
@@ -14,19 +14,41 @@ 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])
+    - Switched `LocalDateTime` scalars to `yyyy-MM-ddTHH:mm:ss` format in types:
+        - `chrono::NaiveDateTime`.
+        - `time::PrimitiveDateTime`.
+    - Switched from `Date` scalar to `LocalDate` scalar in types:
+        - `chrono::NaiveDate`.
+        - `time::Date`.
+    - Switched from `UtcDateTime` scalar to `DateTime` scalar in types:
+        - `bson::DateTime`.
+    - Corrected `TimeZone` scalar in types:
+        - `chrono_tz::Tz`.
+    - Renamed `Url` scalar to `URL` in types:
+        - `url::Url`.
+    - Renamed `Uuid` scalar to `UUID` in types:
+        - `uuid::Uuid`.
 
 ### Added
 
-- [`jiff` crate] integration behind `jiff` [Cargo feature]. ([#1271])
+- [`jiff` crate] integration behind `jiff` [Cargo feature]: ([#1271], [#1270])
+    - `jiff::civil::Date` as `LocalDate` scalar.
+    - `jiff::civil::Time` as `LocalTime` scalar.
+    - `jiff::civil::DateTime` as `LocalDateTime` scalar. ([#1275])
+    - `jiff::Timestamp` as `DateTime` scalar.
+    - `jiff::Span` as `Duration` scalar.
 
 ### Changed
 
 - Updated [GraphiQL] to [3.5.0 version](https://github.com/graphql/graphiql/blob/graphiql%403.5.0/packages/graphiql/CHANGELOG.md#350). ([#1274])
 
 [#1252]: /../../pull/1252
+[#1270]: /../../issues/1270
 [#1271]: /../../pull/1271
 [#1272]: /../../pull/1272
 [#1274]: /../../pull/1274
+[#1275]: /../../pull/1275
 
 
 

diff --git a/juniper/Cargo.toml b/juniper/Cargo.toml
@@ -46,7 +46,7 @@ anyhow = { version = "1.0.47", optional = true }
 async-trait = "0.1.39"
 auto_enums = "0.8"
 bigdecimal = { version = "0.4", optional = true }
-bson = { version = "2.4", features = ["chrono-0_4"], optional = true }
+bson = { version = "2.4", optional = true }
 chrono = { version = "0.4.30", features = ["alloc"], default-features = false, optional = true }
 chrono-tz = { version = "0.9", default-features = false, optional = true }
 fnv = "1.0.5"

diff --git a/juniper/src/executor_tests/interfaces_unions.rs b/juniper/src/executor_tests/interfaces_unions.rs
@@ -6,6 +6,7 @@ mod interface {
         GraphQLObject,
     };
 
+    #[allow(dead_code)] // TODO: Consider this for the GraphQL interfaces in the expansion.
     #[graphql_interface(for = [Cat, Dog])]
     trait Pet {
         fn name(&self) -> &str;

diff --git a/juniper/src/executor_tests/introspection/mod.rs b/juniper/src/executor_tests/introspection/mod.rs
@@ -24,6 +24,7 @@ enum Sample {
 struct Scalar(i32);
 
 /// A sample interface
+#[allow(dead_code)] // TODO: Consider this for the GraphQL interfaces in the expansion.
 #[graphql_interface(name = "SampleInterface", for = Root)]
 trait Interface {
     /// A sample field in the interface