apollo_fetch_upload_rails_middleware 0.2.0.alpha → 1.0.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0c45b7a219023f114244d9d561288f5f073823f1
-  data.tar.gz: f8c9bf9b2f05f8b0eec9e9aeb732d84777c76eed
+SHA256:
+  metadata.gz: '0742048ae5b92d8ac9f64f6ac57ea00fba3dcb92265c30e3acaa60f8d466524b'
+  data.tar.gz: 0bf560ea2ea86edc752ddf6431a30a5b9e5602503507a31e605e0dfab7b2548d
 SHA512:
-  metadata.gz: 17fc13fdadcdfcf28f0f1447db947cc4534263f0730f347021717299634bc1949b16c3330b39562761946f30e3322e069e248db19ed39f3c989fcc336bf1afba
-  data.tar.gz: 0e38e114ec355ef32a44dc0fc6cd5aafe671e7af11240b7bd1b2fd8498b72d4cd097d9f0d163a6bafeadbfc6a34473d94d0a554b65eeba53f27ba3c578f4a0f2
+  metadata.gz: e48cd2fe15cb4782ff7f045ef4cea086731e2222c1e634646fe5cb3d0558d64f49dd8f8a56c1875bdbadfa56bfcfcc6b8baafde79e413b213a895a087c88951c
+  data.tar.gz: 4ec7740ee4f13872385f19d7f32d109bb3739718314e2c4d0375a77766a7298d0512fdd335822b0ab96c75d51eb7d20fcc07143c1eb27d0b970f2aac2717e126

data/lib/apollo_fetch_upload_rails_middleware/middleware.rb

@@ -6,68 +6,150 @@ module ApolloFetchUploadRailsMiddleware
 
     def call(env)
       request = Rack::Request.new(env)
-      if request.content_type.try(:start_with?, 'multipart/form-data') && request.params.key?('operations')
+
+      if request.content_type.try(:start_with?, 'multipart/form-data') &&
+         request.params.key?('operations') &&
+         request.params.key?('map')
+
         gql_operations = JSON.parse(request.params['operations'])
-        request.update_param('query', gql_operations['query'])
-        request.update_param('variables', gql_operations['variables'])
-        request.update_param('operationName', gql_operations['operationName'])
-
-        # Gather the param key/value pairs for which the values are File instances (sent as part
-        # of the Form POST from apollo fetch upload client-side middleware,
-        # cf. https://github.com/apollographql/apollo-fetch/blob/master/packages/apollo-fetch-upload/src/index.ts).
-        file_kv_pairs = []
-        request.params.each do |k, v|
-          next unless k.start_with?('variables.') &&
-                      v.is_a?(Hash) &&
-                      v.key?(:tempfile) &&
-                      v[:tempfile].is_a?(Tempfile)
-
-          file_kv_pairs << [k, v]
+        file_to_variables_map = JSON.parse(request.params['map'])
+
+        # Gather file data.
+        file_to_metadata_map = {}
+        file_to_variables_map.each_key do |file_index|
+          file_to_metadata_map[file_index] = validate_file_info(request.params[file_index.to_s])
+        end
+
+        if gql_operations.is_a?(Hash)
+          request.update_param('query', gql_operations['query'])
+          request.update_param('operationName', gql_operations['operationName'])
+          request.update_param(
+            'variables',
+            fill_in_gql_variables(
+              file_to_variables_map,
+              file_to_metadata_map,
+              gql_operations['variables'],
+            ),
+          )
+        elsif gql_operations.is_a?(Array)
+          gql_operations.each_with_index do |gql_operation, idx|
+            gql_operation['variables'] = fill_in_gql_variables(
+              file_to_variables_map,
+              file_to_metadata_map,
+              gql_operation['variables'],
+              batch_index: idx,
+            )
+          end
+
+          # cf. https://github.com/rmosolgo/graphql-ruby/blob/master/
+          # guides/queries/multiplex.md#apollo-query-batching
+          # -> "Apollo sends the params in a _json variable when batching is enabled"
+          request.update_param('_json', gql_operations)
+        else
+          raise 'Invalid JSON in "operations" request param.'
         end
