Skip to content

academy.exchange.cloud.backend

MailboxBackend

Bases: Protocol

Backend protocol for storing mailboxes on server.

check_mailbox async 

check_mailbox(
    client: ClientInfo, uid: EntityId
) -> MailboxStatus

Check if a mailbox exists, or is terminated.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to check.

Returns:

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
async def check_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> MailboxStatus:
    """Check if a mailbox exists, or is terminated.

    Args:
        client: Client making the request.
        uid: Mailbox id to check.

    Returns:
        The mailbox status.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    ...

create_mailbox async 

create_mailbox(
    client: ClientInfo,
    uid: EntityId,
    agent: tuple[str, ...] | None = None,
) -> None

Create a mailbox is not exists.

This method should be idempotent.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to check.

  • agent (tuple[str, ...] | None, default: None ) –

    The agent_mro for behavior discovery.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
async def create_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
    agent: tuple[str, ...] | None = None,
) -> None:
    """Create a mailbox is not exists.

    This method should be idempotent.

    Args:
        client: Client making the request.
        uid: Mailbox id to check.
        agent: The agent_mro for behavior discovery.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    ...

terminate async 

terminate(client: ClientInfo, uid: EntityId) -> None

Close a mailbox.

For security, the manager should keep a gravestone so the same id cannot be re-registered.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to close.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
async def terminate(self, client: ClientInfo, uid: EntityId) -> None:
    """Close a mailbox.

    For security, the manager should keep a gravestone so the same id
    cannot be re-registered.

    Args:
        client: Client making the request.
        uid: Mailbox id to close.

    Raises:
        ForbiddenError: If the client does not have the right permissions.

    """
    ...

discover async 

discover(
    client: ClientInfo, agent: str, allow_subclasses: bool
) -> list[AgentId[Any]]

Find mailboxes of matching agent class.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • agent (str) –

    Agent class to search for.

  • allow_subclasses (bool) –

    Include agents that inherit from the target.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
