feat(graphql): validate timezone id as a GraphQL Scalar

Related to #1299

Signed-off-by: Thomas Citharel <tcit@tcit.fr>
This commit is contained in:
Thomas Citharel 2023-06-05 09:12:02 +02:00
parent 2dd0e13eba
commit 845bb6ac90
No known key found for this signature in database
GPG key ID: A061B9DDE0CA0773
9 changed files with 46 additions and 10 deletions

View file

@ -295,7 +295,7 @@ export const JOIN_EVENT = gql`
$email: String $email: String
$message: String $message: String
$locale: String $locale: String
$timezone: String $timezone: Timezone
) { ) {
joinEvent( joinEvent(
eventId: $eventId eventId: $eventId

View file

@ -151,7 +151,7 @@ export const LOGGED_USER_TIMEZONE = gql`
export const SET_USER_SETTINGS = gql` export const SET_USER_SETTINGS = gql`
mutation SetUserSettings( mutation SetUserSettings(
$timezone: String $timezone: Timezone
$notificationOnDay: Boolean $notificationOnDay: Boolean
$notificationEachWeek: Boolean $notificationEachWeek: Boolean
$notificationBeforeEvent: Boolean $notificationBeforeEvent: Boolean

View file

@ -31,6 +31,7 @@ defmodule Mobilizon.GraphQL.Schema do
import_types(Absinthe.Plug.Types) import_types(Absinthe.Plug.Types)
import_types(Custom.UUID) import_types(Custom.UUID)
import_types(Custom.Point) import_types(Custom.Point)
import_types(Custom.Timezone)
import_types(Schema.ActivityType) import_types(Schema.ActivityType)
import_types(Schema.UserType) import_types(Schema.UserType)

View file

@ -22,7 +22,7 @@ defmodule Mobilizon.GraphQL.Schema.AddressType do
field(:url, :string, description: "The address's URL") field(:url, :string, description: "The address's URL")
field(:id, :id, description: "The address's ID") field(:id, :id, description: "The address's ID")
field(:origin_id, :string, description: "The address's original ID from the provider") field(:origin_id, :string, description: "The address's original ID from the provider")
field(:timezone, :string, description: "The (estimated) timezone of the location") field(:timezone, :timezone, description: "The (estimated) timezone of the location")
field(:picture_info, :picture_info, description: "A picture associated with the address") field(:picture_info, :picture_info, description: "A picture associated with the address")
end end
@ -75,7 +75,7 @@ defmodule Mobilizon.GraphQL.Schema.AddressType do
field(:url, :string, description: "The address's URL") field(:url, :string, description: "The address's URL")
field(:id, :id, description: "The address's ID") field(:id, :id, description: "The address's ID")
field(:origin_id, :string, description: "The address's original ID from the provider") field(:origin_id, :string, description: "The address's original ID from the provider")
field(:timezone, :string, description: "The (estimated) timezone of the location") field(:timezone, :timezone, description: "The (estimated) timezone of the location")
end end
@desc """ @desc """

View file

@ -43,7 +43,7 @@ defmodule Mobilizon.GraphQL.Schema.ConfigType do
field(:upload_limits, :upload_limits, description: "The configuration for upload limits") field(:upload_limits, :upload_limits, description: "The configuration for upload limits")
field(:timezones, list_of(:string), description: "The instance's available timezones") field(:timezones, list_of(:timezone), description: "The instance's available timezones")
field(:features, :features, description: "The instance's features") field(:features, :features, description: "The instance's features")
field(:restrictions, :restrictions, description: "The instance's restrictions") field(:restrictions, :restrictions, description: "The instance's restrictions")
field(:version, :string, description: "The instance's version") field(:version, :string, description: "The instance's version")

View file

@ -0,0 +1,35 @@
defmodule Mobilizon.GraphQL.Schema.Custom.Timezone do
@moduledoc """
The timezone scalar type allows timezone ID strings to be passed in and out.
"""
use Absinthe.Schema.Notation
import Mobilizon.Web.Gettext, only: [dgettext: 3]
scalar :timezone, name: "Timezone" do
description("""
The `Timezone` scalar type represents a timezone identifier,
as registered in the IANA Time Zone Database.
""")
serialize(&encode/1)
parse(&decode/1)
end
@spec decode(Absinthe.Blueprint.Input.String.t()) :: {:ok, term} | :error
@spec decode(Absinthe.Blueprint.Input.Null.t()) :: {:ok, nil}
defp decode(%Absinthe.Blueprint.Input.String{value: value}) do
if Tzdata.zone_exists?(value),
do: {:ok, value},
else: {:error, dgettext("errors", "Timezone ID %{timezone} is invalid", timezone: value)}
end
defp decode(%Absinthe.Blueprint.Input.Null{}) do
{:ok, nil}
end
defp decode(_) do
:error
end
defp encode(value), do: value
end

View file

@ -250,7 +250,7 @@ defmodule Mobilizon.GraphQL.Schema.EventType do
field(:show_start_time, :boolean, description: "Show event start time") field(:show_start_time, :boolean, description: "Show event start time")
field(:show_end_time, :boolean, description: "Show event end time") field(:show_end_time, :boolean, description: "Show event end time")
field(:timezone, :string, description: "The event's timezone") field(:timezone, :timezone, description: "The event's timezone")
field(:hide_organizer_when_group_event, :boolean, field(:hide_organizer_when_group_event, :boolean,
description: description:
@ -303,7 +303,7 @@ defmodule Mobilizon.GraphQL.Schema.EventType do
field(:show_start_time, :boolean, description: "Show event start time") field(:show_start_time, :boolean, description: "Show event start time")
field(:show_end_time, :boolean, description: "Show event end time") field(:show_end_time, :boolean, description: "Show event end time")
field(:timezone, :string, description: "The event's timezone") field(:timezone, :timezone, description: "The event's timezone")
field(:hide_organizer_when_group_event, :boolean, field(:hide_organizer_when_group_event, :boolean,
description: description:

View file

@ -96,7 +96,7 @@ defmodule Mobilizon.GraphQL.Schema.Events.ParticipantType do
arg(:email, :string, description: "The anonymous participant's email") arg(:email, :string, description: "The anonymous participant's email")
arg(:message, :string, description: "The anonymous participant's message") arg(:message, :string, description: "The anonymous participant's message")
arg(:locale, :string, description: "The anonymous participant's locale") arg(:locale, :string, description: "The anonymous participant's locale")
arg(:timezone, :string, description: "The anonymous participant's timezone") arg(:timezone, :timezone, description: "The anonymous participant's timezone")
middleware(Rajska.QueryAuthorization, permit: :all, rule: :"write:participation") middleware(Rajska.QueryAuthorization, permit: :all, rule: :"write:participation")
resolve(&Participant.actor_join_event/3) resolve(&Participant.actor_join_event/3)
end end

View file

@ -220,7 +220,7 @@ defmodule Mobilizon.GraphQL.Schema.UserType do
""" """
object :user_settings do object :user_settings do
meta(:authorize, :user) meta(:authorize, :user)
field(:timezone, :string, description: "The timezone for this user") field(:timezone, :timezone, description: "The timezone for this user")
field(:notification_on_day, :boolean, field(:notification_on_day, :boolean,
description: "Whether this user will receive an email at the start of the day of an event." description: "Whether this user will receive an email at the start of the day of an event."
@ -450,7 +450,7 @@ defmodule Mobilizon.GraphQL.Schema.UserType do
@desc "Set user settings" @desc "Set user settings"
field :set_user_settings, :user_settings do field :set_user_settings, :user_settings do
arg(:timezone, :string, description: "The timezone for this user") arg(:timezone, :timezone, description: "The timezone for this user")
arg(:notification_on_day, :boolean, arg(:notification_on_day, :boolean,
description: description: