Skip to content

The open alternative to Salesforce, designed for AI.

Keep where objects built in another realm, and refuse a where condition the builder cannot read (#26919)

Félix Malfait1f7a54fd277a
diff --git a/packages/twenty-server/src/engine/twenty-orm/query-builder/__tests__/workspace-select-query-builder-where.spec.ts b/packages/twenty-server/src/engine/twenty-orm/query-builder/__tests__/workspace-select-query-builder-where.spec.ts
index a917468e1d7..86637d0581c 100644
--- a/packages/twenty-server/src/engine/twenty-orm/query-builder/__tests__/workspace-select-query-builder-where.spec.ts
+++ b/packages/twenty-server/src/engine/twenty-orm/query-builder/__tests__/workspace-select-query-builder-where.spec.ts
@@ -1,3 +1,5 @@
+import { runInNewContext } from 'node:vm';
+
import { And, Equal, In, LessThan, Not } from 'typeorm';
import { TwentyOrmException } from 'src/engine/twenty-orm/exceptions/twenty-orm.exception';
@@ -204,4 +206,49 @@ describe('WorkspaceSelectQueryBuilder where', () => {
expect(queryBuilder.getQuery()).toContain('("person"."companyId" IS NULL)');
});
+
+ it('should filter on an object-literal where built in another realm', () => {
+ const { queryBuilder } = buildQueryBuilder();
+
+ queryBuilder
+ .setFindOptions({ select: { id: true } })
+ .where(runInNewContext("({ companyId: 'company-1' })"));
+
+ const [text, values] = queryBuilder.getQueryAndParameters();
+
+ expect(text).toContain('("person"."companyId" = $1)');
+ expect(values).toEqual(['company-1']);
+ });
+
+ it('should apply a find operator from another copy of typeorm', () => {
+ let isolatedIn: typeof In = In;
+
+ jest.isolateModules(() => {
+ isolatedIn = jest.requireActual<typeof import('typeorm')>('typeorm').In;
+ });
+
+ const { queryBuilder } = buildQueryBuilder();
+
+ queryBuilder
+ .setFindOptions({ select: { id: true } })
+ .where({ companyId: isolatedIn(['company-1', 'company-2']) });
+
+ const [text, values] = queryBuilder.getQueryAndParameters();
+
+ expect(isolatedIn).not.toBe(In);
+ expect(text).toContain('("person"."companyId" IN ($1, $2))');
+ expect(values).toEqual(['company-1', 'company-2']);
+ });
+
+ it('should refuse a where condition it cannot read instead of dropping it', () => {
+ const { queryBuilder } = buildQueryBuilder();
+
+ queryBuilder.setFindOptions({ select: { id: true } });
+
+ expect(() =>
+ queryBuilder.where(
+ new Map([['companyId', 'company-1']]) as unknown as string,
+ ),
+ ).toThrow(TwentyOrmException);
+ });
});
diff --git a/packages/twenty-server/src/engine/twenty-orm/query-builder/types/query-builder.type.ts b/packages/twenty-server/src/engine/twenty-orm/query-builder/types/query-builder.type.ts
index 343cc31c87e..0dfe2b87baf 100644
--- a/packages/twenty-server/src/engine/twenty-orm/query-builder/types/query-builder.type.ts
+++ b/packages/twenty-server/src/engine/twenty-orm/query-builder/types/query-builder.type.ts
@@ -30,12 +30,19 @@ export const isWhereFactoryLike = (
condition !== null &&
typeof (condition as WhereFactoryLike).whereFactory === 'function';
+// Compares prototype depth, not identity: an object literal built in another
+// realm, such as an integration test file, has its own Object.prototype.
export const isObjectWhereLike = (
condition: unknown,
-): condition is ObjectWhereLike =>
- typeof condition === 'object' &&
- condition !== null &&
- Object.getPrototypeOf(condition) === Object.prototype;
+): condition is ObjectWhereLike => {
+ if (typeof condition !== 'object' || condition === null) {
+ return false;
+ }
+
+ const prototype = Object.getPrototypeOf(condition);
+
+ return prototype === null || Object.getPrototypeOf(prototype) === null;
+};
export const isNegatedWhereFactoryLike = (condition: unknown): boolean =>
isWhereFactoryLike(condition) && InstanceChecker.isNotBrackets(condition);
diff --git a/packages/twenty-server/src/engine/twenty-orm/query-builder/utils/__tests__/apply-mutation-criteria.util.spec.ts b/packages/twenty-server/src/engine/twenty-orm/query-builder/utils/__tests__/apply-mutation-criteria.util.spec.ts
index c45f4570cd7..9b8d1403135 100644
--- a/packages/twenty-server/src/engine/twenty-orm/query-builder/utils/__tests__/apply-mutation-criteria.util.spec.ts
+++ b/packages/twenty-server/src/engine/twenty-orm/query-builder/utils/__tests__/apply-mutation-criteria.util.spec.ts
@@ -1,3 +1,5 @@
+import { runInNewContext } from 'node:vm';
+
import { FieldMetadataType } from 'twenty-shared/types';
import { TwentyOrmException } from 'src/engine/twenty-orm/exceptions/twenty-orm.exception';
@@ -90,4 +92,25 @@ describe('applyMutationCriteriaToQueryBuilder', () => {
applyMutationCriteriaToQueryBuilder(buildQueryBuilder(), ''),
).toThrow(TwentyOrmException);
});
+
+ it.each([
+ ['an empty where object', {}],
+ ['an empty null-prototype where object', Object.create(null)],
+ ['a where array with an empty entry', [{ name: 'Ada' }, {}]],
+ ['a where array with an empty null-prototype entry', [Object.create(null)]],
+ ])('throws on %s, which would reach every row', (_label, criteria) => {
+ expect(() =>
+ applyMutationCriteriaToQueryBuilder(buildQueryBuilder(), criteria),
+ ).toThrow(TwentyOrmException);
+ });
+
+ it('applies a where object built in another realm', () => {
+ const [text, values] = applyMutationCriteriaToQueryBuilder(
+ buildQueryBuilder(),
+ [runInNewContext("({ name: 'Ada' })")],
+ ).getQueryAndParameters();
+
+ expect(text).toContain('"person"."name" = $1');
+ expect(values).toContain('Ada');
+ });
});
diff --git a/packages/twenty-server/src/engine/twenty-orm/query-builder/utils/apply-mutation-criteria.util.ts b/packages/twenty-server/src/engine/twenty-orm/query-builder/utils/apply-mutation-criteria.util.ts
index 31762785585..2d4f844eb47 100644
--- a/packages/twenty-server/src/engine/twenty-orm/query-builder/utils/apply-mutation-criteria.util.ts
+++ b/packages/twenty-server/src/engine/twenty-orm/query-builder/utils/apply-mutation-criteria.util.ts
@@ -5,7 +5,10 @@ import {
TwentyOrmExceptionCode,
} from 'src/engine/twenty-orm/exceptions/twenty-orm.exception';
import { type WorkspaceSelectQueryBuilder } from 'src/engine/twenty-orm/query-builder/workspace-select-query-builder';
-import { type ObjectWhereLike } from 'src/engine/twenty-orm/query-builder/types/query-builder.type';
+import {
+ isObjectWhereLike,
+ type ObjectWhereLike,
+} from 'src/engine/twenty-orm/query-builder/types/query-builder.type';
export type MutationCriteria =
| string
@@ -13,10 +16,16 @@ export type MutationCriteria =
| ObjectWhereLike
| ObjectWhereLike[];
-const isPlainObject = (value: unknown): value is ObjectWhereLike =>
- typeof value === 'object' &&
- value !== null &&
- Object.getPrototypeOf(value) === Object.prototype;
+// A where object with no key filters nothing, so the mutation would reach
+// every row of the table.
+const assertWhereObjectFilters = (whereObject: ObjectWhereLike): void => {
+ if (Object.keys(whereObject).length === 0) {
+ throw new TwentyOrmException(
+ 'A mutation criteria where object cannot be empty',
+ TwentyOrmExceptionCode.INVALID_PARAMETER,
+ );
+ }
+};
export const applyMutationCriteriaToQueryBuilder = (
queryBuilder: WorkspaceSelectQueryBuilder,
@@ -49,13 +58,15 @@ export const applyMutationCriteriaToQueryBuilder = (
return queryBuilder;
}
- if (!criteria.every(isPlainObject)) {
+ if (!criteria.every(isObjectWhereLike)) {
throw new TwentyOrmException(
'A mutation criteria array must be all ids or all where objects',
TwentyOrmExceptionCode.INVALID_PARAMETER,
);
}
+ criteria.forEach(assertWhereObjectFilters);
+
queryBuilder.where({
whereFactory: (nestedQueryBuilder) => {
criteria.forEach((entry, index) => {
@@ -71,6 +82,8 @@ export const applyMutationCriteriaToQueryBuilder = (
return queryBuilder;
}
+ assertWhereObjectFilters(criteria);
+
queryBuilder.where(criteria);
return queryBuilder;
diff --git a/packages/twenty-server/src/engine/twenty-orm/query-builder/workspace-select-query-builder.ts b/packages/twenty-server/src/engine/twenty-orm/query-builder/workspace-select-query-builder.ts
index 916b4e602e6..75c3915f35c 100644
--- a/packages/twenty-server/src/engine/twenty-orm/query-builder/workspace-select-query-builder.ts
+++ b/packages/twenty-server/src/engine/twenty-orm/query-builder/workspace-select-query-builder.ts
@@ -1,6 +1,7 @@
import { type ObjectsPermissions } from 'twenty-shared/types';
import { isDefined, pascalCase } from 'twenty-shared/utils';
-import { FindOperator, type ObjectLiteral } from 'typeorm';
+import { type ObjectLiteral } from 'typeorm';
+import { InstanceChecker } from 'typeorm/util/InstanceChecker';
import { RelationType } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-type.interface';
@@ -59,7 +60,7 @@ const isNestedWhereObject = (value: unknown): value is ObjectWhereLike =>
isDefined(value) &&
typeof value === 'object' &&
!Array.isArray(value) &&
- !(value instanceof FindOperator) &&
+ !InstanceChecker.isFindOperator(value) &&
!(value instanceof Date);
export type QueryBuilderContext = {
@@ -843,6 +844,15 @@ export class WorkspaceSelectQueryBuilder implements WhereExpressionLike {
return this;
}
+ // Dropping a condition it cannot read would widen the query, and a
+ // delete to every row.
+ if (typeof condition !== 'string') {
+ throw new TwentyOrmException(
+ 'A where condition must be a SQL string, a where object or a where factory',
+ TwentyOrmExceptionCode.INVALID_QUERY,
+ );
+ }
+
if (condition.length > 0) {
this.whereClauses.push({ operator, sql: `(${condition})` });
}
@@ -895,7 +905,7 @@ export class WorkspaceSelectQueryBuilder implements WhereExpressionLike {
hasCompositeChildColumns &&
isDefined(value) &&
typeof value === 'object' &&
- !(value instanceof FindOperator) &&
+ !InstanceChecker.isFindOperator(value) &&
!Array.isArray(value)
) {
for (const [subFieldName, subValue] of Object.entries(
@@ -1077,7 +1087,7 @@ export class WorkspaceSelectQueryBuilder implements WhereExpressionLike {
return parameterName;
};
- if (value instanceof FindOperator) {
+ if (InstanceChecker.isFindOperator(value)) {
switch (value.type) {
case 'in':
return `${quotedColumn} IN (:...${nextParameter(value.value)})`;