wanhose/cookie-dialog-monster
wanhose/cookie-dialog-monster
2
5
Fork 0
Code Issues 304 Pull Requests Releases 18 Wiki Activity

feat(api): improve report issue template

Browse Source
This commit is contained in:
wanhose 2024-05-06 20:41:12 +02:00
parent 335a185075
commit 1790407353
4 changed files with 46 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
packages/api/package.json
View File

@ -12,12 +12,14 @@
"@fastify/rate-limit": "^9.1.0",
"fastify": "^4.26.2",
"node-fetch": "^2.7.0",
"octokit": "^3.2.1"
"octokit": "^3.2.1",
"ua-parser-js": "^1.0.37"
},
"devDependencies": {
"@tsconfig/node20": "^20.1.4",
"@types/node": "^20.12.8",
"@types/node-fetch": "2.6.11",
"@types/ua-parser-js": "^0.7.39",
"@typescript-eslint/eslint-plugin": "^7.8.0",
"@typescript-eslint/parser": "^7.8.0",
"eslint": "^8.57.0",

16
packages/api/src/routes/v2/report.ts
View File

@ -1,6 +1,7 @@
import { FastifyInstance, RouteShorthandOptions } from 'fastify';
import environment from 'services/environment';
import { octokit } from 'services/octokit';
import { UAParser } from 'ua-parser-js';
type PostReportBody = {
reason?: string;
@ -40,6 +41,7 @@ export default (server: FastifyInstance, options: RouteShorthandOptions, done: (
owner: environment.github.owner,
repo: environment.github.repo,
});
const ua = new UAParser(request.body.userAgent ?? '').getResult();
const url = new URL(request.body.url).hostname
.split('.')
.slice(-3)
@ -54,10 +56,16 @@ export default (server: FastifyInstance, options: RouteShorthandOptions, done: (
assignees: [environment.github.owner],
body: [
'## Specifications',
`- <b>Reason:</b> ${request.body.reason ?? '-'}`,
`- <b>URL:</b> ${request.body.url}`,
`- <b>User-Agent:</b> ${request.body.userAgent ?? '-'}`,
`- <b>Version:</b> ${request.body.version}`,
'#### Browser',
`${ua.browser.name ? `${ua.browser.name} ${ua.browser.version || ''}` : '-'}`,
'#### Device',
`${ua.device.type && ua.device.vendor ? `${ua.device.vendor} (${ua.device.type})` : '-'}`,
'#### Reason',
request.body.reason ?? '-',
'#### URL',
request.body.url,
'#### Version',
request.body.version,
].join('\n'),
labels: ['bug'],
owner: environment.github.owner,

20
packages/api/src/routes/v3/report.ts
View File

@ -1,6 +1,7 @@
import { FastifyInstance, RouteShorthandOptions } from 'fastify';
import environment from 'services/environment';
import { octokit } from 'services/octokit';
import { UAParser } from 'ua-parser-js';
interface PostReportBody {
readonly reason?: string;
@ -29,7 +30,7 @@ export default (server: FastifyInstance, _options: RouteShorthandOptions, done:
type: 'string',
},
},
required: ['url', 'version'],
required: ['reason', 'url', 'version'],
type: 'object',
},
},
@ -39,6 +40,7 @@ export default (server: FastifyInstance, _options: RouteShorthandOptions, done:
owner: environment.github.owner,
repo: environment.github.repo,
});
const ua = new UAParser(request.body.userAgent ?? '').getResult();
const url = new URL(request.body.url).hostname
.split('.')
.slice(-3)
@ -55,10 +57,18 @@ export default (server: FastifyInstance, _options: RouteShorthandOptions, done:
assignees: [environment.github.owner],
body: [
'## Specifications',
`- <b>Reason:</b> ${request.body.reason ?? '-'}`,
`- <b>URL:</b> ${request.body.url}`,
`- <b>User-Agent:</b> ${request.body.userAgent ?? '-'}`,
`- <b>Version:</b> ${request.body.version}`,
...(ua.browser.name && ua.browser.version
? ['#### Browser', `${ua.browser.name} (${ua.browser.version})`]
: []),
...(ua.device.type && ua.device.vendor
? ['#### Device', `${ua.device.vendor} (${ua.device.type})`]
: []),
'#### Reason',
request.body.reason ?? '-',
'#### URL',
request.body.url,
'#### Version',
request.body.version,
].join('\n'),
labels: ['bug'],
owner: environment.github.owner,

16
yarn.lock
View File

@ -929,6 +929,13 @@ __metadata:
languageName: node
linkType: hard
"@types/ua-parser-js@npm:^0.7.39":
version: 0.7.39
resolution: "@types/ua-parser-js@npm:0.7.39"
checksum: 10c0/fea522f42dfc2854d9c93144a13c3db3bbe1c791458451db06d46bec7e1dbbe945d1542e02bb38378e39a04bdb7810b43e2ead26f9e6c250832e187312522708
languageName: node
linkType: hard
"@typescript-eslint/eslint-plugin@npm:^7.8.0":
version: 7.8.0
resolution: "@typescript-eslint/eslint-plugin@npm:7.8.0"
@ -1307,6 +1314,7 @@ __metadata:
"@tsconfig/node20": "npm:^20.1.4"
"@types/node": "npm:^20.12.8"
"@types/node-fetch": "npm:2.6.11"
"@types/ua-parser-js": "npm:^0.7.39"
"@typescript-eslint/eslint-plugin": "npm:^7.8.0"
"@typescript-eslint/parser": "npm:^7.8.0"
eslint: "npm:^8.57.0"
@ -1320,6 +1328,7 @@ __metadata:
ts-node: "npm:^10.9.2"
tsconfig-paths: "npm:^4.2.0"
typescript: "npm:^5.4.5"
ua-parser-js: "npm:^1.0.37"
languageName: unknown
linkType: soft
@ -5396,6 +5405,13 @@ __metadata:
languageName: node
linkType: hard
"ua-parser-js@npm:^1.0.37":
version: 1.0.37
resolution: "ua-parser-js@npm:1.0.37"
checksum: 10c0/dac8cf82a55b2e097bd2286954e01454c4cfcf23c9d9b56961ce94bda3cec5a38ca536e6e84c20a4000a9d4b4a4abcbd98ec634ccebe21be36595ea3069126e4
languageName: node
linkType: hard
"undefsafe@npm:^2.0.5":
version: 2.0.5
resolution: "undefsafe@npm:2.0.5"