Programming exercises: Feature Proposal - Store repository URLs without base path in the database

[SimonEntholzer]

Feature Proposal

Spec Version 1.0.0

Context

The Participation table stores the repository URL of the repository, which contains the files.

Problem

• There is a lot of redundant information, as the basePath is the same for every repository URL.
• Migrating the server to another domain can break access to repositories.

Motivation

Describe the motivation WHY the problem needs solving. Specify the affected users/roles.

• Save space in the database
• Making the stored repository independent of the domain of the Artemis server (e.g. if there's a change from ase.tum.de to tum.de, all the participations in the database need to be migrated, or if. e.g. the Gitlab instance changes location/domain)

Requirements Engineering

Existing (Problematic) Solution / System

Currently the whole repository URL is stored for a participation in the database.

Proposed System

Only store the Path of the repositories in the database.
Reconstruct the full URL from the path, and the server's base path, to provide it to the user.

Requirements

1. FR: Users see clone URL: Users can still see the complete clone URL in the UI
2. FR: Store only Path in db: The database column should only contain the repository path, and not the base URL.

Analysis

Analysis Object Model

• The repositoryUri attribute in participation should be replaced with repositoryPath

System Architecture

• Make sure, when a participation is loaded, the full clone URL is reconstructed from the path in the database and the servers base URL.

Subsystem Decomposition.

• When the repository URL is extracted from the user's request to clone/pull/push, extract the path, and pass that further instead of the whole repository URL. (HTTPS: see LocalVCServletService.authenticateAndAuthorizeGitRequest SSH: see SshGitLocationResolverService.resolveRootDirectory)

Persistent Data Management

• Create a migration to remove all the basepath prefixes from the repository_url column
• rename the repository_url column to repository_path

UI/UX Design

No changes to the UI