ncc

austenstone · Apr 26, 2024 · 336de7d · 336de7d
1 parent 7cb9b2a
commit 336de7d
Show file tree

Hide file tree

Showing 9 changed files with 601 additions and 3,822 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,7 +1,6 @@
+MIT License
 
-The MIT License (MIT)
-
-Copyright (c) 2018 GitHub, Inc. and contributors
+Copyright GitHub
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -10,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.LICENSE.txt b/dist/index.js.LICENSE.txt
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/job-summary.js b/dist/job-summary.js
@@ -0,0 +1,260 @@
+import { summary } from "@actions/core";
+const groupBreakdown = (key, data, sort) => {
+    const breakdown = data.reduce((acc, item) => {
+        const _key = key instanceof Function ? key(item) : item[key];
+        item.breakdown.forEach((breakdownItem) => {
+            if (acc[breakdownItem[_key]]) {
+                acc[breakdownItem[_key]].suggestions_count += breakdownItem.suggestions_count;
+                acc[breakdownItem[_key]].acceptances_count += breakdownItem.acceptances_count;
+                acc[breakdownItem[_key]].lines_suggested += breakdownItem.lines_suggested;
+                acc[breakdownItem[_key]].lines_accepted += breakdownItem.lines_accepted;
+                acc[breakdownItem[_key]].active_users += breakdownItem.active_users;
+            }
+            else {
+                acc[breakdownItem[_key]] = {
+                    language: breakdownItem.language.replace(/-/g, '&#8209;'),
+                    editor: breakdownItem.editor,
+                    suggestions_count: breakdownItem.suggestions_count,
+                    acceptances_count: breakdownItem.acceptances_count,
+                    lines_suggested: breakdownItem.lines_suggested,
+                    lines_accepted: breakdownItem.lines_accepted,
+                    active_users: breakdownItem.active_users,
+                };
+            }
+        });
+        return acc;
+    }, {});
+    return Object.fromEntries(Object.entries(breakdown).sort(sort ? sort : (a, b) => b[1].acceptances_count - a[1].acceptances_count));
+};
+export const createJobSummaryUsage = (data) => {
+    const languageUsage = groupBreakdown('language', data);
+    const editorUsage = groupBreakdown('editor', data);
+    const dayOfWeekUsage = groupBreakdown((item) => dateFormat(item.day, { weekday: 'long' }), data, (a, b) => {
+        const days = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'];
+        return days.indexOf(a[0]) - days.indexOf(b[0]);
+    });
+    const totalAcceptanceCount = data.reduce((acc, item) => acc + item.total_acceptances_count, 0);
+    const totalSuggestionsCount = data.reduce((acc, item) => acc + item?.total_suggestions_count, 0);
+    const totalAcceptanceRate = (totalAcceptanceCount / totalSuggestionsCount * 100).toFixed(2);
+    const totalLinesOfCodeAccepted = data.reduce((acc, item) => acc + item?.total_lines_accepted, 0);
+    const mostActiveDay = data.reduce((acc, item) => (acc.total_active_users > item.total_active_users) ? acc : item);
+    const highestAcceptanceRateDay = data.reduce((acc, item) => ((acc.total_acceptances_count / acc.total_suggestions_count) > (item.total_acceptances_count / item.total_suggestions_count)) ? acc : item);
+    return summary
+        .addHeading(`Copilot Usage<br>${dateFormat(data[0].day)} - ${dateFormat(data[data.length - 1].day)}`)
+        .addHeading(`Suggestions: ${totalSuggestionsCount.toLocaleString()}`, 3)
+        .addHeading(`Acceptances: ${totalAcceptanceCount.toLocaleString()}`, 3)
+        .addHeading(`Acceptance Rate: ${totalAcceptanceRate}%`, 3)
+        .addHeading(`Lines of Code Accepted: ${totalLinesOfCodeAccepted.toLocaleString()}`, 3)
+        .addRaw(getXyChartAcceptanceRate(data))
+        .addRaw(getXyChartDailyActiveUsers(data))
+        .addHeading('Language Usage')
+        .addRaw(getPieChartLanguageUsage(languageUsage))
+        .addTable(getTableLanguageData(languageUsage))
+        .addHeading('Editor Usage')
+        .addRaw(getPieChartEditorUsage(editorUsage))
+        .addTable(getTableEditorData(editorUsage))
+        .addHeading('Daily Usage')
+        .addHeading(`The most active day was ${dateFormat(mostActiveDay.day)} with ${mostActiveDay.total_active_users} active users.`, 3)
+        .addHeading(`The day with the highest acceptance rate was ${dateFormat(highestAcceptanceRateDay.day)} with an acceptance rate of ${(highestAcceptanceRateDay.total_acceptances_count / highestAcceptanceRateDay.total_suggestions_count * 100).toFixed(2)}%.`, 3)
+        .addRaw(getPieChartWeekdayUsage(dayOfWeekUsage))
+        .addTable(getTableData(data));
+};
+export const createJobSummarySeatInfo = (data) => {
+    return summary
+        .addHeading('Seat Info')
+        .addHeading(`Seat Management Setting: ${data.seat_management_setting}`, 3)
+        .addHeading(`Public Code Suggestions Enabled: ${data.public_code_suggestions}`, 3)
+        .addHeading(`IDE Chat Enabled: ${data.ide_chat}`, 3)
+        .addHeading(`Platform IDE Enabled: ${data.platform_ide}`, 3)
+        .addHeading(`Platform Chat Enabled: ${data.platform_chat}`, 3)
+        .addHeading(`CLI Enabled: ${data.cli}`, 3)
+        .addHeading(`Total Seats: ${data.seat_breakdown.total}`, 3)
+        .addHeading(`Added this cycle: ${data.seat_breakdown.added_this_cycle}`, 3)
+        .addHeading(`Pending invites: ${data.seat_breakdown.pending_invitation}`, 3)
+        .addHeading(`Pending cancellations: ${data.seat_breakdown.pending_cancellation}`, 3)
+        .addHeading(`Active this cycle: ${data.seat_breakdown.active_this_cycle}`, 3)
+        .addHeading(`Inactive this cycle: ${data.seat_breakdown.inactive_this_cycle}`, 3);
+};
+export const createJobSummarySeatAssignments = (data) => {
+    if (!data)
+        data = [];
+    return summary
+        .addHeading('Seat Assignments')
+        .addTable([
+        [
+            { data: 'Avatar', header: true },
+            { data: 'Login', header: true },
+            { data: 'Team', header: true },
+            { data: 'Last Activity', header: true },
+            { data: 'Last Editor Used', header: true },
+            { data: 'Created At', header: true },
+            { data: 'Updated At', header: true },
+            { data: 'Pending Cancellation Date', header: true }
+        ],
+        ...data.map(seat => [
+            seat.assignee?.avatar_url,
+            seat.assignee?.login,
+            String(seat.assigning_team?.name),
+            seat.last_activity_at ? dateFormat(seat.last_activity_at) : 'No Activity',
+            seat.last_activity_editor,
+            dateFormat(seat.created_at),
+            dateFormat(seat.updated_at),
+            dateFormat(seat.pending_cancellation_date)
+        ])
+    ]);
+};
+export const createJobSummaryFooter = async (organization) => {
+    summary
+        .addLink(`Manage Access for ${organization}`, `https://github.com/organizations/${organization}/settings/copilot/seat_management`)
+        .write();
+};
+const getTableData = (data) => {
+    return [
+        [
+            { data: 'Day', header: true },
+            { data: 'Suggestions', header: true },
+            { data: 'Acceptances', header: true },
+            { data: 'Acceptance Rate', header: true },
+            { data: 'Lines Suggested', header: true },
+            { data: 'Lines Accepted', header: true },
+            { data: 'Active Users', header: true },
+            { data: 'Chat Acceptances', header: true },
+            { data: 'Chat Turns', header: true },
+            { data: 'Active Chat Users', header: true }
+        ],
+        ...data.map(item => [
+            dateFormat(item.day),
+            item.total_suggestions_count?.toLocaleString(),
+            item.total_acceptances_count?.toLocaleString(),
+            `${(item.total_acceptances_count / item.total_suggestions_count * 100).toFixed(2)}%`,
+            item.total_lines_suggested?.toLocaleString(),
+            item.total_lines_accepted?.toLocaleString(),
+            item.total_active_users?.toLocaleString(),
+            item.total_chat_acceptances?.toLocaleString(),
+            item.total_chat_turns?.toLocaleString(),
+            item.total_active_chat_users?.toLocaleString()
+        ])
+    ];
+};
+const getPieChartWeekdayUsage = (data) => {
+    return `\n\`\`\`mermaid
+pie showData
+title Suggestions by Day of the Week
+${Object.entries(data)
+        .map(([language, obj]) => `"${language}" : ${obj.suggestions_count}`)
+        .join('\n')}
+\`\`\`\n`;
+};
+const getTableLanguageData = (languageUsage) => {
+    return [
+        [
+            { data: 'Language', header: true },
+            { data: 'Suggestions', header: true },
+            { data: 'Acceptances', header: true },
+            { data: 'Acceptance Rate', header: true },
+            { data: 'Lines Suggested', header: true },
+            { data: 'Lines Accepted', header: true },
+            { data: 'Active Users', header: true }
+        ],
+        ...Object.entries(languageUsage).map(([language, data]) => [
+            language,
+            data.suggestions_count.toLocaleString(),
+            data.acceptances_count.toLocaleString(),
+            `${((data.acceptances_count / data.suggestions_count) * 100).toFixed(2)}%`,
+            data.lines_suggested.toLocaleString(),
+            data.lines_accepted.toLocaleString(),
+            data.active_users.toLocaleString()
+        ])
+    ];
+};
+const getTableEditorData = (editorUsage) => {
+    return [
+        [
+            { data: 'Editor', header: true },
+            { data: 'Suggestions', header: true },
+            { data: 'Acceptances', header: true },
+            { data: 'Acceptance Rate', header: true },
+            { data: 'Lines Suggested', header: true },
+            { data: 'Lines Accepted', header: true },
+            { data: 'Active Users', header: true }
+        ],
+        ...Object.entries(editorUsage).map(([editor, data]) => [
+            editor,
+            data.suggestions_count.toLocaleString(),
+            data.acceptances_count.toLocaleString(),
+            `${((data.acceptances_count / data.suggestions_count) * 100).toFixed(2)}%`,
+            data.lines_suggested.toLocaleString(),
+            data.lines_accepted.toLocaleString(),
+            data.active_users.toLocaleString()
+        ])
+    ];
+};
+const getPieChartLanguageUsage = (languageUsage) => {
+    return `\n\`\`\`mermaid
+pie showData
+title Language Usage
+    ${Object.entries(languageUsage)
+        .sort((a, b) => b[1].suggestions_count - a[1].suggestions_count)
+        .slice(0, 20)
+        .map(([language, obj]) => `"${language}" : ${obj.suggestions_count}`)
+        .join('\n')}
+\`\`\`\n`;
+};
+const getPieChartEditorUsage = (editorUsage) => {
+    return `\n\`\`\`mermaid
+pie showData
+title Editor Usage
+    ${Object.entries(editorUsage)
+        .sort((a, b) => b[1].suggestions_count - a[1].suggestions_count)
+        .map(([editor, obj]) => `"${editor}" : ${obj.suggestions_count}`)
+        .join('\n')}
+\`\`\`\n`;
+};
+const getXyChartAcceptanceRate = (data) => {
+    const maxAcceptances = Math.max(...data.map((item) => item.total_acceptances_count)) + 10;
+    return `\n\`\`\`mermaid
+---
+config:
+    xyChart:
+        width: ${data.length * 45}
+        height: 500
+        xAxis:
+            labelPadding: 20
+    themeVariables:
+        xyChart:
+            backgroundColor: "transparent"
+---
+xychart-beta
+  title "Accepts & Acceptance Rate"
+  x-axis [${data.map((item) => `"${dateFormat(item.day, { month: '2-digit', day: '2-digit' })}"`).join(', ')}]
+  y-axis "Acceptances" 0 --> ${maxAcceptances}
+  bar [${data.map((item) => item.total_acceptances_count).join(', ')}]
+  line [${data.map((item) => (item.total_acceptances_count / item.total_suggestions_count) * maxAcceptances).join(', ')}]
+\`\`\`\n`;
+};
+const getXyChartDailyActiveUsers = (data) => {
+    const maxActiveUsers = Math.max(...data.map((item) => item.total_active_users)) + 10;
+    return `\n\`\`\`mermaid
+---
+config:
+    xyChart:
+        width: ${data.length * 45}
+        height: 500
+        xAxis:
+            labelPadding: 20
+    themeVariables:
+        xyChart:
+            backgroundColor: "transparent"
+---
+xychart-beta
+  title "Daily Active Users"
+  x-axis [${data.map((item) => `"${dateFormat(item.day, { month: '2-digit', day: '2-digit' })}"`).join(', ')}]
+  y-axis "Active Users" 0 --> ${maxActiveUsers}
+  line [${data.map((item) => item.total_active_users).join(', ')}]
+\`\`\`\n`;
+};
+const dateFormat = (date, format = { month: 'numeric', day: 'numeric', year: 'numeric' }) => {
+    if (!date)
+        return 'undefined';
+    return new Date(date).toLocaleDateString('en-US', format);
+};