Merge pull request #1824 from shakacode/merge-pro-subtree-with-ci

Phase 2: Merge react_on_rails_pro repository via git subtree with complete history preservation

Author: AbanoubGhadban

.circleci/config.yml

@@ -0,0 +1,376 @@
+version: 2
+
+# Monorepo CircleCI config for React on Rails Pro package
+# Updated to work from root directory with pro package in react_on_rails_pro/
+
+aliases:
+ # Print critical data and executables versions.
+ - &print-system-info
+ name: Print system information
+ command: |
+ echo "Linux release: "; cat /etc/issue
+ echo "Current user: "; whoami
+ echo "Current directory: "; pwd
+ echo "Ruby version: "; ruby -v
+ echo "Node version: "; node -v
+ echo "Yarn version: "; yarn --version
+ echo "Bundler version: "; bundle --version
+ - &lint-js
+ name: Linting of JS (Pro package only)
+ working_directory: react_on_rails_pro
+ command: yarn run nps eslint
+
+ - &lint-ruby
+ name: Linting of Ruby (Pro package only)
+ working_directory: react_on_rails_pro
+ command: bundle exec rubocop
+
+ - &format
+ name: Check formatting (Pro package only)
+ working_directory: react_on_rails_pro
+ command: yarn run nps format.listDifferent
+
+ - &typescript-check
+ name: Check TypeScript (Pro package only)
+ working_directory: react_on_rails_pro
+ command: yarn run nps check-typescript
+
+ # Install/update Node modules for renderer package unless existing set of modules is satisfying Yarn.
+ - &install-package-node-modules
+ name: Install Node modules with Yarn for pro renderer package
+ working_directory: react_on_rails_pro
+ command: |
+ sudo yarn global add yalc
+ yarn install --frozen-lockfile --no-progress --no-emoji
+
+ # Install/update Node modules for dummy app unless existing set of modules is satisfying Yarn.
+ - &install-dummy-app-node-modules
+ name: Install Node modules with Yarn for pro dummy app
+ working_directory: react_on_rails_pro
+ command: |
+ cd spec/dummy
+ yarn install --frozen-lockfile --no-progress --no-emoji
+
+ # Install ruby gems unless existing set of gems is satisfying bundler.
+ - &install-dummy-app-ruby-gems
+ name: Install Ruby Gems for pro dummy app
+ working_directory: react_on_rails_pro
+ command: |
+ gem install bundler -v "2.5.4"
+ echo "Bundler version: "; bundle --version
+ bundle config set --local path 'vendor/bundle'
+ bundle config set --local disable_checksum_validation true
+ cd spec/dummy && bundle lock --add-platform 'x86_64-linux' && bundle _2.5.4_ check || bundle _2.5.4_ install --jobs=4 --retry=3
+
+ - &generate-dummy-app-packs
+ name: Generate file-system based entrypoints (Pro)
+ working_directory: react_on_rails_pro
+ command: |
+ cd spec/dummy
+ bundle exec rake react_on_rails:generate_packs
+
+ # Install ruby gems unless existing set of gems is satisfying bundler.
+ - &install-package-ruby-gems
+ name: Install Ruby Gems for pro package
+ working_directory: react_on_rails_pro
+ command: |
+ gem install bundler -v "2.5.4"
+ echo "Bundler version: "; bundle --version
+ bundle config set --local path 'vendor/bundle'
+ bundle config set --local disable_checksum_validation true
+ bundle _2.5.4_ check || bundle _2.5.4_ install --jobs=4 --retry=3
+
+ # Restore node_modules dir from cache using yarn.lock checksum as a key.
+ - &restore-package-node-modules-cache
+ name: Restore cached node_modules directory (Pro)
+ keys:
+ - v4-pro-package-node-modules-cache-{{ checksum "react_on_rails_pro/yarn.lock" }}
+
+ # Restore spec/dummy/node_modules dir from cache using yarn.lock checksum as a key.
+ - &restore-dummy-app-node-modules-cache
+ name: Restore cached spec/dummy/node_modules directory (Pro)
+ keys:
+ - v4-pro-dummy-app-node-modules-cache-{{ checksum "react_on_rails_pro/spec/dummy/yarn.lock" }}
+
+ # Restore vendor/bundle dir from cache using Gemfile.lock checksum as a key.
+ - &restore-dummy-app-gem-cache
+ name: Restore cached Ruby Gems for pro dummy app
+ keys:
+ - v4-pro-dummy-app-gem-cache-{{ checksum "react_on_rails_pro/spec/dummy/Gemfile.lock" }}
+
+ # Restore vendor/bundle dir from cache using react_on_rails_pro.gemspec checksum as a key.
+ - &restore-package-gem-cache
+ name: Restore cached Ruby Gems for pro package
+ keys:
+ - v4-pro-package-app-gem-cache-{{ checksum "react_on_rails_pro/react_on_rails_pro.gemspec" }}
+
+ # Restore webpack bundles for dummy app from cache
+ - &restore-dummy-app-webpack-bundle-cache
+ name: Restore cached webpack bundles for pro dummy app
+ key: v4-pro-dummy-app-webpack-bundle-{{ .Revision }}
+
+ # NOTE: Sometimes CI generated docker images are not updated in time to keep up with the minimum required
+ # by chromedriver versions of Chrome. Just bump here Chrome version if chromedriver raises errors
+ - &install-latest-chrome
+ name: Ensure minimum required Chrome version
+ command: |
+ echo -e "Installed $(google-chrome --version)\n"
+ MINIMUM_REQUIRED_CHROME_VERSION=75
+ INSTALLED_CHROME_MAJOR_VERSION="$(google-chrome --version | tr ' .' '\t' | cut -f3)"
+ if [[ $INSTALLED_CHROME_MAJOR_VERSION < $MINIMUM_REQUIRED_CHROME_VERSION ]]; then
+ wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
+ sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
+ sudo apt-get update
+ sudo apt-get install google-chrome-stable
+ echo -e "\nInstalled $(google-chrome --version)"
+ fi
+
+jobs:
+ # Lint all
+ lint-js-and-ruby:
+ docker:
+ - image: &docker_image cimg/ruby:3.3.7-browsers
+ steps:
+ - checkout
+ - run: *print-system-info
+ - restore_cache: *restore-package-node-modules-cache
+ - restore_cache: *restore-package-gem-cache
+ - restore_cache: *restore-dummy-app-node-modules-cache
+ - run: *install-package-ruby-gems
+ - run: *install-package-node-modules
+ - run: *install-dummy-app-ruby-gems
+ - run: *install-dummy-app-node-modules
+ - run:
+ name: Install Node modules with Yarn for ExecJS dummy app (Pro)
+ working_directory: react_on_rails_pro
+ command: |
+ cd spec/execjs-compatible-dummy
+ yarn install --frozen-lockfile --no-progress --no-emoji
+ - run: *generate-dummy-app-packs
+ - run: *lint-ruby
+ - run: *lint-js
+ - run: *format
+ - run: *typescript-check
+
+ # Install Node modules for Renderer package with Yarn and save them to cache.
+ install-package-node-packages:
+ docker:
+ - image: *docker_image
+ steps:
+ - checkout
+ - run: *print-system-info
+ - restore_cache: *restore-package-node-modules-cache
+ - run: *install-package-node-modules
+ - save_cache:
+ name: Save pro root node_modules to cache
+ key: v4-pro-package-node-modules-cache-{{ checksum "react_on_rails_pro/yarn.lock" }}
+ paths:
+ - react_on_rails_pro/node_modules
+
+ # Install Node modules for dummy app with Yarn and save them to cache.
+ install-dummy-app-node-packages:
+ docker:
+ - image: *docker_image
+ steps:
+ - checkout
+ - run: *print-system-info
+ - restore_cache: *restore-dummy-app-node-modules-cache
+ - run: *install-package-node-modules
+ - run: *install-dummy-app-node-modules
+ - save_cache:
+ name: Save pro spec/dummy/node_modules to cache
+ key: v4-pro-dummy-app-node-modules-cache-{{ checksum "react_on_rails_pro/spec/dummy/yarn.lock" }}
+ paths:
+ - react_on_rails_pro/spec/dummy/node_modules
+
+ # Install Ruby gems for package with Bundler and save them to cache.
+ install-package-ruby-gems:
+ docker:
+ - image: *docker_image
+ steps:
+ - checkout
+ - run: *print-system-info
+ - restore_cache: *restore-package-gem-cache
+ - run: *install-package-ruby-gems
+ - save_cache:
+ name: Save pro package ruby gems to cache
+ key: v4-pro-package-app-gem-cache-{{ checksum "react_on_rails_pro/react_on_rails_pro.gemspec" }}
+ paths:
+ - react_on_rails_pro/vendor/bundle
+
+ # Install Ruby gems for dummy app with Bundler and save them to cache.
+ install-dummy-app-ruby-gems:
+ docker:
+ - image: *docker_image
+ steps:
+ - checkout
+ - run: *print-system-info
+ - restore_cache: *restore-dummy-app-gem-cache
+ - run: *install-dummy-app-ruby-gems
+ - save_cache:
+ name: Save pro dummy app ruby gems to cache
+ key: v4-pro-dummy-app-gem-cache-{{ checksum "react_on_rails_pro/spec/dummy/Gemfile.lock" }}
+ paths:
+ - react_on_rails_pro/spec/dummy/vendor/bundle
+
+ # Build client and server bundles for dummy app with Webpack and save them to cache.
+ # NOTE: keeping around this cache in case we have multiple rspec suites in the future to tests
+ # different node renderers.
+ build-dummy-app-webpack-test-bundles:
+ docker:
+ - image: *docker_image
+ steps:
+ - checkout
+ - run: *print-system-info
+ - restore_cache: *restore-package-node-modules-cache
+ - restore_cache: *restore-dummy-app-node-modules-cache
+ - restore_cache: *restore-dummy-app-gem-cache
+ - run: *install-package-node-modules
+ - run: *install-dummy-app-node-modules
+ - run: *install-dummy-app-ruby-gems
+ - run: *generate-dummy-app-packs
+ - run:
+ name: Build test bundles for pro dummy app
+ working_directory: react_on_rails_pro
+ command: cd spec/dummy && yarn run build:test
+ - save_cache:
+ name: Save test webpack bundles to cache (for build number checksum used by rspec job)
+ key: v4-pro-dummy-app-webpack-bundle-{{ .Revision }}
+ paths:
+ - react_on_rails_pro/spec/dummy/public/webpack/test
+ - react_on_rails_pro/spec/dummy/ssr-generated
+
+ # Run JS unit tests for Renderer package.
+ package-js-tests:
+ docker:
+ - image: *docker_image
+ steps:
+ - checkout
+ - run: *print-system-info
+ - restore_cache: *restore-package-node-modules-cache
+ - run: rm -rf react_on_rails_pro/spec/dummy/public/webpack
+ - run: rm -rf react_on_rails_pro/spec/dummy/ssr-generated
+ - restore_cache: *restore-dummy-app-webpack-bundle-cache
+ - run: *install-package-node-modules
+ # https://circleci.com/docs/collect-test-data/#jest
+ - run:
+ name: Run JS unit tests for Pro Renderer package
+ working_directory: react_on_rails_pro
+ command: yarn run nps test.ci
+ environment:
+ JEST_JUNIT_OUTPUT_DIR: ./jest
+ JEST_JUNIT_ADD_FILE_ATTRIBUTE: "true"
+ - store_test_results:
+ path: ./jest
+
+ rspec-package-specs:
+ docker:
+ - image: *docker_image
+ steps:
+ - checkout
+ - run: *print-system-info
+ - restore_cache: *restore-package-gem-cache
+ - run: *install-package-ruby-gems
+ - run:
+ name: Run rspec tests (Pro package)
+ working_directory: react_on_rails_pro
+ command: |
+ bundle exec rspec spec/react_on_rails_pro
+ - store_test_results:
+ path: ~/rspec
+ - store_artifacts:
+ path: react_on_rails_pro/log/test.log
+
+ # Start Renderer and run RSpec test suite for dummy app.
+ # NOTES:
+ # Seems that we cannot use symlinks (yarn link) with caches for the main renderer package
+ # react-on-rails-pro-node-renderer. Consequently, we just reinstall the top level, renderer, node packages
+ # as well as the
+ rspec-dummy-app-node-renderer:
+ docker:
+ - image: *docker_image
+ steps:
+ - checkout
+ - run: *print-system-info
+ - restore_cache: *restore-package-gem-cache
+ - restore_cache: *restore-package-node-modules-cache
+ - restore_cache: *restore-dummy-app-node-modules-cache
+ - restore_cache: *restore-dummy-app-gem-cache
+ - run: rm -rf react_on_rails_pro/spec/dummy/public/webpack
+ - run: rm -rf react_on_rails_pro/spec/dummy/ssr-generated
+ - restore_cache: *restore-dummy-app-webpack-bundle-cache
+ - run: *install-dummy-app-ruby-gems
+ - run: *install-package-node-modules
+ - run: *install-latest-chrome
+ - run: *install-dummy-app-node-modules
+ - run:
+ name: Generate file-system based entrypoints (Pro)
+ working_directory: react_on_rails_pro
+ command: cd spec/dummy && bundle exec rake react_on_rails:generate_packs
+ - run:
+ name: Run Pro Node renderer in a background
+ working_directory: react_on_rails_pro
+ command: cd spec/dummy && yarn run node-renderer
+ background: true
+ - run:
+ name: run rails server in background (Pro dummy app)
+ working_directory: react_on_rails_pro
+ command: cd spec/dummy && RAILS_ENV=test rails server
+ background: true
+ - run:
+ name: wait for rails server to start
+ command: |
+ while ! curl -s http://localhost:3000 > /dev/null; do sleep 1; done
+ - run:
+ name: Run rspec tests (Pro dummy app)
+ working_directory: react_on_rails_pro/spec/dummy
+ command: |
+ circleci tests glob "spec/**/*_spec.rb" |
+ circleci tests run --command="xargs bundle exec rspec \
+ --profile 10 \
+ --format progress \
+ --format RspecJunitFormatter \
+ --out ~/rspec/rspec.xml \
+ --format documentation" \
+ --verbose \
+ --split-by=timings
+ - store_test_results:
+ path: ~/rspec
+ - store_artifacts:
+ path: react_on_rails_pro/spec/dummy/tmp/screenshots
+ - store_artifacts:
+ path: react_on_rails_pro/spec/dummy/log/test.log
+ - store_artifacts:
+ path: react_on_rails_pro/spec/dummy/yarn-error.log
+
+workflows:
+ version: 2
+ build-and-test:
+ jobs:
+ - install-package-node-packages
+ - install-package-ruby-gems
+ - install-dummy-app-node-packages:
+ requires:
+ - install-package-node-packages
+ - install-dummy-app-ruby-gems
+ - lint-js-and-ruby:
+ requires:
+ - install-package-node-packages
+ - install-package-ruby-gems
+ - install-dummy-app-node-packages
+ - build-dummy-app-webpack-test-bundles:
+ requires:
+ - install-package-node-packages
+ - install-dummy-app-node-packages
+ - install-dummy-app-ruby-gems
+ - package-js-tests:
+ requires:
+ - install-package-node-packages
+ - build-dummy-app-webpack-test-bundles
+ - rspec-package-specs:
+ requires:
+ - install-package-ruby-gems
+ - rspec-dummy-app-node-renderer:
+ requires:
+ - install-package-ruby-gems
+ - build-dummy-app-webpack-test-bundles

.prettierignore

@@ -1,5 +1,7 @@
 node_modules/
 package.json
+# Exclude pro package (has its own formatting)
+react_on_rails_pro/
 tmp/
 coverage/
 **/app/assets/webpack/

.rubocop.yml

@@ -28,6 +28,7 @@ AllCops:
  - 'coverage/**/*'
  - 'gen-examples/examples/**/*'
  - 'node_modules/**/*'
+ - 'react_on_rails_pro/**/*' # Exclude pro package (has its own linting)
  - 'spec/dummy/bin/*'
  - 'spec/fixtures/**/*'
  - 'spec/react_on_rails/dummy-for-generators/**/*'