cypress-on-rails 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc763de97980a2be63d8eac1ca850d9695c7e1778c8678d83cec0de7c8270b37
-  data.tar.gz: 9c830d9c70faebc8aac3891caa6ab3547cdf66fe9c89d3eda131248086ff55a2
+  metadata.gz: 2dc7073afd439183f15dbe8e33fd275ec4ec4121c2640e026ed5d7f80bc2736c
+  data.tar.gz: 2361d555bab1bae7072d8909275669a139b9c2ee255f5f8195660189208591fa
 SHA512:
-  metadata.gz: 88104bb87f1ab6933c17495ff3cbe112a27fc8daa5ee97752eb25e72e46d1ca6e2b54b907857650d49455ca3cb30534e6a6e4d02a6d5f240ddc69ea9d9c5cdac
-  data.tar.gz: 61f547751df2b0500d15b3480732823916a6b3ce0a768cbed696764ec9ddb3853b0d4919e9f2a8249803830b70334f0914c8075d0eb97d84abf68c9835747d1a
+  metadata.gz: 717a48f1352f07b052683ba0699d2806191aed7ebc249e6c0f319af8f2e47d3eb0062787fa6d847ce326afe66325c59859806c9f93f3f95a8276e6aec85d580f
+  data.tar.gz: abee0f60bec8a8eca395b6a621c33c0caa731452f5e253d27b80c967cd7138a992cb29c68fa41bafcddc85a3f02e6767f6a3f5bcf77ffbaad543264c31d5630a

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [1.16.0]
+[Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.15.1...v1.16.0
+
+### Added
+* Add support for `before_request` options on the middleware, for authentication [PR 138](https://github.com/shakacode/cypress-on-rails/pull/138) by [RomainEndelin]
+
+## [1.15.1]
+[Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.15.0...v1.15.1
+
+### Fixed
+* fix cypress_folder deprecation warning by internal code [PR 136](https://github.com/shakacode/cypress-on-rails/pull/136)
+
 ## [1.15.0]
 [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.14.0...v1.15.0
 

data/README.md

@@ -17,7 +17,7 @@ Need help with cypress-on-rails? Contact [ShakaCode](mailto:justin@shakacode.com
 # Totally new to Cypress?
 Suggest you first learn the basics of Cypress before attempting to integrate with Ruby on Rails
 
-* [Good start Here](https://docs.cypress.io/examples/examples/tutorials.html#Best-Practices)
+* [Good start Here](https://docs.cypress.io/examples/tutorials.html#Best-Practices)
 
 # Totally new to Playwright?
 Suggest you first learn the basics of Playwright before attempting to integrate with Ruby on Rails
@@ -395,6 +395,47 @@ describe('My First Test', () => {
 })
 ```
 
+## `before_request` configuration
+
+You may perform any custom action before running a CypressOnRails command, such as authentication, or sending metrics.  Please set `before_request` as part of the CypressOnRails configuration.
+
+You should get familiar with [Rack middlewares](https://www.rubyguides.com/2018/09/rack-middleware/).
+If your function returns a `[status, header, body]` response, CypressOnRails will halt, and your command will not be executed. To execute the command, `before_request` should return `nil`.
+
+### Authenticate CypressOnRails
+
+```ruby
+  CypressOnRails.configure do |c|
+    # ...
+
+    # Refer to https://www.rubydoc.info/gems/rack/Rack/Request for the `request` argument.
+    c.before_request = lambda { |request|
+      body = JSON.parse(request.body.string)
+      if body['cypress_token'] != ENV.fetch('SWEEP_CYPRESS_SECRET_TOKEN')
+        # You may also use warden for authentication:
+        #   if !request.env['warden'].authenticate(:secret_key)
+        return [401, {}, ['unauthorized']]
+      end
+
+    }
+  end
+```
+
+### Send usage metrics
+
+```ruby
+  CypressOnRails.configure do |c|
+    # ...
+
+    # Refer to https://www.rubydoc.info/gems/rack/Rack/Request for the `request` argument.
+    c.before_request = lambda { |request|
+      statsd = Datadog::Statsd.new('localhost', 8125)
+
+      statsd.increment('cypress_on_rails.requests')
+    }
+  end
+```
+
 ## Usage with other rack applications
 
 Add CypressOnRails to your config.ru
@@ -477,6 +518,11 @@ In `config/initializers/cypress_on_rails.rb`, add this line:
     <img alt="ScoutAPM" src="https://user-images.githubusercontent.com/4244251/184881152-9f2d8fba-88ac-4ba6-873b-22387f8711c5.png" height="120px">
   </picture>
 </a>
+<a href="https://controlplane.com">
+  <picture>
+    <img alt="Control Plane" src="https://github.com/shakacode/.github/assets/20628911/90babd87-62c4-4de3-baa4-3d78ef4bec25" height="120px">
+  </picture>
+</a>
 <br />
 <a href="https://www.browserstack.com">
   <picture>

data/lib/cypress_on_rails/command_executor.rb

@@ -15,12 +15,12 @@ module CypressOnRails
 
     def self.load_e2e_helper
       e2e_helper_file = "#{configuration.install_folder}/e2e_helper.rb"
-      cypress_helper_file = "#{configuration.cypress_folder}/cypress_helper.rb"
+      cypress_helper_file = "#{configuration.install_folder}/cypress_helper.rb"
       if File.exist?(e2e_helper_file)
         Kernel.require e2e_helper_file
       elsif File.exist?(cypress_helper_file)
         Kernel.require cypress_helper_file
-        warn "cypress_helper.rb and cypress_folder are deprecated, please use the install generator to create e2e_helper.rb using install_folder"
+        warn "cypress_helper.rb is deprecated, please rename the file to e2e_helper.rb"
       else
         logger.warn "could not find #{e2e_helper_file} nor #{cypress_helper_file}"
       end

data/lib/cypress_on_rails/configuration.rb

@@ -6,6 +6,7 @@ module CypressOnRails
     attr_accessor :install_folder
     attr_accessor :use_middleware
     attr_accessor :use_vcr_middleware
+    attr_accessor :before_request
     attr_accessor :logger
 
     # Attributes for backwards compatibility
@@ -30,6 +31,7 @@ module CypressOnRails
       self.install_folder = 'spec/e2e'
       self.use_middleware = true
       self.use_vcr_middleware = false
+      self.before_request = -> (request) {}
       self.logger = Logger.new(STDOUT)
     end
 

data/lib/cypress_on_rails/middleware.rb

@@ -47,6 +47,10 @@ module CypressOnRails
     end
 
     def handle_command(req)
+      maybe_env = configuration.before_request.call(req)
+      # Halt the middleware if an Rack Env was returned by `before_request`
+      return maybe_env unless maybe_env.nil?
+
       body = JSON.parse(req.body.read)
       logger.info "handle_command: #{body}"
       commands = Command.from_body(body, configuration)

data/lib/cypress_on_rails/version.rb

@@ -1,3 +1,3 @@
 module CypressOnRails
-  VERSION = '1.15.0'.freeze
+  VERSION = '1.16.0'.freeze
 end

data/lib/generators/cypress_on_rails/templates/config/initializers/cypress_on_rails.rb.erb

@@ -7,6 +7,15 @@ if defined?(CypressOnRails)
     c.use_middleware = !Rails.env.production?
     <% unless options.experimental %># <% end %> c.use_vcr_middleware = !Rails.env.production?
     c.logger = Rails.logger
+
+    # If you want to enable a before_request logic, such as authentication, logging, sending metrics, etc.
+    #   Refer to https://www.rubydoc.info/gems/rack/Rack/Request for the `request` argument.
+    #   Return nil to continue through the Cypress command. Return a response [status, header, body] to halt.
+    # c.before_request = lambda { |request|
+    #   unless request.env['warden'].authenticate(:secret_key)
+    #     return [403, {}, ["forbidden"]]
+    #   end
+    # }
   end
 
   # # if you compile your asssets on CI

data/spec/cypress_on_rails/configuration_spec.rb

@@ -8,19 +8,23 @@ RSpec.describe CypressOnRails::Configuration do
     expect(CypressOnRails.configuration.install_folder).to eq('spec/e2e')
     expect(CypressOnRails.configuration.use_middleware?).to eq(true)
     expect(CypressOnRails.configuration.logger).to_not be_nil
+    expect(CypressOnRails.configuration.before_request).to_not be_nil
   end
 
   it 'can be configured' do
     my_logger = Logger.new(STDOUT)
+    before_request_lambda = -> (_) { return [200, {}, ['hello world']] }
     CypressOnRails.configure do |config|
       config.api_prefix = '/api'
       config.install_folder = 'my/path'
       config.use_middleware = false
       config.logger = my_logger
+      config.before_request = before_request_lambda
     end
     expect(CypressOnRails.configuration.api_prefix).to eq('/api')
     expect(CypressOnRails.configuration.install_folder).to eq('my/path')
     expect(CypressOnRails.configuration.use_middleware?).to eq(false)
     expect(CypressOnRails.configuration.logger).to eq(my_logger)
+    expect(CypressOnRails.configuration.before_request).to eq(before_request_lambda)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cypress-on-rails
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.0
 platform: ruby
 authors:
 - miceportal team
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-05 00:00:00.000000000 Z
+date: 2023-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack