elasticgraph-graphql 0.18.0.0

data/lib/elastic_graph/graphql/scalar_coercion_adapters/valid_time_zones.rb

@@ -0,0 +1,634 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+module ElasticGraph
+  class GraphQL
+    module ScalarCoercionAdapters
+      # The set of all valid time zones. We expect this set to align with the official IANA
+      # list[^1][^2][^3], but ultimately we pass these time zones to the datastore and need
+      # to enumerate all time zones it supports. Since Elasticsearch and OpenSearch run on the JVM and the
+      # date format docs[^4] link to Java's `java.time.format.DateTimeFormatter` class, we
+      # can conclude that they support the time zones that the java class supports. This set
+      # is generated by `script/dump_time_zones`, which queries Java's `java.time.ZoneId`[^5]
+      # class to get the set of time zones supported on the JVM.
+      #
+      # DO NOT EDIT BY HAND.
+      #
+      # [^1]: https://www.iana.org/time-zones
+      # [^2]: https://en.wikipedia.org/wiki/Tz_database
+      # [^3]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List
+      # [^4]: https://www.elastic.co/guide/en/elasticsearch/reference/7.10/mapping-date-format.html#custom-date-formats
+      # [^5]: https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html
+      VALID_TIME_ZONES = %w[
+        Africa/Abidjan
+        Africa/Accra
+        Africa/Addis_Ababa
+        Africa/Algiers
+        Africa/Asmara
+        Africa/Asmera
+        Africa/Bamako
+        Africa/Bangui
+        Africa/Banjul
+        Africa/Bissau
+        Africa/Blantyre
+        Africa/Brazzaville
+        Africa/Bujumbura
+        Africa/Cairo
+        Africa/Casablanca
+        Africa/Ceuta
+        Africa/Conakry
+        Africa/Dakar
+        Africa/Dar_es_Salaam
+        Africa/Djibouti
+        Africa/Douala
+        Africa/El_Aaiun
+        Africa/Freetown
+        Africa/Gaborone
+        Africa/Harare
+        Africa/Johannesburg
+        Africa/Juba
+        Africa/Kampala
+        Africa/Khartoum
+        Africa/Kigali
+        Africa/Kinshasa
+        Africa/Lagos
+        Africa/Libreville
+        Africa/Lome
+        Africa/Luanda
+        Africa/Lubumbashi
+        Africa/Lusaka
+        Africa/Malabo
+        Africa/Maputo
+        Africa/Maseru
+        Africa/Mbabane
+        Africa/Mogadishu
+        Africa/Monrovia
+        Africa/Nairobi
+        Africa/Ndjamena
+        Africa/Niamey
+        Africa/Nouakchott
+        Africa/Ouagadougou
+        Africa/Porto-Novo
+        Africa/Sao_Tome
+        Africa/Timbuktu
+        Africa/Tripoli
+        Africa/Tunis
+        Africa/Windhoek
+        America/Adak
+        America/Anchorage
+        America/Anguilla
+        America/Antigua
+        America/Araguaina
+        America/Argentina/Buenos_Aires
+        America/Argentina/Catamarca
+        America/Argentina/ComodRivadavia
+        America/Argentina/Cordoba
+        America/Argentina/Jujuy
+        America/Argentina/La_Rioja
+        America/Argentina/Mendoza
+        America/Argentina/Rio_Gallegos
+        America/Argentina/Salta
+        America/Argentina/San_Juan
+        America/Argentina/San_Luis
+        America/Argentina/Tucuman
+        America/Argentina/Ushuaia
+        America/Aruba
+        America/Asuncion
+        America/Atikokan
+        America/Atka
+        America/Bahia
+        America/Bahia_Banderas
+        America/Barbados
+        America/Belem
+        America/Belize
+        America/Blanc-Sablon
+        America/Boa_Vista
+        America/Bogota
+        America/Boise
+        America/Buenos_Aires
+        America/Cambridge_Bay
+        America/Campo_Grande
+        America/Cancun
+        America/Caracas
+        America/Catamarca
+        America/Cayenne
+        America/Cayman
+        America/Chicago
+        America/Chihuahua
+        America/Ciudad_Juarez
+        America/Coral_Harbour
+        America/Cordoba
+        America/Costa_Rica
+        America/Creston
+        America/Cuiaba
+        America/Curacao
+        America/Danmarkshavn
+        America/Dawson
+        America/Dawson_Creek
+        America/Denver
+        America/Detroit
+        America/Dominica
+        America/Edmonton
+        America/Eirunepe
+        America/El_Salvador
+        America/Ensenada
+        America/Fort_Nelson
+        America/Fort_Wayne
+        America/Fortaleza
+        America/Glace_Bay
+        America/Godthab
+        America/Goose_Bay
+        America/Grand_Turk
+        America/Grenada
+        America/Guadeloupe
+        America/Guatemala
+        America/Guayaquil
+        America/Guyana
+        America/Halifax
+        America/Havana
+        America/Hermosillo
+        America/Indiana/Indianapolis
+        America/Indiana/Knox
+        America/Indiana/Marengo
+        America/Indiana/Petersburg
+        America/Indiana/Tell_City
+        America/Indiana/Vevay
+        America/Indiana/Vincennes
+        America/Indiana/Winamac
+        America/Indianapolis
+        America/Inuvik
+        America/Iqaluit
+        America/Jamaica
+        America/Jujuy
+        America/Juneau
+        America/Kentucky/Louisville
+        America/Kentucky/Monticello
+        America/Knox_IN
+        America/Kralendijk
+        America/La_Paz
+        America/Lima
+        America/Los_Angeles
+        America/Louisville
+        America/Lower_Princes
+        America/Maceio
+        America/Managua
+        America/Manaus
+        America/Marigot
+        America/Martinique
+        America/Matamoros
+        America/Mazatlan
+        America/Mendoza
+        America/Menominee
+        America/Merida
+        America/Metlakatla
+        America/Mexico_City
+        America/Miquelon
+        America/Moncton
+        America/Monterrey
+        America/Montevideo
+        America/Montreal
+        America/Montserrat
+        America/Nassau
+        America/New_York
+        America/Nipigon
+        America/Nome
+        America/Noronha
+        America/North_Dakota/Beulah
+        America/North_Dakota/Center
+        America/North_Dakota/New_Salem
+        America/Nuuk
+        America/Ojinaga
+        America/Panama
+        America/Pangnirtung
+        America/Paramaribo
+        America/Phoenix
+        America/Port-au-Prince
+        America/Port_of_Spain
+        America/Porto_Acre
+        America/Porto_Velho
+        America/Puerto_Rico
+        America/Punta_Arenas
+        America/Rainy_River
+        America/Rankin_Inlet
+        America/Recife
+        America/Regina
+        America/Resolute
+        America/Rio_Branco
+        America/Rosario
+        America/Santa_Isabel
+        America/Santarem
+        America/Santiago
+        America/Santo_Domingo
+        America/Sao_Paulo
+        America/Scoresbysund
+        America/Shiprock
+        America/Sitka
+        America/St_Barthelemy
+        America/St_Johns
+        America/St_Kitts
+        America/St_Lucia
+        America/St_Thomas
+        America/St_Vincent
+        America/Swift_Current
+        America/Tegucigalpa
+        America/Thule
+        America/Thunder_Bay
+        America/Tijuana
+        America/Toronto
+        America/Tortola
+        America/Vancouver
+        America/Virgin
+        America/Whitehorse
+        America/Winnipeg
+        America/Yakutat
+        America/Yellowknife
+        Antarctica/Casey
+        Antarctica/Davis
+        Antarctica/DumontDUrville
+        Antarctica/Macquarie
+        Antarctica/Mawson
+        Antarctica/McMurdo
+        Antarctica/Palmer
+        Antarctica/Rothera
+        Antarctica/South_Pole
+        Antarctica/Syowa
+        Antarctica/Troll
+        Antarctica/Vostok
+        Arctic/Longyearbyen
+        Asia/Aden
+        Asia/Almaty
+        Asia/Amman
+        Asia/Anadyr
+        Asia/Aqtau
+        Asia/Aqtobe
+        Asia/Ashgabat
+        Asia/Ashkhabad
+        Asia/Atyrau
+        Asia/Baghdad
+        Asia/Bahrain
+        Asia/Baku
+        Asia/Bangkok
+        Asia/Barnaul
+        Asia/Beirut
+        Asia/Bishkek
+        Asia/Brunei
+        Asia/Calcutta
+        Asia/Chita
+        Asia/Choibalsan
+        Asia/Chongqing
+        Asia/Chungking
+        Asia/Colombo
+        Asia/Dacca
+        Asia/Damascus
+        Asia/Dhaka
+        Asia/Dili
+        Asia/Dubai
+        Asia/Dushanbe
+        Asia/Famagusta
+        Asia/Gaza
+        Asia/Harbin
+        Asia/Hebron
+        Asia/Ho_Chi_Minh
+        Asia/Hong_Kong
+        Asia/Hovd
+        Asia/Irkutsk
+        Asia/Istanbul
+        Asia/Jakarta
+        Asia/Jayapura
+        Asia/Jerusalem
+        Asia/Kabul
+        Asia/Kamchatka
+        Asia/Karachi
+        Asia/Kashgar
+        Asia/Kathmandu
+        Asia/Katmandu
+        Asia/Khandyga
+        Asia/Kolkata
+        Asia/Krasnoyarsk
+        Asia/Kuala_Lumpur
+        Asia/Kuching
+        Asia/Kuwait
+        Asia/Macao
+        Asia/Macau
+        Asia/Magadan
+        Asia/Makassar
+        Asia/Manila
+        Asia/Muscat
+        Asia/Nicosia
+        Asia/Novokuznetsk
+        Asia/Novosibirsk
+        Asia/Omsk
+        Asia/Oral
+        Asia/Phnom_Penh
+        Asia/Pontianak
+        Asia/Pyongyang
+        Asia/Qatar
+        Asia/Qostanay
+        Asia/Qyzylorda
+        Asia/Rangoon
+        Asia/Riyadh
+        Asia/Saigon
+        Asia/Sakhalin
+        Asia/Samarkand
+        Asia/Seoul
+        Asia/Shanghai
+        Asia/Singapore
+        Asia/Srednekolymsk
+        Asia/Taipei
+        Asia/Tashkent
+        Asia/Tbilisi
+        Asia/Tehran
+        Asia/Tel_Aviv
+        Asia/Thimbu
+        Asia/Thimphu
+        Asia/Tokyo
+        Asia/Tomsk
+        Asia/Ujung_Pandang
+        Asia/Ulaanbaatar
+        Asia/Ulan_Bator
+        Asia/Urumqi
+        Asia/Ust-Nera
+        Asia/Vientiane
+        Asia/Vladivostok
+        Asia/Yakutsk
+        Asia/Yangon
+        Asia/Yekaterinburg
+        Asia/Yerevan
+        Atlantic/Azores
+        Atlantic/Bermuda
+        Atlantic/Canary
+        Atlantic/Cape_Verde
+        Atlantic/Faeroe
+        Atlantic/Faroe
+        Atlantic/Jan_Mayen
+        Atlantic/Madeira
+        Atlantic/Reykjavik
+        Atlantic/South_Georgia
+        Atlantic/St_Helena
+        Atlantic/Stanley
+        Australia/ACT
+        Australia/Adelaide
+        Australia/Brisbane
+        Australia/Broken_Hill
+        Australia/Canberra
+        Australia/Currie
+        Australia/Darwin
+        Australia/Eucla
+        Australia/Hobart
+        Australia/LHI
+        Australia/Lindeman
+        Australia/Lord_Howe
+        Australia/Melbourne
+        Australia/NSW
+        Australia/North
+        Australia/Perth
+        Australia/Queensland
+        Australia/South
+        Australia/Sydney
+        Australia/Tasmania
+        Australia/Victoria
+        Australia/West
+        Australia/Yancowinna
+        Brazil/Acre
+        Brazil/DeNoronha
+        Brazil/East
+        Brazil/West
+        CET
+        CST6CDT
+        Canada/Atlantic
+        Canada/Central
+        Canada/Eastern
+        Canada/Mountain
+        Canada/Newfoundland
+        Canada/Pacific
+        Canada/Saskatchewan
+        Canada/Yukon
+        Chile/Continental
+        Chile/EasterIsland
+        Cuba
+        EET
+        EST5EDT
+        Egypt
+        Eire
+        Etc/GMT
+        Etc/GMT+0
+        Etc/GMT+1
+        Etc/GMT+10
+        Etc/GMT+11
+        Etc/GMT+12
+        Etc/GMT+2
+        Etc/GMT+3
+        Etc/GMT+4
+        Etc/GMT+5
+        Etc/GMT+6
+        Etc/GMT+7
+        Etc/GMT+8
+        Etc/GMT+9
+        Etc/GMT-0
+        Etc/GMT-1
+        Etc/GMT-10
+        Etc/GMT-11
+        Etc/GMT-12
+        Etc/GMT-13
+        Etc/GMT-14
+        Etc/GMT-2
+        Etc/GMT-3
+        Etc/GMT-4
+        Etc/GMT-5
+        Etc/GMT-6
+        Etc/GMT-7
+        Etc/GMT-8
+        Etc/GMT-9
+        Etc/GMT0
+        Etc/Greenwich
+        Etc/UCT
+        Etc/UTC
+        Etc/Universal
+        Etc/Zulu
+        Europe/Amsterdam
+        Europe/Andorra
+        Europe/Astrakhan
+        Europe/Athens
+        Europe/Belfast
+        Europe/Belgrade
+        Europe/Berlin
+        Europe/Bratislava
+        Europe/Brussels
+        Europe/Bucharest
+        Europe/Budapest
+        Europe/Busingen
+        Europe/Chisinau
+        Europe/Copenhagen
+        Europe/Dublin
+        Europe/Gibraltar
+        Europe/Guernsey
+        Europe/Helsinki
+        Europe/Isle_of_Man
+        Europe/Istanbul
+        Europe/Jersey
+        Europe/Kaliningrad
+        Europe/Kiev
+        Europe/Kirov
+        Europe/Kyiv
+        Europe/Lisbon
+        Europe/Ljubljana
+        Europe/London
+        Europe/Luxembourg
+        Europe/Madrid
+        Europe/Malta
+        Europe/Mariehamn
+        Europe/Minsk
+        Europe/Monaco
+        Europe/Moscow
+        Europe/Nicosia
+        Europe/Oslo
+        Europe/Paris
+        Europe/Podgorica
+        Europe/Prague
+        Europe/Riga
+        Europe/Rome
+        Europe/Samara
+        Europe/San_Marino
+        Europe/Sarajevo
+        Europe/Saratov
+        Europe/Simferopol
+        Europe/Skopje
+        Europe/Sofia
+        Europe/Stockholm
+        Europe/Tallinn
+        Europe/Tirane
+        Europe/Tiraspol
+        Europe/Ulyanovsk
+        Europe/Uzhgorod
+        Europe/Vaduz
+        Europe/Vatican
+        Europe/Vienna
+        Europe/Vilnius
+        Europe/Volgograd
+        Europe/Warsaw
+        Europe/Zagreb
+        Europe/Zaporozhye
+        Europe/Zurich
+        GB
+        GB-Eire
+        GMT
+        GMT0
+        Greenwich
+        Hongkong
+        Iceland
+        Indian/Antananarivo
+        Indian/Chagos
+        Indian/Christmas
+        Indian/Cocos
+        Indian/Comoro
+        Indian/Kerguelen
+        Indian/Mahe
+        Indian/Maldives
+        Indian/Mauritius
+        Indian/Mayotte
+        Indian/Reunion
+        Iran
+        Israel
+        Jamaica
+        Japan
+        Kwajalein
+        Libya
+        MET
+        MST7MDT
+        Mexico/BajaNorte
+        Mexico/BajaSur
+        Mexico/General
+        NZ
+        NZ-CHAT
+        Navajo
+        PRC
+        PST8PDT
+        Pacific/Apia
+        Pacific/Auckland
+        Pacific/Bougainville
+        Pacific/Chatham
+        Pacific/Chuuk
+        Pacific/Easter
+        Pacific/Efate
+        Pacific/Enderbury
+        Pacific/Fakaofo
+        Pacific/Fiji
+        Pacific/Funafuti
+        Pacific/Galapagos
+        Pacific/Gambier
+        Pacific/Guadalcanal
+        Pacific/Guam
+        Pacific/Honolulu
+        Pacific/Johnston
+        Pacific/Kanton
+        Pacific/Kiritimati
+        Pacific/Kosrae
+        Pacific/Kwajalein
+        Pacific/Majuro
+        Pacific/Marquesas
+        Pacific/Midway
+        Pacific/Nauru
+        Pacific/Niue
+        Pacific/Norfolk
+        Pacific/Noumea
+        Pacific/Pago_Pago
+        Pacific/Palau
+        Pacific/Pitcairn
+        Pacific/Pohnpei
+        Pacific/Ponape
+        Pacific/Port_Moresby
+        Pacific/Rarotonga
+        Pacific/Saipan
+        Pacific/Samoa
+        Pacific/Tahiti
+        Pacific/Tarawa
+        Pacific/Tongatapu
+        Pacific/Truk
+        Pacific/Wake
+        Pacific/Wallis
+        Pacific/Yap
+        Poland
+        Portugal
+        ROK
+        Singapore
+        SystemV/AST4
+        SystemV/AST4ADT
+        SystemV/CST6
+        SystemV/CST6CDT
+        SystemV/EST5
+        SystemV/EST5EDT
+        SystemV/HST10
+        SystemV/MST7
+        SystemV/MST7MDT
+        SystemV/PST8
+        SystemV/PST8PDT
+        SystemV/YST9
+        SystemV/YST9YDT
+        Turkey
+        UCT
+        US/Alaska
+        US/Aleutian
+        US/Arizona
+        US/Central
+        US/East-Indiana
+        US/Eastern
+        US/Hawaii
+        US/Indiana-Starke
+        US/Michigan
+        US/Mountain
+        US/Pacific
+        US/Samoa
+        UTC
+        Universal
+        W-SU
+        WET
+        Zulu
+      ].to_set
+    end
+  end
+end

