feat(filter): implement ensureFields utility

[InvictusMB]

Split from #5592

Checklist

• DCO (Developer Certificate of Origin) signed in all commits
• npm test passes on your machine
• New tests added or existing tests modified to cover all changes
• Code conforms with the style guide
• API Documentation in code was updated
• Documentation in /docs/site was updated
• Affected artifact templates in packages/cli were updated
• Affected example projects in examples/* were updated

👉 Check out how to submit a PR 👈

[raymondfeng]

@achrinza Would you like to review it?

[bajtos]

@mdbetancourt could you please review the changes proposed in this pull request? I feel they may be related to the work you contributed in #6517.

[mdbetancourt]

@bajtos It looks good to me, @InvictusMB I think you can make some changes to make the code more understandable and avoid adding a library like lodash, I made the suggestions quickly so maybe you have to make some final adjustments

[mdbetancourt]

this is some hard to understand a suggestion could be uses every instead of some negation a vanilla version:

Suggested change

	const isDisablingOnly = _.size(fields) > 0 && !_.some(fields, Boolean);
	const isDisablingOnly = Object.values(fields).length > 0 && Object.values(fields).every(f => !f);

[mdbetancourt]

Suggested change

	export function matchesFields<T extends object = AnyObject>(
	fields: (keyof T)[],
	filter?: Filter<T>,
	) {
	const normalized = new FilterBuilder(filter).build();
	const targetFields = normalized.fields;
	if (!targetFields) {
	return true;
	}
	const isDisablingOnly =
	_.size(targetFields) > 0 && !_.some(targetFields, Boolean);
	for (const f of fields) {
	if (!targetFields[f] && (f in targetFields || !isDisablingOnly)) {
	return false;
	}
	}
	return true;
	}
	function isSuperset(set, subset) {
	for (let elem of subset) {
	if (!set.has(elem)) {
	return false
	}
	}
	return true
	}
	function difference(setA, setB) {
	let _difference = new Set(setA)
	for (let elem of setB) {
	_difference.delete(elem)
	}
	return _difference
	}

[mdbetancourt]

Suggested change

	const fields = builder.build().fields;
	if (!fields || matchesFields(targetFields, filter)) {
	return {
	filter: builder.build(),
	fieldsAdded: [] as (keyof T)[],
	};
	}
	const fields = new Set(Object.keys(builder.build().fields));
	const target = new Set(Object.keys(targetFields))
	if (!fields.size || isSuperset(target, fields)) {
	return {
	filter: builder.build(),
	fieldsAdded: [],
	};
	}

[mdbetancourt]

Suggested change

	const fieldsAdded = (isDisablingOnly ? _.keys(fields) : []) as (keyof T)[];
	targetFields.forEach(f => {
	if (!fields[f]) {
	fieldsAdded.push(f);
	builder.fields(f);
	}
	});
	const newFilter = builder.build();
	// if the filter only hides the fields, unset the entire fields clause
	if (isDisablingOnly) {
	delete filter.fields;
	}
	return {
	filter: newFilter,
	fieldsAdded: _.uniq(fieldsAdded) as (keyof T)[],
	} as const;
	}
	const fieldsAdded = difference(target, fields)
	fieldsAdded.forEach(builder.fields)
	return {
	filter: builder.build(),
	fieldsAdded
	} as const;
	}

[agnes512]

Almost LGTM 👍 I will review it again once those comments from @mdbetancourt are addressed.

[dhmlau]

@agnes512, assigning this PR to you since you're helping it to land. Thanks.

[agnes512]

@InvictusMB any updates?

[stale]

This pull request has been marked stale because it has not seen activity within two months. It will be closed within 14 days of being stale unless there is new activity.

[InvictusMB]

Not stale. I'll have time to refresh this soon.

[stale]

This pull request has been marked stale because it has not seen activity within two months. It will be closed within 14 days of being stale unless there is new activity.

[stale]

This pull request has been closed due to continued inactivity. If you are interested in finishing the proposed changes, then feel free to re-open this pull request or open a new one.