Top Menu

Jump to content
Home
    • Projects
    • Work packages
    • News
    • Getting started
    • Introduction video
      Welcome to OpenProject Community
      Get a quick overview of project management and team collaboration with OpenProject. You can restart this video from the help menu.

    • Help and support
    • User guides
    • Videos
    • Shortcuts
    • Community forum
    • Professional support

    • Additional resources
    • Data privacy and security policy
    • Digital accessibility (DE)
    • OpenProject website
    • Security alerts / Newsletter
    • OpenProject blog
    • Release notes
    • Report a bug
    • Development roadmap
    • Add and edit translations
    • API documentation
  • Sign in
      Forgot your password?
      Create a new account

      or sign in with your existing account

      Google

Side Menu

  • Overview
  • Activity
  • Roadmap
  • Work packages
  • Calendars
  • Team planners
  • Boards
  • Forums
  • Wiki
    • Table of contents
      • Expanded. Click to collapseCollapsed. Click to showDeveloper
        • Hierarchy leafAccessibility Checklist
        • Hierarchy leafCode Review Guidelines
        • Expanded. Click to collapseCollapsed. Click to showContribution
          • Hierarchy leafGit Workflow
          • Hierarchy leafTranslations
        • Expanded. Click to collapseCollapsed. Click to showDeveloping Plugins
          • Hierarchy leafDeveloping an OmniAuth Authentication Plugin
        • Hierarchy leafRelease Process
        • Hierarchy leafReport a bug
        • Hierarchy leafSecurity
        • Hierarchy leafSetting up an OpenLDAP server for testing
        • Hierarchy leafTheme Features
      • Hierarchy leafDownload
      • Expanded. Click to collapseCollapsed. Click to showFeature tour
        • Hierarchy leafRelease Notes OpenProject 30
        • Expanded. Click to collapseCollapsed. Click to showRelease Notes OpenProject 30 - Overview
          • Hierarchy leafGlossary
          • Hierarchy leafRelease Notes - Accessibility
          • Hierarchy leafRelease Notes - Accessibility changes
          • Hierarchy leafRelease Notes - Add work package queries as menu items to sidebar
          • Hierarchy leafRelease Notes - Copy projects based on Templates
          • Hierarchy leafRelease Notes - Design changes
          • Hierarchy leafRelease Notes - Fixed Bugs
          • Hierarchy leafRelease Notes - Keyboard Shortcuts
          • Hierarchy leafRelease Notes - Project settings
          • Hierarchy leafRelease Notes - Ruby&Rails Update
          • Hierarchy leafRelease Notes - Security
          • Hierarchy leafRelease Notes - Timelines
          • Hierarchy leafRelease Notes - Work packages
      • Hierarchy leafHowto create animated gifs
      • Hierarchy leafMigration Squashing
      • Hierarchy leafMod security
      • Hierarchy leafNew work package page
      • Hierarchy leafOP3 to OP4 Debian upgrade
      • Hierarchy leafOP4 Ubuntu1404 Stable with MySQL in production
      • Hierarchy leafOpenProject 40 Development Setup
      • Expanded. Click to collapseCollapsed. Click to showOpenProject Foundation
        • Hierarchy leafBoards
        • Hierarchy leafMembers
        • Hierarchy leafOPF-Meetings
        • Hierarchy leafStatutes
      • Expanded. Click to collapseCollapsed. Click to showRelease Notes
        • Hierarchy leafOpenProject released on Bitnami
      • Expanded. Click to collapseCollapsed. Click to showRelease Notes OpenProject 40 - Overview
        • Hierarchy leafRelease Notes OpenProject 40 - Accessibility improvements
        • Hierarchy leafRelease Notes OpenProject 40 - Column header functions in work package table
        • Hierarchy leafRelease Notes OpenProject 40 - Improved Design
        • Hierarchy leafRelease Notes OpenProject 40 - Integrated query title on work package page
        • Hierarchy leafRelease Notes OpenProject 40 - Integrated toolbar on work package page
        • Hierarchy leafRelease Notes OpenProject 40 - OmniAuth integration for OpenProject
        • Hierarchy leafRelease Notes OpenProject 40 - Work package details pane
      • Expanded. Click to collapseCollapsed. Click to showSecurity and privacy
        • Hierarchy leafFAQ
      • Expanded. Click to collapseCollapsed. Click to showSupport
        • Expanded. Click to collapseCollapsed. Click to showDownload and Installation
          • Hierarchy leafInstallation MacOS
          • Expanded. Click to collapseCollapsed. Click to showInstallation OpenProject 3 0
            • Hierarchy leafDebian Stable with MySQL in production
            • Hierarchy leafInstallation Ubuntu
            • Hierarchy leafInstallation Windows
            • Hierarchy leafInstallation on Centos 65 x64 with Apache and PostgreSQL 93
          • Expanded. Click to collapseCollapsed. Click to showInstallation OpenProject 40
            • Hierarchy leafOP4 Debian Stable with MySQL in production
          • Expanded. Click to collapseCollapsed. Click to showMigration paths
            • Hierarchy leafFrom Chilliproject to OpenProject
            • Hierarchy leafMigration 15 to 30
            • Hierarchy leafMigration 24 to 30
            • Hierarchy leafMigration Redmine 2x › OpenProject 30
            • Hierarchy leafOpenProject 3 Migration
          • Hierarchy leafOpenProject 40
        • Expanded. Click to collapseCollapsed. Click to showNews
          • Hierarchy leafNew OpenProject Translations Plugin
          • Hierarchy leafNew Plugin on OpenProjectorg Local Avatars
          • Hierarchy leafNew design for OpenProject
          • Hierarchy leafNews Accessibility workshop for OpenProject
          • Hierarchy leafNews Glossary for OpenProject
          • Hierarchy leafNews Heartbleed fixed
          • Hierarchy leafNews Icon Fonts
          • Hierarchy leafNews OpenProject 30 Release
          • Hierarchy leafNews Release GitHub Integration Plugin
          • Hierarchy leafNews Success Story Deutsche Telekom
          • Hierarchy leafNews Timelines
          • Hierarchy leafOpenProject 3013 released
          • Hierarchy leafOpenProject 3017 released
          • Hierarchy leafOpenProject 40 released
          • Hierarchy leafOpenProject 40 will be coming soon
          • Hierarchy leafOpenProject 405 released
          • Hierarchy leafOpenProject and pkgrio
          • Hierarchy leafOpenProject news moved to a new blog
          • Hierarchy leafOpenProjectBitnami
          • Hierarchy leafPackager version with plugins released ("Community edition")
          • Hierarchy leafRegistration OpenProject-Foundation
          • Hierarchy leafRelease OpenProject AuthPlugins
          • Hierarchy leafUpdates on OpenProject
          • Hierarchy leafWe need your feedback for the the new fullscreen view for work packages
        • Hierarchy leafOpenProject Plug-Ins
      • Expanded. Click to collapseCollapsed. Click to showWiki
        • Hierarchy leaf2nd Level Support
