cypress-on-rails 1.15.1 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cb0dd8412c42d59d5c687cd911a1a41819296f0fd8c8796e58365620be94897
-  data.tar.gz: 0baeb4e448a0f7e069f0774caadb0829f6ecd710f38ef06942674c2114cd9244
+  metadata.gz: 9c9e7d196e802c6bc10ed4a31fdfc868d92a4f059452e3315fa6c2b525f0ff17
+  data.tar.gz: 7378fe702963ed71a808dcdcf518c60519ef5c0149211b1e7e8692823dbb3796
 SHA512:
-  metadata.gz: 2836bd208f1cb49b4ad0e25c2bd20cfe6b7fcaaac97fa739e7dc10516fb291b0a220a6bab3678f05329c104bf0f596fb4ec8e9fb2f2d28fade4d59299e1c7169
-  data.tar.gz: 783e8a833f7dd2e386b7fa0b245c1ce9c039835a1600e511148f0cb76a584819f5a1a9af88d1681bbd86a8dfefa4a43a389ea871dce18a30224791f0b6e7cd2f
+  metadata.gz: 49c39f927764cab07fd2e1e7dd5c73773a60ce3c515666267fc8602e00b233c0d18f905653df742acb56c16ab594c7c463b13d66e71cde04be5ba785555c3150
+  data.tar.gz: 39701b20ce5fa8024fc9672dd49bbe6f66445d50f45764a22ad18068684595ebb5bd87f6b9a7d031b84df36cb5c705d1f808e056482f11c79247c4b9cd8ccbb4

data/.gitignore

@@ -9,4 +9,5 @@ vendor/bundle
 .vscode
 node_modules
 package-lock.json
