Fixing 'Unknown Enum Attribute' Error in Rails 7.1

When upgrading your Rails application to version 7.1, you may encounter an error stating Unknown enum attribute 'auth_type' for Company. This issue arises when the enum is defined in your model before the corresponding database column is created. Here’s how to resolve it.

Understanding the Issue

In Rails 7.1, ActiveRecord enforces stricter checks on enums. If the attribute defined in the enum does not exist in the database schema at the time of model loading, you will receive this error. This is particularly relevant for the Company model that integrates with WorkOS.

Example Model Definition

Here’s an example of how your Company model might look:

class Company < ApplicationRecord
  enum auth_type: {
    password: 'password',
    magic_link: 'magic_link',
    google: 'google',
    microsoft: 'microsoft',
    saml: 'saml',
    workos: 'workos',
    developer: 'developer'
  }, _prefix: :auth_by
end

Steps to Fix the Error

1. Check Database Migration: Ensure that the migration for the auth_type column is executed before the model is loaded. You can do this by checking your migration files and their execution order.

2. Migrate in Two Steps: If your migration is not being executed before the model is loaded, consider splitting the migration into two steps. First, create the column without the enum definition, and then update the model to include the enum after the migration is complete.

3. Verify Column Type: Make sure that the column type for auth_type in your database is compatible with the enum values you are defining. Typically, this should be a string or integer type.

Conclusion

By ensuring that your database schema is correctly set up before loading the model, you can avoid the 'Unknown enum attribute' error in Rails 7.1. This will allow your WorkOS integration to function smoothly without interruptions.

For further details, refer to the Rails GitHub Issue discussing this change.