René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Class caching is too aggressive in dev","articleBody":"## This issue is a (choose one):\r\n\r\n- [x] Problem/bug report.\r\n- [ ] Feature request.\r\n- [ ] Request for support. **Note: Please try to avoid submitting issues for support requests. Use [Gitter](https://gitter.im/cerebris/jsonapi-resources) instead.** \r\n\r\n## Checklist before submitting:\r\n\r\n- [x] I've searched for an existing issue.\r\n- [ ] I've asked my question on [Gitter](https://gitter.im/cerebris/jsonapi-resources) and have not received a satisfactory answer.\r\n- [x] I've included a complete [bug report template](https://github.com/cerebris/jsonapi-resources/blob/master/lib/bug_report_templates/rails_5_master.rb). This step helps us and allows us to see the bug without trying to reproduce the problem from your description. It helps you because you will frequently detect if it's a problem specific to your project.\r\n- [ ] The feature I'm asking for is compliant with the [JSON:API](http://jsonapi.org/) spec.\r\n\r\n## Description\r\n\r\nChoose one section below and delete the other:\r\n\r\n### Bug reports:\r\n\r\nI'm using the `v0-11-dev` branch, and recently upgraded from commit 1bdacf1 to 311b1fe. If I start the server I can make a request for a resource just fine, but if I modify any resource I get empty results returned until I restart my dev server. I stepped through the commits on the `v0-11-dev` branch between the range above and narrowed it down to 2668b6b that seems to have introduced the bug. The resource queries after making code changes have a `AND (TRUE=FALSE)` condition appended to them which causes nothing to be returned. \r\n\r\nSteps to reproduce:\r\n\r\n1. Start dev server.\r\n    * Note, I have `eager_load = false, cache_classes = false` in development.rb, but do separately eager load my models if that might make a difference.\r\n3. Request a resource index, in my case \"users\"\r\n    * I see queries like this: `User Count (0.5ms)  SELECT COUNT(*) FROM \"users\"`\r\n4. Make any change to a resource, even an unrelated one. In my case, I removed the `updated_at` field from the list of fields\r\n5. Make the same request from step 2 again\r\n    * I now see queries like this: `User Count (0.2ms)  SELECT COUNT(*) FROM \"users\" WHERE (TRUE=FALSE)`\r\n    \r\n## UPDATE Feb 7, 2024\r\nThe `WHERE (TRUE=FALSE)` bit isn't specifically coming from `jsonapi-resources`, but is coming from `CanCanCan`, it's their default scope if no rules apply and you use `accessible_by` which I am using, and no rules apply due to class caching (more on that below).\r\n\r\nThe underlying problem is that the [new class caching](https://github.com/cerebris/jsonapi-resources/blob/v0-11-dev/lib/jsonapi/resource_common.rb#L543-L557) introduced in 2668b6b doesn't get reset when Rails reloads your application. I believe this is because `JSONAPI::Resource` doesn't live within the app, so modifications to the app code don't get picked up. So if you make a change to your app, then the following is true:\r\n* `YourModelResource` returns the new code (since it lives within the app)\r\n* `YourModelResource.resource_klass_for` returns the new code (again, it was reloaded)\r\n* `JSONAPI::Resource.resource_klass_for` returns the old code because it wasn't reloaded. Aside from the problems with `CanCanCan` I ran into, this also means that changes to resources don't get picked up without restarting your server.\r\n\r\nHere's the bug report template that reproduces this issue. Warning, it will write to `./app/resources/your_model_resource.rb` because the file needs to be there so the autoloader can reload it.\r\n```\r\n# ensure the resource exists in the \"unedited state\"\r\nMY_RESOURCE_FILE_PATH = File.dirname(__FILE__)\r\nputs \"creating resource file in #{MY_RESOURCE_FILE_PATH}\"\r\n`mkdir -p #{MY_RESOURCE_FILE_PATH}/app/resources`\r\n`echo 'class YourModelResource \u003c JSONAPI::Resource; attribute :name; end' \u003e #{MY_RESOURCE_FILE_PATH}/app/resources/your_model_resource.rb`\r\n\r\nbegin\r\n  require 'bundler/inline'\r\n  require 'bundler'\r\nrescue LoadError =\u003e e\r\n  STDERR.puts 'Bundler version 1.10 or later is required. Please update your Bundler'\r\n  raise e\r\nend\r\n\r\ngemfile(true, ui: ENV['SILENT'] ? Bundler::UI::Silent.new : Bundler::UI::Shell.new) do\r\n  source 'https://rubygems.org'\r\n\r\n  gem 'rails', require: false\r\n  gem 'sqlite3', platform: :mri\r\n\r\n  if ENV['JSONAPI_RESOURCES_PATH']\r\n    puts \"installing jsonapi-resources @ #{ENV['JSONAPI_RESOURCES_PATH']}\"\r\n    gem 'jsonapi-resources', path: ENV['JSONAPI_RESOURCES_PATH'], require: false\r\n  elsif ENV['BEFORE_BUG']\r\n    puts \"installing jsonapi-resources @ 0bbbc0bc9d3dbe547fc9a7e34aab2185d0cef682\"\r\n    gem 'jsonapi-resources', git: 'https://github.com/cerebris/jsonapi-resources', ref: '0bbbc0bc9d3dbe547fc9a7e34aab2185d0cef682', require: false\r\n  else\r\n    puts \"installing jsonapi-resources @ v0-11-dev\"\r\n    gem 'jsonapi-resources', git: 'https://github.com/cerebris/jsonapi-resources', branch: 'v0-11-dev', require: false\r\n  end\r\n\r\nend\r\n\r\n# prepare active_record database\r\nrequire 'active_record'\r\n\r\nclass NullLogger \u003c Logger\r\n  def initialize(*_args)\r\n  end\r\n\r\n  def add(*_args, \u0026_block)\r\n  end\r\nend\r\n\r\nActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')\r\nActiveRecord::Base.logger = ENV['SILENT'] ? NullLogger.new : Logger.new(STDOUT)\r\nActiveRecord::Migration.verbose = !ENV['SILENT']\r\n\r\nActiveRecord::Schema.define do\r\n  # Add your schema here\r\n  create_table :your_models, force: true do |t|\r\n    t.string :name\r\n  end\r\nend\r\n\r\nclass YourModel \u003c ActiveRecord::Base\r\nend\r\n\r\n# prepare rails app\r\nrequire 'action_controller/railtie'\r\n# require 'action_view/railtie'\r\nrequire 'jsonapi-resources'\r\n\r\nclass ApplicationController \u003c ActionController::Base\r\nend\r\n\r\n# prepare jsonapi resources and controllers\r\nclass YourModelsController \u003c ApplicationController\r\n  include JSONAPI::ActsAsResourceController\r\nend\r\n\r\nclass TestApp \u003c Rails::Application\r\n  config.root = File.dirname(__FILE__)\r\n  config.logger = ENV['SILENT'] ? NullLogger.new : Logger.new(STDOUT)\r\n  Rails.logger = config.logger\r\n\r\n  secrets.secret_token = 'secret_token'\r\n  secrets.secret_key_base = 'secret_key_base'\r\n\r\n\r\n  config.cache_classes = false\r\n  config.eager_load = false\r\n  config.hosts = [\"example.org\"]\r\nend\r\n\r\n# initialize app\r\nRails.application.initialize!\r\n\r\nJSONAPI.configure do |config|\r\n  config.json_key_format = :underscored_key\r\n  config.route_format = :underscored_key\r\nend\r\n\r\n# draw routes\r\nRails.application.routes.draw do\r\n  jsonapi_resources :your_models, only: [:index, :create]\r\nend\r\n\r\n# prepare tests\r\nrequire 'minitest/autorun'\r\nrequire 'rack/test'\r\n\r\n# Replace this with the code necessary to make your test fail.\r\nclass BugTest \u003c Minitest::Test\r\n\r\n  def test_resource_klass_cache_refreshes\r\n    assert_equal(\r\n      YourModelResource.object_id,\r\n      JSONAPI::Resource.resource_klass_for('your_models').object_id,\r\n      \"Expected resource to be returned from resource_klass_for\"\r\n    )\r\n    assert_equal(\r\n      %i[id name],\r\n      YourModelResource.fields,\r\n      \"Expected YourModelResource definition to be reset to default fields\"\r\n    )\r\n    assert_equal(\r\n      %i[id name],\r\n      JSONAPI::Resource.resource_klass_for('your_models').fields,\r\n      \"Expected JSONAPI::Resource.resource_klass_for definition to be reset to default fields\"\r\n    )\r\n\r\n    # \"update\" the resource class to make `display_name` the new `name` attribute\r\n    `echo 'class YourModelResource \u003c JSONAPI::Resource; attribute :display_name, delegate: :name; end' \u003e #{Rails.root}/app/resources/your_model_resource.rb`\r\n    Rails.application.reloader.reload!\r\n\r\n    assert_equal(\r\n      %i[id display_name],\r\n      YourModelResource.fields,\r\n      \"Expected YourModelResource definition to be reloaded\"\r\n    )\r\n\r\n    assert_equal(\r\n      %i[id display_name],\r\n      JSONAPI::Resource.resource_klass_for('your_models').fields,\r\n      \"Expected JSONAPI::Resource.resource_klass_for definition to be reloaded\"\r\n    )\r\n    assert_equal(\r\n      YourModelResource.object_id,\r\n      JSONAPI::Resource.resource_klass_for('your_models').object_id,\r\n      \"Expected updated resource to be returned from resource_klass_for after reload\"\r\n    )\r\n  end\r\nend\r\n```\r\n\r\nRun `BEFORE_BUG=true ruby test_template.rb` to see it pass\r\nRun `ruby test_template.rb` to see it fail against v0-11-dev","author":{"url":"https://github.com/adamkiczula","@type":"Person","name":"adamkiczula"},"datePublished":"2024-01-25T15:39:37.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/1439/jsonapi-resources/issues/1439"}