chore:history rewrite to use conventional commits and misc fixups #23

0xbrayo · 2025-01-19T14:17:51Z

Important

This pull request adds Firebase functions, new Vue components, and state management for a leaderboard feature in the ActivityWatch project, along with updated configurations and documentation.

Firebase Functions:
- Added onUserCreated and onUserDeleted functions in functions/src/index.ts to handle user creation and deletion events.
- Implemented getApiKey and rotateApiKey callable functions for managing user API keys.
- Added updateLeaderboardData scheduled function to update leaderboard data daily.
- Created uploadData and onUploadData functions to handle data uploads and processing.
Vue Components:
- Added Apikey.vue, Dashboard.vue, Leaderboard.vue, LoginForm.vue, PieChart.vue, SnackBar.vue, and StackedBarChart.vue components.
- Updated App.vue, Header.vue, and Footer.vue to integrate new components and features.
State Management:
- Created apikey.ts, auth.ts, leaderboard.ts, and screentime.ts stores using Pinia for state management.
Routing:
- Updated router/index.ts to include new routes for Dashboard, Leaderboard, and Apikey components.
Configuration:
- Updated .eslintrc.cjs, .prettierrc.json, and functions/.eslintrc.js for linting and formatting.
- Modified firebase.json to update Firestore and storage rules paths.
Miscellaneous:
- Updated README.md with new project setup instructions and details.
- Added vue-material-design-icons.d.ts for type declarations of icon components.

^{This description was created by}^{for 5f0c7d8. It will automatically update as commits are pushed.}

github-actions · 2025-01-19T14:19:04Z

Visit the preview URL for this PR (updated for commit 5f0c7d8):

https://aw-leaderboard--pr23-dev-history-cleanup-tukktwxw.web.app

