hecks 3.12.0 → 3.13.0

data/lib/hecks/projections/site/table.rb

@@ -60,7 +60,8 @@ module Hecks
 
         # @param registry [Runtime::Registry] a registry holding the Site chapter
         # @return [Hash{Symbol => Array<String>}] each constrained field to its allowed values, and
-        #   `:http_method` to the verbs a route may answer
+        #   `:http_method` to the verbs a route may answer and `:edge_function_kind` to the kinds of
+        #   `EdgeFunction` row
         # @raise [Invalid] when the registry does not hold the Site chapter
         def self.vocabulary(registry)
           site = registry.bluebook("Site") or
@@ -69,7 +70,8 @@ module Hecks
           members = lambda do |name|
             route.value_objects.find { |object| object.hecks_name == name }.members.map { |member| member.fetch(:value) }
           end
-          RowBuilder::VOCABULARY.transform_values(&members).merge(http_method: members.call("HttpMethod"))
+          closed = RowBuilder::VOCABULARY.transform_values(&members)
+          closed.merge(http_method: members.call("HttpMethod"), edge_function_kind: members.call("EdgeFunctionKind"))
         end
 
         # @param chapter [Bluebook::Chapter] a chapter to search

data/lib/hecks/site/bluebook/site.bluebook

@@ -12,7 +12,9 @@
 # The same command projects the CDN: a project that adds Edge, EdgePolicy, EdgeOrigin and EdgeRule rows
 # to its chapter has the CloudFront behaviours and the listener rules written into the marked regions
 # of the template it owns (the `:site_cdn` projection). Those rows are the template's facts, so only the
-# closed sets they draw on, cache class and origin, are named here.
+# closed sets they draw on, cache class, origin and the kind of an EdgeFunction row, are named here. A
+# route's `edge:` names an EdgeFunction row, a viewer-request function the projection writes into the
+# template's `edge_functions` region and attaches to that route's behaviour.
 #
 # Each run records that it was requested before the SiteToolchain port is asked, and what came of
 # it after. No command declares a role: the chapter boots standing alone.
@@ -33,6 +35,7 @@ Hecks.bluebook "Site" do
     attribute :source, Source,  optional: true
     attribute :http_method, HttpMethod, optional: true
     attribute :preview, Preview, optional: true
+    attribute :edge, EdgeName, optional: true
 
     # `/blog/:slug.html` names a parameter; a trailing `/*` matches everything beneath a prefix. A
     # row with a `command:` or `query:` source may leave its path out, and the projection derives it
@@ -78,6 +81,18 @@ Hecks.bluebook "Site" do
       attribute :value, String, one_of: ["public", "draft"]
     end
 
+    # The logical id of an `EdgeFunction` row: the viewer-request function the route's behaviour runs.
+    value_object "EdgeName" do
+      attribute :value, String, pattern: '\A[A-Za-z][A-Za-z0-9]*\z'
+    end
+
+    # What an `EdgeFunction` row asks the projection to write: `redirect_host` answers a request for
+    # a watched path on an alias host with a redirect to the canonical host and leaves every other
+    # request alone.
+    value_object "EdgeFunctionKind" do
+      attribute :value, String, one_of: ["redirect_host"]
+    end
+
     # The HTTP verbs a route answers.
     value_object "HttpMethod" do
       attribute :value, String, one_of: ["GET", "POST", "PUT", "PATCH", "DELETE"]

data/lib/hecks/tools/oidc_manifests.rb

@@ -6,7 +6,8 @@ require_relative "../tools"
 module Hecks
   module Tools
     # Projects each domain's OIDC client and scope manifest (`Hecks::Projections::OIDC`) into an
-    # `oidc.json` beside the domain.
+    # `oidc.json` beside the domain, or into one `<chapter>.oidc.json` for each chapter of a
+    # directory that holds several.
     #
     # A domain that has no bluebook is skipped and one that cannot be projected is reported, so a
     # sweep over the whole checkout carries on past either. `hecks deploy
@@ -45,20 +46,57 @@ module Hecks
            .uniq.sort
       end
 
+      # Projects one manifest for each chapter the directory holds.
+      #
       # @param root [String] the checkout
       # @param path [String] a domain directory, relative to `root`
       # @return [void]
       def project(root, path)
-        runtime = Hecks.boot(File.join(root, path), install_driving: false)
-        name    = runtime.registry.bluebooks.keys.first
-        return warn("  #{path}: no bluebook found — skipped") unless name
+        registry = Hecks.boot(File.join(root, path), install_driving: false).registry
+        return warn("  #{path}: no bluebook found — skipped") if registry.bluebooks.empty?
 
