Fixes #37651 - Fix error msg about invalid MAC appearing twice #10245

adamlazik1 · 2024-07-16T13:25:04Z

Currently when entering an invalid MAC address while editing a host's interface, the message shown is:
"'fa:16:3e:17:3e:19x' is not a valid MAC address and is not a valid MAC address"

This is because before the validation itself, another method normalize_mac is called, which also raises an error upon finding a MAC address invalid (foreman/app/models/nic/base.rb).

Since I found the method normalize_mac being used at multiple places, I did not want to alter the behavior of this method. Validation through the MacAddressValidator seems to be used only once, so I deemed more proper to edit the method there. Still, I am not certain if the two methods are equivalent as far as validation goes, so I just added a condition which prevents duplicating the error message if normalize_mac already threw an error.

ekohl · 2024-07-22T16:56:40Z

app/validators/mac_address_validator.rb

-    record.errors.add(attribute, (options[:message] || _("is not a valid MAC address")))
+    err_msg = _("is not a valid MAC address")
+    # error message can already be present from the Net::Validations::normalize_mac method
+    if record.errors.full_messages.none? { |message| message.include?(err_msg) }


Would it be sufficient to check if for the given attribute there's already any error message? I'd like to avoid doing string comparisons on error messages because it can easily break on translations. For example, when one is missing a translation while the other is translated. Or in a different way so it's not a substring.

Thanks for the tip, it seems to do the trick.

ekohl · 2024-07-23T15:31:46Z

app/validators/mac_address_validator.rb

@@ -6,7 +6,10 @@ def validate_each(record, attribute, value)
  end

  def make_invalid(record, attribute)
-    record.errors.add(attribute, (options[:message] || _("is not a valid MAC address")))
+    # error message can already be present from the Net::Validations::normalize_mac method
+    if record.errors[:mac].empty?


Shouldn't this be for the same attribute?

Suggested change

if record.errors[:mac].empty?

if record.errors[attribute].empty?

Sorry for the double comment, but I just looked and in the other place it's also hardcoded:

foreman/app/services/ipam/base.rb

Lines 64 to 69 in 2d5bd87

def normalize_mac!

return unless mac.present?

self.mac = Net::Validations.normalize_mac(mac)

rescue Net::Validations::Error

errors.add(:mac, _('is not a valid MAC address'))

end

That makes me question why we call normalize twice. I'm not sure the service should add an error in the first place but it was introduced in 990dee6 so I suspect this bug has been around for a long time.

What I suspect happens is that it calls before_validation:

foreman/app/models/nic/base.rb

Line 14 in 2d5bd87

before_validation :normalize_mac

foreman/app/models/nic/base.rb

Lines 282 to 287 in 2d5bd87

def normalize_mac

self.mac = Net::Validations.normalize_mac(mac)

true

rescue Net::Validations::Error => e

errors.add(:mac, e.message)

end

