Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-11-14T06:18:24Z

Adiyora:

=Expertiza=

Expertiza is an open-source project built using Ruby on Rails. It provides a platform for instructors and students to manage, submit, and evaluate assignments and projects. Instructors can create, edit, and grade assignments, while students can collaborate in teams, submit their work, and review peers' submissions. Expertiza supports submission across various document types, including URLs and wiki pages.

=Project Description=

Refactor the GraphQL API endpoint for contribution metrics by
* replacing hard-coded variables with reusable constants</li>
* implementing and publishing GraphQL queries as Flask endpoints so that the queries can be sent to the GitHub GraphQL API using a URL.</li>

=Key Objectives=
API Endpoint Development:

* Integrate existing code with Flask to expose GraphQL queries as API endpoints.

Testing and Validation:

* Conduct thorough testing (unit tests and integration tests) to verify the correctness and reliability of the implemented endpoints.
* Validate API functionality across different scenarios to ensure robustness and reliability.

=Implementation=

Each query was refactored by replacing hard-coded variables with new constants defined in [[CSC/ECE_517_Fall_2024_-_G2401_Refactor_Graphql_API_endpoint_for_contribution_metrics#Constants | Constants]]

===/comments===

* user_commit_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User commit comments.png|1000px]]

* user_gist_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User gist comments.png|1000px]]

* user_issue_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User issue comments.png|1000px]]

* user_repository_discussion_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User repo discussion comments.png|1000px]]

===/contributions===

* user_gists [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/890d7b2e8bc0656f8b76aac593b4e8702851a41a Git commit]

[[File:User gists.png|1000px]]

* user_issues [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/890d7b2e8bc0656f8b76aac593b4e8702851a41a Git commit]

[[File:User issues.png|1000px]]

* user_pull_requests [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/890d7b2e8bc0656f8b76aac593b4e8702851a41a Git commit]

[[File:User pull requests.png|1000px]]

===/time_range_contributions===

* user_contributions_collection [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/e659abccfa53588579d8074c560545eb6bd962dd Git commit]

[[File:User contributions collections.png|1000px]]

=Constants=