async def discover(
    self,
    client: ClientInfo,
    agent: str,
    allow_subclasses: bool,
) -> list[AgentId[Any]]:
    """Find mailboxes of matching agent class.

    Args:
        client: Client making the request.
        agent: Agent class to search for.
        allow_subclasses: Include agents that inherit from the target.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    ...

get async 

get(
    client: ClientInfo,
    uid: EntityId,
    *,
    timeout: float | None = None
) -> Message[Any]

Get messages from a mailbox.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to get messages.

  • timeout (float | None, default: None ) –

    Time in seconds to wait for message. If None, wait indefinitely.

Raises:

Source code in academy/exchange/cloud/backend.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
async def get(
    self,
    client: ClientInfo,
    uid: EntityId,
    *,
    timeout: float | None = None,
) -> Message[Any]:
    """Get messages from a mailbox.

    Args:
        client: Client making the request.
        uid: Mailbox id to get messages.
        timeout: Time in seconds to wait for message.
            If None, wait indefinitely.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
        TimeoutError: There was not message received during the timeout.
    """
    ...

put async 

put(client: ClientInfo, message: Message[Any]) -> None

Put a message in a mailbox.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • message (Message[Any]) –

    Message to put in mailbox.

Raises:

Source code in academy/exchange/cloud/backend.py 
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
async def put(self, client: ClientInfo, message: Message[Any]) -> None:
    """Put a message in a mailbox.

    Args:
        client: Client making the request.
        message: Message to put in mailbox.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
        MessageTooLargeError: The message is larger than the message
            size limit for this exchange.
    """
    ...

share_mailbox async 

share_mailbox(
    client: ClientInfo, uid: EntityId, group_uid: str
) -> None

Share a mailbox with a Globus Group.

Only the owner of the Mailbox is allowed to share with a Globus Group. This method should be idempotent.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to share.

  • group_uid (str) –

    Globus Group id to share.

Raises:

Source code in academy/exchange/cloud/backend.py 
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
async def share_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
    group_uid: str,
) -> None:
    """Share a mailbox with a Globus Group.

    Only the owner of the Mailbox is allowed to share with a Globus Group.
    This method should be idempotent.

    Args:
        client: Client making the request.
        uid: Mailbox id to share.
        group_uid: Globus Group id to share.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox to share does not exist.
        MailboxTerminatedError: The mailbox is closed.
    """
    ...

get_mailbox_shares async 

get_mailbox_shares(
    client: ClientInfo, uid: EntityId
) -> list[str]

Get list of globus groups the mailbox is shared with.

Only the owner of the Mailbox is allowed to share with a Globus Group. This method should be idempotent.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to share.

Returns:

  • list[str] –

    List of globus groups id strings

Raises:

Source code in academy/exchange/cloud/backend.py 
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
async def get_mailbox_shares(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> list[str]:
    """Get list of globus groups the mailbox is shared with.

    Only the owner of the Mailbox is allowed to share with a Globus Group.
    This method should be idempotent.

    Args:
        client: Client making the request.
        uid: Mailbox id to share.

    Returns:
        List of globus groups id strings

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
    """
    ...

remove_mailbox_shares async 

remove_mailbox_shares(
    client: ClientInfo, uid: EntityId, group_uid: str
) -> None

Stop sharing a mailbox with a group.

Only the owner of the Mailbox is allowed to share with a Globus Group. This method should be idempotent (removing a group that the mailbox is not shared with is a no-op).

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to share.

  • group_uid (str) –

    Globus Group id to remove.

Raises:

Source code in academy/exchange/cloud/backend.py 
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
async def remove_mailbox_shares(
    self,
    client: ClientInfo,
    uid: EntityId,
    group_uid: str,
) -> None:
    """Stop sharing a mailbox with a group.

    Only the owner of the Mailbox is allowed to share with a Globus Group.
    This method should be idempotent (removing a group that the mailbox
    is not shared with is a no-op).

    Args:
        client: Client making the request.
        uid: Mailbox id to share.
        group_uid: Globus Group id to remove.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox to share does not exist.
        MailboxTerminatedError: The mailbox is closed.
    """
    ...

update_heartbeat async 

update_heartbeat(uid: EntityId) -> None

Update the heartbeat timestamp for a mailbox.

Parameters:

  • uid (EntityId) –

    Mailbox id to update.

Source code in academy/exchange/cloud/backend.py 
230
231
232
233
234
235
236
async def update_heartbeat(self, uid: EntityId) -> None:
    """Update the heartbeat timestamp for a mailbox.

    Args:
        uid: Mailbox id to update.
    """
    ...

heartbeat_status async 

heartbeat_status(uid: EntityId) -> float | None

Get the last heartbeat timestamp of a mailbox.

Parameters:

  • uid (EntityId) –

    Mailbox id to check.

Returns:

  • float | None –

    Unix timestamp of the last heartbeat, or None if never recorded.

Source code in academy/exchange/cloud/backend.py 
238
239
240
241
242
243
244
245
246
247
async def heartbeat_status(self, uid: EntityId) -> float | None:
    """Get the last heartbeat timestamp of a mailbox.

    Args:
        uid: Mailbox id to check.

    Returns:
        Unix timestamp of the last heartbeat, or None if never recorded.
    """
    ...

PythonBackend 

PythonBackend(message_size_limit_kb: int = 1024)

Mailbox backend using in-memory python data structures.

Parameters:

  • message_size_limit_kb (int, default: 1024 ) –

    Maximum message size to allow.

Source code in academy/exchange/cloud/backend.py 
257
258
259
260
261
262
263
264
265
266
267
268
269
def __init__(
    self,
    message_size_limit_kb: int = 1024,
) -> None:
    self._owners: dict[EntityId, str | None] = {}
    self._shares: dict[EntityId, set[str]] = {}
    self._mailboxes: dict[EntityId, AsyncQueue[Message[Any]]] = {}
    self._terminated: set[EntityId] = set()
    self._agents: dict[AgentId[Any], tuple[str, ...]] = {}
    self._locks: dict[EntityId, asyncio.Lock] = {}
    self._requests: dict[EntityId, dict[uuid.UUID, Header]] = {}
    self.message_size_limit = message_size_limit_kb * KB_TO_BYTES
    self.last_active: dict[EntityId, float] = {}

check_mailbox async 

check_mailbox(
    client: ClientInfo, uid: EntityId
) -> MailboxStatus

Check if a mailbox exists, or is terminated.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to check.

Returns:

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
async def check_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> MailboxStatus:
    """Check if a mailbox exists, or is terminated.

    Args:
        client: Client making the request.
        uid: Mailbox id to check.

    Returns:
        The mailbox status.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    if uid not in self._mailboxes:
        return MailboxStatus.MISSING
    elif not self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    async with self._locks[uid]:
        if uid in self._terminated:
            return MailboxStatus.TERMINATED
        else:
            return MailboxStatus.ACTIVE

create_mailbox async 

create_mailbox(
    client: ClientInfo,
    uid: EntityId,
    agent: tuple[str, ...] | None = None,
) -> None

