Merge pull request #442 from gertrude-app/richer-filter-status

dash: adapt to richer child computer status
gertrude-app · Jan 30, 2025 · 8ddccfe · 8ddccfe
2 parents e1553be + 66700a5
commit 8ddccfe
Show file tree

Hide file tree

Showing 19 changed files with 90 additions and 62 deletions.
diff --git a/dash/app/cypress/e2e/computers.cy.ts b/dash/app/cypress/e2e/computers.cy.ts
@@ -10,7 +10,7 @@ describe(`computers`, () => {
     modelFamily: `macBookPro`,
     modelIdentifier: `Mac14,10`,
     appVersion: `2.0.12`,
-    users: [{ name: `Little Jimmy`, id: `user-1`, isOnline: true }],
+    users: [{ name: `Little Jimmy`, id: `user-1`, status: { case: `filterOn` } }],
     serialNumber: `C02Z12345678`,
     releaseChannel: `stable`,
   };

diff --git a/dash/app/cypress/e2e/onboarding.cy.ts b/dash/app/cypress/e2e/onboarding.cy.ts
@@ -23,6 +23,7 @@ describe(`dashboard onboarding nudges`, () => {
       subscriptionStatus: { case: `paid` },
       notifications: [],
       verifiedNotificationMethods: [],
+      hasAdminChild: false,
     });
     cy.interceptPql(`CreatePendingAppConnection`, { code: 123456 });
     cy.interceptPql(`GetUser`, leopold);
@@ -55,8 +56,14 @@ describe(`dashboard onboarding nudges`, () => {
 
   it(`connect device from dashboard nudge`, () => {
     cy.interceptPql(`GetDashboardWidgets`, {
-      // we have a child, but no devices
-      users: [{ name: leopold.name, id: leopold.id, isOnline: true, numDevices: 0 }],
+      users: [
+        {
+          name: leopold.name,
+          id: leopold.id,
+          status: { case: `filterOn` },
+          numDevices: 0, // <- child, but no devices
+        },
+      ],
       unlockRequests: [],
       userActivitySummaries: [],
       recentScreenshots: [],
@@ -71,7 +78,14 @@ describe(`dashboard onboarding nudges`, () => {
 
   it(`recommends that you add a notification if there aren't any`, () => {
     cy.interceptPql(`GetDashboardWidgets`, {
-      users: [{ name: leopold.name, id: leopold.id, isOnline: true, numDevices: 1 }],
+      users: [
+        {
+          name: leopold.name,
+          id: leopold.id,
+          status: { case: `filterOn` },
+          numDevices: 1,
+        },
+      ],
       unlockRequests: [],
       userActivitySummaries: [],
       recentScreenshots: [],

diff --git a/dash/app/cypress/e2e/signup.cy.ts b/dash/app/cypress/e2e/signup.cy.ts
@@ -111,6 +111,7 @@ describe(`payment`, () => {
       subscriptionStatus: { case: `paid` },
       notifications: [],
       verifiedNotificationMethods: [],
+      hasAdminChild: false,
     });
 
     cy.interceptPql(`StripeUrl`, { url: `/stripe-url` });

diff --git a/dash/app/src/components/routes/Users.tsx b/dash/app/src/components/routes/Users.tsx
@@ -65,6 +65,6 @@ export function deviceProps(
     modelTitle: apiDevice.modelTitle,
     modelIdentifier: apiDevice.modelIdentifier,
     name: apiDevice.customName,
-    status: apiDevice.isOnline ? `online` : `offline`,
+    status: apiDevice.status,
   };
 }
diff --git a/dash/app/src/reducers/__tests__/mocks.ts b/dash/app/src/reducers/__tests__/mocks.ts
@@ -85,7 +85,7 @@ export function user(override: Partial<User> = {}): User {
         modelFamily: `macBookAir`,
         modelTitle: `MacBook Air`,
         modelIdentifier: `MacBookAir8,1`,
-        isOnline: true,
+        status: { case: `filterOn` },
       },
     ],
     createdAt: new Date().toISOString(),
@@ -101,7 +101,7 @@ export function userDevice(override: Partial<Device> = {}): Device {
       {
         name: `Little Jimmy`,
         id: uuid(),
-        isOnline: true,
+        status: { case: `filterOn` },
       },
     ],
     modelIdentifier: `MacBookAir8,1`,

diff --git a/dash/components/src/Computers/EditComputer.tsx b/dash/components/src/Computers/EditComputer.tsx
@@ -3,7 +3,7 @@ import cx from 'classnames';
 import { Button, SelectMenu, TextInput } from '@shared/components';
 import { Link } from 'react-router-dom';
 import Badge from '@shared/components/src/Badge';
-import type { ReleaseChannel } from '@dash/types';
+import type { ChildComputerStatus, ReleaseChannel } from '@dash/types';
 import PageHeading from '../PageHeading';
 
 interface Props {
@@ -19,7 +19,7 @@ interface Props {
   users: Array<{
     name: string;
     id: string;
-    isOnline: boolean;
+    status: ChildComputerStatus;
   }>;
   saveButtonDisabled: boolean;
   onSave(): unknown;
@@ -146,25 +146,28 @@ export default EditComputer;
 interface ComputerUserProps {
   name: string;
   id: string;
-  isOnline: boolean;
+  status: ChildComputerStatus;
 }
 
-const ComputerUser: React.FC<ComputerUserProps> = ({ name, id, isOnline }) => (
-  <Link
-    to={`/children/${id}`}
-    className="flex justify-between items-center odd:bg-slate-50 hover:bg-slate-100 transition-[background-color] duration-100 px-4 py-3 rounded-xl"
-  >
-    <h4 className="text-slate-700 font-semibold sm:text-lg">{name}</h4>
-    <div className="flex items-center gap-2">
-      <span className={cx(`text-sm`, isOnline ? `text-slate-600` : `text-slate-400`)}>
-        {isOnline ? `online` : `offline`}
-      </span>
-      <div
-        className={cx(
-          `w-3 h-3 rounded-full`,
-          isOnline ? `bg-green-400` : ` shadow-inner bg-slate-100`,
-        )}
-      />
-    </div>
-  </Link>
-);
+const ComputerUser: React.FC<ComputerUserProps> = ({ name, id, status }) => {
+  const isOnline = status.case !== `offline`;
+  return (
+    <Link
+      to={`/children/${id}`}
+      className="flex justify-between items-center odd:bg-slate-50 hover:bg-slate-100 transition-[background-color] duration-100 px-4 py-3 rounded-xl"
+    >
+      <h4 className="text-slate-700 font-semibold sm:text-lg">{name}</h4>
+      <div className="flex items-center gap-2">
+        <span className={cx(`text-sm`, isOnline ? `text-slate-600` : `text-slate-400`)}>
+          {isOnline ? `online` : `offline`}
+        </span>
+        <div
+          className={cx(
+            `w-3 h-3 rounded-full`,
+            isOnline ? `bg-green-400` : ` shadow-inner bg-slate-100`,
+          )}
+        />
+      </div>
+    </Link>
+  );
+};
diff --git a/dash/components/src/Computers/ListComputers.tsx b/dash/components/src/Computers/ListComputers.tsx
@@ -26,7 +26,7 @@ const ListComputers: React.FC<Props> = ({ devices }) => (
     )}
     <div className="mt-8 grid grid-cols-1 lg+:grid-cols-2 2xl:grid-cols-3 gap-8">
       {devices.map((device) => {
-        const onlineUser = device.users.find((user) => user.isOnline);
+        const onlineUser = device.users.find((user) => user.status.case !== `offline`);
         return (
           <ComputerCard
             key={device.id}

diff --git a/dash/components/src/Dashboard/UsersOverviewWidget.tsx b/dash/components/src/Dashboard/UsersOverviewWidget.tsx
@@ -46,10 +46,10 @@ const UsersOverview: React.FC<Props> = ({ className, users }) => {
 
 export default UsersOverview;
 
-const UserOverview: React.FC<User> = ({ isOnline, name }) => (
+const UserOverview: React.FC<User> = ({ status, name }) => (
   <div className="flex justify-between items-center rounded-xl py-4 px-4 even:bg-slate-50/50">
     <h3 className="font-medium text-slate-900">{name}</h3>
-    {isOnline ? (
+    {status.case !== `offline` ? (
       <Badge size="large" className="!px-4" type="green">
         <i className="mr-2 fa-solid fa-circle text-green-400 text-sm scale-50" />
         online

diff --git a/dash/components/src/Users/UserDevice.tsx b/dash/components/src/Users/UserDevice.tsx
@@ -1,14 +1,15 @@
 import React from 'react';
 import cx from 'classnames';
 import { Link } from 'react-router-dom';
+import type { ChildComputerStatus } from '@dash/types';
 
 type Props = {
   id: UUID;
   deviceId: UUID;
   modelTitle: string;
   modelIdentifier: string;
   name?: string;
-  status: 'online' | 'offline';
+  status: ChildComputerStatus;
   className?: string;
 };
 
@@ -42,7 +43,7 @@ const UserDevice: React.FC<Props> = ({
         {name && <h4 className="text-sm text-slate-500 line-clamp-1">{modelTitle}</h4>}
       </div>
     </div>
-    {status === `online` && (
+    {status.case !== `offline` && (
       <>
         <div className="flex items-center gap-2 mr-2">
           <span className={`text-sm text-slate-500 hidden xs:block`}>online</span>

diff --git a/dash/types/src/pairql/pairs/GetDashboardWidgets.ts b/dash/types/src/pairql/pairs/GetDashboardWidgets.ts
@@ -1,4 +1,5 @@
 // auto-generated, do not edit
+import type { ChildComputerStatus } from '../shared';
 
 export namespace GetDashboardWidgets {
   export type Input = void;
@@ -7,7 +8,7 @@ export namespace GetDashboardWidgets {
     users: Array<{
       id: UUID;
       name: string;
-      isOnline: boolean;
+      status: ChildComputerStatus;
       numDevices: number;
     }>;
     userActivitySummaries: Array<{

diff --git a/dash/types/src/pairql/shared.ts b/dash/types/src/pairql/shared.ts
@@ -34,13 +34,21 @@ export interface BlockedApp {
   schedule?: RuleSchedule;
 }
 
+export type ChildComputerStatus =
+  | { case: 'filterSuspended'; resuming?: ISODateString }
+  | { case: 'downtime'; ending?: ISODateString }
+  | { case: 'downtimePaused'; resuming?: ISODateString }
+  | { case: 'offline' }
+  | { case: 'filterOff' }
+  | { case: 'filterOn' };
+
 export type ClientAuth = 'none' | 'user' | 'admin' | 'superAdmin';
 
 export interface Device {
   id: UUID;
   name?: string;
   releaseChannel: ReleaseChannel;
-  users: Array<{ id: UUID; name: string; isOnline: boolean }>;
+  users: Array<{ id: UUID; name: string; status: ChildComputerStatus }>;
   appVersion: string;
   serialNumber: string;
   modelIdentifier: string;
@@ -207,7 +215,7 @@ export type UserActivityItem =
 export interface UserDevice {
   id: UUID;
   deviceId: UUID;
-  isOnline: boolean;
+  status: ChildComputerStatus;
   modelFamily: DeviceModelFamily;
   modelTitle: string;
   modelIdentifier: string;

diff --git a/storybook/stories/dash/Computers/EditComputer.stories.tsx b/storybook/stories/dash/Computers/EditComputer.stories.tsx
@@ -27,12 +27,12 @@ export const Default: Story = props({
     {
       name: `Sally`,
       id: `456`,
-      isOnline: false,
+      status: { case: `offline` },
     },
     {
       name: `Little Jimmy`,
       id: `123`,
-      isOnline: true,
+      status: { case: `filterOn` },
     },
   ],
   saveButtonDisabled: false,

diff --git a/storybook/stories/dash/Computers/ListComputers.stories.tsx b/storybook/stories/dash/Computers/ListComputers.stories.tsx
@@ -23,7 +23,7 @@ export const WithOne: Story = props({
       name: `Silvery`,
       modelIdentifier: `Mac14,10`,
       modelTitle: `16" MacBook Pro (2023)`,
-      users: [{ name: `John Doe`, isOnline: true, id: `123` }],
+      users: [{ name: `John Doe`, status: { case: `filterOn` }, id: `123` }],
     },
   ],
 });
@@ -36,27 +36,27 @@ export const WithMany: Story = props({
       name: `Silvery`,
       modelIdentifier: `Mac14,10`,
       modelTitle: `16" MacBook Pro (2023)`,
-      users: [{ name: `John Doe`, isOnline: true, id: `123` }],
+      users: [{ name: `John Doe`, status: { case: `filterOn` }, id: `123` }],
     },
     {
       id: `device-2`,
       name: `Blacky`,
       modelIdentifier: `MacPro6,1`,
       modelTitle: `Mac Pro (2013)`,
-      users: [{ name: `John Doe`, isOnline: true, id: `123` }],
+      users: [{ name: `John Doe`, status: { case: `filterOn` }, id: `123` }],
     },
     {
       id: `device-3`,
       modelIdentifier: `Mac14,15`,
       modelTitle: `15" MacBook Air (2023)`,
-      users: [{ name: `John Doe`, isOnline: true, id: `123` }],
+      users: [{ name: `John Doe`, status: { case: `filterOn` }, id: `123` }],
     },
     {
       id: `device-4`,
       name: `Spacey`,
       modelIdentifier: `Mac14,13`,
       modelTitle: `Mac Studio (2023)`,
-      users: [{ name: `John Doe`, isOnline: true, id: `123` }],
+      users: [{ name: `John Doe`, status: { case: `filterOn` }, id: `123` }],
     },
   ],
 });

diff --git a/storybook/stories/dash/Dashboard/Dashboard.stories.tsx b/storybook/stories/dash/Dashboard/Dashboard.stories.tsx
@@ -43,9 +43,9 @@ export const Default: Story = props({
     },
   ]),
   users: withIds([
-    { name: `Little Jimmy`, isOnline: true, numDevices: 1 },
-    { name: `Sally`, isOnline: true, numDevices: 2 },
-    { name: `Henry`, isOnline: false, numDevices: 0 },
+    { name: `Little Jimmy`, status: { case: `filterOn` }, numDevices: 1 },
+    { name: `Sally`, status: { case: `filterOn` }, numDevices: 2 },
+    { name: `Henry`, status: { case: `offline` }, numDevices: 0 },
   ]),
   userActivitySummaries: withIdsAnd({ numReviewed: 0 }, [
     { name: `Little Jimmy`, numUnreviewed: 245 },
@@ -98,7 +98,7 @@ export const NoUsers: Story = props({
 // @screenshot: xs,lg
 export const NoDevices: Story = props({
   ...Default.args,
-  users: withIds([{ name: `Little Jimmy`, isOnline: true, numDevices: 0 }]),
+  users: withIds([{ name: `Little Jimmy`, status: { case: `filterOn` }, numDevices: 0 }]),
 });
 
 // @screenshot: xs,lg

diff --git a/storybook/stories/dash/Dashboard/UsersOverviewWidget.stories.tsx b/storybook/stories/dash/Dashboard/UsersOverviewWidget.stories.tsx
@@ -11,9 +11,9 @@ type Story = StoryObj<typeof meta>;
 
 export const Default: Story = props({
   users: withIds([
-    { name: `Little Jimmy`, isOnline: true, numDevices: 1 },
-    { name: `Sally`, isOnline: true, numDevices: 2 },
-    { name: `Henry`, isOnline: false, numDevices: 0 },
+    { name: `Little Jimmy`, status: { case: `filterOn` }, numDevices: 1 },
+    { name: `Sally`, status: { case: `filterOn` }, numDevices: 2 },
+    { name: `Henry`, status: { case: `offline` }, numDevices: 0 },
   ]),
 });
 

diff --git a/storybook/stories/dash/Users/EditUser.stories.tsx b/storybook/stories/dash/Users/EditUser.stories.tsx
@@ -101,14 +101,14 @@ export const Default: Story = props({
       name: `Silvery`,
       modelIdentifier: `Mac14,10`,
       modelTitle: `16" MacBook Pro (2023)`,
-      status: `online`,
+      status: { case: `filterOn` },
     },
     {
       id: `2`,
       deviceId: `2`,
       modelIdentifier: `Mac14,14`,
       modelTitle: `Mac Studio (2023)`,
-      status: `offline`,
+      status: { case: `offline` },
     },
   ],
   requestPublicKeychainRequest: { state: `idle` },

diff --git a/storybook/stories/dash/Users/ListUsers.stories.tsx b/storybook/stories/dash/Users/ListUsers.stories.tsx
@@ -46,7 +46,7 @@ export const Default: Story = props({
           name: `Silvery`,
           modelIdentifier: `Mac14,10`,
           modelTitle: `16" MacBook Pro (2023)`,
-          status: `online`,
+          status: { case: `filterOn` },
         },
       ],
     },
@@ -64,14 +64,14 @@ export const Default: Story = props({
           modelIdentifier: `Mac14,13`,
           name: `Lil' Studio`,
           modelTitle: `Mac Studio (2023)`,
-          status: `offline`,
+          status: { case: `offline` },
         },
         {
           id: `3`,
           deviceId: `3`,
           modelIdentifier: `iMac21,2`,
           modelTitle: `27" iMac (2021)`,
-          status: `online`,
+          status: { case: `filterOn` },
         },
       ],
     },