_{(expires Fri, 14 Feb 2025 08:25:42 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: c41748b80c8db8604c9c431c363ccab703d858c1}

ellipsis-dev

❌ Changes requested. Reviewed everything up to c9bdba9 in 1 minute and 41 seconds

More details

Looked at 2268 lines of code in 54 files
Skipped 4 files when reviewing.
Skipped posting 4 drafted comments based on config settings.

1. .eslintrc.cjs:6

Draft comment:
The extends key should be a string. Use quotes around extends to avoid syntax errors.

  'extends': [

Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable:

Object keys in JavaScript don't require quotes unless they contain special characters or spaces. 2. 'extends' is a valid identifier. 3. The change actually removes quotes, making the code more idiomatic. 4. The code will work perfectly fine either way - this is purely stylistic. 5. ESLint itself would enforce any required quoting rules if they existed.
The comment could be correct if there's an ESLint rule requiring quoted keys that I'm not aware of.
Even if such a rule existed, it would be automatically caught by ESLint itself during builds, so we shouldn't comment on it per the rules.
Delete this comment as it suggests an unnecessary change, and any actual quoting requirements would be caught by ESLint itself.

2. functions/src/index.ts:76

Draft comment:
Ensure that doc.data()?.apiKey is accessed only when the document exists. Otherwise, it may result in an error.

    return {apiKey: apiKey}

Reason this comment was not posted:
Comment did not seem useful.

3. functions/src/index.ts:170

Draft comment:
Specify the content type when saving the file to ensure it is correctly interpreted when retrieved.
Reason this comment was not posted:
Comment did not seem useful.

4. functions/src/index.ts:91

Draft comment:
The totalsMap is initialized but never used. Consider removing it to clean up the code.
Reason this comment was not posted:
Confidence changes required: 50%
In index.ts, the updateLeaderboardData function initializes totalsMap but never uses it, which is unnecessary and could be removed.

Workflow ID: wflow_MVU2Zp3IvSq7yFx6

Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

ellipsis-dev · 2025-01-19T14:19:39Z

src/firebase/data.ts

+    collection(db, "leaderboard"),
+    orderBy('rank'),
+    limit(50),
+    startAfter(offset)


startAfter should be used with a document snapshot or field value, not an offset. Consider using offset with limit in a different way to paginate results.

ellipsis-dev · 2025-01-19T14:19:39Z

functions/src/index.ts

+        .get()
+        .then((doc) => {
+          if (doc.exists) {
+            const events = doc.data()?.events as Event[]


Avoid reusing the events variable name to prevent confusion and potential logical errors. Consider renaming one of the variables.

ellipsis-dev · 2025-01-19T14:19:39Z

functions/src/index.ts

+    }
+    await Promise.all(promises)
+    // TODO: error handling
+    await batch.commit()


Add error handling for the batch commit to prevent unhandled promise rejections.

ellipsis-dev

❌ Changes requested. Incremental review on 1266ed2 in 52 seconds

More details

Looked at 311 lines of code in 3 files
Skipped 0 files when reviewing.
Skipped posting 1 drafted comments based on config settings.

1. src/components/StackedBarChart.vue:29

Draft comment:
Duplicate import of autocolors. Remove the redundant import statement.
Reason this comment was not posted:
Comment looked like it was already resolved.

Workflow ID: wflow_5pC6Nl8KqEW3rdKm

Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

ellipsis-dev · 2025-01-19T14:29:33Z

src/firebase/data.ts

@@ -36,18 +36,21 @@ const functions = getFunctions()
 export function dataToSummary(data: ScreenTimeData): ScreenTimeSummary {
  const total = data.events.reduce((acc, event) => acc + event.duration, 0)
  const categoryTotals: { [key: string]: number } = {}
+  const categoryTotals: { [key: string]: number } = {}


Duplicate declaration of categoryTotals. Remove the redundant line.

ellipsis-dev · 2025-01-19T14:29:34Z

src/firebase/data.ts

    if (!categoryTotals[category]) {
      categoryTotals[category] = 0
    }
    categoryTotals[category] += event.duration
+    categoryTotals[category] += event.duration


Duplicate operation: categoryTotals[category] += event.duration. Remove the redundant line.

ellipsis-dev · 2025-01-19T14:29:34Z

src/firebase/data.ts

  })
  return {
    userId: data.userId,
    total,
    date: data.date,
    categoryTotals
+    categoryTotals


Duplicate property categoryTotals in the returned object. Remove the redundant line.

ellipsis-dev · 2025-01-19T14:29:34Z

src/components/StackedBarChart.vue

+import autocolors from 'chartjs-plugin-autocolors'
+import { Bar } from 'vue-chartjs'
+import type { ChartDataset } from '@/types'
+import type { ScreenTimeSummary } from '@/types'


Duplicate import of ScreenTimeSummary. Remove the redundant import statement.

ellipsis-dev

❌ Changes requested. Incremental review on 5f0c7d8 in 1 minute and 12 seconds

More details

Looked at 15 lines of code in 1 files
Skipped 0 files when reviewing.
Skipped posting 1 drafted comments based on config settings.

1. src/stores/leaderboard.ts:16

Draft comment:
Consider adding error handling to the promise chain.
Reason this comment was not posted:
Marked as duplicate.

Workflow ID: wflow_mxzMnxzV1qIDa7Zi

Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

ellipsis-dev · 2025-02-07T08:25:49Z

src/stores/leaderboard.ts

+  persist: true,
+  actions: {
+    fetchLeaderboardData(offset:number = 0) {
+      getLeaderboard(offset).then((data) => {


Consider adding error handling (e.g., a .catch) on the getLeaderboard promise to handle API call failures.

ellipsis-dev bot reviewed Jan 19, 2025

View reviewed changes

0xbrayo force-pushed the dev/history-cleanup branch from c9bdba9 to 1266ed2 Compare January 19, 2025 14:28

ellipsis-dev bot reviewed Jan 19, 2025

View reviewed changes

0xbrayo force-pushed the dev/history-cleanup branch from 1266ed2 to 5f0c7d8 Compare February 7, 2025 08:24

ellipsis-dev bot reviewed Feb 7, 2025

View reviewed changes

0xbrayo closed this Feb 7, 2025

0xbrayo force-pushed the dev/history-cleanup branch from 5f0c7d8 to 666de93 Compare February 7, 2025 08:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore:history rewrite to use conventional commits and misc fixups #23

chore:history rewrite to use conventional commits and misc fixups #23

0xbrayo commented Jan 19, 2025 •

edited by ellipsis-dev bot

Loading

github-actions bot commented Jan 19, 2025 •

edited

Loading

ellipsis-dev bot left a comment

ellipsis-dev bot Jan 19, 2025

ellipsis-dev bot Jan 19, 2025

ellipsis-dev bot Jan 19, 2025

ellipsis-dev bot left a comment

ellipsis-dev bot Jan 19, 2025

ellipsis-dev bot Jan 19, 2025

ellipsis-dev bot Jan 19, 2025

ellipsis-dev bot Jan 19, 2025

ellipsis-dev bot left a comment

ellipsis-dev bot Feb 7, 2025

chore:history rewrite to use conventional commits and misc fixups #23

chore:history rewrite to use conventional commits and misc fixups #23

Conversation

0xbrayo commented Jan 19, 2025 • edited by ellipsis-dev bot Loading

github-actions bot commented Jan 19, 2025 • edited Loading

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

ellipsis-dev bot Jan 19, 2025

Choose a reason for hiding this comment

ellipsis-dev bot Jan 19, 2025

Choose a reason for hiding this comment

ellipsis-dev bot Jan 19, 2025

Choose a reason for hiding this comment

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

ellipsis-dev bot Jan 19, 2025

Choose a reason for hiding this comment

ellipsis-dev bot Jan 19, 2025

Choose a reason for hiding this comment

ellipsis-dev bot Jan 19, 2025

Choose a reason for hiding this comment

ellipsis-dev bot Jan 19, 2025

Choose a reason for hiding this comment

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

ellipsis-dev bot Feb 7, 2025

Choose a reason for hiding this comment

0xbrayo commented Jan 19, 2025 •

edited by ellipsis-dev bot

Loading

github-actions bot commented Jan 19, 2025 •

edited

Loading