@dxos/shell 0.3.11-main.fbbdc2a → 0.3.11-main.fc97a54

package/src/panels/IdentityPanel/useAgentHandlers.ts

@@ -0,0 +1,88 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { useCallback, useEffect, useState } from 'react';
+
+import { type CancellableInvitation } from '@dxos/client-protocol';
+import { invariant } from '@dxos/invariant';
+import { useAgentHostingProviderClient, type Client } from '@dxos/react-client';
+import { type Identity } from '@dxos/react-client/halo';
+import { Invitation, InvitationEncoder } from '@dxos/react-client/invitations';
+
+export const useAgentHandlers = ({
+  client,
+  invitations,
+  identity,
+}: {
+  client: Client;
+  invitations: CancellableInvitation[];
+  identity: Identity | null;
+}) => {
+  const [validationMessage, setValidationMessage] = useState('');
+  const [agentStatus, setAgentStatus] = useState('');
+  const [agentActive, setAgentActive] = useState(false);
+  const agentHostingProviderClient = useAgentHostingProviderClient(client.config);
+
+  useEffect(() => {
+    const fetchAgentStatus = async () => {
+      // TODO(nf): if agent exists, subscribe to updates instead of oneshot status
+      if (agentHostingProviderClient) {
+        const agentStatus = await agentHostingProviderClient?.getAgent(identity?.identityKey.truncate() ?? 'foo');
+        if (agentStatus) {
+          setAgentActive(true);
+          setAgentStatus(agentStatus);
+        } else {
+          setAgentActive(false);
+          setValidationMessage('No agent deployed via provider.');
+        }
+      } else {
+        setValidationMessage('No agent provider configured.');
+      }
+    };
+    void fetchAgentStatus();
+  }, []);
+
+  const handleAgentCreate = useCallback(async (invitation: Invitation) => {
+    const invitationCode = InvitationEncoder.encode(invitation);
+    if (invitation.state === Invitation.State.CONNECTING) {
+      console.log(JSON.stringify({ invitationCode, authCode: invitation.authCode }));
+      invariant(identity, 'Identity not found');
+      if (agentHostingProviderClient) {
+        try {
+          const res = await agentHostingProviderClient?.createAgent(invitationCode, identity.identityKey.truncate());
+          // TODO(nf): human-consumable response from API
+          setAgentStatus(res);
+          setAgentActive(true);
+          setValidationMessage('');
+        } catch (err: any) {
+          setValidationMessage(`error creating agent: ${err.message}`);
+        }
+      }
+    }
+  }, []);
+
+  const onAgentCreate = async () => {
+    invitations.forEach((invitation) => invitation.cancel());
+
+    // TODO(nf): do this work in the hosting provider client?
+    const invitation = client.halo.share({ type: Invitation.Type.MULTIUSE, authMethod: Invitation.AuthMethod.NONE });
+
+    invitation.subscribe(handleAgentCreate);
+  };
+
+  const onAgentDestroy = async () => {
+    const identity = client.halo.identity.get();
+    invariant(identity, 'Identity not found');
+    try {
+      await agentHostingProviderClient?.destroyAgent(identity.identityKey.truncate());
+      setValidationMessage('No agent deployed via provider.');
+      setAgentStatus('');
+      setAgentActive(false);
+    } catch (err: any) {
+      setValidationMessage(`error destroying agent: ${err.message}`);
+    }
+  };
+
+  return { onAgentCreate, onAgentDestroy, validationMessage, agentStatus, agentActive };
+};

package/src/panels/JoinPanel/JoinPanel.tsx

@@ -193,8 +193,6 @@ export const JoinPanel = ({
     },
   });
 
