Merge pull request #2 from mondaycom/feature/add-policy

Add @Policy directive support

Author: arutkowski00

.bundle/config

@@ -0,0 +1,3 @@
+---
+BUNDLE_BUILD__JARO_WINKLER: "--with-cflags=-Wno-error=incompatible-function-pointer-types"
+BUNDLE_BUILD__DEBASE: "--with-cflags=-Wno-error=incompatible-function-pointer-types"

.gitignore

@@ -9,3 +9,5 @@ node_modules/
 .circleci/processed-config.yml
 
 .DS_Store
+
+/.idea

.stignore

@@ -0,0 +1,47 @@
+*.gem
+*.rbc
+.idea
+coverage
+InstalledFiles
+pkg
+spec/reports
+spec/examples.txt
+test/tmp
+test/version_tmp
+tmp
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build
+*.bridgesupport
+build-iPhoneOS
+build-iPhoneSimulator
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+.yardoc
+_yardoc
+
+## Environment normalization:
+vendor/bundle
+lib/bundler/man
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

Gemfile.lock

@@ -47,9 +47,7 @@ GEM
     debase-ruby_core_source (3.2.0)
     diff-lcs (1.5.0)
     erubi (1.12.0)
-    google-protobuf (3.22.2-arm64-darwin)
-    google-protobuf (3.22.2-x86_64-darwin)
-    google-protobuf (3.22.2-x86_64-linux)
+    google-protobuf (3.22.2)
     graphql (2.0.19)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
@@ -58,7 +56,11 @@ GEM
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
+    mini_portile2 (2.8.7)
     minitest (5.18.0)
+    nokogiri (1.14.2)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
     nokogiri (1.14.2-arm64-darwin)
       racc (~> 1.4)
     nokogiri (1.14.2-x86_64-darwin)
@@ -119,6 +121,7 @@ GEM
 PLATFORMS
   arm64-darwin-21
   arm64-darwin-22
+  ruby
   x86_64-darwin-20
   x86_64-darwin-21
   x86_64-darwin-22

README.md

@@ -302,6 +302,20 @@ class User < BaseObject
 end
 ```
 
+### The `@policy` directive (Apollo Federation v2)
+
+[Apollo documentation](https://www.apollographql.com/docs/federation/federated-types/federated-directives/#policy)
+
+Call `policy` within your class definition or pass the `policy:` option to your field definition:
+
+```ruby
+class Product < BaseObject
+  policy policies: [["stock:read"]]
+  field :id, ID, null: false
+  field :inStock, Boolean, null: false, policy: { policies: [["stock:read"]] }
+end
+```
+
 ### Field set syntax
 
 Field sets can be either strings encoded with the Apollo Field Set [syntax]((https://www.apollographql.com/docs/apollo-server/federation/federation-spec/#scalar-_fieldset)) or arrays, hashes and snake case symbols that follow the graphql-ruby conventions:

lib/apollo-federation/enum.rb

@@ -18,6 +18,16 @@ def tag(name:)
       def inaccessible
         add_directive(name: 'inaccessible')
       end
+
+      def policy(policies)
+        add_directive(
+          name: "policy",
+          arguments: [
+            name: 'policies',
+            values: policies,
+          ]
+        )
+      end
     end
   end
 end

lib/apollo-federation/field.rb

@@ -8,7 +8,7 @@ module Field
     include HasDirectives
 
     VERSION_1_DIRECTIVES = %i[external requires provides].freeze
-    VERSION_2_DIRECTIVES = %i[shareable inaccessible override tags].freeze
+    VERSION_2_DIRECTIVES = %i[shareable inaccessible override policy tags].freeze
 
     def initialize(*args, **kwargs, &block)
       add_v1_directives(**kwargs)
@@ -59,7 +59,7 @@ def add_v1_directives(external: nil, requires: nil, provides: nil, **_kwargs)
       nil
     end
 
-    def add_v2_directives(shareable: nil, inaccessible: nil, override: nil, tags: [], **_kwargs)
+    def add_v2_directives(shareable: nil, inaccessible: nil, override: nil, tags: [], policy: nil, **_kwargs)
       if shareable
         add_directive(name: 'shareable')
       end
@@ -78,6 +78,16 @@ def add_v2_directives(shareable: nil, inaccessible: nil, override: nil, tags: []
         )
       end
 
+      if policy
+        add_directive(
+          name: "policy",
+          arguments: [
+            name: 'policies',
+            values: policy[:policies]
+          ]
+        )
+      end
+
       tags.each do |tag|
         add_directive(
           name: 'tag',

lib/apollo-federation/interface.rb

@@ -26,6 +26,16 @@ def tag(name:)
         add_directive(name: 'tag', arguments: [name: 'name', values: name])
       end
 
+      def policy(policies)
+        add_directive(
+          name: "policy",
+          arguments: [
+            name: 'policies',
+            values: policies,
+          ]
+        )
+      end
+
       def key(fields:, camelize: true)
         add_directive(
           name: 'key',

lib/apollo-federation/object.rb

@@ -32,6 +32,16 @@ def tag(name:)
         add_directive(name: 'tag', arguments: [name: 'name', values: name])
       end
 
+      def policy(policies)
+        add_directive(
+          name: "policy",
+          arguments: [
+            name: 'policies',
+            values: policies,
+          ]
+        )
+      end
+
       def key(fields:, camelize: true, resolvable: true)
         arguments = [
           name: 'fields',

lib/apollo-federation/scalar.rb

@@ -18,6 +18,16 @@ def tag(name:)
       def inaccessible
         add_directive(name: 'inaccessible')
       end
+
+      def policy(policies)
+        add_directive(
+          name: "policy",
+          arguments: [
+            name: 'policies',
+            values: policies,
+          ]
+        )
+      end
     end
   end
 end

lib/apollo-federation/schema.rb

@@ -7,7 +7,7 @@
 
 module ApolloFederation
   module Schema
-    IMPORTED_DIRECTIVES = ['inaccessible', 'tag'].freeze
+    IMPORTED_DIRECTIVES = ['inaccessible', 'policy', 'tag'].freeze
 
     def self.included(klass)
       klass.extend(CommonMethods)
@@ -64,7 +64,7 @@ def federation_2_prefix
 
         <<~SCHEMA
           extend schema
-            @link(url: "https://specs.apollo.dev/federation/v2.3"#{federation_namespace}, import: [#{(IMPORTED_DIRECTIVES.map { |directive| "\"@#{directive}\"" }).join(', ')}])
+            @link(url: "https://specs.apollo.dev/federation/v#{federation_version}"#{federation_namespace}, import: [#{(IMPORTED_DIRECTIVES.map { |directive| "\"@#{directive}\"" }).join(', ')}])
 
         SCHEMA
       end

spec/apollo-federation/schema_spec.rb

@@ -15,13 +15,13 @@
       expect(schema.federation_version).to eq('1.0')
     end
 
-    it 'returns the specified version when set to 2.0' do
+    it 'returns the specified version when set to 2.6' do
       schema = Class.new(GraphQL::Schema) do
         include ApolloFederation::Schema
-        federation version: '2.0'
+        federation version: '2.6'
       end
 
-      expect(schema.federation_version).to eq('2.0')
+      expect(schema.federation_version).to eq('2.6')
     end
 
     it 'returns the specified version when set to 2.3' do