U ڲg'K@sbdZddlmZddlmZmZddlmZddlZddlZddl m Z ddl m Z m Z mZddlmZdd lmZddlZddlZdd lmZdd lmZdd lmZd ZddgZdZdeZdZddejdZ dZ!ddddZ"d*dddddd dZ#Gd!ddZ$Gd"ddZ%Gd#d$d$Z&eGd%ddZ'eGd&d'd'Z(eGd(d)d)Z)dS)+zFirebase Functions module.) annotations)datetime timedelta)parseN) b64encode)AnyOptionalDict) dataclass) Credentials)App) _http_client)_utilsZ _functions TaskOptions task_queuezHprojects/{project_id}/locations/{location_id}/queues/{resource_id}/tasksz%https://cloudtasks.googleapis.com/v2/zChttps://{location_id}-{project_id}.cloudfunctions.net/{resource_id}2zfire-admin-python/{0})zX-GOOG-API-FORMAT-VERSIONzX-FIREBASE-CLIENTz us-central1_FunctionsService)returncCst|ttS)N)rZget_app_service_FUNCTIONS_ATTRIBUTErappr service_urlZ task_payloadrespZ task_nameZ task_resourcer(rrrenqueues  zTaskQueue.enqueue)task_idrc Csptd|||jtd|}z|jjd|tdWn0tj j k rj}zt |W5d}~XYnXdS)aDeletes an enqueued task if it has not yet started. This action requires `cloudtasks.tasks.delete` IAM permission on the service account. Args: task_id: The ID of the task relative to this queue. Raises: FirebaseError: If an error occurs while requesting the task to be deleted by the Cloud Functions service. ValueError: If the input arguments are invalid. rQ/delete)r?r@N) r2r3rDr6rEr rGrHrKrLrMrr*)r%rQrNr(rrrrSs  zTaskQueue.deleteResource) resource_nameresource_id_keyrcCsTd|krt|dSd|d}t||}|dkr:tdt|d|d|d d S) z;Parses a full or partial resource path into a ``Resource``.rR)r9z'^(projects/([^/]+)/)?locations/([^/]+)/z /([^/]+)$NzInvalid resource name format.r r7r9)rTresearchr")r%rUrVregmatchrrrr5s   zTaskQueue._parse_resource_name)resource url_formatrcCs|j|j|j|jdS)z=Generates url path from a ``Resource`` and url format string.rZ)formatr r7r9)r%r_r`rrrrDs zTaskQueue._get_urlTask)datar_r<rcCsddditt|ddid}t|d}|dk r|jdk r\|jd|j|jd<|jdk rx|j dk rxt d |jdk r|j dkrt |jt st d |j d |_|j dk r|jdkrt |j tr|j d krt d t t|j d}| d |_|jdk rLt |jtr6|jdks6|jdkr>t d|jd|_|jdk rt|jsnt d||td|j|_|jdk rt|jst d|j|jd<|S)z9Validate and create a Task from optional ``TaskOptions``.service_account_emailz Content-Typezapplication/json)r? oidc_tokenrGr@) http_requestNr@zMBoth sechdule_delay_seconds and schedule_time cannot be set at the same time.z%schedule_time should be UTC datetime.z%Y-%m-%dT%H:%M:%S.%fZrz.schedule_delay_seconds should be positive int.)secondsizOdispatch_deadline_seconds should be int in the range of 15s to 1800s (30 mins).sztask_id can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.rRzFuri must be a valid RFC3986 URI string using the https or http schema.r?)rrAdumpsencodedecoderbr@rg schedule_timeschedule_delay_secondsr" isinstancerstrftimeintutcnowrdispatch_deadline_secondsdispatch_deadlinerQr2 is_task_idrD_CLOUD_TASKS_API_RESOURCE_PATHrBuriis_url)r%rcr_r<Ztask_http_requestr>rnrrrrCsl          z TaskQueue._validate_task_options)r>r_rrcCs~t|jds"||t|jd<t|rht|jtrh|jj}|jddd|i|jd<|jd=nd|jj i|jd<|S)z*Prepares task to be sent with credentials.r?r@ AuthorizationzBearer $rfre) r2is_non_empty_stringrgrD_FIREBASE_FUNCTION_URL_FORMATrpr$ComputeEngineCredentialstokenre)r%r>r_rZid_tokenrrrrFs    zTaskQueue._update_task_payload)N)N) r+r,r-r.r&rPrSr5rDrCrFrrrrrts"  9c@sZeZdZdZedddddZedddd Zedd d d Zedd ddZdS)r2z*A collection of data validation utilities.rr)labelvaluecCs6t|tstd|||dkr2td||dS)zDChecks if given value is a non-empty string and throws error if not.z{0} "{1}" must be a string.rdz%{0} "{1}" must be a non-empty string.N)rprr"ra)r)rrrrrr31s z"_Validators.check_non_empty_string)rcCst|tr|dkrdSdS)z=Checks if given value is a non-empty string and returns bool.rdFT)rpr)r)rrrrr{9sz_Validators.is_non_empty_string)rQcCs(d}t||dk r$t|dkr$dSdS)z)Checks if given value is a valid task id.z^[A-Za-z0-9_-]+$NiTF)r[r^len)r)rQr]rrrrv@sz_Validators.is_task_id)r?cCsPt|tsdSz&t|}|jr*|jdkr0WdSWdStk rJYdSXdS)z%Checks if given value is a valid url.F)httphttpsTN)rprrurlparsenetlocscheme Exception)r)r?parsedrrrryHs  z_Validators.is_urlN) r+r,r-r.r/r3r{rvryrrrrr2/sr2c@sZeZdZUdZdZded<dZded<dZded<dZded <dZ d ed <dZ ded <dS) raD Task Options that can be applied to a Task. Args: schedule_delay_seconds: The number of seconds after the current time at which to attempt or retry the task. Should only be set if ``schedule_time`` is not set. schedule_time: The time when the task is scheduled to be attempted or retried. Should only be set if ``schedule_delay_seconds`` is not set. dispatch_deadline_seconds: The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a ``DEADLINE_EXCEEDED`` failure. Cloud Tasks will retry the task according to the ``RetryConfig``. The default is 10 minutes. The deadline must be in the range of 15 seconds and 30 minutes (1800 seconds). task_id: The ID to use for the enqueued task. If not provided, one will be automatically generated. If provided, an explicitly specified task ID enables task de-duplication. Task IDs should be strings that contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_) with a maximum length of 500 characters. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will throw an error with code `functions/task-already-exists`. Another task with the same ID can't be created for ~1hour after the original task was deleted or executed. Because there is an extra lookup cost to identify duplicate task IDs, setting ID significantly increases latency. Also, note that the infrastructure relies on an approximately uniform distribution of task IDs to store and serve tasks efficiently. For this reason, using hashed strings for the task ID or for the prefix of the task ID is recommended. Choosing task IDs that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. Push IDs from the Firebase Realtime Database make poor IDs because they are based on timestamps and will cause contention (slowdowns) in your task queue. Reversed push IDs however form a perfect distribution and are an ideal key. To reverse a string in Python use ``reversedString = someString[::-1]`` headers: HTTP request headers to include in the request to the task queue function. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced: `Authorization`, `Host`, `Content-Length`, `User-Agent` and others cannot be overridden. A complete list of these ignored or replaced headers can be found in the following definition of the HttpRequest.headers property: https://cloud.google.com/tasks/docs/reference/rest/v2/projects.locations.queues.tasks#httprequest By default, Content-Type is set to 'application/json'. The size of the headers must be less than 80KB. uri: The full URL that the request will be sent to. Must be a valid RFC3986 https or http URL. Nz Optional[int]rozOptional[datetime]rnrtrrQzOptional[Dict[str, str]]r@rx) r+r,r-r.ro__annotations__rnrtrQr@rxrrrrrVs 8     c@s>eZdZUdZded<dZded<dZded<dZded<dS) rbaContains the relevant fields for enqueueing tasks that trigger Cloud Functions. This is a limited subset of the Cloud Functions `Task` resource. See the following page for definitions of this class's properties: https://cloud.google.com/tasks/docs/reference/rest/v2/projects.locations.queues.tasks#resource:-task Args: httpRequest: The request to be made by the task worker. name: The name of the function. See the Cloud docs for the format of this property. schedule_time: The time when the task is scheduled to be attempted or retried. dispatch_deadline: The deadline for requests sent to the worker. zDict[str, Optional[str | dict]]rgNrrBrnru)r+r,r-r.rrBrnrurrrrrbs    rbc@s2eZdZUdZded<dZded<dZded<dS)rTzContains the parsed address of a resource. Args: resource_id: The ID of the resource. project_id: The project ID of the resource. location_id: The location ID of the resource. rr9Nrr r7)r+r,r-r.rr r7rrrrrTs  rT)NN)*r. __future__rrrurllibrr[rAbase64rtypingrrr Z dataclassesr Zgoogle.auth.compute_enginer r}rKZfirebase_adminr r rr__all__rwrEr|ra __version__rHr8rrrrr2rrbrTrrrrsT          <'@