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(skilavottord): Error when trying to view and save recycling companies #16159

Merged

Conversation

birkirkristmunds
Copy link
Member

@birkirkristmunds birkirkristmunds commented Sep 25, 2024

TS-920

What

  • Fix path when trying to view recycling company
  • Fix error when trying to save recycling company

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
    • Enhanced routing for the Recycling Companies section to prevent duplicated paths when editing.
    • Improved data handling by removing unnecessary properties before sending requests to the backend, ensuring smoother operations.

- Fix path when trying to view recycling company
- Fix error when trying to save recycling company
@birkirkristmunds birkirkristmunds requested a review from a team as a code owner September 25, 2024 16:06
Copy link
Contributor

coderabbitai bot commented Sep 25, 2024

Walkthrough

The pull request introduces modifications to the RecyclingCompanies and RecyclingCompanyUpdate components. It updates the handleUpdate function to enhance routing by preventing duplicated paths when navigating to the edit route. Additionally, the handleUpdateRecyclingPartner function is adjusted to remove the __typename property from the input object before sending it to the backend, addressing potential errors in the request payload.

Changes

File Change Summary
apps/skilavottord/web/screens/RecyclingCompanies/RecyclingCompanies.tsx Updated handleUpdate to improve routing by preventing duplicated paths in router.push.
apps/skilavottord/web/screens/RecyclingCompanies/RecyclingCompanyUpdate/RecyclingCompanyUpdate.tsx Modified handleUpdateRecyclingPartner to remove the __typename property from the input object.

Possibly related PRs

Suggested reviewers

  • helgifr

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
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 (2)
apps/skilavottord/web/screens/RecyclingCompanies/RecyclingCompanyUpdate/RecyclingCompanyUpdate.tsx (1)

118-120: Approve change with suggestions for improvement

This change effectively addresses the PR objective by preventing the backend error when saving a recycling company. Good job on identifying and fixing this issue!

However, I have a couple of suggestions to further improve the code:

  1. For better performance, consider using object destructuring instead of the delete operator:
const { __typename, ...inputWithoutTypename } = input;
  1. To enhance type safety, explicitly type the input object:
const handleUpdateRecyclingPartner = handleSubmit(async (input: RecyclingPartnerInput) => {
  const { __typename, ...inputWithoutTypename } = input;
  // Use inputWithoutTypename in the mutation
  // ...
});

These changes will maintain the functionality while improving performance and type safety.

🧰 Tools
Biome

[error] 119-119: Avoid the delete operator which can impact performance.

Unsafe fix: Use an undefined assignment instead.

(lint/performance/noDelete)

apps/skilavottord/web/screens/RecyclingCompanies/RecyclingCompanies.tsx (1)

75-77: Approved: Path duplication issue resolved

The removal of BASE_PATH from the pathname in router.push is a good fix for the path duplication issue. This change aligns with NextJS best practices by simplifying the routing logic.

Consider updating the inline comment to provide more context:

- pathname: routes.recyclingCompanies.edit, // with BASE-PATH it duplicates the path
+ pathname: routes.recyclingCompanies.edit, // Removed BASE_PATH to prevent path duplication

This change makes the comment more explicit about the fix that was implemented.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 33c68ca and 6530008.

📒 Files selected for processing (2)
  • apps/skilavottord/web/screens/RecyclingCompanies/RecyclingCompanies.tsx (1 hunks)
  • apps/skilavottord/web/screens/RecyclingCompanies/RecyclingCompanyUpdate/RecyclingCompanyUpdate.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
apps/skilavottord/web/screens/RecyclingCompanies/RecyclingCompanies.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."
apps/skilavottord/web/screens/RecyclingCompanies/RecyclingCompanyUpdate/RecyclingCompanyUpdate.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."
Biome
apps/skilavottord/web/screens/RecyclingCompanies/RecyclingCompanyUpdate/RecyclingCompanyUpdate.tsx

[error] 119-119: Avoid the delete operator which can impact performance.

Unsafe fix: Use an undefined assignment instead.

(lint/performance/noDelete)

🔇 Additional comments not posted (1)
apps/skilavottord/web/screens/RecyclingCompanies/RecyclingCompanies.tsx (1)

Line range hint 1-329: Overall adherence to coding guidelines

This component demonstrates good adherence to the provided coding guidelines:

  1. It follows NextJS best practices for file structure and routing.
  2. It efficiently manages state using React hooks and Apollo Client for GraphQL queries.
  3. It implements server-side rendering techniques through the use of useQuery from Apollo Client.
  4. The component and its utilities are properly typed with TypeScript, ensuring type safety.

The recent change improves the routing logic, further aligning the code with NextJS best practices.

Copy link

codecov bot commented Sep 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.67%. Comparing base (7e1f9d9) to head (96a714d).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #16159      +/-   ##
==========================================
- Coverage   36.69%   36.67%   -0.03%     
==========================================
  Files        6776     6769       -7     
  Lines      139578   139289     -289     
  Branches    39678    39575     -103     
==========================================
- Hits        51222    51087     -135     
+ Misses      88356    88202     -154     
Flag Coverage Δ
api 3.39% <ø> (ø)
application-system-api 41.64% <ø> (ø)
application-template-api-modules 23.70% <ø> (-0.02%) ⬇️
application-ui-shell 21.29% <ø> (ø)
web 1.83% <ø> (ø)

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

see 50 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 7e1f9d9...96a714d. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Sep 25, 2024

Datadog Report

All test runs f4c7a0c 🔗

6 Total Test Services: 0 Failed, 5 Passed
➡️ Test Sessions change in coverage: 17 no change

Test Services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
api 0 0 0 4 0 2.86s 1 no change Link
application-system-api 0 0 0 111 2 3m 3.24s 1 no change Link
application-template-api-modules 0 0 0 109 0 1m 52.08s 1 no change Link
application-ui-shell 0 0 0 74 0 34.96s 1 no change Link
service-portal-health 0 0 0 0 0 547.32ms 1 no change Link
web 0 0 0 84 0 28.86s 1 no change Link

Copy link
Member

@veronikasif veronikasif left a comment

Choose a reason for hiding this comment

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

lgtm 💯

@birkirkristmunds birkirkristmunds added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Sep 26, 2024
@kodiakhq kodiakhq bot merged commit ec2b57e into main Sep 26, 2024
53 checks passed
@kodiakhq kodiakhq bot deleted the fix/skilavottord-fix-error-in-recycling-companies-viewing branch September 26, 2024 12:30
birkirkristmunds added a commit that referenced this pull request Sep 27, 2024
…nies (#16159)

- Fix path when trying to view recycling company
- Fix error when trying to save recycling company

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
kodiakhq bot added a commit that referenced this pull request Sep 27, 2024
* chore(skilavottord): Inspect why traffic endpoint is not always returning data (#16151)

- Added loggers
- make sure Traffic is only called when needed

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

* fix(skilavottord): Error when trying to view and save recycling companies (#16159)

- Fix path when trying to view recycling company
- Fix error when trying to save recycling company

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
thoreyjona pushed a commit that referenced this pull request Oct 2, 2024
…nies (#16159)

- Fix path when trying to view recycling company
- Fix error when trying to save recycling company

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
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