feat: Accept single filter function rather than dict

[mike-plummer]

CP-2790

Updates made in #8 added the ability to provide filter functions to conditionally exclude certain trait values from being used during selector generation. In a nod to performance these were structured to only call a filter function if the trait being considered exactly matched the one under consideration (exact attribute name match, usually). However, it is desired that filters be able to supply a regex to match traits (e.g. allow filtering multiple attributes with the same criteria) which necessitates a change in contract to supply a single filter function that encapsulates all the necessary filtering logic. This will have a small performance impact on selector generation since every single trait will need to call into this filter function, but impact can be mitigated by aggressive use of the supplied type and key params as well as appropriate caching/memoization when crafting the filter param.

Note: I had originally planned to handle caching internally here (since we already are doing so for overall selector gen and isUnique checks) but doing so required pulling in a lot of knowledge of how filters are being structured for our specific use case. I backed that out to reduce coupling and believe caching can be handled as efficiently/elegantly by the caller, but if anyone sees a superior approach I'd be interested to hear it since this lib has significant performance implications for UICov.

Once this merges there will be follow-on changes in cypress-services side to update this dep and build an appropriate filter function off of config

Before

unique(
  element,
  {
    filters: {
      'ng-type': (type, key, value) => value !== 'test',
      'ng-kind': (type, key, value) => value !== 'test'
    }
  }
)

After

unique(
  element,
  {
    filter: _.memoize(
      (type, key, value) => {
        if (type === 'attribute' && /^((ng-type)|(ng-kind))$/.test(key)) {
          return value !== 'test'
        }
        return true
      },
      (type, key, value) => `${type}${key}${value}`
    )
  }
)

[tbiethman]

Makes sense to me - wanted to confirm we're releasing a new major version (2.0.0) for this?

[mike-plummer]

Makes sense to me - wanted to confirm we're releasing a new major version (2.0.0) for this?

@tbiethman Yes, this is a breaking change so I will mark this as such on merge which should trigger a major version bump

[github-actions]

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