Custom frame range: Plugin works with specific family

[iLLiCiTiT]

Changelog Description

The custom frame plugin does work with specific family "custom.frame.range", but also has backwards compatibility for the families that were defined by deadline plugin but only for hosts that did work with deadline addon.

Additional info

Using this approach it still works for hosts that did work before, but hosts that would like to use this new feature has to add "custom.frame.range" to instance to be able to show the option.

Testing notes:

1. Validate the proposed logic if actually makes sense!!!
2. For hosts and families for which it was already working it should work.
3. Add the "custom.frame.range" family to an instance in some other host to validate it shows for it too.

[moonyuet]

Tested with ynput/ayon-3dsmax#163, works with me.

[iLLiCiTiT]

Tested with ynput/ayon-3dsmax#163, works with me.

Nice! @BigRoy do you think this is good idea?

[BigRoy]

LGTM

I wonder if the family should actually be something like framerange.custom instead? 🤔 Fine with it either way - just feel like since we're pushing out more families as we intended that we need some naming rules? 🗡️

[LiborBatek]

I have been using it while testing the ayon-3dsmax and its been working together well...

[iLLiCiTiT]

just feel like since we're pushing out more families as we intended that we need some naming rules? 🗡️

I 100% agree, that's why I asked for you to take a look 🙂 . My initial idea was to use customizable.frame.range which exactly describes what "can" happen instead. Not sure if that is good idea tho...

[BigRoy]

Let's mark the below backwards compatibility in code cleary.

Suggested change

	if not IS_FARM_HOST:
	return False
	families.add(i_product_base_type)
	return bool(families.intersection(FARM_HOST_NAMES))
	# Backwards compatibility for farm host/families logic
	if not IS_FARM_HOST:
	return False
	families.add(i_product_base_type)
	return bool(families.intersection(FARM_HOST_NAMES))

I also wonder whether if this returns True we should log it.

Suggested change

	if not IS_FARM_HOST:
	return False
	families.add(i_product_base_type)
	return bool(families.intersection(FARM_HOST_NAMES))
	# Backwards compatibility for farm host/families logic
	if not IS_FARM_HOST:
	return False
	families.add(i_product_base_type)
	legacy_farm_families = families.intersection(FARM_HOST_NAMES)
	if legacy_farm_families:
	cls.log.debug(f"Detected legacy farm families: {legacy_farm_families}")
	return True
	return False

Just so that in time we can still notice which are using the old logic and whether we can deprecate them down the line.

[BigRoy]

I'd probably reverse them to something like:

framerange.custom_frames`

(I think if we were to pick that we'd need camelCase? framerange.customFrames?)
Or:

framerange.custom

@iLLiCiTiT

I think the . between frame and range is redundant, and even somewhat wrong.