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

fix: add copy button to log details sections #2708

Merged
merged 2 commits into from
Dec 5, 2024

Conversation

ogzhanolguncu
Copy link
Contributor

@ogzhanolguncu ogzhanolguncu commented Dec 5, 2024

What does this PR do?

Fixes # (issue)

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • Try to copy in logs detail one of request headers or request body

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features

    • Introduced a button in the LogMetaSection and LogSection components to copy content to the clipboard.
    • Added success and error notifications for clipboard actions.
    • Enhanced UI with hover effects for the copy buttons.
  • Bug Fixes

    • Improved error handling for clipboard operations.

Copy link

vercel bot commented Dec 5, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 5, 2024 2:41pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 5, 2024 2:41pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 5, 2024 2:41pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 5, 2024 2:41pm

Copy link

changeset-bot bot commented Dec 5, 2024

⚠️ No Changeset found

Latest commit: 613bf16

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Dec 5, 2024

Warning

Rate limit exceeded

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

Reviewing files that changed from the base of the PR and between dfa360b and 613bf16.

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes introduce new clipboard functionality to the LogMetaSection and LogSection components. Both components now include buttons that allow users to copy content to the clipboard. The handleClick function manages the clipboard operations, displaying success or error notifications based on the outcome. Additionally, a new helper function, getFormattedContent, is added to format the content for copying in the LogSection. The UI is updated to enhance visibility and interaction, particularly with buttons that appear on hover.

Changes

File Path Change Summary
apps/dashboard/app/(app)/logs/components/log-details/components/log-meta.tsx Added handleClick function for clipboard copying; introduced a button with hover visibility for copying content.
apps/dashboard/app/(app)/logs/components/log-details/components/log-section.tsx Added handleClick function and getFormattedContent helper function for formatting details; updated layout for new copy button.

Possibly related PRs

Suggested reviewers

  • mcstepp
  • perkinsjr
  • chronark

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>, 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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

github-actions bot commented Dec 5, 2024

Thank you for following the naming conventions for pull request titles! 🙏

Copy link

pullflow-com bot commented Dec 5, 2024

From OzAndreas Thomas Our default copy button looked a bit ugly to me so I did this instead. Don't judge me 😂

Copy link
Contributor

@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.

Actionable comments posted: 4

🧹 Outside diff range and nitpick comments (2)
apps/dashboard/app/(app)/logs/components/log-details/components/log-section.tsx (1)

61-72: Improve content formatting robustness

The formatting helper function needs additional error handling and optimization:

  1. Missing validation for malformed headers
  2. No handling of empty or invalid entries
  3. Could be optimized for large arrays

Consider this more robust implementation:

 const getFormattedContent = (details: string | string[]) => {
   if (Array.isArray(details)) {
     return details
+      .filter(Boolean) // Remove empty entries
       .map((header) => {
+        if (!header.includes(':')) return header.trim();
         const [key, ...valueParts] = header.split(":");
         const value = valueParts.join(":").trim();
-        return `${key}: ${value}`;
+        return key.trim() ? `${key.trim()}: ${value}` : value;
       })
+      .filter(Boolean) // Remove empty results
       .join("\n");
   }
-  return details;
+  return details?.trim() ?? '';
 };
apps/dashboard/app/(app)/logs/components/log-details/components/log-meta.tsx (1)

23-32: Consider improving mobile experience and accessibility.

The current implementation has some UX considerations:

  1. The hover-only visibility might not work well on mobile devices
  2. Adding a tooltip would improve user understanding
  3. Success/error feedback could be more closely tied to the button location

Consider these improvements:

 <Button
   variant="outline"
   onClick={handleClick}
-  className="absolute bottom-2 right-3 opacity-0 group-hover:opacity-100 transition-opacity"
+  className="absolute bottom-2 right-3 opacity-0 group-hover:opacity-100 md:opacity-30 transition-opacity"
   aria-label="Copy content"
+  title="Copy to clipboard"
 >
   <Copy size={14} />
 </Button>

This change:

  • Makes the button semi-visible on mobile (no hover state)
  • Adds a native tooltip via title attribute
  • Maintains the hover effect for desktop users
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6b9f353 and dfa360b.

📒 Files selected for processing (2)
  • apps/dashboard/app/(app)/logs/components/log-details/components/log-meta.tsx (1 hunks)
  • apps/dashboard/app/(app)/logs/components/log-details/components/log-section.tsx (2 hunks)
🧰 Additional context used
📓 Learnings (1)
apps/dashboard/app/(app)/logs/components/log-details/components/log-meta.tsx (1)
Learnt from: unrenamed
PR: unkeyed/unkey#2652
File: apps/dashboard/components/dashboard/copy-button.tsx:38-38
Timestamp: 2024-11-10T16:45:16.994Z
Learning: The `copyToClipboardWithMeta` function currently has an unused `_meta` parameter. Consider removing it or utilizing it appropriately, especially when introducing the `useCopyToClipboard` hook.
🔇 Additional comments (3)
apps/dashboard/app/(app)/logs/components/log-details/components/log-section.tsx (2)

Line range hint 1-12: LGTM: Clean imports and well-typed interface

The imports are appropriate for the clipboard functionality, and the component interface is properly typed with TypeScript.


Line range hint 1-72: Verify component integration and consistency

Let's ensure this implementation is consistent with other similar components in the codebase.

✅ Verification successful

Implementation is consistent with codebase patterns

The verification shows that:

  1. The clipboard copy functionality is consistently implemented across multiple components in the codebase, including similar components like copy-code-button.tsx and copy-button.tsx.
  2. The LogSection component is properly integrated and used in the log details view (apps/dashboard/app/(app)/logs/components/log-details/index.tsx).
  3. The toast implementation follows the same pattern (toast.success/toast.error) used throughout the application.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for similar copy button implementations
echo "Searching for similar copy button implementations..."
rg -l "navigator\.clipboard" --type tsx

# Search for other uses of LogSection component
echo "Checking LogSection usage..."
rg "LogSection" --type tsx

# Look for other toast implementations
echo "Checking toast implementation consistency..."
rg "toast\.(success|error)" --type tsx

Length of output: 474


Script:

#!/bin/bash
# Search for similar copy button implementations
echo "Searching for similar copy button implementations..."
rg -l "navigator\.clipboard"

# Search for other uses of LogSection component
echo "Checking LogSection usage..."
rg "LogSection"

# Look for other toast implementations
echo "Checking toast implementation consistency..."
rg "toast\.(success|error)"

Length of output: 19231

apps/dashboard/app/(app)/logs/components/log-details/components/log-meta.tsx (1)

1-4: LGTM! Imports are well-organized and necessary.

All imported components and utilities are properly utilized in the implementation.

@ogzhanolguncu ogzhanolguncu added this pull request to the merge queue Dec 5, 2024
@chronark chronark removed this pull request from the merge queue due to a manual request Dec 5, 2024
@coderabbitai coderabbitai bot mentioned this pull request Dec 17, 2024
18 tasks
@coderabbitai coderabbitai bot mentioned this pull request Jan 9, 2025
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants