Skip to content
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

Jump to bottom

fix: validate operation body #5537

Merged
merged 3 commits into from
Aug 28, 2024
Merged

fix: validate operation body #5537

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
38a17d8
fix: validate operation body
n1ru4l Aug 27, 2024
7b01304
add tests
n1ru4l Aug 28, 2024
d9a3e56
fix metrics
n1ru4l Aug 28, 2024
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
12 changes: 6 additions & 6 deletions packages/services/usage/src/usage-processor-1.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,21 +269,21 @@ export function validateOperationMapRecord(record: OperationMapRecord) {
};
}

function isValidOperationBody(op: OperationMapRecord) {
const cached = validOperationBodyCache.get(op.operation);
export function isValidOperationBody(operation: string) {
const cached = validOperationBodyCache.get(operation);

if (typeof cached === 'boolean') {
return cached;
}

try {
parse(op.operation, {
parse(operation, {
noLocation: true,
});
validOperationBodyCache.set(op.operation, true);
validOperationBodyCache.set(operation, true);
return true;
} catch (error) {
validOperationBodyCache.set(op.operation, false);
validOperationBodyCache.set(operation, false);
return false;
}
}
Expand All @@ -304,7 +304,7 @@ export function validateOperation(operation: IncomingOperation, operationMap: Op
}

if (validate(operation)) {
if (!isValidOperationBody(operationMap[operation.operationMapKey])) {
if (!isValidOperationBody(operationMap[operation.operationMapKey].operation)) {
return {
valid: false,
errors: [
Expand Down
11 changes: 8 additions & 3 deletions packages/services/usage/src/usage-processor-2.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import * as tb from '@sinclair/typebox';
import * as tc from '@sinclair/typebox/compiler';
import { invalidRawOperations, rawOperationsSize, totalOperations, totalReports } from './metrics';
import { TokensResponse } from './tokens';
import { isValidOperationBody } from './usage-processor-1';

export function usageProcessorV2(
logger: Logger,
Expand Down Expand Up @@ -74,7 +75,7 @@ export function usageProcessorV2(

const newKeyMappings = new Map<OperationMapRecord, string>();

function getOperationMapRecord(operationMapKey: string): string | null {
function getOperationMapRecordKey(operationMapKey: string): string | null {
const operationMapRecord = incoming.map[operationMapKey] as OperationMapRecord | undefined;

if (!operationMapRecord) {
Expand All @@ -83,6 +84,10 @@ export function usageProcessorV2(

let newOperationMapKey = newKeyMappings.get(operationMapRecord);

if (!isValidOperationBody(operationMapRecord.operation)) {
return null;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

null will lead to an incorrect information for us, I mean this metric:
https://github.com/kamilkisiela/graphql-hive/blob/38a17d8f2fdd9ae1c8ae0622cdea156c1ccc45db/packages/services/usage/src/usage-processor-2.ts#L119

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could do what we do in usage-1, return to the sender that N operations were accepted and M operations rejected?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kamilkisiela we already do, see tests: 7b01304 (#5537)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed the incorrect information in d9a3e56 (#5537)

}

if (newOperationMapKey === undefined) {
const sortedFields = operationMapRecord.fields.sort();
newOperationMapKey = createHash('md5')
Expand All @@ -106,7 +111,7 @@ export function usageProcessorV2(
}

for (const operation of incomingOperations) {
const operationMapKey = getOperationMapRecord(operation.operationMapKey);
const operationMapKey = getOperationMapRecordKey(operation.operationMapKey);

// if the record does not exist -> skip the operation
if (operationMapKey === null) {
Expand Down Expand Up @@ -154,7 +159,7 @@ export function usageProcessorV2(
}

for (const operation of incomingSubscriptionOperations) {
const operationMapKey = getOperationMapRecord(operation.operationMapKey);
const operationMapKey = getOperationMapRecordKey(operation.operationMapKey);

// if the record does not exist -> skip the operation
if (operationMapKey === null) {
Expand Down
Loading