And then it validates (which is the code you're editing now):

foreman/app/models/nic/base.rb

Line 24 in 2d5bd87

validates :mac, :mac_address => true, :allow_blank => true

It makes me think your current patch is a correct short term fix (because it does make still ensure it's invalid), but we should really untangle the whole mess.

Sorry for the double comment, but I just looked and in the other place it's also hardcoded:

foreman/app/services/ipam/base.rb

Lines 64 to 69 in 2d5bd87

def normalize_mac!

return unless mac.present?

self.mac = Net::Validations.normalize_mac(mac)

rescue Net::Validations::Error

errors.add(:mac, _('is not a valid MAC address'))

end

That makes me question why we call normalize twice. I'm not sure the service should add an error in the first place but it was introduced in 990dee6 so I suspect this bug has been around for a long time.

I am not sure if normalize_mac and MacAddressValidator do the same thing, so I'd prefer not to touch that 😄

@ekohl should I revert this back to record.errors.[:mac]?

ekohl

This looks good to me. Just one small note where I'm not entirely sure about the Rails API.

ekohl · 2024-07-30T13:36:10Z

app/validators/mac_address_validator.rb

@@ -6,7 +6,10 @@ def validate_each(record, attribute, value)
  end

  def make_invalid(record, attribute)
-    record.errors.add(attribute, (options[:message] || _("is not a valid MAC address")))
+    # error message can already be present from the Net::Validations::normalize_mac method
+    if record.errors[attribute].empty?


Do you happen to know if it's guaranteed to be non-nil? I'd be tempted to add the safe navigator.

Suggested change

if record.errors[attribute].empty?

if record.errors[attribute]&.empty?

I think it should always be non-nil, but we can't do anything wrong by adding the safe navigator so I am accepting the suggestion.

Actually, I realized this inverts the logic should record.errors be nil. I will come up with something else.

Added check for nil.

Currently when entering an invalid MAC address while editing a host's interface, the message shown is: "'fa:16:3e:17:3e:19x' is not a valid MAC address and is not a valid MAC address" This is because before the validation itself, another method Net::Validations::normalize_mac is called, which also raises an error upon finding a MAC address invalid (foreman/app/models/nic/base.rb). Since I found the method normalize_mac being used at multiple places, I did not want to alter the behavior of this method. Validation through the MacAddressValidator seems to be used only once, so I deemed more proper to edit the method there. Still, I am not certain if the two methods are equivalent as far as validation goes, so I just added a condition which prevents duplicating the error message if normalize_mac already threw an error.

pr-processor bot added the Not yet reviewed label Jul 16, 2024

adamlazik1 force-pushed the fix-mac-error-message branch 2 times, most recently from 9c0dcbe to bcea13d Compare July 22, 2024 11:16

ekohl requested changes Jul 22, 2024

View reviewed changes

pr-processor bot added Waiting on contributor and removed Not yet reviewed labels Jul 22, 2024

ekohl mentioned this pull request Jul 23, 2024

Improve review labels for PRs theforeman/foreman-documentation#3155

Open

adamlazik1 force-pushed the fix-mac-error-message branch from bcea13d to c35c37d Compare July 23, 2024 14:25

pr-processor bot added Needs re-review and removed Waiting on contributor labels Jul 23, 2024

adamlazik1 force-pushed the fix-mac-error-message branch from c35c37d to d0fa1d0 Compare July 23, 2024 14:26

ekohl reviewed Jul 23, 2024

View reviewed changes

adamlazik1 force-pushed the fix-mac-error-message branch from d0fa1d0 to a4ab4bb Compare July 23, 2024 16:12

ekohl previously approved these changes Jul 30, 2024

View reviewed changes

pr-processor bot removed the Needs re-review label Jul 30, 2024

adamlazik1 dismissed ekohl’s stale review via 800a4a6 July 30, 2024 13:46

pr-processor bot added the Waiting on contributor label Jul 30, 2024

adamlazik1 force-pushed the fix-mac-error-message branch from 800a4a6 to ffce2b8 Compare July 30, 2024 13:48

pr-processor bot added Needs re-review and removed Waiting on contributor labels Jul 30, 2024

adamlazik1 force-pushed the fix-mac-error-message branch 2 times, most recently from aa6c7c4 to b4eccd2 Compare July 30, 2024 14:06

adamlazik1 force-pushed the fix-mac-error-message branch from b4eccd2 to abf0c87 Compare July 30, 2024 14:12

ekohl approved these changes Jul 30, 2024

View reviewed changes

pr-processor bot removed the Needs re-review label Jul 30, 2024

ekohl merged commit 38fae6e into theforeman:develop Jul 30, 2024
50 of 51 checks passed

adamlazik1 deleted the fix-mac-error-message branch July 30, 2024 15:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes #37651 - Fix error msg about invalid MAC appearing twice #10245

Fixes #37651 - Fix error msg about invalid MAC appearing twice #10245

adamlazik1 commented Jul 16, 2024

ekohl Jul 22, 2024

adamlazik1 Jul 23, 2024

ekohl Jul 23, 2024

ekohl Jul 23, 2024

adamlazik1 Jul 23, 2024

adamlazik1 Jul 23, 2024

adamlazik1 Jul 30, 2024 •

edited

Loading

ekohl left a comment

ekohl Jul 30, 2024

adamlazik1 Jul 30, 2024

adamlazik1 Jul 30, 2024 •

edited

Loading

adamlazik1 Jul 30, 2024

	if record.errors[:mac].empty?
	if record.errors[attribute].empty?

	def normalize_mac!
	return unless mac.present?
	self.mac = Net::Validations.normalize_mac(mac)
	rescue Net::Validations::Error
	errors.add(:mac, _('is not a valid MAC address'))
	end

	def normalize_mac
	self.mac = Net::Validations.normalize_mac(mac)
	true
	rescue Net::Validations::Error => e
	errors.add(:mac, e.message)
	end

	if record.errors[attribute].empty?
	if record.errors[attribute]&.empty?

Fixes #37651 - Fix error msg about invalid MAC appearing twice #10245

Fixes #37651 - Fix error msg about invalid MAC appearing twice #10245

Conversation

adamlazik1 commented Jul 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamlazik1 Jul 30, 2024 • edited Loading

Choose a reason for hiding this comment

ekohl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamlazik1 Jul 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamlazik1 Jul 30, 2024 •

edited

Loading

adamlazik1 Jul 30, 2024 •

edited

Loading