Dev environment: Add basic Devcontainer pointed at sqlite (#1484)

* Add devcontainer

* Fix image

* Fix

* Swap to sqlite

* Fix DB migrations on other DBs that aren't postgres

* Add libpq-dev, as its easier than explaining to new devs to run CI=1 DB=sqlite bundle

* Fix Ruby 3.4 deps

* Fix Ruby 3.4 deps

* Adjust migration

* Change history

* Add install script

* Allow in dev the codespaces proxy

* Update post install

* Rubocop

* Update 20230422234321_create_action_text_tables.action_text.rb

* Fix devcontainer

* Purge snap version

* Update firefox install

* Change migration to be optional

* Change migration to be optional

* Change migration to be optional

* Fix forms

Author: CloCkWeRX

.devcontainer/devcontainer.json

@@ -0,0 +1,7 @@
+{
+	"image": "mcr.microsoft.com/devcontainers/base:ubuntu-24.04",
+	"features": {
+		"ghcr.io/devcontainers/features/ruby:1": {}
+	},
+	"postCreateCommand": "sh .devcontainer/install.sh"
+}

.devcontainer/install.sh

@@ -0,0 +1,21 @@
+#! /bin/bash
+
+sudo add-apt-repository -y ppa:mozillateam/ppa
+
+echo -e "Package: firefox*\nPin: release o=LP-PPA-mozillateam-ppa\nPin-Priority: 550\n\nPackage: firefox*\nPin: release o=Ubuntu\nPin-Priority: -1" | sudo tee /etc/apt/preferences.d/99-mozillateamppa
+
+sudo apt-get update
+
+sudo apt install -y libpq-dev # Not strictly needed, but easier than explaining to users to constantly pass DB=sqlite
+sudo apt install -y firefox 
+
+bundle
+
+cp config/database.sqlite.yml config/database.yml
+
+bundle exec rake db:create
+bundle exec rake db:migrate
+bundle exec rake db:seed
+bundle exec rake ffcrm:demo:load
+
+bundle exec rails s -b 0.0.0.0

Gemfile

@@ -109,5 +109,11 @@ gem 'mini_magick'
 gem 'image_processing', '~> 1.2'
 gem 'jquery-ui-rails', git: 'https://github.com/jquery-ui-rails/jquery-ui-rails.git', tag: 'v7.0.0' # See https://github.com/jquery-ui-rails/jquery-ui-rails/issues/146
 
+# Ruby 3.4 explict dependencies
+gem 'bigdecimal'
+gem 'mutex_m'
+gem 'drb'
+gem 'csv'
+
 # Workaround problems from concurrent-ruby 1.3.5
 require "logger"

Gemfile.lock

@@ -109,6 +109,7 @@ GEM
       execjs (~> 2)
     base64 (0.2.0)
     bcrypt (3.1.20)
+    bigdecimal (3.2.2)
     bootsnap (1.18.6)
       msgpack (~> 1.2)
     bootstrap (5.0.2)
@@ -159,6 +160,7 @@ GEM
     crass (1.0.6)
     css_parser (1.19.0)
       addressable
+    csv (3.3.5)
     database_cleaner (2.1.0)
       database_cleaner-active_record (>= 2, < 3)
     database_cleaner-active_record (2.2.0)
@@ -178,9 +180,8 @@ GEM
       devise (>= 4.9.0)
       rails-i18n
     diff-lcs (1.6.1)
-    dynamic_form (1.3.1)
-      actionview (> 5.2.0)
-      activemodel (> 5.2.0)
+    drb (2.2.3)
+    dynamic_form (1.2.0)
     email_reply_parser_ffcrm (0.5.0)
     erubi (1.13.1)
     execjs (2.10.0)
@@ -261,6 +262,7 @@ GEM
       libv8-node (~> 24.1.0.0)
     minitest (5.25.5)
     msgpack (1.8.0)
+    mutex_m (0.3.0)
     nenv (0.3.0)
     net-imap (0.5.7)
       date
@@ -507,6 +509,7 @@ DEPENDENCIES
   acts-as-taggable-on (>= 3.4.3)
   acts_as_commentable!
   acts_as_list
+  bigdecimal
   bootsnap
   bootstrap (~> 5.0.0)
   brakeman
@@ -520,10 +523,12 @@ DEPENDENCIES
   coffee-rails
   coffee-script-source (~> 1.8, >= 1.8.0)
   country_select
+  csv
   database_cleaner
   devise (~> 4.6)
   devise-encryptable
   devise-i18n
+  drb
   dynamic_form
   email_reply_parser_ffcrm
   execjs
@@ -541,6 +546,7 @@ DEPENDENCIES
   jquery-ui-rails!
   mini_magick
   mini_racer
+  mutex_m
   nokogiri (>= 1.8.1)
   paper_trail (~> 15.1.0)
   pg

app/controllers/application_controller.rb

@@ -79,7 +79,9 @@ def auto_complete
   # See http://blog.nvisium.com/2014/09/understanding-protectfromforgery.html for more details.
   #----------------------------------------------------------------------------
   def handle_unverified_request
-    raise ActionController::InvalidAuthenticityToken
+    unless ENV.fetch('CODESPACE_NAME', nil) && Rails.env.development?
+      raise ActionController::InvalidAuthenticityToken
+    end
   end
 
   #

config/environments/development.rb

@@ -83,5 +83,20 @@
     # Checks for improperly declared sprockets dependencies.
     # Raises helpful error messages.
     config.assets.raise_runtime_errors = true
+
+    # Are we running in a GitHub Codespace?
+    if ENV.fetch('CODESPACE_NAME', nil)
+      config.host = "#{ENV['CODESPACE_NAME']}-3000.app.github.dev:443"
+      config.hosts << ".preview.app.github.dev"
+      config.hosts << ".app.github.dev"
+
+      config.force_ssl = true
+      config.action_dispatch.cookies_same_site_protection = :lax
+
+      config.action_dispatch.trusted_proxies = [
+        # Trust all IPs (safe in dev only)
+        IPAddr.new("0.0.0.0/0"), IPAddr.new("::/0")
+      ]
+    end
   end
 end

db/migrate/20230422234321_optionally_create_action_text_tables.action_text.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# This migration comes from action_text (originally 20180528164100)
+class OptionallyCreateActionTextTables < ActiveRecord::Migration[6.0]
+  def change
+    # Use Active Record's configured type for primary and foreign keys
+    primary_key_type, foreign_key_type = primary_and_foreign_key_types
+
+    create_table :action_text_rich_texts, id: primary_key_type, if_not_exists: true do |t|
+      t.string     :name, null: false
+      t.text       :body, size: :long
+      t.references :record, null: false, polymorphic: true, index: false, type: foreign_key_type
+
+      t.timestamps
+
+      t.index %i[record_type record_id name], name: "index_action_text_rich_texts_uniqueness", unique: true
+    end
+  end
+
+  private
+
+  def primary_and_foreign_key_types
+    config = Rails.configuration.generators
+    setting = config.options[config.orm][:primary_key_type]
+    primary_key_type = setting || :primary_key
+    foreign_key_type = setting || :bigint
+    [primary_key_type, foreign_key_type]
+  end
+end

db/migrate/20230526211831_create_active_storage_tables.active_storage.rb

@@ -6,7 +6,7 @@ def change
     # Use Active Record's configured type for primary and foreign keys
     primary_key_type, foreign_key_type = primary_and_foreign_key_types
 
-    create_table :active_storage_blobs, id: primary_key_type do |t|
+    create_table :active_storage_blobs, id: primary_key_type, if_not_exists: true do |t|
       t.string   :key,          null: false
       t.string   :filename,     null: false
       t.string   :content_type
@@ -19,7 +19,7 @@ def change
       t.index [:key], unique: true
     end
 
-    create_table :active_storage_attachments, id: primary_key_type do |t|
+    create_table :active_storage_attachments, id: primary_key_typ, if_not_exists: true do |t|
       t.string     :name,     null: false
       t.references :record,   null: false, polymorphic: true, index: false, type: foreign_key_type
       t.references :blob,     null: false, type: foreign_key_type
@@ -30,7 +30,7 @@ def change
       t.foreign_key :active_storage_blobs, column: :blob_id
     end
 
-    create_table :active_storage_variant_records, id: primary_key_type do |t|
+    create_table :active_storage_variant_records, id: primary_key_type, if_not_exists: true do |t|
       t.belongs_to :blob, null: false, index: false, type: foreign_key_type
       t.string :variation_digest, null: false
 

db/migrate/20230526212613_convert_to_active_storage.rb

@@ -4,19 +4,16 @@ class ConvertToActiveStorage < ActiveRecord::Migration[5.2]
   require 'open-uri'
 
   def up
-    get_blob_id = case ENV['CI'] && ENV['DB']
-                  when 'sqlite'
-                    'LAST_INSERT_ROWID()'
-                  when 'mysql'
-                    'LAST_INSERT_ID()'
-                  when 'postgres'
-                    'LASTVAL()'
-                  else
-                    'LASTVAL()'
-                  end
-
     ActiveRecord::Base.connection.raw_connection.then do |conn|
+      get_blob_id = case ENV['CI'] && ENV['DB']
+                    when 'mysql'
+                      'LAST_INSERT_ID()'
+                    else
+                      'LASTVAL()'
+                    end
+      get_blob_id = 'LAST_INSERT_ROWID()' if conn.is_a?(SQLite3::Database)
       if conn.is_a?(::PG::Connection)
+        get_blob_id = 'LASTVAL()'
         conn.prepare('active_storage_blobs', <<-SQL)
           INSERT INTO active_storage_blobs (
             key, filename, content_type, metadata, byte_size, checksum, created_at

db/schema.rb

@@ -11,9 +11,6 @@
 # It's strongly recommended that you check this file into your version control system.
 
 ActiveRecord::Schema[7.0].define(version: 2023_05_26_212613) do
-  # These are extensions that must be enabled in order to support this database
-  enable_extension "plpgsql"
-
   create_table "account_contacts", force: :cascade do |t|
     t.integer "account_id"
     t.integer "contact_id"
@@ -55,6 +52,16 @@
     t.index ["user_id", "name", "deleted_at"], name: "index_accounts_on_user_id_and_name_and_deleted_at", unique: true
   end
 
+  create_table "action_text_rich_texts", force: :cascade do |t|
+    t.string "name", null: false
+    t.text "body"
+    t.string "record_type", null: false
+    t.bigint "record_id", null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["record_type", "record_id", "name"], name: "index_action_text_rich_texts_uniqueness", unique: true
+  end
+
   create_table "active_storage_attachments", force: :cascade do |t|
     t.string "name", null: false
     t.string "record_type", null: false
@@ -247,12 +254,12 @@
     t.text "collection"
     t.boolean "disabled"
     t.boolean "required"
-    t.integer "maxlength"
+    t.integer "maxlength", limit: 4
     t.datetime "created_at", precision: nil
     t.datetime "updated_at", precision: nil
     t.integer "pair_id"
     t.text "settings"
-    t.integer "minlength", default: 0
+    t.integer "minlength", limit: 4, default: 0
     t.string "pattern"
     t.string "autofocus"
     t.string "autocomplete"
@@ -417,7 +424,7 @@
 
   create_table "users", force: :cascade do |t|
     t.string "username", limit: 32, default: "", null: false
-    t.string "email", limit: 254, default: "", null: false
+    t.string "email", limit: 254
     t.string "first_name", limit: 32
     t.string "last_name", limit: 32
     t.string "title", limit: 64
@@ -448,8 +455,8 @@
     t.datetime "remember_created_at", precision: nil
     t.string "authentication_token"
     t.string "confirmation_token", limit: 255
-    t.datetime "confirmed_at", precision: nil
-    t.datetime "confirmation_sent_at", precision: nil
+    t.datetime "confirmed_at"
+    t.datetime "confirmation_sent_at"
     t.index ["authentication_token"], name: "index_users_on_authentication_token", unique: true
     t.index ["confirmation_token"], name: "index_users_on_confirmation_token", unique: true
     t.index ["email"], name: "index_users_on_email"
@@ -461,7 +468,7 @@
   create_table "versions", force: :cascade do |t|
     t.string "item_type", null: false
     t.integer "item_id", null: false
-    t.string "event", limit: 512, null: false
+    t.string "event", limit: 512
     t.string "whodunnit"
     t.text "object"
     t.datetime "created_at", precision: nil