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

chore(web): Prevent 500 error in case of failure when fetching PowerBi embed props #16723

Conversation

RunarVestmann
Copy link
Member

@RunarVestmann RunarVestmann commented Nov 5, 2024

Prevent 500 error in case of failure when fetching PowerBi embed props

What

  • Client secret expired and the backend throws an error that gets forwared to the frontend
  • I added a try catch block and still log the error in case it happens because I don't think it's correct to cause a 500 error on the web when a single PowerBi report can't be embedded

Screenshots / Gifs

Before

Screenshot 2024-11-05 at 13 26 00

After

Screenshot 2024-11-05 at 13 25 32

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

Summary by CodeRabbit

  • New Features

    • Enhanced error handling in the Power BI service for improved reliability.
  • Bug Fixes

    • Implemented logging for errors occurring during the retrieval of embed properties.

@RunarVestmann RunarVestmann added the automerge Merge this PR as soon as all checks pass label Nov 5, 2024
@RunarVestmann RunarVestmann requested review from a team as code owners November 5, 2024 13:27
Copy link
Contributor

coderabbitai bot commented Nov 5, 2024

Walkthrough

The pull request modifies the PowerBiService class in libs/cms/src/lib/powerbi.service.ts by adding a logger for improved error handling. The constructor is updated to inject a Logger, and the getEmbedProps method is enhanced with a try-catch block to log errors instead of returning null silently. This change retains the original functionality while improving robustness against exceptions during asynchronous operations.

Changes

File Path Change Summary
libs/cms/src/lib/powerbi.service.ts - Added import for Logger and LOGGER_PROVIDER.
- Updated constructor to inject logger.
- Enhanced getEmbedProps method with error logging in a try-catch block.

Possibly related PRs

Suggested reviewers

  • thorkellmani

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

🧹 Outside diff range and nitpick comments (1)
libs/cms/src/lib/powerbi.service.ts (1)

40-62: Consider implementing more robust error handling strategies

The current implementation could benefit from:

  1. Distinguishing between different types of failures (auth failures vs. API failures)
  2. Implementing retry mechanisms for transient failures
  3. Providing more detailed error information to the caller

Consider implementing a custom error class:

class PowerBiServiceError extends Error {
  constructor(
    message: string,
    public readonly code: 'AUTH_FAILED' | 'REPORT_NOT_FOUND' | 'EMBED_FAILED',
    public readonly cause?: Error
  ) {
    super(message);
    this.name = 'PowerBiServiceError';
  }
}

This would allow for more specific error handling upstream while maintaining the current null return for backward compatibility.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2d97d44 and 4e9ec66.

