Lazy evaluate Doorkeeper config when loading files and executing initializers

[nbulaj]

Root of the issue is the fact that Rails or some specific gems (like Sorbet) could load model files before initializers have been run. Since some models have constructions like:

class Some
  if Doorkeper.config.blabla
    # do smth
  end
end

in their class body - it will trigger an error because @config still doesn't exist (Doorkeeper.configure block wasn't called).

The same is applied to Doorkeeper railtie (engine): it adds some custom parameters filters based on the OAuth configuration, but it does it even for the new Rails apps which have not yet generated an initializer (just added a gem and run rails g doorkeeper:install).

What should be done:

• Avoid checking config values in railtie initializers (config could be nil for Rails apps which just installed the gem. see above issues)
• Avoid checking config in class definitions (move adding Polymorphic resource owner into an ORM hook)

---

Addresses:

• Remove doorkeeper config error #1615
• rails generate doorkeeper:install fails with Doorkeeper::MissingConfiguration error #1617
• Missing configuration should be a log warning, not an error #1577

[johnnyshields]

double whitespace before do here

[johnnyshields]

This line still raises an error.

[zavan]

This broke my initializer in development (I haven't tested in production):

Jan 30 12:08:52 ubuntu-jammy rails[186539]: /usr/local/lib/ruby/gems/3.2.0/gems/activesupport-7.0.4.2/lib/active_support/inflector/methods.rb:280:in `constantize': uninitialized constant DoorkeeperAccessToken (NameError)
Jan 30 12:08:52 ubuntu-jammy rails[186539]:       Object.const_get(camel_cased_word)
Jan 30 12:08:52 ubuntu-jammy rails[186539]:             ^^^^^^^^^^
Jan 30 12:08:52 ubuntu-jammy rails[186539]:         from /usr/local/lib/ruby/gems/3.2.0/gems/activesupport-7.0.4.2/lib/active_support/core_ext/string/inflections.rb:74:in `constantize'
Jan 30 12:08:52 ubuntu-jammy rails[186539]:         from /usr/local/lib/ruby/gems/3.2.0/gems/doorkeeper-5.6.3/lib/doorkeeper/config.rb:425:in `access_token_model'

I have in my initializer/config:

Doorkeeper.configure do
  # ...
  access_token_class 'DoorkeeperAccessToken'
  # ...
end

Rails v7.0.4.2

[nbulaj]

Yeah, can I see your DoorkeeperAccessToken implementation? Where it is located? How it looks like @zavan ?

[zavan]

Yeah, can I see your DoorkeeperAccessToken implementation? Where it is located? How it looks like @zavan ?

It's a regular rails model in app/models/doorkeeper_access_token.rb:

class DoorkeeperAccessToken < ApplicationRecord
  include ::Doorkeeper::Orm::ActiveRecord::Mixins::AccessToken

  after_save :sync_legacy_token

  private

  def sync_legacy_token
    #
  end
end

Downgrading to v5.6.2 works.

[nbulaj]

@zavan could you please try with fix-custom-models branch ?

[zavan]

@zavan could you please try with fix-custom-models branch ?

It works 😄