+      end
+
+      @app.call(env)
+    end
+
+    def fill_in_gql_variables(
+      file_to_variables_map,
+      file_to_metadata_map,
+      variables_h,
+      batch_idx: nil
+    )
+      # file_to_variables_map is of type map<int, [string]>, mapping file indices to the GQL variables which
+      # use that file (the author of apollo-upload-client does it this way to support batching more efficiently).
+      #
+      # request.params should have keys of file indices (as strings) mapping to metadata about the file itself, e.g.
+      #
+      #    "0"=> {
+      #      :filename=>"f6765.pdf",
+      #      :type=>"application/pdf",
+      #      :name=>"0",
+      #      :tempfile=>
+      #        <File:/var/folders/cc/fwn8xb8s6jzdg672klspnvg40000gn/T/RackMultipart20180719-18089-y5qrhg.pdf>,
+      #      :head=>
+      #        "Content-Disposition: form-data; name=\"0\"; filename=\"f6765.pdf\"\r\n" +
+      #        "Content-Type: application/pdf\r\n"
+      #    }
+      #
+      # So, what we need to do is go through all of the files, and for each GQL variable which uses that file,
+      # set it (using pathset, set below) to have that File instance.
 
-        variables_wrapper = ActiveSupport::HashWithIndifferentAccess.new(
-          variables: gql_operations['variables'],
-        )
+      variables_wrapper = { variables: variables_h }.with_indifferent_access
 
-        file_kv_pairs.each do |kv_pair|
-          path, file = kv_pair
+      file_to_variables_map.each do |file_index, variable_paths|
+        file_info = file_to_metadata_map[file_index]
 
-          file_info = {
-            name: file[:filename],
-            path: file[:tempfile].path,
-            size: file[:tempfile].size,
-            type: file[:type],
-          }
+        variable_paths.each do |variable_path|
+          variable_path_components = variable_path.split('.')
+
+          unless batch_idx.nil?
+            # We only care about this variable path if it matches the given batch_idx.
+            # Otherwise, it doesn't apply to this operation.
+            variable_path_batch_idx = variable_path_components.shift
+            next unless batch_idx == variable_path_batch_idx
+          end
 
           pathset(
             variables_wrapper,
-            path.split('.'), # path_components
+            variable_path_components,
             file_info,
           )
         end
-
-        request.update_param('variables', variables_wrapper[:variables])
       end
 
-      @app.call(env)
+      variables_wrapper[:variables]
     end
 
     private
 
-    def pathset(h, path_components, val_h)
-      if path_components.blank?
-        h.merge!(val_h)
-        return
+    def pathset(variables_h, path_components, file_info)
+      # Find the immediate parent, and then set file info on parent's field
+      # named path_components.last.
+
+      raise 'Not deep enough' unless path_components.size >= 2
+
+      h_or_a = variables_h
+      while path_components.size > 1
+        path_component = path_components.shift
+        if h_or_a.is_a?(Array)
+          h_or_a = h_or_a[path_component.to_i]
+        elsif h_or_a.is_a?(Hash)
+          h_or_a = h_or_a[path_component]
+        else
+          raise 'Unexpected type in variables path.'
+        end
       end
 
-      curr_path_component = path_components.shift
-      if h.key?(curr_path_component)
-        raise 'Invalid path' unless h[curr_path_component].is_a?(Hash)
+      # Now the last path component is the field we want to set.
+      raise 'Bad path components.' unless path_components.size == 1
+      field_name = path_components.first
+
+      if h_or_a.is_a?(Hash)
+        h_or_a[field_name] = file_info
+      elsif h_or_a.is_a?(Array)
+        h_or_a[field_name.to_i] = file_info
       else
-        h[curr_path_component] = {}
+        raise 'Unexpected type in variables path.'
       end
+    end
+
+    def validate_file_info(file_data)
+      [:filename, :tempfile, :type].each do |k|
+        raise "Missing key '#{k.to_s}' in file data." unless file_data[k].present?
+      end
+
+      raise 'Expected Tempfile in file_data[:tempfile]' unless file_data[:tempfile].is_a?(Tempfile)
 
-      pathset(h[curr_path_component], path_components, val_h)
+      {
+        name: file_data[:filename],
+        path: file_data[:tempfile].path,
+        size: file_data[:tempfile].size,
+        type: file_data[:type],
+      }
     end
   end
 end

data/lib/apollo_fetch_upload_rails_middleware/version.rb

@@ -1,3 +1,3 @@
 module ApolloFetchUploadRailsMiddleware
-  VERSION = '0.2.0.alpha'.freeze
+  VERSION = '1.0.0.alpha'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apollo_fetch_upload_rails_middleware
 version: !ruby/object:Gem::Version
-  version: 0.2.0.alpha
+  version: 1.0.0.alpha
 platform: ruby
 authors:
 - Abe Land
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-24 00:00:00.000000000 Z
+date: 2018-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Rails middleware for using the apollo-fetch-upload npm package on the client.