Create a mailbox is not exists.

This method should be idempotent.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to check.

  • agent (tuple[str, ...] | None, default: None ) –

    The agent_mro for behavior discovery.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
async def create_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
    agent: tuple[str, ...] | None = None,
) -> None:
    """Create a mailbox is not exists.

    This method should be idempotent.

    Args:
        client: Client making the request.
        uid: Mailbox id to check.
        agent: The agent_mro for behavior discovery.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    if not self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    mailbox = self._mailboxes.get(uid, None)
    if mailbox is None:
        if sys.version_info >= (3, 13):  # pragma: >=3.13 cover
            queue: AsyncQueue[Message[Any]] = Queue()
        else:  # pragma: <3.13 cover
            queue: AsyncQueue[Message[Any]] = Queue().async_q
        self._mailboxes[uid] = queue
        self._terminated.discard(uid)
        self._owners[uid] = client.client_id
        self._locks[uid] = asyncio.Lock()
        if agent is not None and isinstance(uid, AgentId):
            self._agents[uid] = agent
        logger.info(
            'Created mailbox for %s',
            uid,
            extra={'academy.mailbox_id': uid},
        )

terminate async 

terminate(client: ClientInfo, uid: EntityId) -> None

Close a mailbox.

For security, the manager should keep a gravestone so the same id cannot be re-registered.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to close.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
async def terminate(self, client: ClientInfo, uid: EntityId) -> None:
    """Close a mailbox.

    For security, the manager should keep a gravestone so the same id
    cannot be re-registered.

    Args:
        client: Client making the request.
        uid: Mailbox id to close.

    Raises:
        ForbiddenError: If the client does not have the right permissions.

    """
    if not self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    self._terminated.add(uid)
    mailbox = self._mailboxes.get(uid, None)
    if mailbox is None:
        return

    async def send(message: Message[Any]) -> None:
        await self.put(client, message)

    pending_requests: list[Header] | None = None
    async with self._locks[uid]:
        pending_requests = list(self._requests.pop(uid, {}).values())
        mailbox.shutdown(immediate=True)

    await _respond_pending_requests_on_terminate(
        pending_requests,
        send,
    )

update_heartbeat async 

update_heartbeat(uid: EntityId) -> None

Update the heartbeat timestamp for a mailbox.

Source code in academy/exchange/cloud/backend.py 
411
412
413
async def update_heartbeat(self, uid: EntityId) -> None:
    """Update the heartbeat timestamp for a mailbox."""
    self.last_active[uid] = time.time()

heartbeat_status async 

heartbeat_status(uid: EntityId) -> float | None

Get the last heartbeat timestamp for a mailbox.

Source code in academy/exchange/cloud/backend.py 
415
416
417
418
419
420
421
422
423
async def heartbeat_status(self, uid: EntityId) -> float | None:
    """Get the last heartbeat timestamp for a mailbox."""
    if uid not in self._mailboxes:
        raise BadEntityIdError(uid)

    if self.last_active.get(uid) is None:
        return None

    return time.time() - self.last_active[uid]

discover async 

discover(
    client: ClientInfo, agent: str, allow_subclasses: bool
) -> list[AgentId[Any]]

Find mailboxes of matching agent class.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • agent (str) –

    Agent class to search for.

  • allow_subclasses (bool) –

    Include agents that inherit from the target.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
async def discover(
    self,
    client: ClientInfo,
    agent: str,
    allow_subclasses: bool,
) -> list[AgentId[Any]]:
    """Find mailboxes of matching agent class.

    Args:
        client: Client making the request.
        agent: Agent class to search for.
        allow_subclasses: Include agents that inherit from the target.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    found: list[AgentId[Any]] = []
    for aid, agents in self._agents.items():
        if not self._has_permissions(client, aid):
            continue
        if aid in self._terminated:
            continue
        if agent == agents[0] or (allow_subclasses and agent in agents):
            found.append(aid)
    return found

get async 

get(
    client: ClientInfo,
    uid: EntityId,
    *,
    timeout: float | None = None
) -> Message[Any]

Get messages from a mailbox.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to get messages.

  • timeout (float | None, default: None ) –

    Time in seconds to wait for message. If None, wait indefinitely.

Raises:

