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(web): Load image with 800px width when embedded in rich text #16355

Merged
merged 2 commits into from
Oct 10, 2024

Conversation

RunarVestmann
Copy link
Member

@RunarVestmann RunarVestmann commented Oct 10, 2024

Load image with 800px width when embedded in rich text

To save bandwidth (look at before and after below)

Screenshots / Gifs

Before

Screenshot 2024-10-10 at 13 59 20

After

Screenshot 2024-10-10 at 13 59 55

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features
    • Introduced an Image component for enhanced rendering of image slices within the rich text utility.
    • Improved handling of thumbnail and full-size image URLs based on provided properties.

These updates enhance the overall functionality and user experience by allowing for better integration of images in the content.

@RunarVestmann RunarVestmann added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Oct 10, 2024
@RunarVestmann RunarVestmann requested review from a team as code owners October 10, 2024 14:00
Copy link
Contributor

coderabbitai bot commented Oct 10, 2024

Walkthrough

The changes in this pull request focus on enhancing the richText.tsx file by adding a new Image component and its associated type ImageProps. The Image component is imported from @island.is/island-ui/contentful and integrated into the defaultRenderComponent object, which includes a new rendering function for handling image slices. The existing rendering logic remains intact, ensuring that the new functionality integrates smoothly without disrupting the current structure.

Changes

File Path Change Summary
apps/web/utils/richText.tsx - Added Image component and ImageProps type from @island.is/island-ui/contentful.
- Introduced rendering function for Image in defaultRenderComponent.

Possibly related PRs

Suggested reviewers

  • mannipje

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.

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

codecov bot commented Oct 10, 2024

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 36.73%. Comparing base (13ead6f) to head (da4f024).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
apps/web/utils/richText.tsx 0.00% 4 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #16355      +/-   ##
==========================================
- Coverage   36.74%   36.73%   -0.01%     
==========================================
  Files        6804     6804              
  Lines      140856   140883      +27     
  Branches    40115    40124       +9     
==========================================
+ Hits        51752    51758       +6     
- Misses      89104    89125      +21     
Flag Coverage Δ
air-discount-scheme-web 0.00% <ø> (ø)
api-domains-mortgage-certificate 34.92% <ø> (ø)
application-api-files 57.97% <ø> (ø)
application-core 71.83% <ø> (ø)
application-system-api 41.44% <ø> (ø)
application-template-api-modules 27.97% <ø> (+0.02%) ⬆️
application-templates-accident-notification 29.29% <ø> (ø)
application-templates-car-recycling 3.12% <ø> (ø)
application-templates-criminal-record 26.35% <ø> (ø)
application-templates-driving-license 18.29% <ø> (ø)
application-templates-estate 12.31% <ø> (ø)
application-templates-example-payment 25.14% <ø> (ø)
application-templates-financial-aid 14.27% <ø> (ø)
application-templates-general-petition 23.43% <ø> (ø)
application-templates-marriage-conditions 15.09% <ø> (ø)
application-templates-mortgage-certificate 43.75% <ø> (ø)
application-templates-parental-leave 29.97% <ø> (ø)
application-types 6.71% <ø> (ø)
application-ui-components 1.28% <ø> (ø)
application-ui-shell 21.27% <ø> (ø)
clients-charge-fjs-v2 24.11% <ø> (ø)
clients-syslumenn 49.42% <ø> (ø)
services-auth-admin-api 51.81% <ø> (-0.03%) ⬇️
services-auth-delegation-api 57.32% <ø> (ø)
services-auth-ids-api 51.43% <ø> (+<0.01%) ⬆️
services-auth-personal-representative 45.15% <ø> (+0.03%) ⬆️
services-auth-personal-representative-public 41.27% <ø> (+0.04%) ⬆️
services-auth-public-api 48.91% <ø> (ø)
services-user-notification 47.04% <ø> (+<0.01%) ⬆️
services-user-profile 62.17% <ø> (ø)
web 1.83% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
apps/web/utils/richText.tsx 0.00% <0.00%> (ø)

... and 2 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 13ead6f...da4f024. Read the comment docs.

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: 0

🧹 Outside diff range and nitpick comments (1)
apps/web/utils/richText.tsx (1)

284-288: LGTM: Image rendering function added correctly with room for improvement.

The new Image rendering function is implemented correctly and follows NextJS best practices. Good use of TypeScript for type safety. Consider the following suggestions for improvement:

  1. Extract the URL construction logic into a utility function for better maintainability.
  2. Use environment variables or constants for the width parameters (50 and 800) to make them easily configurable.
  3. Consider adding error handling or a fallback image for cases where slice.url is undefined.

Example refactor:

const constructImageUrl = (baseUrl: string, width: number) => 
  baseUrl ? `${baseUrl}?w=${width}` : '';

Image: (slice: ImageProps) => {
  const thumbnailUrl = constructImageUrl(slice?.url, 50);
  const fullSizeUrl = constructImageUrl(slice?.url, 800);
  return <Image {...slice} thumbnail={thumbnailUrl} url={fullSizeUrl} />;
},
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between df4b50b and c93535c.

📒 Files selected for processing (1)
  • apps/web/utils/richText.tsx (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/web/utils/richText.tsx (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
🔇 Additional comments (1)
apps/web/utils/richText.tsx (1)

7-8: LGTM: New imports added correctly.

The new imports for Image and ImageProps are added correctly and follow the existing naming conventions and TypeScript best practices.

@datadog-island-is
Copy link

datadog-island-is bot commented Oct 10, 2024

Datadog Report

All test runs 6e5ffd6 🔗

33 Total Test Services: 0 Failed, 33 Passed
⬆️ Test Sessions change in coverage: 2 increased, 111 no change

Test Services
This report shows up to 10 services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
air-discount-scheme-web 0 0 0 2 0 8.64s 1 no change Link
api 0 0 0 4 0 2.6s 1 no change Link
api-domains-auth-admin 0 0 0 18 0 12.07s 1 no change Link
api-domains-mortgage-certificate 0 0 0 5 0 16.99s 1 no change Link
application-api-files 0 0 0 12 0 7.3s 1 no change Link
application-core 0 0 0 92 0 20.96s 1 no change Link
application-system-api 0 0 0 120 2 3m 28.87s 1 no change Link
application-template-api-modules 0 0 0 123 0 2m 38.1s 1 increased (+0.01%) Link
application-templates-accident-notification 0 0 0 148 0 21.35s 1 no change Link
application-templates-criminal-record 0 0 0 2 0 12.17s 1 no change Link

@kodiakhq kodiakhq bot merged commit b8b850d into main Oct 10, 2024
98 checks passed
@kodiakhq kodiakhq bot deleted the fix/web-set-image-width branch October 10, 2024 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecated:automerge (Disabled) Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants