Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions .sqlfluff
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,7 @@ status = 'pending'
memberFunderShortCode = 'placeholder'
baseFieldShortCode = 'placeholder'
userKeycloakUserId = '00000000-0000-0000-0000-000000000000'
bulkUploadTaskId = 1
isCollaborative = false
sensitivityFilter_list = NULL
sensitivityFilter_negated = false
2 changes: 1 addition & 1 deletion sqlfluff/requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
sqlfluff==4.1.0
sqlfluff==4.2.0
36 changes: 36 additions & 0 deletions src/database/operations/generators/flattenParameters.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
const isPlainObject = (value: unknown): value is Record<string, unknown> => {
if (value === null || typeof value !== 'object') {
return false;
}
const prototype: unknown = Object.getPrototypeOf(value);
return prototype === Object.prototype || prototype === null;
};

/**
* Flattens nested plain-object parameters into a single-level map with
* `_`-joined keys (e.g. `{ a: { b: 1 } }` -> `{ a_b: 1 }`). Arrays, Dates,
* and other non-plain objects are treated as leaf values and passed through
* unchanged.
*
* This exists so query SQL can reference nested parameter attributes with
* `_` rather than `.` (which sqlfluff misparses as a table-qualified column
* reference) while callers continue to pass structured objects.
*/
const flattenParameters = (
source: Record<string, unknown>,
): Record<string, unknown> => {
const result: Record<string, unknown> = {};
const visit = (value: unknown, prefix: string): void => {
if (isPlainObject(value)) {
for (const [key, nested] of Object.entries(value)) {
visit(nested, prefix === '' ? key : `${prefix}_${key}`);
}
return;
}
result[prefix] = value;
};
visit(source, '');
return result;
};

export { flattenParameters };
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {
getIsAdministratorFromAuthContext,
getKeycloakUserIdFromAuthContext,
} from '../../../types';
import { flattenParameters } from './flattenParameters';
import type { AuthIdentityAndRole, JsonResultSet } from '../../../types';
import type { TinyPg } from 'tinypg';

Expand Down Expand Up @@ -73,7 +74,10 @@ const generateCreateItemOperation =
...operationQueryParameters,
};

const result = await db.sql<JsonResultSet<T>>(queryName, queryParameters);
const result = await db.sql<JsonResultSet<T>>(
queryName,
flattenParameters(queryParameters),
);
const {
rows: [wrappedObject],
} = result;
Expand Down
17 changes: 11 additions & 6 deletions src/database/operations/generators/generateExistsOperation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import {
getIsAdministratorFromAuthContext,
getKeycloakUserIdFromAuthContext,
} from '../../../types';
import { flattenParameters } from './flattenParameters';
import type { AuthIdentityAndRole } from '../../../types';
import type { TinyPg } from 'tinypg';

Expand Down Expand Up @@ -52,12 +53,16 @@ const generateExistsOperation =
}, {});
const {
rows: [row],
} = await db.sql<ExistsResult>(queryName, {
authContextKeycloakUserId: getKeycloakUserIdFromAuthContext(authContext),
authContextIsAdministrator:
getIsAdministratorFromAuthContext(authContext),
...inputAttributeQueryParameters,
});
} = await db.sql<ExistsResult>(
queryName,
flattenParameters({
authContextKeycloakUserId:
getKeycloakUserIdFromAuthContext(authContext),
authContextIsAdministrator:
getIsAdministratorFromAuthContext(authContext),
...inputAttributeQueryParameters,
}),
);
return row?.result ?? false;
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import {
getIsAdministratorFromAuthContext,
getKeycloakUserIdFromAuthContext,
} from '../../../types';
import { flattenParameters } from './flattenParameters';
import type {
AuthIdentityAndRole,
PermissionGrantEntityType,
Expand Down Expand Up @@ -41,13 +42,16 @@ const generateHasPermissionOperation =
getIsAdministratorFromAuthContext(authContext);
const {
rows: [row],
} = await db.sql<HasPermissionResult>(queryName, {
userKeycloakUserId: authContextKeycloakUserId,
isAdministrator: authContextIsAdministrator,
[entityIdParamName]: entityId,
permission,
scope,
});
} = await db.sql<HasPermissionResult>(
queryName,
flattenParameters({
userKeycloakUserId: authContextKeycloakUserId,
isAdministrator: authContextIsAdministrator,
[entityIdParamName]: entityId,
permission,
scope,
}),
);
return row?.hasPermission ?? false;
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import {
getIsAdministratorFromAuthContext,
getKeycloakUserIdFromAuthContext,
} from '../../../types';
import { flattenParameters } from './flattenParameters';
import type {
AuthIdentityAndRole,
Bundle,
Expand Down Expand Up @@ -46,7 +47,7 @@ const generateLoadBundleOperation = <T, P extends [...args: unknown[]]>(
);
const { rows } = await db.sql<PaginatedJsonResultSet<T>>(
queryName,
queryParameters,
flattenParameters(queryParameters),
);
const [firstRow] = rows;
const total = Number(firstRow?.total ?? '0');
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {
getIsAdministratorFromAuthContext,
getKeycloakUserIdFromAuthContext,
} from '../../../types';
import { flattenParameters } from './flattenParameters';
import type { AuthIdentityAndRole, JsonResultSet } from '../../../types';
import type { TinyPg } from 'tinypg';

Expand Down Expand Up @@ -46,7 +47,10 @@ const generateLoadItemOperation =
},
);

