{"record":{"id":"65e642945679dc98","repo":"instructure/canvas-lms","slug":"setting-name-must-be-a-symbol-or-string","errorCode":null,"errorMessage":"setting_name must be a symbol or string","messagePattern":"setting_name must be a symbol or string","errorType":"validation","errorClass":"ArgumentError","httpStatus":null,"severity":"error","filePath":"lib/canvas_operations/base_concerns/settings.rb","lineNumber":83,"sourceCode":"        Canvas::Reloader.reload\n\n        settings_key = settings_key(name, cluster:)\n        value = Setting.get(settings_key, default)\n        log_message(\"Fetched setting #{settings_key} with value `#{value.inspect}` before type casting\", level: :debug)\n\n        value\n      end\n\n      def modify_setting_for(name, value, cluster:)\n        was_success = Setting.set(settings_key(name, cluster:), value)\n        log_message(\"Modified setting #{settings_key(name, cluster:)} to value `#{value.inspect}` successfully? #{was_success}\")\n\n        was_success\n      end\n\n      def setting(setting_name, default:, type_cast: :to_s)\n        raise ArgumentError, \"setting_name cannot be nil\" if setting_name.nil?\n        raise ArgumentError, \"setting_name must be a symbol or string\" unless setting_name.is_a?(Symbol) || setting_name.is_a?(String)\n\n        validate_type_cast!(type_cast, setting_name)\n\n        # Method to get the Setting value and apply type casting\n        #\n        # If no cluster is provided, the current shard's cluster.\n        define_singleton_method(setting_name) do |cluster: nil|\n          cluster ||= Shard.current.database_server.id\n\n          raw_value = setting_for(setting_name, default:, cluster:)\n\n          case type_cast\n          when Symbol\n            raw_value.public_send(type_cast)\n          when Proc\n            type_cast.call(raw_value)\n          end\n        end","sourceCodeStart":65,"sourceCodeEnd":101,"githubUrl":"https://github.com/instructure/canvas-lms/blob/1c9f0bb8013ed69c4f2efe11fd483025469b7e6c/lib/canvas_operations/base_concerns/settings.rb#L65-L101","documentation":"ArgumentError raised by CanvasOperations::Settings#setting when setting_name is neither a Symbol nor a String. This strictness guarantees the settings_key namespace is built from a predictable, inspectable name.","triggerScenarios":"Passing an Integer, nil-like wrapper, or other object as setting_name, e.g. setting(42, default: ...), or a variable holding a non-string type.","commonSituations":"Interpolating numbers/IDs directly as setting names; reading the name from JSON where it parsed as a number; passing a configuration object instead of its key.","solutions":["Convert the value: name.to_s or name.to_sym before calling setting","Verify the variable actually contains the setting's name, not a record or ID","Use a constant/enum of allowed setting names"],"exampleFix":"// before\nsetting(id, default: 5)\n// after\nsetting(id.to_s, default: 5)","handlingStrategy":"type-guard","validationCode":"raise 'must be Symbol or String' unless name.is_a?(Symbol) || name.is_a?(String)","typeGuard":"def valid_setting_name?(name)\n  name.is_a?(Symbol) || name.is_a?(String)\nend","tryCatchPattern":"rescue ArgumentError => e\n  Rails.logger.error(\"Bad setting name: #{e.message}\")\nend","preventionTips":["Normalize names with .to_s/.to_sym before calling","Verify variables hold the name, not a record or ID","Type-annotate config parsers so names parse as strings"],"tags":["ruby","arguments","type-mismatch","canvas-operations"],"backgroundTag":"invalid-argument-value","analyzedSha":"1c9f0bb8013ed69c4f2efe11fd483025469b7e6c","analyzedAt":"2026-09-15T20:33:18.891Z","contentChangedAt":"2026-09-15T20:33:18.891Z","schemaVersion":2},"datasetVersion":"2026-09-23T02:17:17.105Z"}