Redis check for self hosted apps (#2353)

* Redis check for self hosted apps

* Run linter with autocorrect

* Add Redis to CI

.github/workflows/ci.yml

@@ -80,6 +80,7 @@ jobs:
       PLAID_CLIENT_ID: foo
       PLAID_SECRET: bar
       DATABASE_URL: postgres://postgres:postgres@localhost:5432
+      REDIS_URL: redis://localhost:6379
       RAILS_ENV: test
 
     services:
@@ -92,6 +93,12 @@ jobs:
           - 5432:5432
         options: --health-cmd="pg_isready" --health-interval=10s --health-timeout=5s --health-retries=3
 
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+        options: --health-cmd="redis-cli ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
     steps:
       - name: Install packages
         run: sudo apt-get update && sudo apt-get install --no-install-recommends -y google-chrome-stable curl libvips postgresql-client libpq-dev

app/controllers/concerns/self_hostable.rb

@@ -3,6 +3,8 @@ module SelfHostable
 
   included do
     helper_method :self_hosted?, :self_hosted_first_login?
+
+    prepend_before_action :verify_self_host_config
   end
 
   private
@@ -13,4 +15,29 @@ module SelfHostable
     def self_hosted_first_login?
       self_hosted? && User.count.zero?
     end
+
+    def verify_self_host_config
+      return unless self_hosted?
+
+      # Special handling for Redis configuration error page
+      if controller_name == "pages" && action_name == "redis_configuration_error"
+        # If Redis is now working, redirect to home
+        if redis_connected?
+          redirect_to root_path, notice: "Redis is now configured properly! You can now setup your Maybe application."
+        end
+
+        return
+      end
+
+      unless redis_connected?
+        redirect_to redis_configuration_error_path
+      end
+    end
+
+    def redis_connected?
+      Redis.new.ping
+      true
+    rescue Redis::CannotConnectError
+      false
+    end
 end

app/controllers/pages_controller.rb

@@ -1,7 +1,8 @@
 class PagesController < ApplicationController
-  skip_before_action :authenticate_user!, only: %i[early_access]
   include Periodable
 
+  skip_authentication only: :redis_configuration_error
+
   def dashboard
     @balance_sheet = Current.family.balance_sheet
     @accounts = Current.family.accounts.active.with_attached_logo
@@ -47,12 +48,8 @@ class PagesController < ApplicationController
     render layout: "settings"
   end
 
-  def early_access
+  def redis_configuration_error
-    redirect_to root_path if self_hosted?
+    render layout: "blank"
-
-    @invite_codes_count = InviteCode.count
-    @invite_code = InviteCode.order("RANDOM()").limit(1).first
-    render layout: false
   end
 
   private

app/views/layouts/blank.html.erb

@@ -0,0 +1,13 @@
+<%= render "layouts/shared/htmldoc" do %>
+  <div class="min-h-screen bg-surface text-primary font-medium flex flex-col">
+    <div class="flex-1">
+      <%= yield %>
+    </div>
+
+    <% if content_for?(:footer) %>
+      <%= yield :footer %>
+    <% else %>
+      <%= render "layouts/shared/footer" %>
+    <% end %>
+  </div>
+<% end %>

app/views/pages/redis_configuration_error.html.erb

@@ -0,0 +1,59 @@
+<% content_for :title, "Redis Configuration Required - Maybe" %>
+
+<div class="flex items-center justify-center h-full p-4 sm:p-6 lg:p-8">
+  <div class="w-full max-w-md sm:max-w-lg lg:max-w-2xl">
+    <div class="bg-container border border-primary rounded-xl p-6 sm:p-8 shadow-sm">
+      <!-- Icon and Header -->
+      <div class="text-center mb-8">
+        <div class="mx-auto w-16 h-16 bg-red-100 rounded-full flex items-center justify-center mb-4">
+          <%= icon "alert-triangle", class: "w-8 h-8 text-red-600" %>
+        </div>
+        <h1 class="text-xl sm:text-2xl font-bold text-primary mb-2">Redis Configuration Required</h1>
+        <p class="text-sm sm:text-base text-muted">Your self-hosted Maybe installation needs Redis to be properly configured.</p>
+      </div>
+
+      <!-- Explanation -->
+      <div class="mb-8">
+        <div class="bg-amber-50 border border-amber-200 rounded-lg p-4 mb-6">
+          <div class="flex items-start">
+            <%= icon "info", class: "w-5 h-5 text-amber-600 mt-0.5 mr-3 flex-shrink-0" %>
+            <div class="text-sm text-amber-800">
+              <p><strong>Why is Redis required?</strong></p>
+              <p class="mt-1">Maybe uses Redis to power Sidekiq background jobs for tasks like syncing account data, processing imports, and other background operations that keep your financial data up to date.</p>
+            </div>
+          </div>
+        </div>
+
+        <!-- Primary CTA -->
+        <div class="text-center space-y-4">
+          <%= render LinkComponent.new(
+            text: "View Setup Guide",
+            href: "https://github.com/maybe-finance/maybe/blob/main/docs/hosting/docker.md",
+            variant: "primary",
+            size: "lg",
+            icon: "external-link",
+            full_width: true,
+            target: "_blank",
+            rel: "noopener noreferrer"
+          ) %>
+          <p class="text-sm text-muted">Follow our complete Docker setup guide to configure Redis</p>
+        </div>
+      </div>
+
+      <!-- Secondary CTA -->
+      <div class="pt-6 border-t border-primary">
+        <div class="text-center space-y-3">
+          <p class="text-sm text-muted">Once you've configured Redis, refresh this page to continue.</p>
+          <%= render ButtonComponent.new(
+            text: "Refresh Page",
+            variant: "secondary",
+            icon: "refresh-cw",
+            type: "button",
+            full_width: true,
+            onclick: "window.location.reload()"
+          ) %>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

config/routes.rb

@@ -205,6 +205,8 @@ Rails.application.routes.draw do
     post "stripe"
   end
 
+  get "redis-configuration-error", to: "pages#redis_configuration_error"
+
   # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500.
   # Can be used by load balancers and uptime monitors to verify that the app is live.
   get "up" => "rails/health#show", as: :rails_health_check