Run the initial upgrade of the codebase

[briri]

• Compare config after the upgrade to the demo Rails5 app
• Document any diffs and share with the team, especially new files like master.key and credentials.yml.enc
• Edit Gemfile and yarn.lock to unpeg dependencies and set new Ruby version.
• Update the application.rb and environment files
  • Changed config.server_static_files to config.public_file_server.enabled
  • Changed config.static_cache_control to config.public_file_server.headers
• Update any scripts or files that contain a rake command to use rails instead. For example use rails test instead of rake test
• Clean up routes.rb
  • Replace use of :controller and :action with the controller#action string
• DCC make sure you are on Postgres > 9.1! (Update our README and wiki to reflect this!)

[mariapraetzellis]

Estimating 3+ days of work.

[briri]

Work will be done in the rails5 branch which will be kept up to date with the changes made to the development branch for our remaining tickets this sprint.

[briri]

Here's a list of the things done to get from 4.2 to 5.0

• Ran bundle exec rake rails:update and diff changes to config files, splicing in any changes necessary
• Added new ApplicationRecord base Model class and updated all models to inherit from it instead of directly from ActiveRecord::Base. Added some of the generic include statements to this new base class
• Added the app/jobs folder and the new ApplicationJob base class
• Added a [4.2] to all existing ActiveRecord::Migrations
• Added gem 'rails-controller-testing' to support our use of :assigns in controller tests
• Removed RDoc config from Rakefile, Gavin had left a note to drop this in favor Yard Docs
• Updated Fastgettext configuration to move definition of text_domain to top because consolidation of VALIDATION_MESSAGES to the new ApplicationRecord
• Needed to replace all before_filter callbacks in controllers with before_action
• Updated paginable controller so that it uses using strong params

[briri]

Here are a list of tasks done to get from 5.0 to 5.2 (including the step to 5.1):

• Updated the Gemfile to unpeg all gems and bumped rails to 5.2. Then ran bundle update
• Converted use of ::HashWithIndifferentAccess to ActiveSupport::HashWithIndifferentAccess
• Ran rake app:update add diffed changes to splice our custom config back in
• Consolidated old config/initializers/constants.rb and branding.yml.sample into config/initializers/dmproadmap.rb to group them all together (and get them out of the base Rails config) and to use the newer Rails.configuration.x. format
• Added the Bootsnap gem which should improve application performance
• Ran bundle exec rails app:update:bin to regenerate all of the binstubs
• Ran bundle exec rails db:schema:dump to rebuild the schema.rb file
• Added optional: true to Region -> Super Region, Phase -> Plan, Section -> Org relationships just to get the db/seeds.rb working to run tests
• Moved Locale classes from lib/ into a app/services/locale_service.rb file and updated FastGettext initializer which was having trouble initializing after the upgrade.

NOTE Cookie serialization has changed in Rails 5.2. This will cause issues for uses that have cookies that have not expired when then go to the newly upgrade site. We should be able to deal with this through messaging to the user community.

[briri]

Next steps:

Ensure all tests are running. It looks like we will need to add optional: true to many of the belongs_to rellationships

[briri]

Ran through and got all but 2 tests passing. Needed to make the following adjustments:

• Updated requests and controller tests. Rspec switched to named arguments for http requests. (e.g. went from get :index, org: { id: 123 } to get :index, params: { org: { id: 123 } }
• Updated several other models to use optional: true on belongs_to relationships
• Updated ApplicationController to not use hash_with_indifferent_access since Request params are no longer a Hash and allow both string and symbol access
• Updated en-GB get text to remove #fuzzy lines so that warning messages stopped appearing in rspec output
• Added callbacks to User and Org to default the language before saving
• Updated Template latest? method to specify which ':id' to pluck
• Fixed a few mocha Deprecation warnings in model tests
• Had to update the Plan guidance_group_options scope because uniq returns an Array not an ActiveRecord Relation so switch to use distinct
• Fixed User model so that it no longer bothers with the other_organisation text field and instead deals with the Org relationship in the callbacks
• Updated controller to use the newer redirect_back method instead of the now defunct redirect_to :back
• Had to update use of each_key method on strong params to keys.each in QuestionsController since Params is no longer a Hash
• Had to update a couple of pluck calls on scopes to specify the table. (e.g. user.org.plans.pluck(:id) to user.org.plans.pluck("plans.id")

[briri]

NOTE: that the way Rails handles app credentials has changed in 5.2. There is no longer a config/secrets.yml file. It has been replaced by a config/credentials.yml.enc file and a config/master.key file.

Everyone should read this blog post: https://medium.com/cedarcode/rails-5-2-credentials-9b3324851336

We can check in the defaultcredentials.yml.enc generated for this open source project. We will need to update all of our individual deployment strategies to use our own copies of both files.

To generate these files in your own instances, you will need to run EDITOR=vim rails credentials:edit (swap in your favorite editor)