Skip to content

Use valibot for symbolication API response validation #5666

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
mstange merged 2 commits into from
Nov 7, 2025
Merged

Use valibot for symbolication API response validation #5666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
abd8ccf
Use valibot for symbolication API response validation.
mstange Nov 6, 2025
a64c102
Merge branch 'main' into valibot-symbolication-response
mstange Nov 7, 2025
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
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@
"redux-thunk": "^3.1.0",
"reselect": "^4.1.8",
"url": "^0.11.4",
"valibot": "^1.1.0",
"weaktuplemap": "^1.0.0",
"workbox-window": "^7.3.0"
},
Expand Down
165 changes: 39 additions & 126 deletions src/profile-logic/mozilla-symbolication-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
import * as v from 'valibot';
import type {
AddressResult,
LibSymbolicationRequest,
Expand Down Expand Up @@ -28,156 +29,68 @@ export type QuerySymbolicationApiCallback = (
requestJson: string
) => Promise<unknown>;

type APIFoundModulesV5 = {
// For every requested library in the memoryMap, this object contains a string
// key of the form `${debugName}/${breakpadId}`. The value is null if no
// address with the module index was requested, and otherwise a boolean that
// says whether the symbol server had symbols for this library.
[key: string]: null | boolean;
};
// Valibot schemas for API response validation

type APIInlineFrameInfoV5 = {
// For every requested library in the memoryMap, this object contains a string
// key of the form `${debugName}/${breakpadId}`. The value is null if no
// address with the module index was requested, and otherwise a boolean that
// says whether the symbol server had symbols for this library.
const APIFoundModulesV5Schema = v.record(v.string(), v.nullable(v.boolean()));

// Information about functions that were inlined at this address.
const APIInlineFrameInfoV5Schema = v.object({
// The name of the function this inline frame was in, if known.
function?: string;
function: v.optional(v.string()),
// The path of the file that contains the function this inline frame was in, optional.
file?: string;
file: v.optional(v.string()),
// The line number that contains the source code for this inline frame that
// contributed to the instruction at the looked-up address, optional.
// e.g. 543
line?: number;
};
line: v.optional(v.number()),
});

type APIFrameInfoV5 = {
const APIFrameInfoV5Schema = v.object({
// The hex version of the address that we requested (e.g. "0x5ab").
module_offset: string;
module_offset: v.string(),
// The debugName of the library that this frame was in.
module: string;
module: v.string(),
// The index of this APIFrameInfo in its enclosing APIStack.
frame: number;
frame: v.number(),
// The name of the function this frame was in, if symbols were found.
function?: string;
function: v.optional(v.string()),
// The hex offset between the requested address and the start of the function,
// e.g. "0x3c".
function_offset?: string;
function_offset: v.optional(v.string()),
// An optional size, in bytes, of the machine code of the outer function that
// this address belongs to, as a hex string, e.g. "0x270".
function_size?: string;
function_size: v.optional(v.string()),
// The path of the file that contains the function this frame was in, optional.
// As of June 2021, this is only supported on the staging symbolication server
// ("Eliot") but not on the implementation that's currently in production ("Tecken").
// e.g. "hg:hg.mozilla.org/mozilla-central:js/src/vm/Interpreter.cpp:24938c537a55f9db3913072d33b178b210e7d6b5"
file?: string;
file: v.optional(v.string()),
// The line number that contains the source code that generated the instructions at the address, optional.
// (Same support as file.)
// e.g. 543
line?: number;
line: v.optional(v.number()),
// Information about functions that were inlined at this address.
// Ordered from inside to outside.
// As of November 2021, this is only supported by profiler-symbol-server.
// Adding this functionality to the Mozilla symbol server is tracked in
// https://bugzilla.mozilla.org/show_bug.cgi?id=1636194
inlines?: APIInlineFrameInfoV5[];
};
inlines: v.optional(v.array(APIInlineFrameInfoV5Schema)),
});

type APIStackV5 = APIFrameInfoV5[];
const APIStackV5Schema = v.array(APIFrameInfoV5Schema);

type APIJobResultV5 = {
found_modules: APIFoundModulesV5;
stacks: APIStackV5[];
};
const APIJobResultV5Schema = v.object({
found_modules: APIFoundModulesV5Schema,
stacks: v.array(APIStackV5Schema),
});

type APIResultV5 = {
results: APIJobResultV5[];
};
const APIResultV5Schema = v.object({
results: v.array(APIJobResultV5Schema),
});

// Make sure that the JSON blob we receive from the API conforms to our flow
// type definition.
function _ensureIsAPIResultV5(result: unknown): APIResultV5 {
// It's possible (especially when running tests with Jest) that the parameter
// inherits from a `Object` global from another realm. By using toString
// this issue is solved wherever the parameter comes from.
const isObject = (subject: unknown) =>
Object.prototype.toString.call(subject) === '[object Object]';
type APIJobResultV5 = v.InferOutput<typeof APIJobResultV5Schema>;
type APIResultV5 = v.InferOutput<typeof APIResultV5Schema>;
Comment on lines +87 to +88
Copy link
Member

@canova canova Nov 7, 2025

Choose a reason for hiding this comment

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

Ohh, interesting! Didn't know about v.InferOutput! It's convenient!

Copy link
Contributor Author

@mstange mstange Nov 7, 2025

Choose a reason for hiding this comment

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

Indeed! :)

Just a note - this is not a TypeScript thing, it's a valibot thing (but using underlying TypeScript primitives of course): https://github.com/fabian-hiller/valibot/blob/3833d69d3b3a383693000410d40f1b504f446170/library/src/types/infer.ts#L28-L37

Copy link
Member

@canova canova Nov 7, 2025

Choose a reason for hiding this comment

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

Yeah, I assumed it's a valibot thing too. But it's good to be able to convert the valibot schemas into typescript types. Thanks for the pointer to the code!


if (!isObject(result) || !('results' in (result as object))) {
throw new Error('Expected an object with property `results`');
}
const results = (result as { results: unknown }).results;
if (!Array.isArray(results)) {
throw new Error('Expected `results` to be an array');
}
for (const jobResult of results) {
if (
!isObject(jobResult) ||
!('found_modules' in jobResult) ||
!('stacks' in jobResult)
) {
throw new Error(
'Expected jobResult to have `found_modules` and `stacks` properties'
);
}
const found_modules = jobResult.found_modules;
if (!isObject(found_modules)) {
throw new Error('Expected `found_modules` to be an object');
}
const stacks = jobResult.stacks;
if (!Array.isArray(stacks)) {
throw new Error('Expected `stacks` to be an array');
}
for (const stack of stacks) {
if (!Array.isArray(stack)) {
throw new Error('Expected `stack` to be an array');
}
for (const frameInfo of stack) {
if (!isObject(frameInfo)) {
throw new Error('Expected `frameInfo` to be an object');
}
if (
!('module_offset' in frameInfo) ||
!('module' in frameInfo) ||
!('frame' in frameInfo)
) {
throw new Error(
'Expected frameInfo to have `module_offset`, `module` and `frame` properties'
);
}
if ('file' in frameInfo && typeof frameInfo.file !== 'string') {
throw new Error('Expected frameInfo.file to be a string, if present');
}
if ('line' in frameInfo && typeof frameInfo.line !== 'number') {
throw new Error('Expected frameInfo.line to be a number, if present');
}
if (
'function_offset' in frameInfo &&
typeof frameInfo.function_offset !== 'string'
) {
throw new Error(
'Expected frameInfo.function_offset to be a string, if present'
);
}
if (
'function_size' in frameInfo &&
typeof frameInfo.function_size !== 'string'
) {
throw new Error(
'Expected frameInfo.function_size to be a string, if present'
);
}
if ('inlines' in frameInfo) {
const inlines = frameInfo.inlines;
if (!Array.isArray(inlines)) {
throw new Error('Expected `inlines` to be an array');
}
for (const inlineFrame of inlines) {
if (!isObject(inlineFrame)) {
throw new Error('Expected `inlineFrame` to be an object');
}
}
}
}
}
}
return result as APIResultV5;
// Make sure that the JSON blob we receive from the API conforms to our
// type definition using valibot validation.
function _ensureIsAPIResultV5(result: unknown): APIResultV5 {
return v.parse(APIResultV5Schema, result);
}

function getV5ResultForLibRequest(
Expand Down
2 changes: 1 addition & 1 deletion src/test/store/receive-profile.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -937,7 +937,7 @@ describe('actions/receive-profile', function () {
expect.objectContaining({
message:
'Could not obtain symbols for libxul/SOMETHING_FAKE.\n' +
' - Error: There was a problem with the symbolication API request to the symbol server: Expected an object with property `results`\n' +
' - Error: There was a problem with the symbolication API request to the symbol server: Invalid key: Expected "results" but received undefined\n' +
' - Error: No connection to the browser, cannot run querySymbolicationApi\n' +
' - Error: No connection to the browser, cannot obtain symbol tables',
})
Expand Down
5 changes: 5 additions & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12311,6 +12311,11 @@ v8-to-istanbul@^9.0.1:
"@types/istanbul-lib-coverage" "^2.0.1"
convert-source-map "^1.6.0"

valibot@^1.1.0:
version "1.1.0"
resolved "https://registry.yarnpkg.com/valibot/-/valibot-1.1.0.tgz#873bb1af9e1577391690307bfe0520bd1360ec2d"
integrity sha512-Nk8lX30Qhu+9txPYTwM0cFlWLdPFsFr6LblzqIySfbZph9+BFsAHsNvHOymEviUepeIW6KFHzpX8TKhbptBXXw==

validate-npm-package-license@^3.0.1, validate-npm-package-license@^3.0.4:
version "3.0.4"
resolved "https://registry.yarnpkg.com/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz#fc91f6b9c7ba15c857f4cb2c5defeec39d4f410a"
Expand Down