marsbased / pathfinder-rails Goto Github PK

https://github.com/jmhobbs/terminal-parrot

😄 😄 😄 😄 😄

Problem

There are several helpers methods like ask_with_default that can be extracted into a separate file to be reused by other configuration files.

We need to add the option to integrate the app with MarsBased CircleCI

Add Waffle integration and add Waffle badge to project.

We need to discuss this further.

For high-traffic sites we configure a CDN to serve static assets. The CDN is configured to point an Amazon S3 bucket instead of accessing directly to the application compiled assets.

AssetSync is our tool of choice to upload assets to Amazon S3 when deploying new versions of our software.

We need to make it compatible with the Pathfinder Cloud66 configuration: #6

Context

There are some projects with low traffic that can run in a standalone server or clients that prefer to have the application in their own infrastructure.

For some of this projects we are using Docker to manage the installation.

### Task description

Include in the PathFinder the required configuration files (Dockerfile, docker-compose) to be able to deploy the project to an standalone Docker server.

We need to search another name for init_file, as it's doing other things other than creating initializers.

@oriolbcn suggests #cook

The template needs to ask you if you are using MarsMan in the project in order to configure simple_form properly.

There are some questions with default values and some of them without. We must always offer a default value based in our experience building projects.

We are always using the feature/modularize branch. We need to fix this to use the master branch.

path = if File.exists? @rails_template
          File.dirname(@rails_template)
        else
          @tmp_dir = Dir.mktmpdir
          run "git clone -b 'feature/modularize' [email protected]:MarsBased/pathfinder.git #{@tmp_dir}"
          @tmp_dir
        end

It allows you to see the BG jobs errors inside sidekiq.

Instead of executing: rails new new_app -m http://blabla.github.com/pathfinder/template.rb
it would be nice to have an url like http://pathfinder.marsbased.com pointing to the github template file

Rubocop files can be referenced from a URL. The MarsBased rubocop file found in https://github.com/MarsBased/marstyle needs to be referenced in the pathfinder generator.

Marsman can't be integrated as a gem, so we need to manually include all the scss files to the project manually.

We need to add some gems instructions/info when asking for them to share repo url, explain what they do, prevent issues (like double compression: middleware gzip + nginx zip)...

https://stackoverflow.com/questions/26342570/rubocop-linelength-how-to-ignore-lines-with-comments

Problem

Currently Rails template is not working for Rails 5.x projects.

• There are gems not listed in the Gemfile
• Installation of the Gemfile's Rails version doesn't work
• Default Rails version in the Gemfile is 4.x
• Sinatra is not working properly with Rails 5 because of some dependecy problems
• Quiet assets can be removed for Rails 5 because it's already included

Proposed solution

We don't need to support both Rails 5 & Rails 4 in our generator. I suggest changing it to support Rails 5 only.

We are currently planning to open emails in the development environment using Mailcatcher. However, I find that Letter Opener Web has some advantages over Mailcatcher.

See gem documentation for more info: https://github.com/fgrehm/letter_opener_web

Don't confuse with letter_opener, that we discarded in the past because it opened a new browser tab every time an email was sent.

The advantages that I see to change are:

• You don't need to start the Mailcatcher daemon.
• In the environment development.rb file you clearly show that you are using letter_opener_web. With Mailcatcher you are sending to localhost:25
• In staging environments, it's easier to show the letter opener web UI, as it's mounted in the application routes.

WDYT?

This line produces a Rubocop error:

https://github.com/MarsBased/pathfinder/blob/b855cea85850e6e821e0f0c10df611a35b1120f1/recipes/rollbar.rb#L13

Rubocop error: Performance/Redundant Merge.

It is solved by using: config.exception_level_filters['ActionController::RoutingError'] = 'ignore' instead.

It stills add the PostgreSQL gem.

https://github.com/piotrmurach/tty-prompt

Review this model and think about how we should start working with it. After that, we should modify the variable config.mailer in the devise config file.

Some of the code is depending on sidekiq. I'm leaving the code required to implement this.

Routes

resource :status, only: :show

Controller

class StatusesController < ApplicationController

  def show
    check_database
    check_sidekiq_redis
    head :ok
  end

  private

  def check_database
    ActiveRecord::Migrator.current_version
  end

  def check_sidekiq_redis
    Sidekiq.redis(&:info)
  end

end

At MarsBased we usually work with Cloud66. However, there are some configurations that need to be performed when deploying to Cloud66 with the Pathfinder tech stack.

This is a list of common features that we require:

• Bower configuration
• Node configuration
• Fix carrierwave cache permissions
• New relic configuration

We need to add them as an option to the Pathfinder.

Read Changelog and decide what features do we want to support. For example, new system tests.

I think we should create a test codebase to check that every recipe works. This is a nice to have when we update rails gems, or perform a refactor in the code.

I suggest:

• A way to run the wizard in a headless mode to generate a valid app
• Make simple tests to be sure that the dependencies are properly setted up (for example, that rspec doesn't fail, or /admin returns a 200 response for active_admin)

What do you think?

Problem

Currently we have an empty README file. We need to improve it to add relevant information to the project.

Solution

Write a README file covering the following topics:

• Brief description
• Installation instructions
• Options available

https://github.com/steveklabnik/request_store

• Check also if Nginx is already doing it or not.
• Check if it can provoke issues.
• Maybe it can be configured at the Nginx level instead?

https://schneems.com/2017/11/08/80-smaller-rails-footprint-with-rack-deflate/

There is no contributing guide for MarsBased public repositories. We need to create one and then apply it to different projects.

The default configuration needs to be added for the production environment.

The config needs to be optional

Problem

During one of our development projects we made changes to the rails_template.rb file but they weren't moved to the repository.

Proposed solution

Update the current Rails template with those changes.

Seems like our blog posts don't have sufficient information for Pocket to load the images.

Dunno what else to write, it's 3.19am ffs

Steps to reproduce

Run the whole installation with default values.

Expected behavior

After creating the rails project, generators like rails generate devise:install should work.

Actual behavior

Generators launch this error:

config/environments/development.rb:59:in 'block in <top (required)>': uninitialized constant ActiveSupport::EventedFileUpdateChecker (NameError)

Maybe because something related to Rails 5: http://stackoverflow.com/questions/37978091/uninitialized-constant-activesupporteventedfileupdatechecker-in-env-config-fil

System configuration

Rails version: 5.0

Ruby version: 2.3.1

• RSpec
• FactoryGirl
• Faker
• Database Cleaner
• Capybara & Poltergeist

Use case

Sometimes Rails fails with a CSRF Exception. If the request is not AJAX we show an ugly error. If the request is AJAX it is even worse. The application fails silently.

These errors sometimes happen (without a malicious behaviour) when the browser is using a cached page to send a form.

Solution

To prevent this, we need to implement a workaround for these 2 situations. For the Ajax one, I recommend doing this:

Inside ApplicationController
rescue_from ActionController::InvalidAuthenticityToken, with: :recover_from_csrf_ajax_error

def recover_from_csrf_ajax_error
    fail ActionController::InvalidAuthenticityToken unless request.xhr?
    render :refresh_window
  end

and inside application/refresh_window.js

location.reload();

For the other one, maybe we want to render a flash.