Source code in academy/exchange/cloud/backend.py 
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
async def get(
    self,
    client: ClientInfo,
    uid: EntityId,
    *,
    timeout: float | None = None,
) -> Message[Any]:
    """Get messages from a mailbox.

    Args:
        client: Client making the request.
        uid: Mailbox id to get messages.
        timeout: Time in seconds to wait for message.
            If None, wait indefinitely.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
        TimeoutError: There was not message received during the timeout.
    """
    if not self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    try:
        queue = self._mailboxes[uid]
    except KeyError as e:
        raise BadEntityIdError(uid) from e
    try:
        return await asyncio.wait_for(queue.get(), timeout=timeout)
    except QueueShutDown:
        raise MailboxTerminatedError(uid) from None
    except asyncio.TimeoutError:
        # In Python 3.10 and older, asyncio.TimeoutError and TimeoutError
        # are different error types.
        raise TimeoutError(
            f'No message retrieved within {timeout} seconds.',
        ) from None

put async 

put(client: ClientInfo, message: Message[Any]) -> None

Put a message in a mailbox.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • message (Message[Any]) –

    Message to put in mailbox.

Raises:

Source code in academy/exchange/cloud/backend.py 
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
async def put(self, client: ClientInfo, message: Message[Any]) -> None:
    """Put a message in a mailbox.

    Args:
        client: Client making the request.
        message: Message to put in mailbox.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
        MessageTooLargeError: The message is larger than the message
            size limit for this exchange.
    """
    if not self._has_permissions(client, message.dest):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    if sys.getsizeof(message.body) > self.message_size_limit:
        raise MessageTooLargeError(
            sys.getsizeof(message.body),
            self.message_size_limit,
        )

    try:
        queue = self._mailboxes[message.dest]
    except KeyError as e:
        raise BadEntityIdError(message.dest) from e

    if message.is_request():
        self._requests.setdefault(message.dest, {})[message.tag] = (
            message.header
        )
        logger.debug(
            'Tracking in-flight request: tag=%s src=%s dest=%s',
            message.tag,
            message.src,
            message.dest,
            extra={
                'academy.message_tag': message.tag,
                'academy.src': message.src,
                'academy.dest': message.dest,
            },
        )
    elif (
        message.src in self._requests
        and message.tag in self._requests[message.src]
    ):
        request_msg = self._requests[message.src].pop(message.tag)
        if not self._requests[message.src]:
            del self._requests[message.src]
        logger.debug(
            'Response received for in-flight request: '
            'tag=%s src=%s dest=%s',
            request_msg.tag,
            request_msg.src,
            request_msg.dest,
            extra={
                'academy.message_tag': request_msg.tag,
                'academy.src': request_msg.src,
                'academy.dest': request_msg.dest,
            },
        )
    else:
        logger.warning(
            'Response received without corresponding request: '
            'tag=%s src=%s dest=%s',
            message.tag,
            message.src,
            message.dest,
            extra={
                'academy.message_tag': message.tag,
                'academy.src': message.src,
                'academy.dest': message.dest,
            },
        )

    async with self._locks[message.dest]:
        try:
            await queue.put(message)
        except QueueShutDown:
            raise MailboxTerminatedError(message.dest) from None

share_mailbox async 

share_mailbox(
    client: ClientInfo, uid: EntityId, group_uid: str
) -> None

Share a mailbox with a Globus group.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Target Mailbox for sharing

  • group_uid (str) –

    Group id to share mailbox with.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
