Skip to content

[RUM-10511] Add user story vital type #286

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
cy-moi merged 8 commits into from
Jul 22, 2025
Merged

[RUM-10511] Add user story vital type #286

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9372e6d
feat:add user story
cy-moi Jun 27, 2025
5e28223
Update lib/cjs/generated/rum.d.ts
cy-moi Jul 9, 2025
9e1c777
fix: naming
cy-moi Jul 9, 2025
68dbe2a
build
cy-moi Jul 9, 2025
3880ebf
fix: add latest failure reason
cy-moi Jul 9, 2025
42fe845
feat: update naming and description
cy-moi Jul 21, 2025
637b952
fix: build
cy-moi Jul 21, 2025
48d1f53
fix: use update instead of touch
cy-moi Jul 21, 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
14 changes: 13 additions & 1 deletion lib/cjs/generated/rum.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1146,11 +1146,15 @@ export declare type RumVitalEvent = CommonProperties & ViewContainerSchema & {
/**
* Type of the vital
*/
readonly type: 'duration';
readonly type: 'duration' | 'user_story';
Comment thread
cy-moi marked this conversation as resolved.
Outdated
/**
* UUID of the vital
*/
readonly id: string;
/**
* UUID for the instance of the User Story allowing to execute the same User Story multiple times in parallel
*/
readonly instance_id?: string;

@BenoitZugmeyer BenoitZugmeyer Jul 4, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

suggestion: story_id or user_story_id would be clearer

@cy-moi cy-moi Jul 21, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

We changed this to parent_id which indicates that the step can be link to a parent.

/**
* Name of the vital, as it is also used as facet path for its value, it must contain only letters, digits, or the characters - _ . @ $
*/
Expand All @@ -1169,6 +1173,14 @@ export declare type RumVitalEvent = CommonProperties & ViewContainerSchema & {
readonly custom?: {
[k: string]: number;
};
/**
* Type of the user story event that triggered the vital
*/
readonly event_type?: 'start' | 'touch' | 'retry' | 'end';
Comment thread
cy-moi marked this conversation as resolved.
Outdated
/**
* Reason for the failure of the user story, if applicable
*/
readonly failure_reason?: 'timeout' | 'error' | 'cancelled' | 'other';
Comment thread
cy-moi marked this conversation as resolved.
Outdated
[k: string]: unknown;
};
/**
Expand Down
14 changes: 13 additions & 1 deletion lib/esm/generated/rum.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1146,11 +1146,15 @@ export declare type RumVitalEvent = CommonProperties & ViewContainerSchema & {
/**
* Type of the vital
*/
readonly type: 'duration';
readonly type: 'duration' | 'user_story';
/**
* UUID of the vital
*/
readonly id: string;
/**
* UUID for the instance of the User Story allowing to execute the same User Story multiple times in parallel
*/
readonly instance_id?: string;
/**
* Name of the vital, as it is also used as facet path for its value, it must contain only letters, digits, or the characters - _ . @ $
*/
Expand All @@ -1169,6 +1173,14 @@ export declare type RumVitalEvent = CommonProperties & ViewContainerSchema & {
readonly custom?: {
[k: string]: number;
};
/**
* Type of the user story event that triggered the vital
*/
readonly event_type?: 'start' | 'touch' | 'retry' | 'end';
/**
* Reason for the failure of the user story, if applicable
*/
readonly failure_reason?: 'timeout' | 'error' | 'cancelled' | 'other';
[k: string]: unknown;
};
/**
Expand Down
20 changes: 19 additions & 1 deletion schemas/rum/vital-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"type": {
"type": "string",
"description": "Type of the vital",
"enum": ["duration"],
"enum": ["duration", "user_story"],
"readOnly": true
},
"id": {
Expand All @@ -37,6 +37,12 @@
"pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$",
"readOnly": true
},
"instance_id": {
"type": "string",
"description": "UUID for the instance of the User Story allowing to execute the same User Story multiple times in parallel",
"pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$",
"readOnly": true
},
"name": {
"type": "string",
"description": "Name of the vital, as it is also used as facet path for its value, it must contain only letters, digits, or the characters - _ . @ $",
Expand All @@ -61,6 +67,18 @@
"readOnly": true
},
"readOnly": true
},
"event_type": {
"type": "string",
"description": "Type of the user story event that triggered the vital",
"enum": ["start", "touch", "retry", "end"],
"readOnly": true
},
"failure_reason": {
"type": "string",
"description": "Reason for the failure of the user story, if applicable",
"enum": ["timeout", "error", "cancelled", "other"],
"readOnly": true
}
},
"readOnly": true
Expand Down