feat: MemberInfo - expose when a project member joined the project (#745)

* add joinedAt to `MemberInfo`, expose it on `getByDocId` and `getMany`

* fix tests

* typo, spanish lurking

Co-authored-by: Evan Hahn <[email protected]>

---------

Co-authored-by: Tomás Ciccola <[email protected]>
Co-authored-by: Evan Hahn <[email protected]>

Author: 3 people

src/member-api.js

@@ -30,6 +30,7 @@ import { ROLES, isRoleIdForNewInvite } from './roles.js'
  * @prop {import('./roles.js').Role} role
  * @prop {import('@mapeo/schema').DeviceInfo['name']} [name]
  * @prop {import('@mapeo/schema').DeviceInfo['deviceType']} [deviceType]
+ * @prop {import('@mapeo/schema').DeviceInfo['createdAt']} [joinedAt]
  */
 
 export class MemberApi extends TypedEmitter {
@@ -255,6 +256,7 @@ export class MemberApi extends TypedEmitter {
 
       result.name = deviceInfo.name
       result.deviceType = deviceInfo.deviceType
+      result.joinedAt = deviceInfo.createdAt
     } catch (err) {
       // Attempting to get someone else may throw because sync hasn't occurred or completed
       // Only throw if attempting to get themself since the relevant information should be available
@@ -290,6 +292,7 @@ export class MemberApi extends TypedEmitter {
 
           memberInfo.name = deviceInfo?.name
           memberInfo.deviceType = deviceInfo?.deviceType
+          memberInfo.joinedAt = deviceInfo?.createdAt
         } catch (err) {
           // Attempting to get someone else may throw because sync hasn't occurred or completed
           // Only throw if attempting to get themself since the relevant information should be available

test-e2e/members.js

@@ -25,8 +25,16 @@ test('getting yourself after creating project', async (t) => {
   const deviceInfo = manager.getDeviceInfo()
   const project = await manager.getProject(await manager.createProject())
 
-  const me = await project.$member.getById(project.deviceId)
+  const { joinedAt, ...me } = await project.$member.getById(project.deviceId)
+  assert.ok(joinedAt, 'has a `joinedAt` field')
 
+  const joinedAtUnix = new Date(joinedAt).getTime()
+  const now = new Date().getTime()
+
+  assert.ok(
+    Math.abs(joinedAtUnix - now) < 1000,
+    'time of joined project is close to now'
+  )
   assert.deepEqual(
     me,
     {
@@ -39,10 +47,11 @@ test('getting yourself after creating project', async (t) => {
   )
 
   const members = await project.$member.getMany()
+  const { joinedAt: _, ...member } = members[0]
 
   assert.equal(members.length, 1)
   assert.deepEqual(
-    members[0],
+    member,
     {
       deviceId: project.deviceId,
       deviceType: 'tablet',
@@ -68,7 +77,14 @@ test('getting yourself after adding project (but not yet synced)', async (t) =>
     )
   )
 
-  const me = await project.$member.getById(project.deviceId)
+  const { joinedAt, ...me } = await project.$member.getById(project.deviceId)
+  assert.ok(joinedAt, 'joinedAt exists at project')
+  const joinedAtUnix = new Date(joinedAt).getTime()
+  const now = new Date().getTime()
+  assert.ok(
+    Math.abs(now - joinedAtUnix) < 1000,
+    'time between joined project and now is short'
+  )
 
   assert.deepEqual(
     me,
@@ -82,10 +98,11 @@ test('getting yourself after adding project (but not yet synced)', async (t) =>
   )
 
   const members = await project.$member.getMany()
+  const { joinedAt: _, ...member } = members[0]
 
   assert.equal(members.length, 1)
   assert.deepEqual(
-    members[0],
+    member,
     {
       deviceId: project.deviceId,
       deviceType: 'tablet',
@@ -150,17 +167,27 @@ test('getting invited member after invite accepted', async (t) => {
   assert.equal(members.length, 2)
 
   const invitedMember = members.find((m) => m.deviceId === invitee.deviceId)
+  if (invitedMember) {
+    const { joinedAt, ...invitedMemberWithoutJoinedAt } = invitedMember
+    assert.ok(joinedAt, 'joinedAt exists for project')
+    const joinedAtUnix = new Date(joinedAt).getTime()
+    const now = new Date().getTime()
+    assert.ok(
+      Math.abs(now - joinedAtUnix) < 1000,
+      'time between joined project and now is short'
+    )
 
-  assert.deepEqual(
-    invitedMember,
-    {
-      deviceId: invitee.deviceId,
-      deviceType: undefined,
-      name: inviteeName,
-      role: ROLES[MEMBER_ROLE_ID],
-    },
-    'has expected member info with member role'
-  )
+    assert.deepEqual(
+      invitedMemberWithoutJoinedAt,
+      {
+        deviceId: invitee.deviceId,
+        deviceType: undefined,
+        name: inviteeName,
+        role: ROLES[MEMBER_ROLE_ID],
+      },
+      'has expected member info with member role'
+    )
+  }
 
   // TODO: Test that device info of invited member can be read from invitor after syncing
 })