const result = await db.sql<JsonResultSet<T>>(queryName, queryParameters);
const result = await db.sql<JsonResultSet<T>>(
queryName,
flattenParameters(queryParameters),
);
const {
rows: [wrappedObject],
} = result;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {
getIsAdministratorFromAuthContext,
getKeycloakUserIdFromAuthContext,
} from '../../../types';
import { flattenParameters } from './flattenParameters';
import type { AuthIdentityAndRole, JsonResultSet } from '../../../types';
import type { TinyPg } from 'tinypg';

Expand Down Expand Up @@ -46,7 +47,10 @@ const generateRemoveItemOperation =
},
);

const result = await db.sql<JsonResultSet<T>>(queryName, queryParameters);
const result = await db.sql<JsonResultSet<T>>(
queryName,
flattenParameters(queryParameters),
);
const {
rows: [wrappedRemovedObject],
} = result;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {
getIsAdministratorFromAuthContext,
getKeycloakUserIdFromAuthContext,
} from '../../../types';
import { flattenParameters } from './flattenParameters';
import type {
AuthIdentityAndRole,
UpsertJsonResultSet,
Expand Down Expand Up @@ -79,7 +80,7 @@ const generateUpsertItemOperation =

const result = await db.sql<UpsertJsonResultSet<T>>(
queryName,
queryParameters,
flattenParameters(queryParameters),
);
const {
rows: [wrappedObject],
Expand Down
19 changes: 8 additions & 11 deletions src/database/queries/baseFields/select.sql
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,14 @@ SELECT base_field_to_json(base_fields.*) AS object
FROM base_fields
WHERE
CASE
WHEN :sensitivityFilter.list::sensitivity_classification [] IS NULL
WHEN :sensitivityFilter_list::sensitivity_classification [] IS NULL
THEN TRUE
WHEN :sensitivityFilter_negated THEN
NOT (base_fields.sensitivity_classification = any(
:sensitivityFilter_list::sensitivity_classification []
))
ELSE
CASE
WHEN :sensitivityFilter.negated THEN
NOT (base_fields.sensitivity_classification = any(
:sensitivityFilter.list::sensitivity_classification []
))
ELSE
base_fields.sensitivity_classification = any(
:sensitivityFilter.list::sensitivity_classification []
)
END
base_fields.sensitivity_classification = any(
:sensitivityFilter_list::sensitivity_classification []
)
END;
19 changes: 8 additions & 11 deletions src/database/queries/baseFields/selectWithPagination.sql
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,16 @@ WITH
FROM base_fields
WHERE
CASE
WHEN :sensitivityFilter.list::sensitivity_classification [] IS NULL
WHEN :sensitivityFilter_list::sensitivity_classification [] IS NULL
THEN TRUE
WHEN :sensitivityFilter_negated THEN
NOT (base_fields.sensitivity_classification = any(
:sensitivityFilter_list::sensitivity_classification []
))
ELSE
CASE
WHEN :sensitivityFilter.negated THEN
NOT (base_fields.sensitivity_classification = any(
:sensitivityFilter.list::sensitivity_classification []
))
ELSE
base_fields.sensitivity_classification = any(
:sensitivityFilter.list::sensitivity_classification []
)
END
base_fields.sensitivity_classification = any(
:sensitivityFilter_list::sensitivity_classification []
)
END
),

Expand Down
Loading