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

Feat/analytics aggregator #2665

Merged
merged 3 commits into from
Jun 13, 2023

Conversation

mgillian
Copy link
Contributor

@mgillian mgillian commented Jun 5, 2023

Checklist
  • [x ] the individual contributor license agreement is signed
  • [x ] commit message follows commit guidelines
  • [x ] tests are included
  • [x ] documentation is changed or added
  • new security keys and comments added to security.properties
  • new general keys and comments added to portal.properties
  • [x ] any changes that impact configuration or the database DDL added to CHANGES.md
  • message properties have been updated with new phrases
  • view conforms with WCAG 2.0 AA
Description of change

This change introduces a new Aggregator for the AnalyticsPortalEvent. Before now, the AnalyticsPortalEvent, if present, would be ignored after being marked as aggregated. Now, each AnalyticsPortalEvent that is received will be added to the UP_ANALYTICS_EVENTS table, allowing for exporting to an external system on a schedule to be determined. Since AnalyticsPortalEvents by default will not be processed, schools that enable AnalyticsPortalEvents will need to create a process to manage the size of the UP_ANALYTICS_EVENTS table. However, the number of records that are expected to received is relatively small.

return this.eventType;
}

/** @return the eventData */
Copy link

Choose a reason for hiding this comment

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

33% of developers fix this issue

MissingSummary: A summary fragment is required; consider using the value of the @return block as a summary fragment instead.


Suggested change
/** @return the eventData */
/** Returns the eventData.

ℹ️ Expand to see all @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage
@sonatype-lift ignore Leave out the above finding from this PR
@sonatype-lift ignoreall Leave out all the existing findings from this PR
@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
Click here to add LiftBot to another repo.

@sonatype-lift
Copy link

sonatype-lift bot commented Jun 5, 2023

🛠 Lift Auto-fix

Some of the Lift findings in this PR can be automatically fixed. You can download and apply these changes in your local project directory of your branch to review the suggestions before committing.1

# Download the patch
curl https://lift.sonatype.com/api/patch/github.com/uPortal-Project/uPortal/2665.diff -o lift-autofixes.diff

# Apply the patch with git
git apply lift-autofixes.diff

# Review the changes
git diff

Want it all in a single command? Open a terminal in your project's directory and copy and paste the following command:

curl https://lift.sonatype.com/api/patch/github.com/uPortal-Project/uPortal/2665.diff | git apply

Once you're satisfied, commit and push your changes in your project.

Footnotes

  1. You can preview the patch by opening the patch URL in the browser.

Copy link
Contributor

@loulou2u loulou2u left a comment

Choose a reason for hiding this comment

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

Approved

@loulou2u loulou2u merged commit 513e62d into uPortal-Project:master Jun 13, 2023
19 checks passed
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