-yarn.lock
+yarn.lock
+specs_e2e/server.pid

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## [1.17.0]
+[Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.16.0...v1.17.0
+
+### Changed
+* Removed the update generator and reduced options for install generator [PR 149](https://github.com/shakacode/cypress-on-rails/pull/149)
+
+### Fixed
+* fix update index.js in install generator [PR 147](https://github.com/shakacode/cypress-on-rails/pull/147) by [Judahmeek]
+* Support rails 7.1 by adding content-type header to generated on-rails.js file [PR 148](https://github.com/shakacode/cypress-on-rails/pull/148) by [anark]
+* Rewind body before reading it [PR 150](https://github.com/shakacode/cypress-on-rails/pull/150) 
+
+## [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
 

data/README.md

@@ -61,46 +61,43 @@ Generate the boilerplate code using:
 # by default installs only cypress
 bin/rails g cypress_on_rails:install
 
-# if you have/want a different cypress folder (default is cypress)
-bin/rails g cypress_on_rails:install --cypress_folder=spec/cypress
+# if you have/want a different cypress folder (default is e2e)
+bin/rails g cypress_on_rails:install --install_folder=spec/cypress
 
-# to install both cypress and playwright
-bin/rails g cypress_on_rails:install --install_cypress --install_playwright --playwright_folder=playwright
-
-# to change where the Ruby files reside (default is e2e)
-bin/rails g cypress_on_rails:install --install_folder=test/e2e
+# to install playwright instead of cypress
+bin/rails g cypress_on_rails:install --framework playwright
 
 # if you target the Rails server with a path prefix to your URL
 bin/rails g cypress_on_rails:install --api_prefix=/api
 
-# if you want to install cypress with npm
-bin/rails g cypress_on_rails:install --install_cypress_with=npm
+# if you want to install with npm instead
+bin/rails g cypress_on_rails:install --install_with=npm
 
 # if you already have cypress installed globally
-bin/rails g cypress_on_rails:install --no-install-cypress
+bin/rails g cypress_on_rails:install --install_with=skip
 
 # to update the generated files run
-bin/rails g cypress_on_rails:update
+bin/rails g cypress_on_rails:install --install_with=skip
 ```
 
 The generator modifies/adds the following files/directory in your application:
 * `config/initializers/cypress_on_rails.rb` used to configure Cypress on Rails
-* `spec/cypress/e2e/` contains your cypress tests
-* `spec/playwright/e2e/` contains your playwright tests
-* `spec/cypress/support/on-rails.js` contains Cypress on Rails support code
-* `spec/playwright/support/on-rails.js` contains Playwright on Rails support code
-* `spec/e2e/app_commands/scenarios/` contains your Cypress on Rails scenario definitions
-* `spec/e2e/cypress_helper.rb` contains helper code for Cypress on Rails app commands
+* `e2e/cypress/integration/` contains your cypress tests
+* `e2e/cypress/support/on-rails.js` contains Cypress on Rails support code
+* `e2e/cypress/e2e_helper.rb` contains helper code to require libraries like factory_bot
+* `e2e/cypress/app_commands/` contains your scenario definitions
+* `e2e/playwright/e2e/` contains your playwright tests
+* `e2e/playwright/support/on-rails.js` contains Playwright on Rails support code
 
-If you are not using `database_cleaner` look at `spec/e2e/app_commands/clean.rb`.
-If you are not using `factory_bot` look at `spec/e2e/app_commands/factory_bot.rb`.
+If you are not using `database_cleaner` look at `e2e/cypress/app_commands/clean.rb`.
+If you are not using `factory_bot` look at `e2e/cypress/app_commands/factory_bot.rb`.
 
 Now you can create scenarios and commands that are plain Ruby files that get loaded through middleware, the ruby sky is your limit.
 
 ### Update your database.yml
 
-When running `cypress test` or `playwright test` on your local computer it's recommended to start your server in development mode so that changes you
-make are picked up without having to restart the server.
+When writing and running tests on your local computer it's recommended to start your server in development mode so that changes you
+make are picked up without having to restart your local server.
 It's recommended you update your `database.yml` to check if the `CYPRESS` environment variable is set and switch it to the test database
 otherwise cypress will keep clearing your development database.
 
@@ -127,11 +124,9 @@ Getting started on your local environment
 CYPRESS=1 bin/rails server -p 5017
 
 # in separate window start cypress
-yarn cypress open
+yarn cypress open --project ./e2e
 # or for npm
-node_modules/.bin/cypress open
-# or if you changed the cypress folder to spec/cypress
-yarn cypress open --project ./spec
+npx cypress open --project ./e2e
 # or for playwright
 yarn playwright test --ui
 # or using npm
@@ -144,9 +139,9 @@ How to run cypress on CI
 # setup rails and start server in background
 # ...
 
-yarn run cypress run
+yarn run cypress run --project ./e2e
 # or for npm
-npx cypress run
+npx cypress run --project ./e2e
 ```
 
 ### Example of using factory bot
@@ -395,6 +390,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
@@ -422,6 +458,9 @@ Cypress.Commands.add('appCommands', (body) => {
     method: 'POST',
     url: '/__cypress__/command',
     body: JSON.stringify(body),
+    headers: {
+      'Content-Type': 'application/json; charset=utf-8',
+    },
     log: true,
     failOnStatusCode: true
   })
@@ -477,6 +516,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/cypress-on-rails.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'railties', '>= 3.2'
-  s.add_development_dependency 'factory_bot'
+  s.add_development_dependency 'factory_bot', '!= 6.4.5'
   s.add_development_dependency 'vcr'
   s.metadata = {
     "bug_tracker_uri"   => "https://github.com/shakacode/cypress-on-rails/issues",

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,11 @@ 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?
+
+      req.body.rewind
       body = JSON.parse(req.body.read)
       logger.info "handle_command: #{body}"
       commands = Command.from_body(body, configuration)

data/lib/cypress_on_rails/simple_rails_factory.rb

@@ -1,5 +1,3 @@
-require 'active_support/core_ext/string'
-
 module CypressOnRails
   module SimpleRailsFactory
     def self.create(type, *params)

data/lib/cypress_on_rails/version.rb

@@ -1,3 +1,3 @@
 module CypressOnRails
-  VERSION = '1.15.1'.freeze
+  VERSION = '1.17.0'.freeze
 end

data/lib/generators/cypress_on_rails/install_generator.rb

@@ -1,12 +1,9 @@
 module CypressOnRails
   class InstallGenerator < Rails::Generators::Base
     class_option :api_prefix, type: :string, default: ''
+    class_option :framework, type: :string, default: 'cypress'
     class_option :install_folder, type: :string, default: 'e2e'
-    class_option :install_cypress, type: :boolean, default: true
-    class_option :install_playwright, type: :boolean, default: false
     class_option :install_with, type: :string, default: 'yarn'
-    class_option :cypress_folder, type: :string, default: 'cypress'
-    class_option :playwright_folder, type: :string, default: 'playwright'
     class_option :experimental, type: :boolean, default: false
     source_root File.expand_path('../templates', __FILE__)
 
@@ -17,10 +14,11 @@ module CypressOnRails
 
       command = nil
       packages = []
-
-      packages << 'cypress' if options.install_cypress
-      packages.push('playwright', '@playwright/test') if options.install_playwright
-
+      packages = if options.framework == 'cypress'
+                   ['cypress', 'cypress-on-rails']
+                 elsif options.framework == 'playwright'
+                   ['playwright', '@playwright/test']
+                 end
       if options.install_with == 'yarn'
         command = "yarn --cwd=#{install_dir} add #{packages.join(' ')} --dev"
       elsif options.install_with == 'npm'
@@ -31,38 +29,42 @@ module CypressOnRails
         fail "failed to install #{packages.join(' ')}" unless system(command)
       end
 
-      if options.install_cypress
-        template "spec/cypress/support/index.js.erb", "#{options.cypress_folder}/support/index.js"
-        copy_file "spec/cypress/support/commands.js", "#{options.cypress_folder}/support/commands.js"
-        copy_file "spec/cypress.config.js", "#{options.cypress_folder}/../cypress.config.js"
+      if options.framework == 'cypress'
+        template "spec/cypress/support/index.js.erb", "#{options.install_folder}/cypress/support/index.js"
+        copy_file "spec/cypress/support/commands.js", "#{options.install_folder}/cypress/support/commands.js"
+        copy_file "spec/cypress.config.js", "#{options.install_folder}/cypress.config.js"
       end
-      if options.install_playwright
-        template "spec/playwright/support/index.js.erb", "#{options.playwright_folder}/support/index.js"
-        copy_file "spec/playwright.config.js", "#{options.playwright_folder}/../playwright.config.js"
+      if options.framework == 'playwright'
+        template "spec/playwright/support/index.js.erb", "#{options.install_folder}/playwright/support/index.js"
+        copy_file "spec/playwright.config.js", "#{options.install_folder}/playwright.config.js"
       end
     end
 
     def add_initial_files
       template "config/initializers/cypress_on_rails.rb.erb", "config/initializers/cypress_on_rails.rb"
-      template "spec/e2e/e2e_helper.rb.erb", "#{options.install_folder}/e2e_helper.rb"
-      directory 'spec/e2e/app_commands', "#{options.install_folder}/app_commands"
-      if options.install_cypress
-        copy_file "spec/cypress/support/on-rails.js", "#{options.cypress_folder}/support/on-rails.js"
-        directory 'spec/cypress/e2e/rails_examples', "#{options.cypress_folder}/e2e/rails_examples"
+      template "spec/e2e/e2e_helper.rb.erb", "#{options.install_folder}/#{options.framework}/e2e_helper.rb"
+      directory 'spec/e2e/app_commands', "#{options.install_folder}/#{options.framework}/app_commands"
+      if options.framework == 'cypress'
+        copy_file "spec/cypress/support/on-rails.js", "#{options.install_folder}/cypress/support/on-rails.js"
+        directory 'spec/cypress/e2e/rails_examples', "#{options.install_folder}/cypress/e2e/rails_examples"
       end
-      if options.install_playwright
-        copy_file "spec/playwright/support/on-rails.js", "#{options.playwright_folder}/support/on-rails.js"
-        directory 'spec/playwright/e2e/rails_examples', "#{options.playwright_folder}/e2e/rails_examples"
+      if options.framework == 'playwright'
+        copy_file "spec/playwright/support/on-rails.js", "#{options.install_folder}/playwright/support/on-rails.js"
+        directory 'spec/playwright/e2e/rails_examples', "#{options.install_folder}/playwright/e2e/rails_examples"
       end
     end
 
     def update_files
-      append_to_file "#{options.cypress_folder}/support/index.js",
-                     "\nimport './on-rails'",
-                     after: 'import \'./commands\''
-      append_to_file "#{options.playwright_folder}/support/index.js",
-                     "\nimport './on-rails'",
-                     after: '// Import commands.js using ES2015 syntax:'
+      if options.framework == 'cypress'
+        append_to_file "#{options.install_folder}/cypress/support/index.js",
+                       "\nimport './on-rails'",
+                       after: 'import \'./commands\''
+      end
+      if options.framework == 'playwright'
+        append_to_file "#{options.install_folder}/playwright/support/index.js",
+                       "\nimport './on-rails'",
+                       after: '// Import commands.js using ES2015 syntax:'
+      end
     end
   end
 end

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

@@ -1,12 +1,21 @@
 if defined?(CypressOnRails)
   CypressOnRails.configure do |c|
     c.api_prefix = "<%= options.api_prefix %>"
-    c.install_folder = File.expand_path("#{__dir__}/../../<%= options.install_folder %>")
+    c.install_folder = File.expand_path("#{__dir__}/../../<%= options.install_folder %>/<%= options.framework %>")
     # WARNING!! CypressOnRails can execute arbitrary ruby code
     # please use with extra caution if enabling on hosted servers or starting your local server on 0.0.0.0
     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/lib/generators/cypress_on_rails/templates/spec/cypress/support/on-rails.js

@@ -6,6 +6,9 @@ Cypress.Commands.add('appCommands', function (body) {
     method: 'POST',
     url: "/__e2e__/command",
     body: JSON.stringify(body),
+    headers: {
+      'Content-Type': 'application/json',
+    },
     log: false,
     failOnStatusCode: false
   }).then((response) => {
@@ -52,6 +55,9 @@ Cypress.on('fail', (err, runnable) => {
   Cypress.$.ajax({
     url: '/__e2e__/command',
     data: JSON.stringify({name: 'log_fail', options: {error_message: err.message, runnable_full_title: runnable.fullTitle() }}),
+    headers: {
+      'Content-Type': 'application/json',
+    },
     async: false,
     method: 'POST'
   });

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

data/specs_e2e/rails_3_2/test.sh

@@ -10,19 +10,20 @@ export BUNDLE_GEMFILE="$DIR/Gemfile"
 cd $DIR
 
 echo '-- bundle install'
-bundle --version
-bundle install --quiet --gemfile="$DIR/Gemfile" --retry 2 --path vendor/bundle
+gem install bundler -v '1.0.22'
+bundle _1.0.22_ --version
+bundle _1.0.22_ install --quiet --gemfile="$DIR/Gemfile" --path vendor/bundle
 
 echo '-- cypress install'
-bundle exec ./bin/rails g cypress_on_rails:install --install_cypress --install_playwright --install_with=npm
+bundle exec ./bin/rails g cypress_on_rails:install --install_with=npm --install_folder="." --force
 rm -vf cypress/e2e/rails_examples/advance_factory_bot.cy.js
 rm -vf cypress/e2e/rails_examples/using_vcr.cy.js
 
 echo '-- start rails server'
 # make sure the server is not running
-(kill -9 `cat tmp/pids/server.pid` || true )
+(kill -9 `cat ../server.pid` || true )
 
-bundle exec ./bin/rails server -p 5017 -e test &
+bundle exec ./bin/rails server -p 5017 -e test -P ../server.pid &
 sleep 2 # give rails a chance to start up correctly
 
 echo '-- cypress run'
@@ -31,13 +32,19 @@ cp -fv ../cypress.config.js .
 # then
 #     node_modules/.bin/cypress run
 # else
-    node_modules/.bin/cypress run --record
+    npx cypress run --record
 # fi
 
+echo '-- playwright install'
+bundle exec ./bin/rails g cypress_on_rails:install --framework playwright --install_with=npm --install_folder="." --force
+rm -vf playwright/e2e/rails_examples/advance_factory_bot.cy.js
+rm -vf playwright/e2e/rails_examples/using_vcr.cy.js
+
 echo '-- playwright run'
 cp -fv ../playwright.config.js .
 npx playwright install-deps
+npx playwright install
 npx playwright test playwright/e2e/
 
 echo '-- stop rails server'
-kill -9 `cat tmp/pids/server.pid`
+kill -9 `cat ../server.pid` || true

data/specs_e2e/rails_4_2/.gitignore

@@ -4,6 +4,7 @@ spec/cypress.config.js
 spec/package.json
 spec/yarn.lock
 spec/cypress
+spec/app_commands
 config/initializers/cypress_on_rails.rb
 vendor/bundle
 tmp/pids

data/specs_e2e/rails_4_2/package.json

@@ -4,7 +4,9 @@
   "main": "index.js",
   "license": "MIT",
   "devDependencies": {
-    "cypress": "^10.0.2",
-    "cypress-on-rails": "file:../../plugin"
+    "@playwright/test": "^1.40.1",
+    "cypress": "^10.11.0",
+    "cypress-on-rails": "file:../../plugin",
+    "playwright": "^1.40.1"
   }
 }