async def share_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
    group_uid: str,
) -> None:
    """Share a mailbox with a Globus group.

    Args:
        client: Client making the request.
        uid: Target Mailbox for sharing
        group_uid: Group id to share mailbox with.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    if uid not in self._mailboxes:
        raise BadEntityIdError(uid)

    if uid in self._terminated:
        raise MailboxTerminatedError(uid)

    if not self._has_mailbox_ownership(client, uid):
        raise ForbiddenError(
            f'{client.client_id} cannot share mailbox '
            f'{uid} it does not own.',
        )

    if group_uid not in client.group_memberships:
        raise ForbiddenError(
            f'Owner does not belong to the group {group_uid}',
        )

    if uid not in self._shares:
        self._shares[uid] = set()

    self._shares[uid].add(group_uid)

get_mailbox_shares async 

get_mailbox_shares(
    client: ClientInfo, uid: EntityId
) -> list[str]

Get list of globus groups the mailbox is shared with.

Only the owner of the Mailbox is allowed to share with a Globus Group. This method should be idempotent.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to share.

Returns:

  • list[str] –

    List of globus groups id strings

Raises:

Source code in academy/exchange/cloud/backend.py 
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
async def get_mailbox_shares(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> list[str]:
    """Get list of globus groups the mailbox is shared with.

    Only the owner of the Mailbox is allowed to share with a Globus Group.
    This method should be idempotent.

    Args:
        client: Client making the request.
        uid: Mailbox id to share.

    Returns:
        List of globus groups id strings

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
    """
    if uid not in self._mailboxes:
        raise BadEntityIdError(uid)

    if uid in self._terminated:
        raise MailboxTerminatedError(uid)

    if not self._has_mailbox_ownership(client, uid):
        raise ForbiddenError(
            'Viewing shared groups requires ownership',
        )

    return list(self._shares.get(uid, set()))

remove_mailbox_shares async 

remove_mailbox_shares(
    client: ClientInfo, uid: EntityId, group_uid: str
) -> None

Stop sharing a mailbox with a group.

Only the owner of the Mailbox is allowed to share with a Globus Group. This method should be idempotent (removing a group that the mailbox is not shared with is a no-op).

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to share.

  • group_uid (str) –

    Globus Group id to remove.

Raises:

Source code in academy/exchange/cloud/backend.py 
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
async def remove_mailbox_shares(
    self,
    client: ClientInfo,
    uid: EntityId,
    group_uid: str,
) -> None:
    """Stop sharing a mailbox with a group.

    Only the owner of the Mailbox is allowed to share with a Globus Group.
    This method should be idempotent (removing a group that the mailbox
    is not shared with is a no-op).

    Args:
        client: Client making the request.
        uid: Mailbox id to share.
        group_uid: Globus Group id to remove.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox to share does not exist.
        MailboxTerminatedError: The mailbox is closed.
    """
    ...

    if uid not in self._mailboxes:
        raise BadEntityIdError(uid)

    if uid in self._terminated:
        raise MailboxTerminatedError(uid)

    if not self._has_mailbox_ownership(client, uid):
        raise ForbiddenError(
            f'{client.client_id} cannot change permissions on'
            f'mailbox {uid} it does not own.',
        )

    self._shares[uid].discard(group_uid)
    logger.info('Group %s removed from mailbox %s', group_uid, uid)

RedisBackend 

RedisBackend(
    hostname: str = "localhost",
    port: int = 6379,
    *,
    message_size_limit_kb: int = 1024,
    kwargs: dict[str, Any] | None = None,
    mailbox_expiration_s: int | None = None,
    gravestone_expiration_s: int | None = None
)

Redis backend of mailboxes.

Parameters:

  • hostname (str, default: 'localhost' ) –

    Host address of redis.

  • port (int, default: 6379 ) –

    Redis port.

  • message_size_limit_kb (int, default: 1024 ) –

    Maximum message size to allow.

  • kwargs (dict[str, Any] | None, default: None ) –

    Addition arguments to pass to redis session.

Source code in academy/exchange/cloud/backend.py 
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
def __init__(  # noqa: PLR0913
    self,
    hostname: str = 'localhost',
    port: int = 6379,
    *,
    message_size_limit_kb: int = 1024,
    kwargs: dict[str, Any] | None = None,
    mailbox_expiration_s: int | None = None,
    gravestone_expiration_s: int | None = None,
) -> None:
    self.message_size_limit = message_size_limit_kb * KB_TO_BYTES

    if kwargs is None:  # pragma: no branch
        kwargs = {}

    self._client = redis.asyncio.Redis(
        host=hostname,
        port=port,
        decode_responses=False,
        **kwargs,
    )
    self.mailbox_expiration_s = mailbox_expiration_s
    self.gravestone_expiration_s = gravestone_expiration_s

check_mailbox async 

check_mailbox(
    client: ClientInfo, uid: EntityId
) -> MailboxStatus

Check if a mailbox exists, or is terminated.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to check.

Returns:

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
async def check_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> MailboxStatus:
    """Check if a mailbox exists, or is terminated.

    Args:
        client: Client making the request.
        uid: Mailbox id to check.

    Returns:
        The mailbox status.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    if not await self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    status = await self._client.get(self._active_key(uid))
    if status is None:
        return MailboxStatus.MISSING
    elif status.decode() == MailboxStatus.TERMINATED.value:
        return MailboxStatus.TERMINATED
    else:
        return MailboxStatus.ACTIVE

create_mailbox async 

create_mailbox(
    client: ClientInfo,
    uid: EntityId,
    agent: tuple[str, ...] | None = None,
) -> None

Create a mailbox is not exists.

This method should be idempotent.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to check.

  • agent (tuple[str, ...] | None, default: None ) –

    The agent_mro for behavior discovery.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
