Configuring Retries and Failures
Configuring Retries and Failures
- public function getRequiredLeaseTime() — Return the number of seconds this worker needs hold a lease on the task for while it performs work. For most tasks you can leave this at `null`, which will give you a default lease (currently 2 hours).
- public function getMaximumRetryCount() — By default, Doorkeeper workers perform a small number of retries with exponential backoff. A consideration in this policy is that many of these workers are laden with side effects.
- public function getWaitBeforeRetry($task) — See @{method:getMaximumRetryCount} for a description of Doorkeeper retry defaults.
Publishing Stories
Publishing Stories
- protected function publishFeedStory() — Publishes stories into JIRA using the JIRA API.
- public function isEnabled() — This worker is enabled when a JIRA authentication provider is active.
Story Context
Story Context
- protected function getFeedStory() — Get the @{class:PhabricatorFeedStory} that should be published.
- protected function getViewer() — Get the viewer for the act of publishing.
- protected function getPublisher() — Get the @{class:DoorkeeperFeedStoryPublisher} which handles this object.
- protected function getStoryObject() — Get the primary object the story is about, like a @{class:DifferentialRevision} or @{class:ManiphestTask}.
Internals
Internals
- private function loadPublisher() — Load the @{class:DoorkeeperFeedStoryPublisher} which corresponds to this object. Publishers provide a common API for pushing object updates into foreign systems.
- private function getProvider() — Get the active JIRA provider.
- private function findUsersToPossess() — Get a list of users to act as when publishing into JIRA.
Other Methods
Other Methods
- public function __get($name)
- public function __set($name, $value)
- public function current()
- public function key()
- public function next()
- public function rewind()
- public function valid()
- private function throwOnAttemptedIteration()
- public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.
- public function setCurrentWorkerTask($task)
- public function getCurrentWorkerTask()
- public function getCurrentWorkerTaskID()
- final protected function doWork() — Doorkeeper workers set up some context, then call @{method:publishFeedStory}.
- final public function __construct($data)
- final protected function getTaskData()
- final protected function getTaskDataValue($key, $default)
- final public function executeTask()
- final public static function scheduleTask($task_class, $data, $options)
- public function renderForDisplay($viewer)
- public static function setRunAllTasksInProcess($all) — Set this flag to execute scheduled tasks synchronously, in the same process. This is useful for debugging, and otherwise dramatically worse in every way imaginable.
- final protected function log($pattern)
- final protected function queueTask($class, $data, $options) — Queue a task to be executed after this one succeeds.
- final protected function getQueuedTasks() — Get tasks queued as followups by @{method:queueTask}.
- final public function flushTaskQueue($defaults) — Schedule any queued tasks, then empty the task queue.
- final public static function awakenTaskIDs($ids) — Awaken tasks that have yielded.
- protected function newContentSource()
- protected function loadFeedStory()
- private function shouldPostComment()
- private function shouldPostLink()
- private function postComment($account, $jira_key)
- private function renderStoryText()
- private function postLink($account, $jira_key)