Insync? not invoked for Puppet::Property::Boolean

[h-haaks]

Describe the Bug

I have a custom type with a boolean property defined as

newproperty(:myprop, parent: Puppet::Property::Boolean) do
end

On puppet run when 'is' value is true and 'should' value is false, the insync? is never invoked and puppet does not change the value of the property!

I think the problem is here https://github.com/puppetlabs/puppet/blob/main/lib/puppet/property.rb#L274
When @should is false at this point safe_insync? never invoke insync?

Expected Behavior

I would expect puppet to change the value from true to false

[h-haaks]

I'm not sure, but would this fix be enough?
return true if @should.nil?

[joshcooper]

This is https://perforce.atlassian.net/browse/PUP-2368 for properties and https://perforce.atlassian.net/browse/PUP-8442 for parameters. We tried to fix parameters before and caused a regression in the vcs module which caused repos to be forceable deleted, so the fix needs to be opt-in.

There are likely several places where puppet conflates false and nil such as the transaction, resource_harness and events/reports.

The workaround is to use symbols :true :false as described in https://dev.to/betadots/the-ruby-side-of-puppet-part-3-custom-types-and-providers-4hma