data/lib/elastic_graph/graphql/schema/arguments.rb

@@ -0,0 +1,78 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+module ElasticGraph
+  class GraphQL
+    class Schema
+      # A utility module for working with GraphQL schema arguments.
+      module Arguments
+        # A utility method to convert the given `args_hash` to its schema form.
+        # The schema form is the casing of the arguments according to the GraphQL
+        # schema definition.  For example, consider a case like:
+        #
+        # type Query {
+        #   widgets(orderBy: [WidgetSort!]): [Widget!]!
+        # }
+        #
+        # The GraphQL gem converts all arguments to ruby keyword args style (symbolized,
+        # snake_case keys) before passing the args to us, but the `orderBy` argument in
+        # the schema definition uses camelCase. ElasticGraph was designed to flexibly
+        # support whatever casing the schema developer chooses to use but the GraphQL
+        # gem's conversion to keyword args style gets in the way. ElasticGraph needs to
+        # receive the arguments in the casing form defined in the schema so that, for example,
+        # when it creates a datastore query, it correctly filters on fields according
+        # to the casing of the fields in the index.
+        #
+        # This utility method converts an args hash back to its schema form (string keys,
+        # with the casing from the schema) by using the arg definitions themselves to get
+        # the arg names from the GraphQL schema.
+        #
+        # Example:
+        #
+        #   to_schema_form({ order_by: ["size"] }, widgets_field)
+        #     # => { "orderBy" => ["size"] }
+        #
+        # The implementation here was taken from a code snippet provided by the maintainer of
+        # the GraphQL gem: https://github.com/rmosolgo/graphql-ruby/issues/2869
+        def self.to_schema_form(args_value, args_owner)
+          # For custom scalar types (such as `_Any` for apollo federation), `args_owner` won't
+          # response to `arguments`.
+          return args_value unless args_owner.respond_to?(:arguments)
+
+          __skip__ = case args_value
+          when Hash, ::GraphQL::Schema::InputObject
+            arg_defns = args_owner.arguments.values
+
+            {}.tap do |accumulator|
+              args_value.each do |key, value|
+                # Note: we could build `arg_defns` into a hash keyed by `keyword`
+                # outside of this loop, to give us an O(1) lookup here. However,
+                # usually there are a small number of args (e.g 1 or 2, maybe up
+                # to 6 in extreme cases) so it's probably likely to be ultimately
+                # slower to build the hash, particularly when you account for the
+                # extra memory allocation and GC for the hash.
+                arg_defn = arg_defns.find do |a|
+                  a.keyword == key
+                end || raise(SchemaError, "Cannot find an argument definition for #{key.inspect} on `#{args_owner.name}`")
+
+                next_owner = arg_defn.type.unwrap
+                accumulator[arg_defn.name] = to_schema_form(value, next_owner)
+              end
+            end
+          when Array
+            args_value.map { |arg_value| to_schema_form(arg_value, args_owner) }
+          else
+            # :nocov: -- not sure how to cover this but we want this default branch.
+            args_value
+            # :nocov:
+          end
+        end
+      end
+    end
+  end
+end