async def create_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
    agent: tuple[str, ...] | None = None,
) -> None:
    """Create a mailbox is not exists.

    This method should be idempotent.

    Args:
        client: Client making the request.
        uid: Mailbox id to check.
        agent: The agent_mro for behavior discovery.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    if not await self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    await self._client.set(
        self._active_key(uid),
        MailboxStatus.ACTIVE.value,
    )

    if agent is not None:
        await self._client.set(
            self._agent_key(uid),
            ','.join(agent),
        )

    await self._client.set(
        self._owner_key(uid),
        f'{client.client_id}{_OWNER_SUFFIX}',
    )
    await self._update_expirations(uid)

terminate async 

terminate(client: ClientInfo, uid: EntityId) -> None

Close a mailbox.

For security, the manager should keep a gravestone so the same id cannot be re-registered.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to close.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
async def terminate(self, client: ClientInfo, uid: EntityId) -> None:
    """Close a mailbox.

    For security, the manager should keep a gravestone so the same id
    cannot be re-registered.

    Args:
        client: Client making the request.
        uid: Mailbox id to close.

    Raises:
        ForbiddenError: If the client does not have the right permissions.

    """
    if not await self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    status = await self.check_mailbox(client, uid)

    if status in {MailboxStatus.MISSING, MailboxStatus.TERMINATED}:
        return

    await self._client.set(
        self._active_key(uid),
        MailboxStatus.TERMINATED.value,
    )

    if self.gravestone_expiration_s is not None:
        await self._client.expire(
            self._active_key(uid),
            self.gravestone_expiration_s,
        )

    await self._client.delete(self._queue_key(uid))
    # Sending a close sentinel to the queue is a quick way to force
    # the entity waiting on messages to the mailbox to stop blocking.
    # This assumes that only one entity is reading from the mailbox.
    await self._client.rpush(self._queue_key(uid), _CLOSE_SENTINEL)  # type: ignore[misc]
    if isinstance(uid, AgentId):
        await self._client.delete(self._agent_key(uid))

    req_keys = [
        key
        async for key in self._client.scan_iter(
            f'request:{uid.uid}:*',
            count=1000,
        )
    ]
    pending_requests: list[Header] = []
    for req_key in req_keys:
        data = await self._client.get(req_key)
        pending_requests.append(Header.model_validate_json(data.decode()))
        await self._client.delete(req_key)

    async def send(message: Message[Any]) -> None:
        await self.put(client, message)

    await _respond_pending_requests_on_terminate(
        pending_requests,
        send,
    )

update_heartbeat async 

update_heartbeat(uid: EntityId) -> None

Update the heartbeat timestamp for a mailbox.

Source code in academy/exchange/cloud/backend.py 
956
957
958
959
960
961
async def update_heartbeat(self, uid: EntityId) -> None:
    """Update the heartbeat timestamp for a mailbox."""
    now = await self._redis_current_time()

    await self._client.set(self._heartbeat_key(uid), str(now))
    await self._update_expirations(uid)

heartbeat_status async 

heartbeat_status(uid: EntityId) -> float | None

Get the time since last heartbeat timestamp for a mailbox.

Source code in academy/exchange/cloud/backend.py 
963
964
965
966
967
968
969
970
971
972
973
974
975
976
async def heartbeat_status(self, uid: EntityId) -> float | None:
    """Get the time since last heartbeat timestamp for a mailbox."""
    status = await self._client.get(self._active_key(uid))
    if status is None:
        raise BadEntityIdError(uid)

    heartbeat_time = await self._client.get(self._heartbeat_key(uid))

    if heartbeat_time is None:
        return None

    now = await self._redis_current_time()

    return now - float(heartbeat_time.decode())

discover async 

discover(
    client: ClientInfo, agent: str, allow_subclasses: bool
) -> list[AgentId[Any]]

Find mailboxes of matching agent class.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • agent (str) –

    Agent class to search for.

  • allow_subclasses (bool) –

    Include agents that inherit from the target.

Source code in academy/exchange/cloud/backend.py 
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
async def discover(
    self,
    client: ClientInfo,
    agent: str,
    allow_subclasses: bool,
) -> list[AgentId[Any]]:
    """Find mailboxes of matching agent class.

    Args:
        client: Client making the request.
        agent: Agent class to search for.
        allow_subclasses: Include agents that inherit from the target.
    """
    found: list[AgentId[Any]] = []
    async for key in self._client.scan_iter(
        'agent:*',
        count=1000,
    ):  # pragma: no branch
        mro_str = (await self._client.get(key)).decode()
        assert isinstance(mro_str, str)
        mro = mro_str.split(',')
        if agent == mro[0] or (allow_subclasses and agent in mro):
            aid: AgentId[Any] = AgentId(
                uid=uuid.UUID(key.decode().split(':')[-1]),
            )
            found.append(aid)

    active: list[AgentId[Any]] = []
    for aid in found:
        if await self._has_permissions(client, aid):
            status = await self._client.get(self._active_key(aid))
            if (
                status.decode() == MailboxStatus.ACTIVE.value
            ):  # pragma: no branch
                active.append(aid)

    return active

get async 

get(
    client: ClientInfo,
    uid: EntityId,
    *,
    timeout: float | None = None
) -> Message[Any]

Get messages from a mailbox.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to get messages.

  • timeout (float | None, default: None ) –

    Time in seconds to wait for message. If None, wait indefinitely.

Raises:

Source code in academy/exchange/cloud/backend.py 
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
async def get(
    self,
    client: ClientInfo,
    uid: EntityId,
    *,
    timeout: float | None = None,
) -> Message[Any]:
    """Get messages from a mailbox.

    Args:
        client: Client making the request.
        uid: Mailbox id to get messages.
        timeout: Time in seconds to wait for message.
            If None, wait indefinitely.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
        TimeoutError: There was not message received during the timeout.
    """
    if not await self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    _timeout = timeout if timeout is not None else 0
    status = await self._client.get(
        self._active_key(uid),
    )
    if status is None:
        raise BadEntityIdError(uid)
    elif status.decode() == MailboxStatus.TERMINATED.value:
        raise MailboxTerminatedError(uid)

    await self._update_expirations(uid)
    if self.mailbox_expiration_s:
        await self._client.expire(
            self._queue_key(uid),
            self.mailbox_expiration_s,
        )

    raw = await self._client.blpop(  # type: ignore[misc]
        [self._queue_key(uid)],
        timeout=_timeout,
    )
    if raw is None:
        raise TimeoutError(
            f'Timeout waiting for next message for {uid} '
            f'after {timeout} seconds.',
        )

    # Only passed one key to blpop to result is [key, item]
    assert len(raw) == 2  # noqa: PLR2004
    if raw[1] == _CLOSE_SENTINEL:  # pragma: no cover
        raise MailboxTerminatedError(uid)
    return Message.model_deserialize(raw[1])

put async 

put(client: ClientInfo, message: Message[Any]) -> None

Put a message in a mailbox.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • message (Message[Any]) –

    Message to put in mailbox.

Raises:

Source code in academy/exchange/cloud/backend.py 
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
async def put(self, client: ClientInfo, message: Message[Any]) -> None:
    """Put a message in a mailbox.

    Args:
        client: Client making the request.
        message: Message to put in mailbox.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
        MessageTooLargeError: The message is larger than the message
            size limit for this exchange.
    """
    if not await self._has_permissions(client, message.dest):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    status = await self._client.get(self._active_key(message.dest))
    if status is None:
        raise BadEntityIdError(message.dest)
    elif status.decode() == MailboxStatus.TERMINATED.value:
        raise MailboxTerminatedError(message.dest)

    serialized = message.model_serialize()
    if len(serialized) > self.message_size_limit:
        raise MessageTooLargeError(
            len(serialized),
            self.message_size_limit,
        )

    if message.is_request():
        await self._client.set(
            self._request_key(message.dest, message.tag),
            message.header.model_dump_json(),
        )
        if self.mailbox_expiration_s:
            await self._client.expire(
                self._request_key(message.dest, message.tag),
                self.mailbox_expiration_s,
            )
        logger.debug(
            'Tracking in-flight request: tag=%s src=%s dest=%s',
            message.tag,
            message.src,
            message.dest,
            extra={
                'academy.message_tag': message.tag,
                'academy.src': message.src,
                'academy.dest': message.dest,
            },
        )
    elif await self._client.exists(
        self._request_key(message.src, message.tag),
    ):
        matching_data = await self._client.get(
            self._request_key(message.src, message.tag),
        )
        matching: Header = Header.model_validate_json(
            matching_data.decode(),
        )
        await self._client.delete(
            self._request_key(message.src, message.tag),
        )
        logger.debug(
            'Response received for in-flight request: '
            'tag=%s src=%s dest=%s',
            matching.tag,
            matching.src,
            matching.dest,
            extra={
                'academy.message_tag': matching.tag,
                'academy.src': matching.src,
                'academy.dest': matching.dest,
            },
        )
    else:
        logger.warning(
            'Response received without corresponding request: '
            'tag=%s src=%s dest=%s',
            message.tag,
            message.src,
            message.dest,
            extra={
                'academy.message_tag': message.tag,
                'academy.src': message.src,
                'academy.dest': message.dest,
            },
        )

    await self._client.rpush(  # type: ignore[misc]
        self._queue_key(message.dest),
        serialized,
    )

    if self.mailbox_expiration_s:
        await self._client.expire(
            self._queue_key(message.dest),
            self.mailbox_expiration_s,
            nx=True,
        )

share_mailbox async 

share_mailbox(
    client: ClientInfo, uid: EntityId, group_uid: str
) -> None

Share a mailbox with a Globus group.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • group_uid (str) –

    Group id to share mailbox with.

  • uid (EntityId) –

    Target Mailbox for sharing

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
async def share_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
    group_uid: str,
) -> None:
    """Share a mailbox with a Globus group.

    Args:
         client: Client making the request.
         group_uid: Group id to share mailbox with.
         uid: Target Mailbox for sharing

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    status = await self._client.get(self._active_key(uid))
    if status is None:
        raise BadEntityIdError(uid)
    elif status.decode() == MailboxStatus.TERMINATED.value:
        raise MailboxTerminatedError(uid)

    if not await self._has_mailbox_ownership(client, uid):
        raise ForbiddenError(
            f'{client.client_id} cannot share mailbox '
            f'{uid} it does not own.',
        )
    if group_uid not in client.group_memberships:
        raise ForbiddenError(
            f'Owner does not belong to the group {group_uid}',
        )

    await self._client.sadd(self._share_key(uid), group_uid)  # type: ignore[misc]