-  console.log('[joinState]', joinState);
-
   useEffect(() => {
     const subscription = joinService.subscribe((state) => {
       log('[state]', state);
@@ -368,6 +366,7 @@ export const JoinPanel = ({
       identityKey: joinState.context.halo.invitation?.identityKey ?? null,
       swarmKey: joinState.context.halo.invitation?.swarmKey ?? null,
       spaceKey: joinState.context.halo.invitation?.spaceKey ?? null,
+      target: joinState.context.halo.invitation?.target ?? null,
     });
   }, [joinState, propsOnDone]);
 
@@ -376,6 +375,7 @@ export const JoinPanel = ({
       identityKey: joinState.context.space.invitation?.identityKey ?? null,
       swarmKey: joinState.context.space.invitation?.swarmKey ?? null,
       spaceKey: joinState.context.space.invitation?.spaceKey ?? null,
+      target: joinState.context.space.invitation?.target ?? null,
     });
   }, [joinState, propsOnDone]);
 

package/src/panels/JoinPanel/joinMachine.ts

@@ -15,7 +15,7 @@ import {
 } from 'xstate';
 
 import { log } from '@dxos/log';
-import type { Client } from '@dxos/react-client';
+import { type Client, AlreadyJoinedError } from '@dxos/react-client';
 import { type Identity } from '@dxos/react-client/halo';
 import { type AuthenticatingInvitationObservable, Invitation, InvitationEncoder } from '@dxos/react-client/invitations';
 
