Skip to content

chore: improve code comments #2167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 28, 2025
Merged

chore: improve code comments #2167

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 10 additions & 13 deletions packages/runtime/src/enhancements/node/policy/policy-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {
type FieldInfo,
type ModelMeta,
} from '../../../cross';
import { isPlainObject, simpleTraverse, lowerCaseFirst, upperCaseFirst } from '../../../local-helpers';
import { isPlainObject, lowerCaseFirst, simpleTraverse, upperCaseFirst } from '../../../local-helpers';
import {
AuthUser,
CrudContract,
Expand Down Expand Up @@ -469,7 +469,7 @@ export class PolicyUtil extends QueryUtils {

if (operation === 'read') {
// merge field-level read override guards
const fieldReadOverrideGuard = this.getFieldReadGuards(db, model, args);
const fieldReadOverrideGuard = this.getCombinedFieldOverrideReadGuards(db, model, args);
if (fieldReadOverrideGuard) {
guard = this.or(guard, fieldReadOverrideGuard);
}
Expand Down Expand Up @@ -610,10 +610,8 @@ export class PolicyUtil extends QueryUtils {
}

if (args.where) {
// inject into fields:
// to-many: some/none/every
// to-one: direct-conditions/is/isNot
// regular fields
// visit fields accessed in where clause and merge field-level policies,
// fields are only allowed in where if they satisfy field-level read policies.
const mergedGuard = this.buildReadGuardForFields(db, model, args.where, {});
args.where = this.mergeWhereClause(args.where, mergedGuard);
}
Expand Down Expand Up @@ -692,12 +690,10 @@ export class PolicyUtil extends QueryUtils {
const prefixConstraintVariables = (constraint: unknown, prefix: string) => {
return simpleTraverse(constraint, ({ value, update }) => {
if (isVariableConstraint(value)) {
update(
{
...value,
name: `${prefix}${value.name}`,
}
);
update({
...value,
name: `${prefix}${value.name}`,
});
}
});
};
Expand Down Expand Up @@ -961,7 +957,8 @@ export class PolicyUtil extends QueryUtils {
return def.fieldLevel?.update?.[field]?.overrideEntityChecker;
}

private getFieldReadGuards(db: CrudContract, model: string, args: { select?: any; include?: any }) {
// visit fields referenced in select/include and return a combined field-level override read guard
private getCombinedFieldOverrideReadGuards(db: CrudContract, model: string, args: { select?: any; include?: any }) {
const allFields = Object.values(getFields(this.modelMeta, model));

// all scalar fields by default
Expand Down
Loading