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

Development: Migrate admin-standardized-competency service to use inject() #9910

Merged
merged 2 commits into from
Dec 22, 2024

Conversation

ole-ve
Copy link
Contributor

@ole-ve ole-ve commented Nov 29, 2024

Checklist

General

Client

Motivation and Context

Client migration to Angular 19

Steps for Testing

  1. Import a standardized competency
  2. Check that respective HTTP calls are performed as expected (browseer dev tools)

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.







Review Progress

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Summary by CodeRabbit

  • Refactor
    • Simplified the dependency injection for the HttpClient service in the Admin Standardized Competency Service, enhancing code clarity without altering functionality.

@ole-ve ole-ve self-assigned this Nov 29, 2024
@ole-ve ole-ve requested a review from a team as a code owner November 29, 2024 16:51
@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Nov 29, 2024
Copy link

coderabbitai bot commented Nov 29, 2024

Walkthrough

The changes in this pull request involve refactoring the AdminStandardizedCompetencyService class to replace constructor-based dependency injection with the inject function for the HttpClient service. The constructor no longer accepts HttpClient as a parameter, simplifying the class design while maintaining the existing functionality of service methods that utilize the httpClient for HTTP requests.

Changes

File Change Summary
src/main/webapp/app/admin/standardized-competencies/admin-standardized-competency.service.ts Updated httpClient initialization from constructor injection to inject(HttpClient), simplifying the constructor.

Possibly related PRs

Suggested labels

server, refactoring, small, maintainer-approved

Suggested reviewers

  • MaximilianAnzinger
  • krusche
  • JohannesStoehr

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eaadd9c and 84b7102.

📒 Files selected for processing (1)
  • src/main/webapp/app/admin/standardized-competencies/admin-standardized-competency.service.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/main/webapp/app/admin/standardized-competencies/admin-standardized-competency.service.ts

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 or @coderabbitai title 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

@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

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b365494 and eaadd9c.

📒 Files selected for processing (1)
  • src/main/webapp/app/admin/standardized-competencies/admin-standardized-competency.service.ts (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
src/main/webapp/app/admin/standardized-competencies/admin-standardized-competency.service.ts (1)

Pattern src/main/webapp/**/*.ts: angular_style:https://angular.io/guide/styleguide;methods_in_html:false;lazy_loading:true;code_reuse:true;tests:meaningful;types:PascalCase;enums:PascalCase;funcs:camelCase;props:camelCase;no_priv_prefix:true;strings:single_quotes;localize:true;btns:functionality;links:navigation;icons_text:newline;labels:associate;code_style:arrow_funcs,curly_braces,open_braces_same_line,indent_4;memory_leak_prevention:true;routes:naming_schema;chart_framework:ngx-charts;responsive_layout:true

🪛 Biome (1.9.4)
src/main/webapp/app/admin/standardized-competencies/admin-standardized-competency.service.ts

[error] 13-13: This constructor is unnecessary.

Unsafe fix: Remove the unnecessary constructor.

(lint/complexity/noUselessConstructor)

🔇 Additional comments (2)
src/main/webapp/app/admin/standardized-competencies/admin-standardized-competency.service.ts (2)

1-2: LGTM! Import changes are correct.

The addition of inject from @angular/core is appropriate for the migration to the new DI pattern.


11-11: LGTM! Correct usage of inject() function.

The migration from constructor-based DI to inject() is implemented correctly, following Angular's recommended patterns for dependency injection.

Copy link

@HawKhiem HawKhiem left a comment

Choose a reason for hiding this comment

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

Tested on TS1. I got the following

image

Copy link

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

@ole-ve
Copy link
Contributor Author

ole-ve commented Dec 16, 2024

Tested on TS1. I got the following

Are you referring to the failing envelope-requests? These are requests to Sentry and commonly fail. Should be unrelated to these changes.

Copy link
Contributor

@raffifasaro raffifasaro left a comment

Choose a reason for hiding this comment

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

Empty constructor

@ole-ve ole-ve requested a review from a team as a code owner December 16, 2024 23:48
@ole-ve ole-ve requested a review from raffifasaro December 17, 2024 09:58
@github-actions github-actions bot removed the stale label Dec 17, 2024
Copy link
Contributor

@florian-glombik florian-glombik left a comment

Choose a reason for hiding this comment

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

Approve code

@krusche krusche added this to the 7.8.0 milestone Dec 22, 2024
@krusche krusche merged commit 73c6285 into develop Dec 22, 2024
31 of 38 checks passed
@krusche krusche deleted the chore/migrate-standardized-admin-competency-service branch December 22, 2024 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Pull requests that update TypeScript code. (Added Automatically!) ready to merge
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

6 participants