Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
feat(chrome-ext): allow feedback on site support (#3853)
Elijah Potterdfe285d8244d
diff --git a/packages/chrome-plugin/src/PopupState.ts b/packages/chrome-plugin/src/PopupState.tsindex d85e3703c..1929a62bc 100644--- a/packages/chrome-plugin/src/PopupState.ts+++ b/packages/chrome-plugin/src/PopupState.ts@@ -10,6 +10,12 @@ export type PopupState =feedback: string;example: string;rule_id: string;+ }+ | {+ page: 'domain-review';+ works: boolean;+ domain: string;+ feedback: string;};export function main(): PopupState {diff --git a/packages/chrome-plugin/src/popup/DomainReview.svelte b/packages/chrome-plugin/src/popup/DomainReview.sveltenew file mode 100644index 000000000..7ef5f302a--- /dev/null+++ b/packages/chrome-plugin/src/popup/DomainReview.svelte@@ -0,0 +1,79 @@+<script lang="ts">+import { Button, Input, Label, Select } from 'components';+import ProtocolClient from '../ProtocolClient';++let {+ domain,+ works,+ feedback,+ onSubmit,+}: { domain: string; works: boolean; feedback: string; onSubmit: () => void } = $props();++let submitting = $state(false);++async function handleSubmit(event: SubmitEvent) {+ event.preventDefault();++ submitting = true;++ const success = await ProtocolClient.postFormData(+ 'https://writewithharper.com/api/domain-reviews',+ {+ domain,+ works: works ? 'yes' : 'no',+ feedback,+ },+ );++ submitting = false;++ if (success) {+ onSubmit();+ }+}+</script>++<div class="p-5">+ <h1 class="text-2xl font-semibold">Domain Review</h1>+ <p class="text-sm">+ Only the data you enter below will be sent to the Harper maintainer.+ </p>+ <form class="mt-4 space-y-6" onsubmit={handleSubmit}>+ <div class="space-y-3">+ <div class="flex items-baseline gap-2">+ <Label class=" ">Which domain would you like to tell us about?</Label>+ </div>+ <Input+ name="domain"+ bind:value={domain}+ placeholder="example.com"+ class="dark:bg-slate-900 dark:border-slate-700 "+ />+ <div class="flex items-baseline gap-2">+ <Label class=" ">Would you say that Harper works well on this domain?</Label>+ </div>+ <Select+ name="works"+ bind:value={works}+ class="dark:bg-slate-900 dark:border-slate-700 "+ >+ <option value={true}>Yes</option>+ <option value={false}>No</option>+ </Select>++ <div class="flex items-baseline gap-2">+ <Label class=" ">Additional Feedback</Label>+ </div>+ <Input+ name="feedback"+ placeholder="Tell us what went wrong."+ bind:value={feedback}+ class="dark:bg-slate-900 dark:border-slate-700 "+ />++ <div class="flex items-center justify-between pt-2">+ <Button type="submit" disabled={submitting}>Submit</Button>+ </div>+ </div>+ </form>+</div>diff --git a/packages/chrome-plugin/src/popup/Main.svelte b/packages/chrome-plugin/src/popup/Main.svelteindex 48ef26ef9..6dfae1cdb 100644--- a/packages/chrome-plugin/src/popup/Main.svelte+++ b/packages/chrome-plugin/src/popup/Main.svelte@@ -1,8 +1,12 @@<script lang="ts">+import { faThumbsDown, faThumbsUp } from '@fortawesome/free-solid-svg-icons';import { Button } from 'components';+import Fa from 'svelte-fa';import generateGreeting from '../generateGreeting';import ProtocolClient from '../ProtocolClient';+let { onReviewDomain }: { onReviewDomain: (works: boolean, domain: string) => void } = $props();+let enabled = $state(true);let domain = $state('');@@ -66,6 +70,10 @@ function openReviewPage() {chrome.tabs.create({ url: REVIEW_URL });}+async function reviewDomain(works: boolean) {+ onReviewDomain(works, (await getCurrentTabDomain()) ?? 'unknown');+}+function isFirefoxExtension(): boolean {try {return new URL(chrome.runtime.getURL('')).protocol === 'moz-extension:';@@ -119,6 +127,7 @@ function daysSince(date: Date): number {</p></section></section>+{#if !isFirefox && installDate != null && daysSince(installDate) > 14 && hasBeenReviewed === false}<section class="bg-primary flex flex-row justify-between p-4">@@ -130,5 +139,20 @@ function daysSince(date: Date): number {Review</Button></section>+ {:else}+ <section class="flex flex-row justify-between p-2 items-center">+ <p class="text-sm font-medium font-sans dark:text-white text-left">+ Does Harper work well on this site?+ </p>++ <div class="flex flex-row *:ml-1">+ <Button size="xs" on:click={() => reviewDomain(true)}>+ <Fa icon={faThumbsUp} />+ </Button>+ <Button size="xs" on:click={() => reviewDomain(false)}>+ <Fa icon={faThumbsDown} />+ </Button>+ </div>+ </section>{/if}</main>diff --git a/packages/chrome-plugin/src/popup/Popup.svelte b/packages/chrome-plugin/src/popup/Popup.svelteindex e057deb7b..83d2b92ed 100644--- a/packages/chrome-plugin/src/popup/Popup.svelte+++ b/packages/chrome-plugin/src/popup/Popup.svelte@@ -6,6 +6,7 @@ import Fa from 'svelte-fa';import logo from '/logo.png';import detectBrowserEngine from '../detectBrowserEngine';import { main, type PopupState } from '../PopupState';+import DomainReview from './DomainReview.svelte';import Main from './Main.svelte';import Onboarding from './Onboarding.svelte';import ReportProblematicLint from './ReportProblematicLint.svelte';@@ -82,9 +83,11 @@ function openUpdateHelpPage() {{#if popupState.page == "onboarding"}<Onboarding onConfirm={() => { popupState = main();}} />{:else if popupState.page == "main"}- <Main />+ <Main onReviewDomain={(works, domain) => { popupState = { page: 'domain-review', works, domain, feedback: "" }} }/>{:else if popupState.page == 'report-error'}<ReportProblematicLint example={popupState.example} rule_id={popupState.rule_id} feedback={popupState.feedback} onSubmit={() => { popupState = main();}} />+ {:else if popupState.page == 'domain-review'}+ <DomainReview works={popupState.works} domain={popupState.domain} feedback={popupState.feedback} onSubmit={() => { popupState = main();}} />{/if}<footer class="flex items-center justify-center gap-6 px-3 py-2 text-sm border-t border-gray-100 rounded-b-lg bg-white/60 dark:border-slate-800 dark:bg-slate-900/70 dark:text-slate-100">diff --git a/packages/web/drizzle/0003_fearless_thanos.sql b/packages/web/drizzle/0003_fearless_thanos.sqlnew file mode 100644index 000000000..9db189b1b--- /dev/null+++ b/packages/web/drizzle/0003_fearless_thanos.sql@@ -0,0 +1,8 @@+CREATE TABLE `domain_review` (+ `id` int AUTO_INCREMENT NOT NULL,+ `works` boolean NOT NULL,+ `feedback` text NOT NULL,+ `domain` text NOT NULL,+ `timestamp` timestamp NOT NULL DEFAULT (now()),+ CONSTRAINT `domain_review_id` PRIMARY KEY(`id`)+);diff --git a/packages/web/drizzle/meta/0003_snapshot.json b/packages/web/drizzle/meta/0003_snapshot.jsonnew file mode 100644index 000000000..0275e0fea--- /dev/null+++ b/packages/web/drizzle/meta/0003_snapshot.json@@ -0,0 +1,164 @@+{+ "version": "5",+ "dialect": "mysql",+ "id": "9358d1e0-0c39-4be8-bf6d-767b7073ac02",+ "prevId": "fbee3b57-d046-43fc-aa34-a2ef07e19993",+ "tables": {+ "domain_review": {+ "name": "domain_review",+ "columns": {+ "id": {+ "name": "id",+ "type": "int",+ "primaryKey": false,+ "notNull": true,+ "autoincrement": true+ },+ "works": {+ "name": "works",+ "type": "boolean",+ "primaryKey": false,+ "notNull": true,+ "autoincrement": false+ },+ "feedback": {+ "name": "feedback",+ "type": "text",+ "primaryKey": false,+ "notNull": true,+ "autoincrement": false+ },+ "domain": {+ "name": "domain",+ "type": "text",+ "primaryKey": false,+ "notNull": true,+ "autoincrement": false+ },+ "timestamp": {+ "name": "timestamp",+ "type": "timestamp",+ "primaryKey": false,+ "notNull": true,+ "autoincrement": false,+ "default": "(now())"+ }+ },+ "indexes": {},+ "foreignKeys": {},+ "compositePrimaryKeys": {+ "domain_review_id": {+ "name": "domain_review_id",+ "columns": ["id"]+ }+ },+ "uniqueConstraints": {},+ "checkConstraint": {}+ },+ "problematic_lint": {+ "name": "problematic_lint",+ "columns": {+ "id": {+ "name": "id",+ "type": "int",+ "primaryKey": false,+ "notNull": true,+ "autoincrement": true+ },+ "is_false_positive": {+ "name": "is_false_positive",+ "type": "boolean",+ "primaryKey": false,+ "notNull": true,+ "autoincrement": false+ },+ "example": {+ "name": "example",+ "type": "text",+ "primaryKey": false,+ "notNull": true,+ "autoincrement": false+ },+ "feedback": {+ "name": "feedback",+ "type": "text",+ "primaryKey": false,+ "notNull": true,+ "autoincrement": false+ },+ "rule_id": {+ "name": "rule_id",+ "type": "text",+ "primaryKey": false,+ "notNull": false,+ "autoincrement": false+ },+ "timestamp": {+ "name": "timestamp",+ "type": "timestamp",+ "primaryKey": false,+ "notNull": true,+ "autoincrement": false,+ "default": "(now())"+ }+ },+ "indexes": {},+ "foreignKeys": {},+ "compositePrimaryKeys": {+ "problematic_lint_id": {+ "name": "problematic_lint_id",+ "columns": ["id"]+ }+ },+ "uniqueConstraints": {},+ "checkConstraint": {}+ },+ "uninstall_feedback": {+ "name": "uninstall_feedback",+ "columns": {+ "id": {+ "name": "id",+ "type": "int",+ "primaryKey": false,+ "notNull": true,+ "autoincrement": true+ },+ "feedback": {+ "name": "feedback",+ "type": "text",+ "primaryKey": false,+ "notNull": true,+ "autoincrement": false+ },+ "timestamp": {+ "name": "timestamp",+ "type": "timestamp",+ "primaryKey": false,+ "notNull": true,+ "autoincrement": false,+ "default": "(now())"+ }+ },+ "indexes": {},+ "foreignKeys": {},+ "compositePrimaryKeys": {+ "uninstall_feedback_id": {+ "name": "uninstall_feedback_id",+ "columns": ["id"]+ }+ },+ "uniqueConstraints": {},+ "checkConstraint": {}+ }+ },+ "views": {},+ "_meta": {+ "schemas": {},+ "tables": {},+ "columns": {}+ },+ "internal": {+ "tables": {},+ "indexes": {}+ }+}diff --git a/packages/web/drizzle/meta/_journal.json b/packages/web/drizzle/meta/_journal.jsonindex b74c8b1dc..3f727d97c 100644--- a/packages/web/drizzle/meta/_journal.json+++ b/packages/web/drizzle/meta/_journal.json@@ -22,6 +22,13 @@"when": 1760546819156,"tag": "0002_blushing_chameleon","breakpoints": true+ },+ {+ "idx": 3,+ "version": "5",+ "when": 1784571049353,+ "tag": "0003_fearless_thanos",+ "breakpoints": true}]}diff --git a/packages/web/src/lib/db/models/DomainReviews.ts b/packages/web/src/lib/db/models/DomainReviews.tsnew file mode 100644index 000000000..7ef44406e--- /dev/null+++ b/packages/web/src/lib/db/models/DomainReviews.ts@@ -0,0 +1,20 @@+import { createInsertSchema, createSelectSchema } from 'drizzle-zod';+import { db } from '..';+import { domainReviewTable } from '../schema';++export type DomainReviewRow = typeof domainReviewTable.$inferSelect;+const DomainReviewRowParser = createSelectSchema(domainReviewTable);++export type DomainReviewSubmission = typeof domainReviewTable.$inferInsert;+const DomainReviewSubmissionParser = createInsertSchema(domainReviewTable);++export default class DomainReviews {+ public static async validateAndCreate(rec: any) {+ const parsed = DomainReviewSubmissionParser.parse(rec);+ await this.create(parsed);+ }++ public static async create(rec: DomainReviewSubmission) {+ await db.insert(domainReviewTable).values(rec);+ }+}diff --git a/packages/web/src/lib/db/schema.ts b/packages/web/src/lib/db/schema.tsindex 8c13978bd..ba71e8804 100644--- a/packages/web/src/lib/db/schema.ts+++ b/packages/web/src/lib/db/schema.ts@@ -15,3 +15,11 @@ export const problematicLintTable = mysqlTable('problematic_lint', {rule_id: text(),timestamp: timestamp().notNull().defaultNow(),});++export const domainReviewTable = mysqlTable('domain_review', {+ id: int().autoincrement().primaryKey(),+ works: boolean().notNull(),+ feedback: text().notNull(),+ domain: text().notNull(),+ timestamp: timestamp().notNull().defaultNow(),+});diff --git a/packages/web/src/routes/api/domain-reviews/+server.ts b/packages/web/src/routes/api/domain-reviews/+server.tsnew file mode 100644index 000000000..57313cd60--- /dev/null+++ b/packages/web/src/routes/api/domain-reviews/+server.ts@@ -0,0 +1,30 @@+import { error, type RequestEvent, redirect } from '@sveltejs/kit';+import DomainReviews from '$lib/db/models/DomainReviews';++export const POST = async ({ request }: RequestEvent) => {+ const data = await request.formData();++ const worksText = data.get('works');+ let works = null;++ switch (worksText) {+ case 'yes':+ works = true;+ break;+ case 'no':+ works = false;+ break;+ }++ if (works === null) {+ error(400, '`works` must be either yes or no.');+ }++ await DomainReviews.validateAndCreate({+ domain: data.get('domain'),+ works,+ feedback: data.get('feedback'),+ });++ throw redirect(303, '/');+};diff --git a/packages/web/src/routes/domain-review/+page.svelte b/packages/web/src/routes/domain-review/+page.sveltenew file mode 100644index 000000000..9b0ec906f--- /dev/null+++ b/packages/web/src/routes/domain-review/+page.svelte@@ -0,0 +1,41 @@+<script lang="ts">+import { Button, Card, Input, Isolate, Label } from 'components';+</script>++<Isolate>+ <div class="flex h-screen flex-row items-center justify-center">+ <Card>+ <h1 class="text-3xl font-semibold">Domain Review</h1>+ <p class="text-sm text-gray-600">+ If Harper is not working correctly on a website, we'd love to know about it.+ </p>+ <form method="POST" class="mt-4 space-y-6" action="/api/domain-reviews">+ <div class="space-y-3">+ <div class="flex items-baseline gap-2">+ <Label>Which domain is causing problems?</Label>+ </div>+ <Input name="domain" placeholder="example.com" required />+ <div class="flex items-baseline gap-2">+ <Label>Does Harper work as expected on this domain?</Label>+ </div>+ <select name="works" required>+ <option value="yes">Yes</option>+ <option value="no">No</option>+ </select>+ <div class="flex items-baseline gap-2">+ <Label>Additional Feedback</Label>+ </div>+ <Input+ name="feedback"+ placeholder="Tell us what went wrong."+ required+ />++ <div class="flex items-center justify-between pt-2">+ <Button type="submit">Submit</Button>+ </div>+ </div>+ </form>+ </Card>+ </div>+</Isolate>