You are here:
  • Forums
  • Development

Content

[Solved] Patching User: uninitialized constant Project::User

Added by Oliver Günther about 8 years ago

While working on a new plugin with a patch for User, I’m experiencing an issue I have no explanation for and am looking for a solution to a blatant mistake, as I can’t find it.

The steps I’ve taken:

  • Clone opf/openproject at dev(02a79032)
  • generate a plugin bundle exec rails generate open_project:plugin test_plugin ../plugins/
  • Added patches [:User] to engine.rb
  • Added lib/open_project/test_plugin/patches/user_patch.rb, which adds a simple instance method foo
  • Add the plugin to Gemfile.plugins
  • Start the server (foreman start -f Profile.dev)

The first request is returned correctly with the patch included to User. At all times, the second request fails with the following exception :

uninitialized constant Project::User

Trace:

Application Trace | Framework Trace | Full Trace
app/models/project.rb:48:in `<class:Project>'
app/models/project.rb:30:in `<top (required)>'
app/models/principal.rb:36:in `<class:Principal>'
app/models/principal.rb:30:in `<top (required)>'
app/models/user.rb:32:in `<top (required)>'
lib/open_project/plugins/acts_as_op_engine.rb:66:in `block (3 levels) in included'
lib/open_project/plugins/acts_as_op_engine.rb:63:in `each'
lib/open_project/plugins/acts_as_op_engine.rb:63:in `block (2 levels) in included'

The error occurs in the lib/open_project/plugins/acts_as_op_engine.rb in the constantize of User in the following line:

klass = klass_name.to_s.constantize

Things I’ve tested:

  • Moved back to stable —> same error
  • Tested a new stack/vm with a clean clone —> same error
  • Loading only my other plugins (e.g., openproject-revisions_git) with a user patch —> works.
    I can’t explain that one. The revisions_git plugin does not use the patch registry, but require_dependency and manual User.send. However, if I use that method in the TestPlugin, it still fails.
  • Loading the test plugin WITH my other plugins (i.e., multiple User patches) —> works fine
    I definitely can’t explain that one..

I’ve added the plugin as an attachment.

Attachments

lib/open_project/test_plugin/engine.rb

# Prevent load-order problems in case openproject-plugins is listed after a plugin in the Gemfile
# or not at all
require 'open_project/plugins'

module OpenProject::TestPlugin
  class Engine < ::Rails::Engine
    engine_name :openproject_test_plugin

    include OpenProject::Plugins::ActsAsOpEngine

    register 'openproject-test_plugin',
             :author_url => 'http://finn.de',
             :requires_openproject => '>= 3.0.0pre13'

    patches [:User]

  end
end

lib/open_project/test_plugin/patches/user_patch.rb

module OpenProject::TestPlugin
  module Patches
    module UserPatch
      def self.included(base)
        base.class_eval do
          unloadable

          include InstanceMethods

        end
      end

      module InstanceMethods
        def foo
          "bar from #{login}"
        end
      end
    end
  end
end

Replies (2)

RE: Patching User: uninitialized constant Project::User - Added by Jens Ulferts about 8 years ago

Hi Oliver,

I think the problem has to do with loading the constants.

There is some weird dependency between Principal, User and Project and depending on when everything is loaded, you can run into problems. At least that happened in the old days when we worked on some plugins changing the User model.

We tried to remove the problem by having some require statements somewhere I can’t remember right now. But apparently, this does not solve your problem.

You should be able to add some require statements to the User patch or to the engine (the later probably). I think it was:

require 'principal'
require 'user'
require 'project'

but the order of those might be different.

Hope to at least get you started. Otherwise, ask again.

RE: Patching User: uninitialized constant Project::User - Added by Oliver Günther about 8 years ago

Hi Jens,

thanks, that does indeed fix the problem!
I’ve tried require_dependency 'user' already, but was unaware that the other two dependencies would solve it.

Should others experience the same issues, If you use require, loading the app displays all sorts of redefined warnings.
Using require_dependency resolves that.

  • (1 - 2/2)
Loading...