-        write_manifest(runtime.registry, name, File.join(root, path, "oidc.json"))
-        puts "  #{path}/oidc.json  <-  #{name}"
+        project_chapters(registry, root, path)
       rescue StandardError => e
         warn "  #{path}: cannot project — #{e.message.lines.first.strip}"
       end
 
+      # The chapters a directory declares: those with a `.bluebook` file under it. A chapter it
+      # only attaches (Governance, for one) is loaded from elsewhere and has its own directory's
+      # manifest.
+      #
+      # @param registry [Hecks::Runtime::Registry] the booted registry of the directory
+      # @param directory [String] the directory that was booted
+      # @return [Array<String>] the chapter names, in load order; the first loaded when none has a
+      #   recorded source
+      def chapters_of(registry, directory)
+        under = "#{File.expand_path(directory)}/"
+        own = registry.bluebooks.keys.select do |name|
+          Array(registry.bluebook_sources[name]).any? { |source| File.expand_path(source).start_with?(under) }
+        end
+        own.empty? ? registry.bluebooks.keys.first(1) : own
+      end
+
+      # @param registry [Hecks::Runtime::Registry] the booted registry of the directory
+      # @param root [String] the checkout
+      # @param path [String] the domain directory, relative to `root`
+      # @return [void]
+      def project_chapters(registry, root, path)
+        names = chapters_of(registry, File.join(root, path))
+        names.each do |name|
+          file = file_for(names, name)
+          write_manifest(registry, name, File.join(root, path, file))
+          puts "  #{path}/#{file}  <-  #{name}"
+        end
+      end
+
+      # A domain of one chapter keeps `oidc.json`; a directory of several chapters, such as the
+      # framework members, gets one manifest each, so none of them stands for the others.
+      #
+      # @param names [Array<String>] every chapter the directory holds
+      # @param name [String] the chapter the manifest is for
+      # @return [String] the manifest's file name: `oidc.json`, or `<chapter>.oidc.json`
+      def file_for(names, name) = names.one? ? "oidc.json" : "#{Naming.snake(name)}.oidc.json"
+
       # @param registry [Hecks::Runtime::Registry] the booted registry
       # @param name [String] the bluebook to project
       # @param out [String] where the manifest goes

data/lib/hecks/tools/site_routes/templates.rb

@@ -27,22 +27,19 @@ module Hecks
           regions = Projector.call(:site_cdn, bluebook: site.chapter, options: { table: site.table, edge: edge })
           relative = template || edge.setting.template
           source = template_source(root, template, relative)
-          text = rewritten(File.read(source), regions, relative, edge)
+          text = rewritten(File.read(source), regions, relative)
           { destination(source, out, template, relative) => text }
         end
 
         # @param text [String] the template
         # @param regions [Hash{String => String}] each region's name to the block that goes in it
         # @param relative [String] the template's name, for a message
-        # @param edge [Projections::Site::Edge] the checked edge
         # @return [String] the template with each region rewritten
-        # @raise [SystemExit] when a region is missing, or a listener_rules region is left behind
-        #   by an edge with no load balancer
-        def rewritten(text, regions, relative, edge)
-          if !edge.alb? && Projections::Site::Regions.region?(text, "listener_rules")
-            abort "project_site: #{relative} has a BEGIN/END GENERATED site_cdn listener_rules region, " \
-                  "and the Edge row says alb: false; remove the region"
-          end
+        # @raise [SystemExit] when a region is missing, or a listener_rules or edge_functions region
+        #   is left behind by an edge that has no load balancer or no EdgeFunction row
+        def rewritten(text, regions, relative)
+          refuse_leftover(text, regions, relative, "listener_rules", "the Edge row says alb: false")
+          refuse_leftover(text, regions, relative, "edge_functions", "the project declares no EdgeFunction rows")
           regions.reduce(text) do |current, (name, block)|
             unless Projections::Site::Regions.region?(current, name)
               abort "project_site: #{relative} has no BEGIN/END GENERATED site_cdn #{name} region"
@@ -52,6 +49,13 @@ module Hecks
           end
         end
 
+        # Refuses a region the edge does not use, so the stale text in it is removed by hand.
+        def refuse_leftover(text, regions, relative, name, reason)
+          return if regions.key?(name) || !Projections::Site::Regions.region?(text, name)
+
+          abort "project_site: #{relative} has a BEGIN/END GENERATED site_cdn #{name} region, and #{reason}; remove the region"
+        end
+
         # @return [Hash] nothing, after refusing a template named for a project with no edge
         def missing_edge(template)
           abort "project_site: --template names #{template}, but the project declares no Edge rows" if template

data/lib/hecks/version.rb

@@ -1,5 +1,5 @@
 module Hecks
   # Read directly by the gemspec, so this file must never require the
   # rest of the gem (its dependencies aren't resolved yet at that point).
-  VERSION = "3.12.0".freeze
+  VERSION = "3.13.0".freeze
 end