File: router_job_crud_ops.py

package info (click to toggle)
python-azure 20250603%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 851,724 kB
  • sloc: python: 7,362,925; ansic: 804; javascript: 287; makefile: 195; sh: 145; xml: 109
file content (439 lines) | stat: -rw-r--r-- 16,870 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
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
332
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
373
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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------

"""
FILE: router_job_crud_ops.py
DESCRIPTION:
    These samples demonstrates how to create Job used in ACS JobRouter.
    You need a valid connection string to an Azure Communication Service to execute the sample

USAGE:
    python router_job_crud_ops.py
    Set the environment variables with your own values before running the sample:
    1) AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING - Communication Service connection string
"""

from datetime import datetime, timedelta
import os
import time


class RouterJobSamples(object):
    connection_string = os.environ["AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING"]

    _job_id = "sample_job"
    _job_w_cp_id = "sample_job_w_cp"
    _job_scheduled_id = "sample_scheduled_job"
    _assignment_id = "sample_assignment"
    _distribution_policy_id = "sample_distribution_policy"
    _classification_policy_id = "sample_classification_policy"
    _queue_id = "sample_queue"
    _worker_id = "sample_worker"

    def setup_distribution_policy(self):
        connection_string = self.connection_string
        distribution_policy_id = self._distribution_policy_id
        from azure.communication.jobrouter import JobRouterAdministrationClient
        from azure.communication.jobrouter.models import LongestIdleMode, DistributionPolicy

        router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str=connection_string)
        print("JobRouterAdministrationClient created successfully!")

        dist_policy = router_admin_client.upsert_distribution_policy(
            distribution_policy_id,
            DistributionPolicy(
                offer_expires_after_seconds=10 * 60,
                mode=LongestIdleMode(min_concurrent_offers=1, max_concurrent_offers=1),
            ),
        )

    def setup_queue(self):
        connection_string = self.connection_string
        queue_id = self._queue_id
        from azure.communication.jobrouter import JobRouterAdministrationClient
        from azure.communication.jobrouter.models import RouterQueue

        router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str=connection_string)

        job_queue: RouterQueue = router_admin_client.upsert_queue(
            queue_id, RouterQueue(distribution_policy_id=self._distribution_policy_id)
        )

    def setup_classification_policy(self):
        connection_string = self.connection_string
        classification_policy_id = self._classification_policy_id

        from azure.communication.jobrouter import (
            JobRouterAdministrationClient,
        )
        from azure.communication.jobrouter.models import (
            StaticRouterRule,
            StaticQueueSelectorAttachment,
            RouterQueueSelector,
            LabelOperator,
            ClassificationPolicy,
        )

        router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str=connection_string)
        print("JobRouterAdministrationClient created successfully!")

        classification_policy = router_admin_client.upsert_classification_policy(
            classification_policy_id,
            ClassificationPolicy(
                prioritization_rule=StaticRouterRule(value=10),
                queue_selector_attachments=[
                    StaticQueueSelectorAttachment(
                        queue_selector=RouterQueueSelector(
                            key="Id", label_operator=LabelOperator.EQUAL, value=self._queue_id
                        )
                    )
                ],
            ),
        )

    def setup_worker(self):
        connection_string = self.connection_string
        worker_id = self._worker_id
        queue_id = self._queue_id

        from azure.communication.jobrouter import JobRouterClient
        from azure.communication.jobrouter.models import RouterChannel, RouterWorker

        router_client = JobRouterClient.from_connection_string(conn_str=connection_string)
        router_worker = router_client.upsert_worker(
            worker_id,
            RouterWorker(
                capacity=100,
                available_for_offers=True,
                channels=[RouterChannel(channel_id="general", capacity_cost_per_job=0)],
                queues=[queue_id],
            ),
        )

    def create_job(self):
        connection_string = self.connection_string
        job_id = self._job_id
        job_w_cp_id = self._job_w_cp_id
        scheduled_job_id = self._job_scheduled_id
        queue_id = self._queue_id
        classification_policy_id = self._classification_policy_id

        # [START create_job]
        from datetime import datetime, timedelta
        from azure.communication.jobrouter import JobRouterClient
        from azure.communication.jobrouter.models import RouterJob, ScheduleAndSuspendMode

        # set `connection_string` to an existing ACS endpoint
        router_client = JobRouterClient.from_connection_string(conn_str=connection_string)
        print("JobRouterAdministrationClient created successfully!")

        # We need to create a distribution policy + queue as a pre-requisite to start creating job
        router_job = router_client.upsert_job(
            job_id,
            RouterJob(channel_id="general", queue_id=queue_id, priority=10, channel_reference="12345"),
        )

        print(f"Job has been successfully created with status: {router_job.status}")

        # Alternatively, a job can also be created while specifying a classification policy
        # As a pre-requisite, we would need to create a classification policy first
        router_job_with_cp = router_client.upsert_job(
            job_w_cp_id,
            RouterJob(
                channel_id="general", classification_policy_id=classification_policy_id, channel_reference="12345"
            ),
        )
        print(f"Job has been successfully created with status: {router_job_with_cp.status}")

        # Additionally, any job can be created as a scheduled job
        # by simply specifying a scheduled_time_utc and setting unavailable_for_matching to true
        router_scheduled_job = router_client.upsert_job(
            scheduled_job_id,
            RouterJob(
                channel_id="general",
                queue_id=queue_id,
                priority=10,
                channel_reference="12345",
                matching_mode=ScheduleAndSuspendMode(schedule_at=datetime.utcnow() + timedelta(0, 30)),
            ),
        )
        print(f"Scheduled job has been successfully created with status: {router_scheduled_job.status}")

        # [END create_job]

    def update_job(self):
        connection_string = self.connection_string
        job_id = self._job_id
        # [START update_job]
        from azure.communication.jobrouter import (
            JobRouterClient,
        )

        # set `connection_string` to an existing ACS endpoint
        router_client: JobRouterClient = JobRouterClient.from_connection_string(conn_str=connection_string)
        print("JobRouterAdministrationClient created successfully!")

        update_job = router_client.upsert_job(job_id, channel_reference="45678")

        print(f"Job has been successfully update with channel reference: {update_job.channel_reference}")
        # [END update_job]

    def get_job(self):
        connection_string = self.connection_string
        job_id = self._job_id
        # [START get_job]
        from azure.communication.jobrouter import JobRouterClient

        router_client = JobRouterClient.from_connection_string(conn_str=connection_string)

        router_job = router_client.get_job(job_id)

        print(f"Successfully fetched router worker with id: {router_job.id}")
        # [END get_job]

    def get_job_position(self):
        connection_string = self.connection_string
        job_id = self._job_id
        # [START get_job_position]
        from azure.communication.jobrouter import JobRouterClient

        router_client = JobRouterClient.from_connection_string(conn_str=connection_string)

        router_job_position = router_client.get_queue_position(job_id)

        print(f"Successfully fetched router job position: {router_job_position.position}")
        # [END get_job_position]

    def reclassify_job(self):
        connection_string = self.connection_string
        job_id = self._job_w_cp_id
        # [START reclassify_job]
        from azure.communication.jobrouter import JobRouterClient

        router_client = JobRouterClient.from_connection_string(conn_str=connection_string)

        router_client.reclassify_job(job_id)

        print(f"Successfully re-classified job")
        # [END reclassify_job]

    def unassign_job(self):
        connection_string = self.connection_string
        job_id = self._job_w_cp_id
        assignment_id = self._assignment_id
        # [START unassign_job]
        from azure.communication.jobrouter import JobRouterClient

        router_client = JobRouterClient.from_connection_string(conn_str=connection_string)

        unassign_job_result = router_client.unassign_job(job_id, assignment_id)

        print(f"Successfully unassigned job")
        # [END unassign_job]

    def accept_job_offer(self):
        connection_string = self.connection_string
        job_id = self._job_id
        worker_id = self._worker_id

        from azure.communication.jobrouter import JobRouterClient
        from azure.communication.jobrouter.models import RouterJobOffer

        router_client = JobRouterClient.from_connection_string(conn_str=connection_string)

        offer_found = False
        while not offer_found:
            worker = router_client.get_worker(worker_id=worker_id)
            if worker.offers and any(worker.offers):
                for offer in worker.offers:
                    offer_found = True if offer.job_id == job_id else False

            if offer_found is False:
                time.sleep(1)

        queried_worker = router_client.get_worker(worker_id=worker_id)
        issued_offer: RouterJobOffer = [offer for offer in queried_worker.offers if offer.job_id == job_id][0]
        offer_id = issued_offer.offer_id

        # [START accept_job_offer]
        from azure.communication.jobrouter.models import RouterJob, AcceptJobOfferResult

        accept_job_offer_result: AcceptJobOfferResult = router_client.accept_job_offer(
            worker_id=worker_id, offer_id=offer_id
        )

        queried_job: RouterJob = router_client.get_job(job_id)

        print(f"Job has been successfully assigned to worker. Current job status: {queried_job.status}")
        print(
            f"Job has been successfully assigned with a worker with assignment "
            f"id: {accept_job_offer_result.assignment_id}"
        )
        # [END accept_job_offer]

        try:
            # [START decline_job_offer]
            from datetime import datetime, timedelta
            from azure.communication.jobrouter.models import DeclineJobOfferOptions

            router_client.decline_job_offer(
                worker_id,
                offer_id,
                DeclineJobOfferOptions(
                    retry_offer_at=datetime.utcnow() + timedelta(0, 30),  # re-offer after 30 secs
                ),
            )
            # [END decline_job_offer]
        except Exception:
            print(f"Error encountered")

    def complete_and_close_job(self):
        connection_string = self.connection_string
        job_id = self._job_id

        # [START complete_job]
        from azure.communication.jobrouter import JobRouterClient
        from azure.communication.jobrouter.models import (
            RouterJob,
            CompleteJobOptions,
        )

        router_client = JobRouterClient.from_connection_string(conn_str=connection_string)

        queried_job: RouterJob = router_client.get_job(job_id)

        assignment_id = [k for k, v in queried_job.assignments.items()][0]

        router_client.complete_job(job_id, assignment_id, CompleteJobOptions(note="Complete job"))

        queried_job: RouterJob = router_client.get_job(job_id)

        print(f"Job has been successfully completed. Current status: {queried_job.status}")
        # [END complete_job]

        # [START close_job]
        from azure.communication.jobrouter.models import RouterJob, CloseJobOptions

        router_client.close_job(job_id, assignment_id, CloseJobOptions(note="Close job"))

        queried_job: RouterJob = router_client.get_job(job_id)

        print(f"Job has been successfully closed. Current status: {queried_job.status}")

        # [END close_job]

    def list_jobs(self):
        connection_string = self.connection_string
        # [START list_jobs]
        from azure.communication.jobrouter import JobRouterClient

        router_client = JobRouterClient.from_connection_string(conn_str=connection_string)

        router_job_iterator = router_client.list_jobs()

        for j in router_job_iterator:
            print(f"Retrieved job with id: {j.id}")

        print(f"Successfully completed fetching jobs")
        # [END list_jobs]

    def list_jobs_batched(self):
        connection_string = self.connection_string
        # [START list_jobs_batched]
        from azure.communication.jobrouter import JobRouterClient

        router_client = JobRouterClient.from_connection_string(conn_str=connection_string)

        router_job_iterator = router_client.list_jobs(results_per_page=10)

        for job_page in router_job_iterator.by_page():
            jobs_in_page = list(job_page)
            print(f"Retrieved {len(jobs_in_page)} jobs in current page")

            for j in jobs_in_page:
                print(f"Retrieved job with id: {j.id}")

        print(f"Successfully completed fetching jobs")
        # [END list_jobs_batched]

    def list_scheduled_jobs(self):
        connection_string = self.connection_string
        # [START list_scheduled_jobs]
        from datetime import datetime
        from azure.communication.jobrouter import JobRouterClient

        router_client = JobRouterClient.from_connection_string(conn_str=connection_string)

        scheduled_before = datetime.utcnow()

        router_job_iterator = router_client.list_jobs(scheduled_before=scheduled_before, results_per_page=10)

        for job_page in router_job_iterator.by_page():
            jobs_in_page = list(job_page)
            print(f"Retrieved {len(jobs_in_page)} jobs in current page")

            for j in jobs_in_page:
                print(f"Retrieved job with id: {j.id}")

        print(f"Successfully completed fetching scheduled jobs")
        # [END list_scheduled_jobs]

    def cancel_job(self):
        connection_string = self.connection_string
        job_id = self._job_w_cp_id

        # [START cancel_job]
        from azure.communication.jobrouter import JobRouterClient

        router_client = JobRouterClient.from_connection_string(conn_str=connection_string)

        router_client.cancel_job(job_id)

        # [END cancel_job]

    def clean_up(self):
        connection_string = self.connection_string
        job_id = self._job_id

        # [START delete_job]
        from azure.communication.jobrouter import JobRouterClient

        router_client = JobRouterClient.from_connection_string(conn_str=connection_string)

        router_client.delete_job(job_id)

        # [END delete_job]
        router_client.cancel_job(self._job_w_cp_id)
        router_client.delete_job(self._job_w_cp_id)
        router_client.cancel_job(self._job_scheduled_id)
        router_client.delete_job(self._job_scheduled_id)
        router_client.delete_worker(self._worker_id)

        from azure.communication.jobrouter import JobRouterAdministrationClient

        router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str=connection_string)
        router_admin_client.delete_classification_policy(self._classification_policy_id)
        router_admin_client.delete_queue(self._queue_id)
        router_admin_client.delete_distribution_policy(self._distribution_policy_id)


if __name__ == "__main__":
    sample = RouterJobSamples()
    sample.setup_distribution_policy()
    sample.setup_queue()
    sample.setup_classification_policy()
    sample.setup_worker()
    sample.create_job()
    sample.get_job()
    sample.update_job()
    sample.reclassify_job()
    sample.get_job_position()
    sample.accept_job_offer()
    sample.complete_and_close_job()
    sample.list_jobs()
    sample.list_jobs_batched()
    sample.list_scheduled_jobs()
    sample.clean_up()