@@ -133,6 +133,12 @@ const getInvitationSubscribable = (
           }
         },
         (error: any) => {
+          if (error instanceof AlreadyJoinedError) {
+            log('[already joined]', { Kind, error });
+            next({ type: `success${Kind}Invitation`, invitation: invitation.get() });
+            return complete?.();
+          }
+
           log.error('[invitation errored]', { Kind, error });
           next({ type: `fail${Kind}Invitation`, reason: 'error' });
           return onError?.(error);
@@ -397,7 +403,7 @@ const joinMachine = createMachine<JoinMachineContext, JoinEvent>(
           event.type.includes('Space') ? { ...context.space, invitation: event.invitation } : context.space,
       }),
       log: (context, event) => {
-        log.info('[transition]', {
+        log('[transition]', {
           event,
           haloInvitation: context.halo.invitation,
           spaceInvitation: context.space.invitation,
@@ -437,9 +443,8 @@ const useJoinMachine = (
     ({ halo }: JoinMachineContext) => {
       if (halo.unredeemedCode) {
         try {
-          const invitationObservable = client.halo.join(
-            InvitationEncoder.decode(defaultCodeFromUrl('halo', halo.unredeemedCode)),
-          );
+          const invitation = InvitationEncoder.decode(defaultCodeFromUrl('halo', halo.unredeemedCode));
+          const invitationObservable = client.halo.join(invitation);
           return {
             ...halo,
             invitationObservable,
@@ -461,20 +466,12 @@ const useJoinMachine = (
       if (space.unredeemedCode) {
         try {
           const invitation = InvitationEncoder.decode(defaultCodeFromUrl('space', space.unredeemedCode));
-          // Don’t join with the invitation if it has already succeeded.
-          if (space.succeededKeys?.has(invitation.spaceKey?.toHex() ?? 'never')) {
-            return {
-              ...space,
-              invitation,
-            };
-          } else {
-            const invitationObservable = client.spaces.join(invitation);
-            return {
-              ...space,
-              invitationObservable,
-              invitationSubscribable: getInvitationSubscribable('Space', invitationObservable),
-            };
-          }
+          const invitationObservable = client.spaces.join(invitation);
+          return {
+            ...space,
+            invitationObservable,
+            invitationSubscribable: getInvitationSubscribable('Space', invitationObservable),
+          };
         } catch (err) {
           log.error('Could not redeem space invitation code', err);
           return space;

package/src/panels/JoinPanel/steps/AdditionMethodChooser.tsx

@@ -35,7 +35,7 @@ export const AdditionMethodChooser = (viewStateProps: AdditionMethodChooserProps
           before={<Plus className={getSize(6)} />}
           onClick={() => send({ type: 'createIdentity' })}
           data-autofocus='choosingAuthMethod'
-          data-testid='create-identity'
+          data-testid='identity-chooser.create-identity'
         >
           {t('create identity label')}
         </CompoundButton>
@@ -44,7 +44,7 @@ export const AdditionMethodChooser = (viewStateProps: AdditionMethodChooserProps
           description={t('join identity description')}
           before={<QrCode className={getSize(6)} />}
           onClick={() => send({ type: 'acceptHaloInvitation' })}
-          data-testid='join-identity'
+          data-testid='identity-chooser.join-identity'
         >
           {t('join identity label')}
         </CompoundButton>
@@ -55,7 +55,7 @@ export const AdditionMethodChooser = (viewStateProps: AdditionMethodChooserProps
           description={t('recover identity description')}
           before={<Textbox className={getSize(6)} />}
           onClick={() => send({ type: 'recoverIdentity' })}
-          data-testid='recover-identity'
+          data-testid='identity-chooser.recover-identity'
         >
           {t('recover identity label')}
         </CompoundButton>

package/src/panels/JoinPanel/steps/InvitationInput.tsx

@@ -39,12 +39,17 @@ export const InvitationInput = (props: InvitationInputProps) => {
     unredeemedCode && setInputValue(unredeemedCode ?? '');
   }, [unredeemedCode]);
 
-  const handleNext = () =>
+  const handleNext = () => {
+    if (inputValue.trim().length === 0) {
+      return;
+    }
+
     send({
       type: `set${Kind}InvitationCode`,
       code: invitationCodeFromUrl(inputValue),
       ...(Kind === 'Space' && { succeededKeys }),
     });
+  };
 
   const exitAction = (
     <Action
@@ -62,6 +67,7 @@ export const InvitationInput = (props: InvitationInputProps) => {
       <div role='none' className='grow flex flex-col justify-center'>
         <Input
           label={<StepHeading>{t('invitation input label')}</StepHeading>}
+          // TODO(burdon): Translation.
           placeholder='Type an invitation code'
           disabled={disabled}
           value={inputValue}

package/src/panels/JoinPanel/steps/InvitationRescuer.tsx

@@ -39,8 +39,8 @@ const InvitationActions = ({
             failReason === 'timeout'
               ? 'timeout status label'
               : failReason === 'cancelled'
-              ? 'cancelled status label'
-              : 'error status label',
+                ? 'cancelled status label'
+                : 'error status label',
           )}
         </StepHeading>
         <div role='none' className='grow' />

package/src/panels/JoinPanel/steps/ResetIdentity.tsx

@@ -50,7 +50,7 @@ export const ResetIdentityImpl = ({ disabled, validationMessage, onConfirm }: Re
           {...{ validationMessage }}
           label={<StepHeading>{t('reset identity input label', { confirmationValue })}</StepHeading>}
           disabled={disabled}
-          data-testid='identity-input'
+          data-testid='reset-identity-input'
           placeholder={confirmationValue}
           onChange={({ target: { value } }) => setInputValue(value)}
         />

package/src/panels/SpacePanel/SpacePanel.stories.tsx

@@ -129,6 +129,7 @@ export const SpaceManagerWithEvenMoreInvites = () => {
                       identityKey = PublicKey.random(),
                       swarmKey,
                       spaceKey = PublicKey.random(),
+                      target = null,
                     } = invitation;
                     return (
                       <InvitationListItemImpl
@@ -140,7 +141,7 @@ export const SpaceManagerWithEvenMoreInvites = () => {
                           invitationCode: id,
                           authCode: state === Invitation.State.READY_FOR_AUTHENTICATION ? '123414' : undefined,
                           id,
-                          result: { identityKey, swarmKey, spaceKey },
+                          result: { identityKey, swarmKey, spaceKey, target },
                           cancel: () => {},
                           authenticate: async (authCode: string) => {},
                           connect: () => {},

package/src/panels/SpacePanel/SpacePanel.tsx

@@ -39,17 +39,19 @@ export const SpacePanelImpl = (props: SpacePanelImplProps) => {
     titleId,
     activeView,
     space,
+    target,
     SpaceManager: SpaceManagerComponent = SpaceManager,
     InvitationManager: InvitationManagerComponent = InvitationManager,
     ...rest
   } = props;
+
   return (
     <DensityProvider density='fine'>
       <SpacePanelHeading {...rest} {...{ titleId, space }} />
       <Viewport.Root activeView={activeView}>
         <Viewport.Views>
           <Viewport.View id='space manager' classNames={stepStyles}>
-            <SpaceManagerComponent active={activeView === 'space manager'} space={space} {...rest} />
+            <SpaceManagerComponent active={activeView === 'space manager'} space={space} target={target} {...rest} />
           </Viewport.View>
           <Viewport.View id='space invitation manager' classNames={stepStyles}>
             <InvitationManagerComponent
@@ -115,6 +117,7 @@ export const SpacePanel = ({
   };
 
   return spaceState.context.invitation ? (
+    // TODO(wittjosiah): Unused? Remove?
     <SpacePanelWithInvitationImpl {...implProps} invitation={spaceState.context.invitation} />
   ) : (
     <SpacePanelImpl {...implProps} />

package/src/panels/SpacePanel/SpacePanelProps.ts

@@ -16,6 +16,7 @@ export type SpacePanelImplProps = {
   titleId: string;
   activeView: string;
   send: (event: SingleOrArray<Event<any>>) => void;
+  target?: string;
   createInvitationUrl: (invitationCode: string) => string;
   space: ErsatzSpace | Space;
   invitationUrl?: string;

package/src/panels/SpacePanel/steps/SpaceManager.tsx

@@ -23,6 +23,7 @@ import {
 import { type SpacePanelStepProps } from '../SpacePanelProps';
 
 export type SpaceManagerImplProps = SpacePanelStepProps & {
+  target?: string;
   invitations?: CancellableInvitationObservable[];
   showInactiveInvitations?: boolean;
   inviteActions?: Record<string, ActionMenuItem>;
@@ -35,7 +36,7 @@ const activeActionKey = 'dxos:react-shell/space-manager/active-action';
 export type SpaceManagerProps = SpaceManagerImplProps & {};
 
 export const SpaceManager = (props: SpaceManagerProps) => {
-  const { space } = props;
+  const { space, target } = props;
   const { t } = useTranslation('os');
   const config = useConfig();
 
@@ -57,6 +58,7 @@ export const SpaceManager = (props: SpaceManagerProps) => {
         const invitation = space.share?.({
           type: Invitation.Type.INTERACTIVE,
           authMethod: Invitation.AuthMethod.SHARED_SECRET,
+          target,
         });
         if (invitation && config.values.runtime?.app?.env?.DX_ENVIRONMENT !== 'production') {
           invitation.subscribe(onInvitationEvent);
@@ -71,6 +73,7 @@ export const SpaceManager = (props: SpaceManagerProps) => {
         const invitation = space.share?.({
           type: Invitation.Type.MULTIUSE,
           authMethod: Invitation.AuthMethod.NONE,
+          target,
         });
         if (invitation && config.values.runtime?.app?.env?.DX_ENVIRONMENT !== 'production') {
           invitation.subscribe(onInvitationEvent);

package/src/playwright/invitations-manager.ts

@@ -70,6 +70,10 @@ export class InvitationsManager extends ScopedShellManager {
     return this.peer(id).getByTestId('space-list-item').nth(nth).textContent();
   }
 
+  async getSpaceMembersCount(id: number) {
+    return this.peer(id).getByTestId('space-members-list').locator('li').count();
+  }
+
   async getAuthCode(): Promise<string> {
     return await this._authCode.wait();
   }
@@ -147,7 +151,7 @@ export class InvitationsManager extends ScopedShellManager {
     const peer = this.peer(id);
     // TODO(wittjosiah): Update ids.
     if (type === 'device') {
-      await peer.getByTestId('join-identity').click();
+      await peer.getByTestId('identity-chooser.join-identity').click();
     }
     await peer.getByTestId(`${type === 'device' ? 'halo' : 'space'}-invitation-input`).waitFor({ timeout: 500 });
     await peer.getByTestId(`${type === 'device' ? 'halo' : 'space'}-invitation-input`).fill(invitation);

package/src/playwright/invitations.spec.ts

@@ -185,6 +185,25 @@ test.describe('Invitations', () => {
       expect(await manager.getSpaceName(0, 1)).to.equal(await manager.getSpaceName(1, 1));
     });
 
+    test('already joined', async () => {
+      await manager.createIdentity(0);
+      await manager.createSpace(0);
+      await manager.openPanel(0, 1);
+      const invitation1 = await manager.createInvitation(0, 'space', { authMethod: Invitation.AuthMethod.NONE });
+      const invitation2 = await manager.createInvitation(0, 'space');
+
+      await manager.createIdentity(1);
+      await manager.openPanel(1, 'join');
+      await manager.acceptInvitation(1, 'space', invitation1);
+      await manager.doneInvitation('space', manager.peer(1));
+
+      await manager.openPanel(1, 'join');
+      await manager.acceptInvitation(1, 'space', invitation2);
+      await manager.doneInvitation('space', manager.peer(1));
+
+      expect(await manager.getSpaceMembersCount(0)).to.equal(2);
+    });
+
     test('no auth method', async () => {
       await manager.createIdentity(0);
       await manager.createSpace(0);

package/src/stories/Invitations.e2e-stories.tsx

@@ -4,10 +4,10 @@
 
 import '@dxosTheme';
 
-import { faker } from '@faker-js/faker';
 import { Laptop, Planet, Plus, PlusCircle, SignIn, QrCode, WifiHigh, WifiSlash } from '@phosphor-icons/react';
 import React, { useMemo, useState } from 'react';
 
+import { faker } from '@dxos/random';
 import { useClient } from '@dxos/react-client';
 import { type Space, type SpaceMember, SpaceProxy, useSpaces } from '@dxos/react-client/echo';
 import { useIdentity } from '@dxos/react-client/halo';
@@ -72,7 +72,7 @@ const Panel = ({ id, panel, setPanel }: { id: number; panel?: PanelType; setPane
         <ButtonGroup classNames='mbe-4'>
           {/* <Tooltip content='Create Space'> */}
           <Button
-            onClick={() => client.spaces.create({ name: faker.animal.bird() })}
+            onClick={() => client.spaces.create({ name: faker.commerce.productName() })}
             data-testid='invitations.create-space'
           >
             <PlusCircle className={getSize(6)} />

package/src/styles/invitationStatusStyles.ts

@@ -26,17 +26,17 @@ export const resolvedStrokeColor = (status: Invitation.State) =>
   status === Invitation.State.ERROR
     ? errorStrokeColor
     : status === Invitation.State.CANCELLED || status === Invitation.State.TIMEOUT
-    ? cancelledStrokeColor
-    : successStrokeColor;
+      ? cancelledStrokeColor
+      : successStrokeColor;
 export const resolvedBgColor = (status: Invitation.State) =>
   status === Invitation.State.ERROR
     ? errorBgColor
     : status === Invitation.State.CANCELLED || status === Invitation.State.TIMEOUT
-    ? cancelledBgColor
-    : successBgColor;
+      ? cancelledBgColor
+      : successBgColor;
 export const resolvedTextColor = (status: Invitation.State) =>
   status === Invitation.State.ERROR
     ? errorTextColor
     : status === Invitation.State.CANCELLED || status === Invitation.State.TIMEOUT
-    ? cancelledTextColor
-    : successTextColor;
+      ? cancelledTextColor
+      : successTextColor;

package/src/testing/shell-manager.ts

@@ -2,12 +2,14 @@
 // Copyright 2023 DXOS.org
 //
 
-import type { ConsoleMessage, Page } from '@playwright/test';
+import type { ConsoleMessage, Dialog, Page } from '@playwright/test';
 
 import { sleep, Trigger } from '@dxos/async';
 
 import { ScopedShellManager } from './scoped-shell-manager';
 
+// TODO(wittjosiah): Normalize data-testids between snake and camel case.
+
 export class ShellManager extends ScopedShellManager {
   private _invitationCode = new Trigger<string>();
   private _authCode = new Trigger<string>();
@@ -27,6 +29,10 @@ export class ShellManager extends ScopedShellManager {
 
   // Getters
 
+  async getDisplayName(): Promise<string | null> {
+    return this.shell.getByTestId('identityHeading.displayName').textContent();
+  }
+
   async isCurrentSpaceViewVisible(): Promise<boolean> {
     return await this.shell.getByTestId('current-space-view').isVisible();
   }
@@ -44,29 +50,50 @@ export class ShellManager extends ScopedShellManager {
     await this.shell.getByTestId('halo-invitation-accepted-done').click();
   }
 
-  async closeShell() {
-    await this.page.keyboard.press('Escape');
+  async createDeviceInvitation(): Promise<string> {
+    this._invitationCode = new Trigger<string>();
+    this._authCode = new Trigger<string>();
+    await this.shell.getByTestId('devices-panel.create-invitation').click();
+    return await this._invitationCode.wait();
   }
 
-  // TODO(wittjosiah): These shortcuts are no longer within the SDK so these commands should live elsewhere.
-  async openCurrentSpace() {
-    await this.page.keyboard.press('Meta+.');
+  async resetDevice() {
+    const handleDialog = async (dialog: Dialog) => {
+      if (dialog.type() === 'confirm') {
+        await dialog.accept();
+      }
+    };
+
+    this.page.on('dialog', handleDialog);
+    await this.shell.getByTestId('devices-panel.sign-out').click();
+    await this.shell.getByTestId('sign-out.reset-device').click();
+    this.page.off('dialog', handleDialog);
   }
 
-  async openSpaceList() {
-    await this.page.keyboard.press('Meta+Shift+>');
+  async joinNewIdentity(invitationCode: string) {
+    await this.shell.getByTestId('devices-panel.sign-out').click();
+    await this.shell.getByTestId('sign-out.join-new-identity').click();
+    await this.shell.getByTestId('reset-identity-input').fill('CONFIRM');
+    await this.shell.getByTestId('reset-identity-input-confirm').click();
+    await this.shell.getByTestId('identity-chooser.join-identity').click();
+    await this.inputInvitation('device', invitationCode, this.shell);
   }
 
-  async showAllSpaces() {
-    await this.shell.getByTestId('show-all-spaces').click();
+  async authenticateDevice(authCode: string, skipDone = true) {
+    // Wait for focus to shift before typing.
+    await sleep(1500);
+    await this.authenticateInvitation('device', authCode, this.shell);
+    // TODO(wittjosiah): When "signing out" and joinging a new identity, the done step seems to be skipped.
+    if (!skipDone) {
+      await this.doneInvitation('device', this.shell);
+    }
   }
 
-  async showCurrentSpace() {
-    await this.shell.getByTestId('show-current-space').click();
+  async closeShell() {
+    await this.page.keyboard.press('Escape');
   }
 
   async createSpaceInvitation(): Promise<string> {
-    await this.openCurrentSpace();
     this._invitationCode = new Trigger<string>();
     this._authCode = new Trigger<string>();
     await this.shell.getByTestId('spaces-panel.create-invitation').click();

package/src/translations/locales/en-US.ts

@@ -69,7 +69,8 @@ export const os = {
   'selecting identity heading': 'Selecting identity',
   'devices heading': 'Devices',
   'identity heading': 'Profile settings',
-  'choose devices label': 'Add device',
+  'choose add device label': 'Add device',
+  'choose devices label': 'Manage devices',
   'choose profile label': 'Edit profile',
   'choose sign out label': 'Sign out',
   'empty space members message': 'There is nobody in this space yet.',
@@ -98,4 +99,9 @@ export const os = {
     'This will clear this device and all associated data. Type {{confirmationValue}} and confirm to continue.',
   'failed to reset identity message': 'Failed to reset identity.',
   'confirmation value': 'CONFIRM',
+  'sign out chooser title': 'DANGER ZONE',
+  'sign out chooser message': 'Proceeding with either action below will erase all data on this device.',
+  'join new identity label': 'Join a new identity',
+  'reset device label': 'Reset device',
+  'reset device confirm message': 'Are you sure you want to reset your device? All data will be lost.',
 };