model_driven_api 3.10.0 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2814cf6ff3fc8c2b60cb3b663aa0860d25161c8cd0971a6b76f3efd0b29df966
-  data.tar.gz: 519245af607dff7b04652b65efb88584dc6559f6cc21a60a5591e7c081a9a00d
+  metadata.gz: af8d0733bb1c7ad78521684f1e9cd36879ce8fd2edac11554fae77a8857446a3
+  data.tar.gz: 8d4f390e60a0edc7fbbe8070145768c317524887643ac5afe055dd8675cfe87d
 SHA512:
-  metadata.gz: d15e193b9f21739e577dbc8243e4bb44ff127fa048d4cef33551b58ee55349f27ccd1ca99ac16044c2eed5f844924389542df276f1d7ba06e89d294af5deb164
-  data.tar.gz: 889853a5ce035794316072a74515842f4a43d41a056523de35993bccf270b51475ac195d5b2b96f08db5b1f6829ab47936616a9e162c7bac682b988ee641a6a5
+  metadata.gz: 607eb70c78ea78450ed752a1351c038736a7ad5f6023b969acb560ea59e20b95a3ff54a718b26465e01420ced20131a23d325bc05f34540a7fa77b6df6677c96
+  data.tar.gz: 22704e9424cdba8feb897dafb62710cf41ebe205dd36ca1d0a4356771c8b5419dfc1d823d2e73d03619c3bc9be4bb10c420a8a50829d396982ffac74cc8cfed7

data/config/initializers/time_with_zone.rb

@@ -1,8 +1,19 @@
-# Turns API calls to always UTC, leaving the APP the freedom to use local timezone
-module ActiveSupport
-    class TimeWithZone
-      def as_json(options = nil)
-        utc
-      end
-    end
-end
+# REMOVED (3.11.0): this file used to monkey-patch ActiveSupport::TimeWithZone#as_json
+# to always return `utc` ("Force json rendered datetimes to UTC", 2021):
+#
+#   class ActiveSupport::TimeWithZone
+#     def as_json(options = nil) = utc
+#   end
+#
+# Why it was removed: the patch flattened EVERY TimeWithZone to UTC at JSON time, so any
+# value deliberately localized for the client — e.g. TimeZoneAware's `<field>_server_tz` /
+# `<field>_record_tz` (thecore_backend_commons), also reused by mytask's Gantt endpoint —
+# was rendered as the bare UTC value ("...T08:00:00.000Z" instead of
+# "...T10:00:00.000+02:00"), making those attributes identical to the raw field.
+#
+# Why removing it is safe: the guarantee the patch provided ("API datetimes are UTC") is now
+# enforced at its source instead — ModelDrivenApi::Engine refuses to boot unless
+# `config.time_zone` is UTC (see the :enforce_utc_time_zone initializer in
+# lib/model_driven_api/engine.rb). With Time.zone pinned to UTC, every plain datetime column
+# still serializes through Rails' standard TimeWithZone#as_json as "...Z", exactly as before;
+# only values explicitly converted with `in_time_zone(...)` now keep their own offset.

data/lib/model_driven_api/engine.rb

@@ -7,6 +7,19 @@ module ModelDrivenApi
         ActionDispatch::Request.parameter_parsers[:json]
     end
 
+    # The backend works exclusively in UTC: every thecore app must keep Rails' default
+    # `config.time_zone = "UTC"` (and ActiveRecord's default `:utc` storage), so every datetime
+    # the API renders is UTC ("...Z") and localization is left entirely to the frontends.
+    # Values a model deliberately localizes (e.g. TimeZoneAware's `_server_tz`/`_record_tz`)
+    # are the only ones rendered with an offset. This replaces the old global
+    # TimeWithZone#as_json -> utc monkey-patch (see config/initializers/time_with_zone.rb for
+    # why that was removed). Runs before Rails applies the zone, so a misconfigured app fails
+    # at boot instead of silently rendering local times.
+    initializer :enforce_utc_time_zone, before: "active_support.initialize_time_zone" do |app|
+      db_zone = app.config.active_record.default_timezone if app.config.respond_to?(:active_record)
+      ModelDrivenApi.enforce_utc!(app.config.time_zone, db_zone)
+    end
+
     initializer :append_migrations do |app|
       unless app.root.to_s == root.to_s
         config.paths["db/migrate"].expanded.each do |expanded_path|

data/lib/model_driven_api/version.rb

@@ -1,3 +1,3 @@
 module ModelDrivenApi
-  VERSION = "3.10.0".freeze
+  VERSION = "3.11.0".freeze
 end

data/lib/model_driven_api.rb

@@ -26,6 +26,22 @@ require "api/open_api/v3"
 require "api/v3/serializer_factory"
 
 module ModelDrivenApi
+  UTC_ZONE_NAMES = %w[UTC Etc/UTC].freeze
+
+  # Raises unless the app is UTC-only: +time_zone+ is config.time_zone, +db_zone+ is
+  # config.active_record.default_timezone (nil = Rails' default, :utc). Called at boot by
+  # ModelDrivenApi::Engine's :enforce_utc_time_zone initializer.
+  def self.enforce_utc!(time_zone, db_zone = nil)
+    unless UTC_ZONE_NAMES.include?(time_zone.to_s)
+      raise ArgumentError, "model_driven_api requires config.time_zone to be UTC (got #{time_zone.inspect}). " \
+                           "The backend is UTC-only; localize dates in the frontend instead."
+    end
+    return if db_zone.nil? || db_zone.to_sym == :utc
+
+    raise ArgumentError, "model_driven_api requires config.active_record.default_timezone to be :utc " \
+                         "(got #{db_zone.inspect})."
+  end
+
   def self.smart_merge src, dest
       src.deeper_merge! dest, {
           extend_existing_arrays: true, 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: model_driven_api
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 3.11.0
 platform: ruby
 authors:
 - Gabriele Tassoni