📒 Files selected for processing (1)
  • libs/cms/src/lib/powerbi.service.ts (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
libs/cms/src/lib/powerbi.service.ts (1)

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

  • Reusability of components and hooks across different NextJS apps.
  • TypeScript usage for defining props and exporting types.
  • Effective tree-shaking and bundling practices."
🔇 Additional comments (2)
libs/cms/src/lib/powerbi.service.ts (2)

11-11: LGTM: Logger integration follows best practices

The addition of the Logger service through dependency injection is well-implemented and follows the established patterns for service instrumentation.

Also applies to: 23-23


40-62: LGTM: Changes maintain service reusability

The error handling improvements make the service more robust while maintaining:

  • Clear TypeScript types
  • Consistent return types
  • Compatibility with existing consumers

libs/cms/src/lib/powerbi.service.ts Outdated Show resolved Hide resolved
Copy link

codecov bot commented Nov 5, 2024

Codecov Report

Attention: Patch coverage is 22.22222% with 7 lines in your changes missing coverage. Please review.

Project coverage is 36.50%. Comparing base (cd92fc2) to head (a97ba4c).
Report is 252 commits behind head on main.

Files with missing lines Patch % Lines
libs/cms/src/lib/powerbi.service.ts 22.22% 7 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #16723      +/-   ##
==========================================
- Coverage   36.51%   36.50%   -0.01%     
==========================================
  Files        6890     6890              
  Lines      143803   143833      +30     
  Branches    40970    40984      +14     
==========================================
  Hits        52511    52511              
- Misses      91292    91322      +30     
Flag Coverage Δ
application-system-api 41.12% <22.22%> (-0.01%) ⬇️
cms 0.42% <0.00%> (-0.01%) ⬇️
cms-translations 38.92% <11.11%> (-0.02%) ⬇️
judicial-system-api 19.57% <ø> (ø)
judicial-system-backend 55.20% <22.22%> (-0.01%) ⬇️
services-auth-admin-api 52.47% <ø> (+0.59%) ⬆️
services-auth-ids-api 52.06% <ø> (+0.59%) ⬆️
services-auth-personal-representative 45.58% <ø> (+0.49%) ⬆️
services-auth-personal-representative-public 41.77% <ø> (+0.49%) ⬆️
services-auth-public-api 49.58% <ø> (+0.61%) ⬆️
services-user-notification 46.88% <22.22%> (-0.01%) ⬇️
services-user-profile 61.76% <ø> (-0.08%) ⬇️

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

Files with missing lines Coverage Δ
libs/cms/src/lib/powerbi.service.ts 18.36% <22.22%> (+2.45%) ⬆️

... and 3 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 2d97d44...a97ba4c. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Nov 5, 2024

Datadog Report

All test runs e0d23b8 🔗

18 Total Test Services: 0 Failed, 17 Passed
🔻 Test Sessions change in coverage: 5 decreased, 1 increased (+0.02%), 33 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
api 0 0 0 4 0 3.05s 1 no change Link
api-domains-auth-admin 0 0 0 18 0 14.06s 1 no change Link
api-domains-communications 0 0 0 5 0 33.13s 1 decreased (-0.02%) Link
api-domains-license-service 0 0 0 0 0 572.64ms 1 no change Link
application-system-api 0 0 0 120 2 3m 41.07s 1 no change Link
application-template-api-modules 0 0 0 123 0 0s N/A Link
auth-api-lib 0 0 0 20 0 31.79s 1 no change Link
cms-translations 0 0 0 3 0 27.62s 1 decreased (-0.02%) Link
judicial-system-api 0 0 0 59 0 6.12s 1 no change Link
judicial-system-backend 0 0 0 20887 0 20m 57.52s 1 decreased (-0.02%) Link

🔻 Code Coverage Decreases vs Default Branch (5)

  • cms-translations - jest 48.37% (-0.02%) - Details
  • api-domains-communications - jest 48.95% (-0.02%) - Details
  • judicial-system-backend - jest 58.7% (-0.02%) - Details
  • services-user-notification - jest 69.53% (-0.02%) - Details
  • services-auth-ids-api - jest 45.33% (-0.01%) - Details

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)
libs/cms/src/lib/powerbi.service.ts (1)

56-59: Consider adding error status to the response type.

Instead of returning null, consider enhancing the response type to include error status. This would help the frontend display appropriate feedback to users.

 export interface GetPowerBiEmbedPropsFromServerResponse {
   accessToken: string;
   embedUrl: string;
+  status: 'success' | 'error';
+  errorMessage?: string;
 }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4e9ec66 and a97ba4c.

📒 Files selected for processing (1)
  • libs/cms/src/lib/powerbi.service.ts (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
libs/cms/src/lib/powerbi.service.ts (1)

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

  • Reusability of components and hooks across different NextJS apps.
  • TypeScript usage for defining props and exporting types.
  • Effective tree-shaking and bundling practices."
🔇 Additional comments (2)
libs/cms/src/lib/powerbi.service.ts (2)

11-11: LGTM: Logger integration looks good!

The Logger integration follows proper dependency injection patterns and TypeScript practices.

Also applies to: 23-23


40-62: Verify complete error handling coverage.

While the try-catch successfully prevents 500 errors, let's verify that all async operations are properly covered.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants