🧹 Remove MultiJSON, JSON and Yajl (Use Oj instead) (#3785)

* Remove MultiJSON

- Use Oj.load and Oj.dump
- Oj.load => rescue StandardError
- Oj.dump + RestController => mode: :compat
- No 'pretty' option anymore

* Remove JSON

- Use Oj.load and Oj.dump

* Remove Yajl

- Use Oj.load and Oj.dump

* Add Cop that detects the usage of other JSON libraries than Oj

Author: philippthun

.rubocop_cc.yml

@@ -8,6 +8,7 @@ require:
   - ./spec/linters/migration/include_string_size.rb
   - ./spec/linters/migration/require_primary_key.rb
   - ./spec/linters/match_requires_with_includes.rb
+  - ./spec/linters/prefer_oj_over_other_json_libraries.rb
 
 AllCops:
   TargetRubyVersion: 3.2
@@ -81,7 +82,7 @@ Rails/CreateTableWithTimestamps: # Exclude for old Migrations
     - !ruby/regexp /db/migrations/202([0-2]|30[0-7]).+\.rb$/
     - spec/**/*
 
-Rails/HttpPositionalArguments: # Brakes Code for specs as it`s not rails used there it`s a test framework(racktest)
+Rails/HttpPositionalArguments: # Breaks Code for specs as it`s not rails used there it`s a test framework(racktest)
   Exclude:
     - spec/**/*
 
@@ -546,13 +547,13 @@ Style/SingleLineDoEndBlock:
   Enabled: true
 
 ### Broken Cops that break code
-Lint/ShadowedException: # Brakes "bundle exec rake rubocop" if enabled
+Lint/ShadowedException: # Breaks "bundle exec rake rubocop" if enabled
   Enabled: false
-Sequel/SaveChanges: # Brakes Code
+Sequel/SaveChanges: # Breaks Code
   Enabled: false
-Rails/DynamicFindBy: # Brakes Code
+Rails/DynamicFindBy: # Breaks Code
   Enabled: false
-Rails/FindEach: # Brakes Code
+Rails/FindEach: # Breaks Code
   Enabled: false
 Rails/RedundantActiveRecordAllMethod: # As we use Sequel this breaks code as it matches Sequel functions
   Enabled: false

Gemfile

@@ -19,7 +19,6 @@ gem 'loggregator_emitter', '~> 5.0'
 gem 'membrane', '~> 1.0'
 gem 'mime-types', '~> 3.5'
 gem 'mock_redis'
-gem 'multi_json'
 gem 'multipart-parser'
 gem 'netaddr', '>= 2.0.4'
 gem 'net-ssh'
@@ -47,7 +46,6 @@ gem 'talentbox-delayed_job_sequel', '~> 4.3.0'
 gem 'thin'
 gem 'unf'
 gem 'vmstat', '~> 2.3'
-gem 'yajl-ruby'
 
 # Rails Components
 gem 'actionpack', '~> 7.1.0'

Gemfile.lock

@@ -628,7 +628,6 @@ DEPENDENCIES
   membrane (~> 1.0)
   mime-types (~> 3.5)
   mock_redis
-  multi_json
   multipart-parser
   mysql2 (~> 0.5.6)
   net-ssh
@@ -681,7 +680,6 @@ DEPENDENCIES
   vcap-concurrency!
   vmstat (~> 2.3)
   webmock (> 2.3.1)
-  yajl-ruby
 
 BUNDLED WITH
    2.4.10

app/controllers/base/base_controller.rb

@@ -203,12 +203,15 @@ def current_user_email
     end
 
     def parse_and_validate_json(body)
-      parsed = body && MultiJson.load(body)
-      raise MultiJson::ParseError.new('invalid request body') unless parsed.is_a?(Hash)
+      begin
+        parsed = Oj.load(body) unless body.nil?
+      rescue StandardError => e
+        bad_request!(e.message)
+      end
+
+      bad_request!('invalid request body') unless parsed.is_a?(Hash)
 
       parsed
-    rescue MultiJson::ParseError => e
-      bad_request!(e.message)
     end
 
     def bad_request!(message)

app/controllers/internal/app_crashed_controller.rb

@@ -26,16 +26,11 @@ def crashed(lrp_process_guid)
     private
 
     def crashed_request
-      crashed = {}
-      begin
-        payload = body.read
-        crashed = MultiJson.load(payload)
-      rescue MultiJson::ParseError => e
-        logger.error('diego.app_crashed.parse-error', payload: payload, error: e.to_s)
-        raise CloudController::Errors::ApiError.new_from_details('MessageParseError', payload)
-      end
-
-      crashed
+      payload = body.read
+      Oj.load(payload)
+    rescue StandardError => e
+      logger.error('diego.app_crashed.parse-error', payload: payload, error: e.to_s)
+      raise CloudController::Errors::ApiError.new_from_details('MessageParseError', payload)
     end
   end
 end

app/controllers/internal/app_readiness_changed_controller.rb

@@ -25,16 +25,11 @@ def readiness_changed(process_guid)
     private
 
     def readiness_request
-      readiness = {}
-      begin
-        payload = body.read
-        readiness = MultiJson.load(payload)
-      rescue MultiJson::ParseError => e
-        logger.error('diego.app_readiness_changed.parse-error', payload: payload, error: e.to_s)
-        raise CloudController::Errors::ApiError.new_from_details('MessageParseError', payload)
-      end
-
-      readiness
+      payload = body.read
+      Oj.load(payload)
+    rescue StandardError => e
+      logger.error('diego.app_readiness_changed.parse-error', payload: payload, error: e.to_s)
+      raise CloudController::Errors::ApiError.new_from_details('MessageParseError', payload)
     end
   end
 end

app/controllers/internal/app_rescheduling_controller.rb

@@ -25,16 +25,11 @@ def rescheduling(process_guid)
     private
 
     def rescheduling_request
-      rescheduling = {}
-      begin
-        payload = body.read
-        rescheduling = MultiJson.load(payload)
-      rescue MultiJson::ParseError => e
-        logger.error('diego.app_rescheduling.parse-error', payload: payload, error: e.to_s)
-        raise CloudController::Errors::ApiError.new_from_details('MessageParseError', payload)
-      end
-
-      rescheduling
+      payload = body.read
+      Oj.load(payload)
+    rescue StandardError => e
+      logger.error('diego.app_rescheduling.parse-error', payload: payload, error: e.to_s)
+      raise CloudController::Errors::ApiError.new_from_details('MessageParseError', payload)
     end
   end
 end

app/controllers/internal/app_security_group_controller.rb

@@ -3,7 +3,7 @@ class AppSecurityGroupController < RestController::BaseController
     allow_unauthenticated_access
     get '/internal/v4/asg_latest_update', :return_asg_latest_update
     def return_asg_latest_update
-      [HTTP::OK, MultiJson.dump({ last_update: AsgLatestUpdate.last_update.to_datetime.rfc3339(9) }, pretty: true)]
+      [HTTP::OK, Oj.dump({ last_update: AsgLatestUpdate.last_update.to_datetime.rfc3339(9) }, mode: :compat)]
     end
   end
 end

app/controllers/internal/packages_controller.rb

@@ -8,7 +8,12 @@ class PackagesController < RestController::BaseController
 
       patch '/internal/v4/packages/:guid', :update
       def update(guid)
-        payload = MultiJson.load(body)
+        begin
+          payload = Oj.load(body)
+        rescue StandardError => e
+          raise CloudController::Errors::ApiError.new_from_details('MessageParseError', e.message)
+        end
+
         message = ::VCAP::CloudController::InternalPackageUpdateMessage.new(payload)
         unprocessable!(message.errors.full_messages) unless message.valid?
 
@@ -20,8 +25,6 @@ def update(guid)
         HTTP::NO_CONTENT
       rescue InternalPackageUpdate::InvalidPackage => e
         unprocessable!(e.message)
-      rescue MultiJson::ParseError => e
-        raise CloudController::Errors::ApiError.new_from_details('MessageParseError', e.message)
       end
 
       private

app/controllers/internal/staging_completion_controller.rb

@@ -94,7 +94,7 @@ def parse_bbs_task_callback(staging_response)
         logger.error('diego.staging.completion-controller.staging-failed', staging_response)
         result[:error] = Diego::FailureReasonSanitizer.sanitize(staging_response[:failure_reason])
       else
-        result[:result] = MultiJson.load(staging_response[:result], symbolize_keys: true)
+        result[:result] = Oj.load(staging_response[:result], symbol_keys: true)
       end
       result
     end
@@ -121,16 +121,11 @@ def prometheus_updater
     attr_reader :stagers
 
     def read_body
-      staging_response = {}
-      begin
-        payload          = body.read
-        staging_response = MultiJson.load(payload, symbolize_keys: true)
-      rescue MultiJson::ParseError => e
-        logger.error('diego.staging.parse-error', payload: payload, error: e.to_s)
-        raise CloudController::Errors::ApiError.new_from_details('MessageParseError', payload)
-      end
-
-      staging_response
+      payload          = body.read
+      Oj.load(payload, symbol_keys: true)
+    rescue StandardError => e
+      logger.error('diego.staging.parse-error', payload: payload, error: e.to_s)
+      raise CloudController::Errors::ApiError.new_from_details('MessageParseError', payload)
     end
   end
 end