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

Pc report service #57

Merged
merged 5 commits into from
Aug 7, 2023
Merged

Pc report service #57

merged 5 commits into from
Aug 7, 2023

Conversation

pconrad
Copy link
Contributor

@pconrad pconrad commented Aug 5, 2023

In this PR, we add a new service (at this point, still not accessible to the end user), along with tests for that service.

The service can be used as the basis to produce a new job (in a future PR) that produces an instructor report.

Overview

This PR adds the entity and repository classes for two new database tables: Report and ReportLine.

A Report is a snapshot of activity about a particular commons. The Report row takes a snapshot of the Commons level information. A ReportLine takes a snapshot of a particular UserCommons in that Commons.

The ReportService has a createReport method that creates a new row in the Report table, and a ReportLine row for each UserCommon row. Together, this is a complete snapshot of the state of the game at the time the report was generated.

Future Work

This PR only creates the database tables, and the Report Service. Future PRs will create:

  • a job to invoke the service (backend)
  • swagger endpoints to launch the job (backend)
  • swagger endpoints to retrieve the report rows (backend)
  • a frontend component to launch the job from the Admin => Jobs page.
  • a frontend feature where Admins can view reports (and possibly download them).

Copy link
Contributor

@jingpeng7527 jingpeng7527 left a comment

Choose a reason for hiding this comment

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

LGTM

@pconrad pconrad merged commit a94d63a into main Aug 7, 2023
8 checks passed
pconrad added a commit that referenced this pull request Aug 31, 2023
fix:Admin page story now shows the fixtures for commons
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants