Merge pull request #12670 from ethereum/crowdin-leaderboard

fix: Crowdin leaderboard data fetching

Author: wackerow

.github/workflows/get-leaderboard-reports.yml

@@ -0,0 +1,64 @@
+name: Update Crowdin leaderboard data
+
+on:
+  schedule:
+    - cron: "20 16 1 * *"
+  workflow_dispatch:
+
+jobs:
+  create_pr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Install ts-node
+        run: yarn global add ts-node
+
+      - name: Set up git
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "GitHub Action"
+
+      - name: Generate timestamp and readable date
+        id: date
+        run: |
+          echo "TIMESTAMP=$(date +'%Y%m%d%H%M%S')" >> $GITHUB_ENV
+          echo "READABLE_DATE=$(date +'%B %-d')" >> $GITHUB_ENV
+
+      - name: Fetch latest dev and create new branch
+        run: |
+          git fetch origin dev
+          git checkout -b "automated-update-${{ env.TIMESTAMP }}" origin/dev
+
+      - name: Run script
+        run: npx ts-node -O '{"module":"commonjs"}' ./src/scripts/crowdin/leaderboard/getLeaderboardReports.ts
+        env:
+          CROWDIN_API_KEY: ${{ secrets.CROWDIN_API_KEY }}
+          CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
+
+      - name: Commit and push
+        run: |
+          git add -A
+          git commit -m "Update Crowdin leaderboard data"
+          git push origin "automated-update-${{ env.TIMESTAMP }}"
+
+      - name: Create PR body
+        run: |
+          echo "This PR was automatically created to update Crowdin leaderboard data." > pr_body.txt
+          echo "This workflows runs on the first of each month at 16:20 (UTC)." >> pr_body.txt
+          echo "" >> pr_body.txt
+          echo "Thank you to everyone contributing to translate ethereum.org ❤️" >> pr_body.txt
+
+      - name: Create Pull Request
+        run: |
+          gh auth login --with-token ${{ secrets.GITHUB_TOKEN }}
+          gh pr create --base dev --head "automated-update-${{ env.TIMESTAMP }}" --title "Update translation leaderboard data from Crowdin - ${{ env.READABLE_DATE }}" --body-file pr_body.txt

src/components/TranslationLeaderboard.tsx

@@ -12,15 +12,11 @@ import {
   useRadioGroup,
 } from "@chakra-ui/react"
 
+import type { CostLeaderboardData } from "@/lib/types"
+
 import Emoji from "./Emoji"
 import Text from "./OldText"
 
-export type TranslationLeaderboardProps = {
-  monthData: any
-  quarterData: any
-  allTimeData: any
-}
-
 const Button = (props) => {
   return (
     <ChakraButton
@@ -82,34 +78,13 @@ const RadioCard = (props) => {
   )
 }
 
-const filterLeaderboardUsers = (item) => {
-  const username = item.user.username.toLowerCase()
-  const fullName = item.user.fullName?.toLowerCase() || ""
-
-  const excludedUsernames = new Set([
-    "ethdotorg",
-    "finnish_sandberg",
-    "norwegian_sandberg",
-    "swedish_sandberg",
-  ])
-
-  return (
-    !excludedUsernames.has(username) &&
-    !username.includes("lqs_") &&
-    !username.includes("removed_user") &&
-    !username.includes("aco_") &&
-    !fullName.includes("aco_") &&
-    !username.includes("aco-") &&
-    !fullName.includes("aco-") &&
-    !username.includes("acc_") &&
-    !fullName.includes("acc_")
-  )
-}
+const sortAndFilterData = (data: CostLeaderboardData[]) =>
+  reverse(sortBy(data, ({ totalCosts }) => totalCosts))
 
-const sortAndFilterData = (data) => {
-  return reverse(sortBy(data, ({ user }) => user.totalCosts)).filter(
-    filterLeaderboardUsers
-  )
+type TranslationLeaderboardProps = {
+  allTimeData: CostLeaderboardData[]
+  monthData: CostLeaderboardData[]
+  quarterData: CostLeaderboardData[]
 }
 
 const TranslationLeaderboard = ({
@@ -124,9 +99,9 @@ const TranslationLeaderboard = ({
   )
 
   const leaderboardData = {
-    monthData: sortAndFilterData(monthData.data),
-    quarterData: sortAndFilterData(quarterData.data),
-    allTimeData: sortAndFilterData(allTimeData.data),
+    monthData: sortAndFilterData(monthData),
+    quarterData: sortAndFilterData(quarterData),
+    allTimeData: sortAndFilterData(allTimeData),
   }
 
   const [filterAmount, updateFilterAmount] = useState(10)
@@ -216,11 +191,8 @@ const TranslationLeaderboard = ({
         </Flex>
         {leaderboardData[dateRangeType]
           .slice(0, filterAmount)
-          .map((item, idx) => {
-            const { user, languages } = item
-            const sortedLanguages = reverse(
-              sortBy(languages, ({ language }) => language.totalCosts)
-            )
+          .map((item: CostLeaderboardData, idx: number) => {
+            const { username, avatarUrl, totalCosts, langs } = item
 
             let emoji: string | null = null
             if (idx === 0) {
@@ -270,12 +242,12 @@ const TranslationLeaderboard = ({
                       w={{ base: "30px", sm: 10 }}
                       borderRadius="50%"
                       display={{ base: "none", s: "block" }}
-                      src={user.avatarUrl}
+                      src={avatarUrl}
                     />
                     <Box maxW={{ base: "100px", sm: "none" }}>
-                      {user.username}
+                      {username}
                       <Text m={0} display="block" fontSize="sm" opacity="0.6">
-                        {sortedLanguages[0].language.name}
+                        {langs[0]}
                       </Text>
                     </Box>
                   </Flex>
@@ -287,7 +259,7 @@ const TranslationLeaderboard = ({
                     fontSize="2xl"
                     text={":writing:"}
                   />
-                  {user.totalCosts}
+                  {totalCosts}
                 </Flex>
               </Flex>
             )