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.

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

feat: update naming to API keys to Access Tokens #4597

Merged
merged 2 commits into from
Feb 27, 2024

Conversation

YounixM
Copy link
Collaborator

@YounixM YounixM commented Feb 26, 2024

image

Screenshot 2024-02-26 150904
Screenshot 2024-02-26 150911
Screenshot 2024-02-26 150918

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features
    • Updated terminology in the UI from "API Keys" to "Access Tokens" for clarity and consistency in the SigNoz API management section.

Copy link

coderabbitai bot commented Feb 26, 2024

Warning

Rate Limit Exceeded

@YounixM has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 23 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 for further information.

Commits Files that changed from the base of the PR and between cf4b11e and e21816f.

Walkthrough

The APIKeys component has transitioned from using "API Keys" to "Access Tokens" in the frontend UI, aligning terminology with the functionality for managing SigNoz API tokens. This semantic update impacts titles, placeholders, buttons, and modals across the component and its test suite.

Changes

File(s) Change Summary
frontend/.../APIKeys.tsx Updated UI texts from "API Keys" to "Access Tokens".
frontend/.../APIKeys.test.tsx Adjusted test suite to reflect new terminology.

🐇✨
In the realm of code, where secrets are told,
A shift in the names, bold and so bold.
From keys to tokens, in tales newly spun,
A rabbit hops forth, under the sun.
"Embrace the change," it cheerfully decrees,
For in new names, lie new keys. 🗝️✨

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

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot added the enhancement New feature or request label Feb 26, 2024
Copy link

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

1 similar comment
Copy link

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between f9eddc9 and 215aa4f.
Files ignored due to path filters (5)
  • frontend/public/locales/en-GB/routes.json is excluded by: !**/*.json
  • frontend/public/locales/en-GB/titles.json is excluded by: !**/*.json
  • frontend/public/locales/en/apiKeys.json is excluded by: !**/*.json
  • frontend/public/locales/en/routes.json is excluded by: !**/*.json
  • frontend/public/locales/en/titles.json is excluded by: !**/*.json
Files selected for processing (2)
  • frontend/src/container/APIKeys/APIKeys.test.tsx (3 hunks)
  • frontend/src/container/APIKeys/APIKeys.tsx (12 hunks)
Additional comments: 12
frontend/src/container/APIKeys/APIKeys.test.tsx (5)
  • 29-31: The terminology update from "API Keys" to "Access Tokens" in the test descriptions and assertions is consistent with the PR objectives. This change accurately reflects the new terminology used within the application.
  • 26-38: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [35-44]

The test case for rendering the list of Access Tokens correctly updates the terminology and ensures that the application's UI changes are covered in the test suite. This is a good practice for maintaining alignment between the application's functionality and its test coverage.

  • 49-52: The test case for opening the modal to add a new token by clicking the "New Token" button correctly reflects the updated terminology. This ensures that the test suite remains relevant and accurately tests the application's behavior.
  • 60-63: The test case for closing the modal to add a new token upon clicking the "Cancel" button is correctly updated to use the new terminology. This change is necessary to keep the test suite aligned with the application's UI and functionality.
  • 82-93: The test case for creating a new token on form submission has been updated to reflect the new terminology and includes interactions with the updated UI elements. This ensures that the test suite accurately tests the application's behavior in response to user actions.
frontend/src/container/APIKeys/APIKeys.tsx (7)
  • 517-519: The update to the component's title and subtitle to use "Access Tokens" instead of "API Keys" is consistent with the PR objectives. This change accurately reflects the new terminology used within the application.
  • 514-528: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [525-536]

The update to the search input placeholder and the label of the button for adding a new token aligns with the terminology change. This ensures that the UI elements are consistent with the new terminology.

  • 549-549: The pagination text has been updated to reflect the terminology change to "tokens" instead of "keys". This is a minor but important detail that contributes to the consistency of the terminology throughout the application.
  • 546-560: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [557-579]

The modal title and button text for deleting a token have been updated to use the new terminology. This change ensures that the modal dialog is consistent with the rest of the application's terminology.

  • 590-596: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [593-617]

The modal title and button text for editing a token have been updated to reflect the new terminology. This ensures that the modal dialog aligns with the application's updated terminology and provides a consistent user experience.

  • 685-691: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [671-709]

The modal title and button text for creating a new token have been updated to use the new terminology. This change is consistent with the PR objectives and ensures that the modal dialog aligns with the updated terminology used throughout the application.

  • 730-736: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [733-774]

The form fields and labels within the "Create new token" modal have been updated to reflect the new terminology. This includes updates to the placeholder text for the token name input and the labels for the role selection. These changes ensure that the form aligns with the updated terminology and provides a clear and consistent user experience.

@vikrantgupta25
Copy link
Collaborator

vikrantgupta25 commented Feb 26, 2024

The base screen is not updated. or the screenshot is old 😅

Copy link

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

Copy link

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between c38247a and cf4b11e.
Files ignored due to path filters (5)
  • frontend/public/locales/en-GB/routes.json is excluded by: !**/*.json
  • frontend/public/locales/en-GB/titles.json is excluded by: !**/*.json
  • frontend/public/locales/en/apiKeys.json is excluded by: !**/*.json
  • frontend/public/locales/en/routes.json is excluded by: !**/*.json
  • frontend/public/locales/en/titles.json is excluded by: !**/*.json
Files selected for processing (2)
  • frontend/src/container/APIKeys/APIKeys.test.tsx (3 hunks)
  • frontend/src/container/APIKeys/APIKeys.tsx (12 hunks)
Files skipped from review as they are similar to previous changes (2)
  • frontend/src/container/APIKeys/APIKeys.test.tsx
  • frontend/src/container/APIKeys/APIKeys.tsx

Copy link

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

Copy link
Collaborator

@vikrantgupta25 vikrantgupta25 left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@YounixM YounixM merged commit 89c6eba into develop Feb 27, 2024
11 of 12 checks passed
@YounixM YounixM deleted the api-ingestion-keys-update branch February 27, 2024 08:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants