Browse Source

Improved error messaging based on feature missing from browser

pull/362/head
Dan Ditomaso 1 year ago
parent
commit
225d6055d4
  1. 138
      src/components/Dialog/NewDeviceDialog.tsx
  2. 7
      src/components/UI/Typography/Link.tsx
  3. 49
      src/core/hooks/useBrowserFeatureDetection.ts

138
src/components/Dialog/NewDeviceDialog.tsx

@ -1,4 +1,7 @@
import { useBrowserFeatureDetection } from "@app/core/hooks/useBrowserFeatureDetection"; import {
type BrowserFeature,
useBrowserFeatureDetection,
} from "@app/core/hooks/useBrowserFeatureDetection";
import { BLE } from "@components/PageComponents/Connect/BLE.tsx"; import { BLE } from "@components/PageComponents/Connect/BLE.tsx";
import { HTTP } from "@components/PageComponents/Connect/HTTP.tsx"; import { HTTP } from "@components/PageComponents/Connect/HTTP.tsx";
import { Serial } from "@components/PageComponents/Connect/Serial.tsx"; import { Serial } from "@components/PageComponents/Connect/Serial.tsx";
@ -8,14 +11,16 @@ import {
DialogHeader, DialogHeader,
DialogTitle, DialogTitle,
} from "@components/UI/Dialog.tsx"; } from "@components/UI/Dialog.tsx";
import { AlertCircle, } from "lucide-react";
import { import {
Tabs, Tabs,
TabsContent, TabsContent,
TabsList, TabsList,
TabsTrigger, TabsTrigger,
} from "@components/UI/Tabs.tsx"; } from "@components/UI/Tabs.tsx";
import { Link } from "@components/UI/Typography/Link.tsx";
import { Subtle } from "@components/UI/Typography/Subtle.tsx"; import { Subtle } from "@components/UI/Typography/Subtle.tsx";
import { Link } from "../UI/Typography/Link";
import { Fragment } from "react/jsx-runtime";
export interface TabElementProps { export interface TabElementProps {
closeDialog: () => void; closeDialog: () => void;
@ -29,19 +34,88 @@ export interface TabManifest {
disabledLink?: string; disabledLink?: string;
} }
export interface NewDeviceProps { export interface NewDeviceProps {
open: boolean; open: boolean;
onOpenChange: (open: boolean) => void; onOpenChange: (open: boolean) => void;
} }
interface FeatureErrorProps {
missingFeatures: BrowserFeature[];
}
const links: { [key: string]: string } = {
"Web Bluetooth":
"https://developer.mozilla.org/en-US/docs/Web/API/Web_Bluetooth_API#browser_compatibility",
"Web Serial":
"https://developer.mozilla.org/en-US/docs/Web/API/Web_Serial_API#browser_compatibility",
"Secure Context":
"https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts",
};
const listFormatter = new Intl.ListFormat('en', {
style: 'long',
type: 'conjunction'
});
const ErrorMessage = ({ missingFeatures }: FeatureErrorProps) => {
if (missingFeatures.length === 0) return null;
const browserFeatures = missingFeatures.filter(feature => feature !== "Secure Context");
const needsSecureContext = missingFeatures.includes("Secure Context");
const formatFeatureList = (features: string[]) => {
const parts = listFormatter.formatToParts(features);
return parts.map((part) => {
if (part.type === 'element') {
return (
<Link
key={part.value}
href={links[part.value]}
>
{part.value}
</Link>
);
}
return <Fragment key={part.value}>{part.value}</Fragment>;
});
};
return (
<Subtle className="flex flex-col items-start gap-2 text-black bg-red-200/80 p-4 rounded-md">
<div className="flex items-center gap-2 w-full">
<AlertCircle size={40} className="mr-2 flex-shrink-0" />
<div className="flex flex-col gap-3">
<p className="text-sm">
{browserFeatures.length > 0 && (
<>
This application requires {formatFeatureList(browserFeatures)}.
Please use a Chromium-based browser like Chrome or Edge.
</>
)}
{needsSecureContext && (
<>
{browserFeatures.length > 0 && " Additionally, it"}
{browserFeatures.length === 0 && "This application"} requires a{" "}
<Link
href={links["Secure Context"]}
>
secure context
</Link>
. Please connect using HTTPS or localhost.
</>
)}
</p>
</div>
</div>
</Subtle>
);
};
export const NewDeviceDialog = ({ export const NewDeviceDialog = ({
open, open,
onOpenChange, onOpenChange,
}: NewDeviceProps): JSX.Element => { }: NewDeviceProps): JSX.Element => {
const { hasRequiredFeatures, isSecureContext, missingFeatures } = useBrowserFeatureDetection(); const { unsupported } = useBrowserFeatureDetection();
console.log(missingFeatures);
const tabs: TabManifest[] = [ const tabs: TabManifest[] = [
{ {
@ -53,23 +127,21 @@ export const NewDeviceDialog = ({
{ {
label: "Bluetooth", label: "Bluetooth",
element: BLE, element: BLE,
disabled: missingFeatures.includes("Web Bluetooth"), disabled:
disabledMessage: unsupported.includes("Web Bluetooth") ||
"Web Bluetooth is currently only supported by Chromium-based browsers", unsupported.includes("Secure Context"),
disabledLink: disabledMessage: "",
"https://developer.mozilla.org/en-US/docs/Web/API/Web_Bluetooth_API#browser_compatibility"
}, },
{ {
label: "Serial", label: "Serial",
element: Serial, element: Serial,
disabled: missingFeatures.includes("Web Serial"), disabled:
disabledMessage: unsupported.includes("Web Serial") ||
"Web Serial is currently only supported by Chromium based browsers", unsupported.includes("Secure Context"),
disabledLink: "https://developer.mozilla.org/en-US/docs/Web/API/Web_Serial_API#browser_compatibility", disabledMessage: "",
}, },
]; ];
return ( return (
<Dialog open={open} onOpenChange={onOpenChange}> <Dialog open={open} onOpenChange={onOpenChange}>
<DialogContent> <DialogContent>
@ -99,40 +171,8 @@ export const NewDeviceDialog = ({
)} )}
</TabsContent> </TabsContent>
))} ))}
<ErrorMessage missingFeatures={unsupported} />
</Tabs> </Tabs>
{!isSecureContext && (
<>
<Subtle>
Web Bluetooth and Web Serial require using a HTTPS connection or to localhost.
</Subtle>
<Subtle>
Read more:&nbsp;
<Link href="https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts">
Secure Contexts
</Link>
</Subtle>
</>
)}
{!hasRequiredFeatures && (
<>
<Subtle>
Web Bluetooth and Web Serial are currently only supported by
Chromium-based browsers.
</Subtle>
<Subtle>
Read more:&nbsp;
<Link href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Bluetooth_API#browser_compatibility">
Web Bluetooth
</Link>
&nbsp;
<Link href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Serial_API#browser_compatibility">
Web Serial
</Link>
</Subtle>
</>
)}
</DialogContent> </DialogContent>
</Dialog> </Dialog>
); );

7
src/components/UI/Typography/Link.tsx

@ -1,14 +1,17 @@
import { cn } from "@app/core/utils/cn";
export interface LinkProps { export interface LinkProps {
href: string; href: string;
children: React.ReactNode; children: React.ReactNode;
className?: string;
} }
export const Link = ({ href, children }: LinkProps): JSX.Element => ( export const Link = ({ href, children, className }: LinkProps): JSX.Element => (
<a <a
href={href} href={href}
target={"_blank"} target={"_blank"}
rel="noopener noreferrer" rel="noopener noreferrer"
className="font-medium text-slate-900 underline underline-offset-4 dark:text-slate-50" className={cn("font-medium text-slate-900 underline underline-offset-4 dark:text-slate-50", className)}
> >
{children} {children}
</a> </a>

49
src/core/hooks/useBrowserFeatureDetection.ts

@ -1,32 +1,29 @@
type Feature = 'Web Bluetooth' | 'Web Serial'; import { useMemo } from 'react';
type FeatureKey = 'bluetooth' | 'serial';
interface BrowserFeatureDetection { export type BrowserFeature = 'Web Bluetooth' | 'Web Serial' | 'Secure Context';
hasRequiredFeatures: boolean;
missingFeatures: Feature[];
isSecureContext: boolean;
}
const featureLabels: Record<FeatureKey, Feature> = { interface BrowserSupport {
bluetooth: 'Web Bluetooth', supported: BrowserFeature[];
serial: 'Web Serial' unsupported: BrowserFeature[];
}; }
export function useBrowserFeatureDetection(): BrowserFeatureDetection { export function useBrowserFeatureDetection(): BrowserSupport {
const { bluetooth, serial } = navigator; const support = useMemo(() => {
const isSecureContext = window.location.protocol === 'https:' || const features: [BrowserFeature, boolean][] = [
window.location.hostname === 'localhost'; ['Web Bluetooth', !!navigator.bluetooth],
['Web Serial', !!navigator.serial],
['Secure Context', window.location.protocol === 'https:' || window.location.hostname === 'localhost']
];
const features = { return features.reduce<BrowserSupport>(
bluetooth, (acc, [feature, isSupported]) => {
serial const list = isSupported ? acc.supported : acc.unsupported;
}; list.push(feature);
return acc;
},
{ supported: [], unsupported: [] }
);
}, []);
return { return support;
hasRequiredFeatures: Object.values(features).every(Boolean),
missingFeatures: Object.entries(features)
.filter(([_, supported]) => !supported)
.map(([feature]) => featureLabels[feature as FeatureKey]),
isSecureContext
};
} }
Loading…
Cancel
Save