https://github.com/highcoreorg/temporal-bundle
Symfony Temporal Bundle with configuration, ActivityRegistry & Worker Running
https://github.com/highcoreorg/temporal-bundle
Last synced: about 1 month ago
JSON representation
Symfony Temporal Bundle with configuration, ActivityRegistry & Worker Running
- Host: GitHub
- URL: https://github.com/highcoreorg/temporal-bundle
- Owner: highcoreorg
- Created: 2023-05-20T19:10:29.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-03-24T14:57:25.000Z (2 months ago)
- Last Synced: 2025-03-29T04:25:16.738Z (about 2 months ago)
- Language: PHP
- Size: 64.5 KB
- Stars: 13
- Watchers: 3
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Symfony Temporal Bundle
## Description
This is a wrapper package for the [official PHP SDK](https://github.com/temporalio/sdk-php) with Activity Registry and full-configurable worker and workflow client.
## Table of Contents (Optional)
If your README is long, add a table of contents to make it easy for users to find what they need.
- [Installation](#installation)
- [Usage](#usage)
- [Credits](#credits)
- [License](#license)
## Installation
Use this command to install
`composer require highcore/temporal-bundle`
## Usage
Create config/workflows.php
And register here your workflows, like a config/bundles.php for symfony
Example config/workflows.php:
```php
logger = new Logger();
}
public function upload(string $localFileName, string $url): void
{
if (!is_file($localFileName)) {
throw new \InvalidArgumentException("Invalid file type: " . $localFileName);
}
// Faking upload to simplify sample implementation.
$this->log('upload activity: uploaded from %s to %s', $localFileName, $url);
}
public function process(string $inputFileName): string
{
try {
$this->log('process activity: sourceFile=%s', $inputFileName);
$processedFile = $this->processFile($inputFileName);
$this->log('process activity: processed file=%s', $processedFile);
return $processedFile;
} catch (\Throwable $e) {
throw $e;
}
}
public function download(string $url): TaskQueueFilenamePair
{
try {
$this->log('download activity: downloading %s', $url);
$data = file_get_contents($url);
$file = tempnam(sys_get_temp_dir(), 'demo');
file_put_contents($file, $data);
$this->log('download activity: downloaded from %s to %s', $url, realpath($file));
return new TaskQueueFilenamePair(self::$taskQueue, $file);
} catch (\Throwable $e) {
throw $e;
}
}
private function processFile(string $filename): string
{
// faking processing for simplicity
return $filename;
}
/**
* @param string $message
* @param mixed ...$arg
*/
private function log(string $message, ...$arg)
{
// by default all error logs are forwarded to the application server log and docker log
$this->logger->debug(sprintf($message, ...$arg));
}
}
```
Example workflow interface:
```php
defaultStoreActivities = Workflow::newActivityStub(
StoreActivitiesInterface::class,
ActivityOptions::new()
->withScheduleToCloseTimeout(CarbonInterval::minute(5))
->withTaskQueue(self::DEFAULT_TASK_QUEUE)
);
}
public function processFile(string $sourceURL, string $destinationURL)
{
/** @var TaskQueueFilenamePair $downloaded */
$downloaded = yield $this->defaultStoreActivities->download($sourceURL);
$hostSpecificStore = Workflow::newActivityStub(
StoreActivitiesInterface::class,
ActivityOptions::new()
->withScheduleToCloseTimeout(CarbonInterval::minute(5))
->withTaskQueue($downloaded->hostTaskQueue)
);
// Call processFile activity to zip the file.
// Call the activity to process the file using worker-specific task queue.
$processed = yield $hostSpecificStore->process($downloaded->filename);
// Call upload activity to upload the zipped file.
yield $hostSpecificStore->upload($processed, $destinationURL);
return 'OK';
}
}
```
Register with symfony service container:
```php
services();
$services->defaults()
->public()
->autowire(true)
->autoconfigure(true);
$services->set(Temporal\Samples\FileProcessing\StoreActivity::class)
// Setting a "label to your activity" will add the activity to the ActivityRegistry,
// allowing your employee to use this activity in your Workflow
->tag('temporal.activity.registry');
```
Now you can run:
```bash
rr serve rr.yaml
```
And call workflow by:
```php
workflowClient->newWorkflowStub(
\Temporal\Samples\FileProcessing\FileProcessingWorkflowInterface::class,
WorkflowOptions::new()
->withRetryOptions(
RetryOptions::new()
->withMaximumAttempts(3)
->withNonRetryableExceptions(\LogicException::class)
)
);
// Start Workflow async, with no-wait result
/** @var WorkflowRunInterface $result */
$result = $this->workflowClient->start($workflow, 'https://example.com/example_file', 's3://s3.example.com');
echo 'Run ID: ' . $result->getExecution()->getRunID();
// Or you can call workflow sync with wait result
$result = $workflow->processingFile('https://example.com/example_file', 's3://s3.example.com');
echo $result; // OK
}
}
```
More php examples you can find [here](https://github.com/temporalio/samples-php)
## Credits
- [Official Temporal PHP SDK](https://github.com/temporalio/sdk-php)
- [Official Temporal PHP Samples](https://github.com/temporalio/samples-php)
- [Symfony Framework](https://github.com/symfony/symfony)
## License
MIT License
Copyright (c) 2023 Highcore.org
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.