get_mailbox_shares async 

get_mailbox_shares(
    client: ClientInfo, uid: EntityId
) -> list[str]

Get list of globus groups the mailbox is shared with.

Only the owner of the Mailbox is allowed to share with a Globus Group. This method should be idempotent.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to share.

Returns:

  • list[str] –

    List of globus groups id strings

Raises:

Source code in academy/exchange/cloud/backend.py 
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
async def get_mailbox_shares(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> list[str]:
    """Get list of globus groups the mailbox is shared with.

    Only the owner of the Mailbox is allowed to share with a Globus Group.
    This method should be idempotent.

    Args:
        client: Client making the request.
        uid: Mailbox id to share.

    Returns:
        List of globus groups id strings

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
    """
    status = await self._client.get(self._active_key(uid))
    if status is None:
        raise BadEntityIdError(uid)
    elif status.decode() == MailboxStatus.TERMINATED.value:
        raise MailboxTerminatedError(uid)

    if not await self._has_mailbox_ownership(client, uid):
        raise ForbiddenError(
            'Viewing shared groups requires ownership',
        )

    _groups = await self._client.smembers(self._share_key(uid))  # type: ignore[misc]
    groups = [g.decode() for g in _groups]
    return groups

remove_mailbox_shares async 

remove_mailbox_shares(
    client: ClientInfo, uid: EntityId, group_uid: str
) -> None

Stop sharing a mailbox with a group.

Only the owner of the Mailbox is allowed to share with a Globus Group. This method should be idempotent (removing a group that the mailbox is not shared with is a no-op).

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to share.

  • group_uid (str) –

    Globus Group id to remove.

Raises:

Source code in academy/exchange/cloud/backend.py 
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
async def remove_mailbox_shares(
    self,
    client: ClientInfo,
    uid: EntityId,
    group_uid: str,
) -> None:
    """Stop sharing a mailbox with a group.

    Only the owner of the Mailbox is allowed to share with a Globus Group.
    This method should be idempotent (removing a group that the mailbox
    is not shared with is a no-op).

    Args:
        client: Client making the request.
        uid: Mailbox id to share.
        group_uid: Globus Group id to remove.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox to share does not exist.
        MailboxTerminatedError: The mailbox is closed.
    """
    status = await self._client.get(self._active_key(uid))
    if status is None:
        raise BadEntityIdError(uid)
    elif status.decode() == MailboxStatus.TERMINATED.value:
        raise MailboxTerminatedError(uid)

    if not await self._has_mailbox_ownership(client, uid):
        raise ForbiddenError(
            f'{client.client_id} cannot change permissions on'
            f'mailbox {uid} it does not own.',
        )

    await self._client.srem(self._share_key(uid), group_uid)  # type: ignore[misc]