feat(performance): Expands search for serviceowners, improved tracing and logging

dagfinno commented 2 weeks ago

Implements more GET testcalls to serviceowner apis and improves tracing and logging

Description

Related Issue(s)

1326

Verification

[ ] Your code builds clean without any errors or warnings
[ ] Manual testing done (required)
[ ] Relevant automated test added (if you find this hard, leave it and we'll help out)

Documentation

[ ] Documentation is updated (either in docs-directory, Altinnpedia or a separate linked PR in altinn-studio-docs., if applicable)

Summary by CodeRabbit

Release Notes

New Features
- Introduced a sentinelPerformanceValue for enhanced performance tracking.
- Added flexibility to performance tests by implementing isSingleUserMode for better user scenario handling.
Improvements
- Enhanced logging and traceability in dialog creation and purging processes.
- Expanded performance thresholds for more detailed monitoring.
- Updated functions to accept dynamic GET request functions, improving modularity.
Bug Fixes
- Improved error handling and conditions for single vs. multi-user modes in various performance test scripts.
Documentation
- Updated comments for clarity regarding options and parameters in several scripts.

coderabbitai[bot] commented 2 weeks ago

[!WARNING]

Rate limit exceeded

@dagfinno has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 50 seconds before requesting another review.

⌛ How to resolve this issue?
After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?
CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.

📥 Commits
Reviewing files that changed from the base of the PR and between 06bce86e5dbfce46821aff3e5b14390ab43c068e and c4c48bc79eec72b2bfda8ff1a140911ede3e4179.

📝 Walkthrough

## Walkthrough The pull request introduces several changes across multiple test scripts in the K6 framework. Key modifications include the addition of a new constant `sentinelPerformanceValue` in the configuration file and the introduction of a variable `isSingleUserMode` in various performance test scripts to streamline user mode checks. Additionally, functions have been updated to enhance their flexibility and traceability, including the use of unique trace identifiers in HTTP headers. Overall, the changes aim to improve the structure and maintainability of the test scripts without altering their fundamental logic. ## Changes | File Path | Change Summary | |-----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | tests/k6/common/config.js | Added constant: `export const sentinelPerformanceValue = "dialogporten-e2e-sentinel-performance";` | | tests/k6/tests/enduser/performance/enduser-search.js | Added import for `randomItem`. Introduced `isSingleUserMode` variable to consolidate user mode checks. Updated logic to call `enduserSearch` based on user mode. | | tests/k6/tests/graphql/performance/graphql-search.js | Added `isSingleUserMode` variable for user mode checks. Updated logic to call `graphqlSearch` based on user mode. | | tests/k6/tests/performancetest_common/createDialog.js | Introduced `traceparent` variable for tracing in `createDialog` and `createAndRemoveDialog` functions. Updated `paramsWithToken` to include `traceparent` and `enduser` properties. | | tests/k6/tests/performancetest_common/simpleSearch.js | Added `getFunction` parameter to several functions for dynamic function selection. Updated `graphqlSearch` and `serviceownerSearch` to include `traceparent` handling. | | tests/k6/tests/performancetest_data/01-create-dialog.js | Added import for `sentinelPerformanceValue`. Updated `cleanUp` function to include `sentinelPerformanceValue` in `searchTags`. | | tests/k6/tests/serviceowner/performance/create-dialog.js | Introduced `isSingleUserMode` variable for user mode checks. Updated logic to call `createDialog` based on user mode. | | tests/k6/tests/serviceowner/performance/create-remove-dialog.js | Added `isSingleUserMode` constant for user mode checks. Updated logic to call `createAndRemoveDialog` based on user mode. | | tests/k6/tests/serviceowner/performance/purge-dialogs.js | Added import for `uuidv4`. Introduced `traceparent` variable for logging. Updated `Authorization` header in `paramsWithToken` to include `traceparent`. | | tests/k6/tests/serviceowner/performance/serviceowner-search.js | Expanded `thresholds` array in `options` object to include additional dialog and transmission activity thresholds. | ## Possibly related PRs - **#1216**: Introduces the constant `sentinelPerformanceValue`, which is utilized in the `cleanUp` function of the retrieved PR. - **#1403**: Relevant changes in `enduser-search.js` ensure effective utilization of `sentinelPerformanceValue` by checking for the presence of end users before executing searches. - **#1435**: The new purge script is designed to clean up dialogs created during tests, potentially involving `sentinelPerformanceValue` for dialog identification. ## Suggested reviewers - oskogstad - arealmaas

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.