Field constants, node constants, and argument constants were all added to the codebase for reusability. Many of the [[CSC/ECE_517_Fall_2024_-_G2401_Refactor_Graphql_API_endpoint_for_contribution_metrics#Flask_API_Endpoints | GraphQL queries]] reference these variables multiple times. [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/48db85397252e609707e7fa34166d34d47e74416 Github commit]

===Field Constants===

[[File:field constants.png|500px]]

===Node Constants===

[[File:node constants.png|500px]]

===Argument Constants===

[[File:argument constants.png|500px]]

=Design Pattern and Strategy=
Our main goal is to help present the user's activities on GitHub which includes comments, contributions, time range contributions and profiles.

'''Frontend GUI (React)''':
* Implement an interactive UI for the users to display the information related to GitHub activities.
* To build a clean and robust frontend design to make it visually appealing.

'''Backend (Flask)''':
* Integrate Flask API endpoints to fetch the data which includes user's comments, contributions, time range contributions and profiles on Github.
* Integrate and implement a GitHub token-based login feature to access the information.

'''Workflow''':
* The backend system will fetch the data of the user's GitHub activities.
* It will pass this information to frontend which is fetched by React.
* After fetching the details from the backend system, it will display it in the form of UI.

== Phase 1 vs Phase 2: Key Differences ==

=== Objective ===
; Phase 1
: Develop a backend service using Flask to interact with the GitHub GraphQL API.
; Phase 2
: Refactor the backend code to improve maintainability by using constants and develop a frontend using React.

=== Backend Queries ===
; Phase 1
: Use hard-coded strings for field names, node names, and arguments.
; Phase 2
: Replace hard-coded strings with reusable constants for fields, nodes, and arguments.

=== API Endpoints ===
; Phase 1
: Implement API endpoints for `/comments`, `/contributions`, `/profiles`, and `/time_range_contributions`.
; Phase 2
: Enhance endpoints with better code readability by using pre-defined constants.

=== Frontend ===
; Phase 1
: No frontend implementation.
; Phase 2
: Develop a React-based frontend that allows users to interact with the GitHub GraphQL API.

=== Bulk Querying ===
; Phase 1
: No support for bulk querying of usernames.
; Phase 2
: Implement a feature that allows users to upload a CSV containing GitHub usernames and retrieves their contribution metrics.

=== Testing ===
; Phase 1
: Perform unit and integration tests for Flask endpoints.
; Phase 2
: Expand tests to include the refactored backend and React frontend functionality.

=== Deliverables ===
; Phase 1
: Deliver a functional backend that can query the GitHub GraphQL API.
; Phase 2
: Deliver a refactored backend, React frontend, and CSV bulk query feature for GitHub metrics.

=Flask API Endpoints=

===/comments===
[[File:Comments api endpoint.png|750px]]

===/contributions===
[[File:Contributions.png|750px]]

===/profiles===
[[File:Profiles.png|750px]]

===/time_range_contributions===
[[File:time_range_contributions.png|750px]]

=Testing=

===/time range contributions===
[[File:Time range contributions test.png|750px]]

===/comments===
[[File:test_user_commit_comments.png|750px]]

[[File:test_user_gist_comments.png|750px]]

[[File:test_user_issue_comments.png|750px]]

=Team=

<b>Mentor:</b>

Jialin Cui

<b>Team Members:</b>

Anjan Jagadishbhai Diyora

Vighnesh Hegde

Kaylie Naylor

=Github Repository=

original: https://github.ncsu.edu/jcui9/GitHub_Miner

forked: https://github.ncsu.edu/vshegde2/GitHub_Miner

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-29T06:35:20Z

Adiyora: Blanked the page

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-29T06:09:39Z

Adiyora: Created page with " # GitHub Contribution Metrics API This project refactors and expands the GitHub GraphQL API endpoint for fetching GitHub contribution metrics. The project integrates several GitHub data queries into a Python Flask framework, making them accessible via RESTful API endpoints. The refactoring focuses on standardizing the use of constants for field and node names, improving readability, maintainability, and ensuring consistency across queries. ## Table of Contents - [Proj..."

# GitHub Contribution Metrics API

This project refactors and expands the GitHub GraphQL API endpoint for fetching GitHub contribution metrics. The project integrates several GitHub data queries into a Python Flask framework, making them accessible via RESTful API endpoints. The refactoring focuses on standardizing the use of constants for field and node names, improving readability, maintainability, and ensuring consistency across queries.

## Table of Contents
- [Project Overview](#project-overview)
- [Key Features](#key-features)
- [Setup and Installation](#setup-and-installation)
- [API Endpoints](#api-endpoints)
- [Refactoring Approach](#refactoring-approach)
- [Screenshots](#screenshots)
- [Future Improvements](#future-improvements)

## Project Overview

The API allows users to fetch various GitHub contribution metrics for individual users, such as commit comments, gist comments, issue comments, repository discussions, pull requests, and more. The project emphasizes the use of constants to make queries more maintainable and consistent.

## Key Features

- **API Endpoint Development**: Exposes GitHub contribution queries as RESTful API endpoints.
- **Refactoring with Constants**: Replaces hardcoded field and node names with pre-defined constants for readability and maintainability.
- **Pagination Support**: Handles large data requests with paginated queries to prevent overload.
- **Time-based Filtering**: Supports filtering contributions by date.

## Setup and Installation

1. **Clone the Repository**:
```bash
git clone <repository_url>
```

2. **Setup Virtual Environment**:
```bash
python -m venv venv
source venv/bin/activate # On Unix/macOS
venv\Scripts\activate # On Windows
```

3. **Install Dependencies**:
```bash
pip install -r requirements.txt
```

4. **Configure GitHub OAuth**:
- Register a new GitHub OAuth App at [GitHub Developer Settings](https://github.com/settings/developers).
- Use the following URLs for local testing:
- **Homepage URL**: `http://127.0.0.1:5000`
- **Authorization callback URL**: `http://127.0.0.1:5000/oauth/login/authorize`
- Copy the Client ID and Client Secret into `backend/app/config.py`.

5. **Setup Database**:
- Configure `SQLALCHEMY_DATABASE_URI` in `backend/app/config.py`.
- Run migrations:
```bash
flask db upgrade
```
- Seed the database:
```bash
python scripts/seed_db.py
```

6. **Run the Application**:
```bash
python run.py
```

## API Endpoints

### Authentication Endpoints
- **/oauth/login**: Initiates the OAuth flow with GitHub.
- **/oauth/authorize**: Callback endpoint for GitHub OAuth.

### Contribution Metrics Endpoints
1. **/api/comments/commit**: Fetch user commit comments.
2. **/api/comments/gist**: Fetch user gist comments.
3. **/api/comments/issue**: Fetch user issue comments.
4. **/api/comments/repository_discussion**: Fetch user repository discussion comments.
5. **/api/contributions/issues**: Fetch user issues.
6. **/api/contributions/gists**: Fetch user gists.
7. **/api/contributions/pull_requests**: Fetch user pull requests.
8. **/api/repositories/discussions**: Fetch user repository discussions.

## Refactoring Approach

The refactoring task involved:
1. **Standardizing Field Names**:
- Hardcoded strings were replaced with pre-defined constants (e.g., `FIELD_LOGIN`, `FIELD_CREATED_AT`, `NODE_USER`, etc.) located in `constants.py`.
- Example before refactoring:
```python
fields=["createdAt", "login"]
```
- Example after refactoring:
```python
fields=[FIELD_CREATED_AT, FIELD_LOGIN]
```

2. **Code Cleanup**:
- Reorganized queries to use `QueryNode` and `QueryNodePaginator` consistently.
- Added helper methods for specific queries to filter data by creation date.

3. **Pagination Handling**:
- Implemented `QueryNodePaginator` to fetch paginated results and handle large datasets.

## Screenshots

### Project Setup
1. **Directory Structure**: Demonstrates the file organization after adding refactored files.
- *Add your screenshot showing the directory structure.*

2. **GitHub OAuth Configuration**: Shows the GitHub OAuth application setup.
- *Add your screenshot showing the GitHub OAuth setup.*

3. **Database Configuration**: Shows the setup for `config.py` with SQLAlchemy and OAuth configurations.
- *Add your screenshot of the database setup in `config.py`.*

### Refactoring Proof
1. **Refactored Code**: Before and after examples in various files.
- *Add screenshots showing your code before and after the refactor, particularly for comments and contributions.*

2. **Constants Usage**: Illustrates the usage of constants in refactored queries.
- *Add a screenshot highlighting the use of constants in any refactored query file.*

3. **Git Commit History**: Shows the commits for refactoring changes.
- *Add a screenshot of the commit history with relevant commit messages, as seen in your source control screenshot.*

### Pull Request
1. **Pull Request on GitHub**: Shows the created pull request with relevant description.
- *Add a screenshot of the pull request creation page with title and description.*

## Future Improvements

- **Enhanced Filtering**: Add more date range filters or filter by contribution type.
- **Error Handling**: Improve error handling for failed requests and authentication issues.
- **Testing**: Add unit and integration tests to ensure query accuracy and API reliability.

---

CSC/ECE 517 Fall 2024

2024-10-29T02:50:04Z

Adiyora:

* [[CSC/ECE 517 Fall 2024 - E2454. Refactor student_task.rb]]
* [[CSC/ECE 517 Fall 2024 - E2456. Refactor teams_user.rb]]
* [[CSC/ECE 517 Fall 2024 - E2455. Refactor sign_up_sheet_controller.rb]]
* [[CSC/ECE 517 Fall 2024 - E2459. View for results of bidding]]
* [[CSC/ECE 517 Fall 2024 - E2461. UI for Courses]]
* [[CSC/ECE 517 Fall 2024 - E2465. UI for Institutions and Notification]]
* [[CSC/ECE 517 Fall 2024 - E2466. UI for Impersonate User]]
* [[CSC/ECE 517 Fall 2024 - E2467. UI for View Submissions]]
* [[CSC/ECE 517 Fall 2024 - E2469. Reimplement grades/view_team]]
* [[CSC/ECE 517 Fall 2024 - E2470. Reimplement grades_controller]]
* [[CSC/ECE 517 Fall 2024 - E2478. Reimplement the Question hierarchy as Item hierarchy]]
* [[CSC/ECE 517 Fall 2024 - E2480. Implement testing for new Bookmarks Controller]]
* [[CSC/ECE 517 Fall 2024 - E2482. Reimplement heatgrid for reviews]]
* [[CSC/ECE 517 Fall 2024 - E2460 Mentor-Meeting Management]]
* [[CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics]]