Development: Add Artemis icon and description to LTI's dynamic registration info

[maximiliansoelch]

Checklist

General

• This is a small issue that I tested locally and was confirmed by another developer on a test server.
• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Server

• Important: I implemented the changes with a very good performance and prevented too many (unnecessary) database calls.
• I strictly followed the server coding and design guidelines.

Motivation and Context

Currently, there is no Artemis description or icon send during the dynamic registration of LTI.

The following screenshot shows a description placeholder and icon in Moodle:

Description

This PR adds an Artemis description and the URI to the Artemis Logo to the LTI's dynamic registration information.

The following screenshot shows a description for Artemis and the Artemis icon in Moodle:

Steps for Testing

Prerequisites:

• Access to Moodle
• Admin Access on a test server

1. Log in to Artemis
2. Navigate to LTI Configuration
   3. If the Moodle instance is already registered, you need to delete it first
3. Copy dynamic registration url
4. Login to Moodle
5. Navigate to Site Administration, Plugins, External Tools, Manage tools
   6. If the Artemis Testserver is already registered in Moodle, you need to delete if first
6. Paste in the copied registration url and click on the Add LTI Advantage button
7. The Artemis Testserver should be registered and the icon as well as the description should be displayed

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

Performance Review

• I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance
• I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Test Coverage

Screenshots

Summary by CodeRabbit

• New Features
  • Added support for a logo URI in client registration, enhancing visual identification in user interfaces.
  • Introduced a description field for tools, allowing for more detailed information about the registered application.

These improvements enhance the configurability and usability of the LTI 1.3 client registration, providing essential metadata for better integration.

[coderabbitai]

Walkthrough

The recent updates to the Lti13ClientRegistration class enhance its functionality by adding new properties for logo URI and tool description. These changes improve the configurability of LTI 1.3 client registrations, allowing for better metadata management essential for user interfaces and integrations. The constructor and methods have been updated accordingly to accommodate these new features.

Changes

Files	Change Summary
src/main/java/de/tum/in/www1/artemis/domain/lti/Lti13ClientRegistration.java	Introduced logoUri and description fields with appropriate getters and setters. Updated constructor to set logoUri.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Lti13ClientRegistration as Client
    participant Lti13ToolConfiguration as ToolConfig

    User->>Client: Create instance with serverUrl
    Client->>Client: setLogoUri(constructed URL)
    Client->>ToolConfig: setDescription("Tool description")
    ToolConfig-->>Client: return description
    Client-->>User: Return Client instance with logo and description

Loading

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[Strohgelaender]

code

[JohannesStoehr]

Code looks good to me

[github-actions]

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.