Skip to content

Commit

Permalink
Check timestamp columns (created_at, updated_at) are NOT NULL
Browse files Browse the repository at this point in the history
Once the timestamps columns are established on a table, they might as
well be NOT NULL to enforce their existence. All ActiveRecord operations
set these values so they will always exist under normal usage.

Fixes #184
  • Loading branch information
jdufresne committed Sep 4, 2024
1 parent 2a69627 commit d0fc304
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,18 @@ class MissingNonNullConstraint < Base # :nodoc:

private

TIMESTAMPS = ["created_at", "created_on", "updated_at", "updated_on"].freeze

def message(column:, table:)
"add `NOT NULL` to #{table}.#{column} - models validates its presence but it's not non-NULL in the database"
if TIMESTAMPS.include?(column)
<<~WARN.squish
add `NOT NULL` to #{table}.#{column} - timestamp columns are set
automatically by Active Record and allowing NULL may lead to
inconsistencies introduced by bulk operations
WARN
else
"add `NOT NULL` to #{table}.#{column} - models validates its presence but it's not non-NULL in the database"
end
end

def detect
Expand Down Expand Up @@ -50,6 +60,8 @@ def sti_base_model?(model)
end

def non_null_needed?(model, column)
return true if TIMESTAMPS.include?(column.name)

belongs_to = model.reflect_on_all_associations(:belongs_to).find do |reflection|
reflection.foreign_key == column.name ||
(reflection.polymorphic? && reflection.foreign_type == column.name)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -310,4 +310,27 @@ def test_config_ignore_columns

refute_problems
end

def test_timestamps_with_null_are_disallowed
Context.create_table(:users) do |t|
t.timestamps null: true
end.define_model

assert_problems(<<~OUTPUT)
add `NOT NULL` to users.created_at - timestamp columns are set automatically by Active Record and allowing NULL may lead to inconsistencies introduced by bulk operations
add `NOT NULL` to users.updated_at - timestamp columns are set automatically by Active Record and allowing NULL may lead to inconsistencies introduced by bulk operations
OUTPUT
end

def test_created_on_updated_on_with_null_are_disallowed
Context.create_table(:users) do |t|
t.datetime :created_on
t.datetime :updated_on
end.define_model

assert_problems(<<~OUTPUT)
add `NOT NULL` to users.created_on - timestamp columns are set automatically by Active Record and allowing NULL may lead to inconsistencies introduced by bulk operations
add `NOT NULL` to users.updated_on - timestamp columns are set automatically by Active Record and allowing NULL may lead to inconsistencies introduced by bulk operations
OUTPUT
end
end

0 comments on commit d0fc304

Please sign in to comment.