Symfony Bundle for Atlassian Connect platform
composer require thecatontheflat/atlassian-connect-bundleAdd the bundle to config/bundles.php
<?php
return [
// ... other bundles
AtlassianConnectBundle\AtlassianConnectBundle::class => ['all' => true],
]The bundle descriptor is used to install your app on Atlassian. When requesting descriptor - this configuration is converted to JSON.
Sample configuration in packages/atlassian-connect.yaml:
atlassian_connect:
dev_tenant: 1
descriptor:
key: 'your-addon-key'
name: 'Your Add-On Name'
description: 'Your Add-On Description'
authentication:
type: jwt
vendor:
name: 'Your Vendor Name'
url: 'https://marketplace.atlassian.com/vendors/1211528'
baseUrl: 'https://your-production-domain.com/'
lifecycle:
installed: '/handshake'
scopes: ['READ', 'WRITE', 'ACT_AS_USER'] # If you want get oauth_client_id need to add scope ACT_AS_USER
modules:
jiraIssueTabPanels:
-
key: 'your-addon-key-tab'
url: '/protected/list?issue=${issue.key}'
weight: 100
name:
value: 'Tab Name'
If you need to overwrite any config in dev/test environment, overwrite that config in the packages/{env}/atlassian-connect.yaml file.
To configure security part - use the following configuration in your security.yml. If you have another firewall that has the "^/" pattern, be sure to set the jwt_secured_area firewall first.
security:
enable_authenticator_manager: true
providers:
jwt_user_provider:
id: jwt_user_provider
firewalls:
jwt_secured_area:
custom_authenticators:
- AtlassianConnectBundle\Security\JWTAuthenticator
pattern: "^/protected"
stateless: true
provider: jwt_user_provider
# If you also need an entry_point
entry_point: AtlassianConnectBundle\Security\JWTAuthenticatorAdd the following configuration to config/routes.yaml:
ac:
resource: "@AtlassianConnectBundle/Resources/config/routing.php"To perform a license check for a certain route - specify the requires_license default in your routing.yml
some_route:
path: ...
defaults:
requires_license: truebin/console doctrine:schema:update --forceIn your protected controller action you can make a signed request to JIRA instance:
<?php declare(strict_types = 1);
namespace App\Controller;
use AtlassianConnectBundle\Service\AtlassianRestClient;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Response;
/**
* @Route("/protected")
*/
class ProtectedController extends Controller
{
/**
* @Route("/", name="main")
*/
public function index()
{
$client = $this->container->get(AtlassianRestClientInterface::class);
// Or
// $client = $this->container->get('atlassian_connect_rest_client');
// If you are not in a security context fetch the tenant first
// $client->setTenant($tenant);
// If you want to impersonate the user
// $client->actAsUser($this->getUser()->getUserName())
// Send request from anonymous plugin user
$issue = $client->get('/rest/api/2/issue/KEY-XXX');
// Send request from choosen user
$user = $client
->setUser('5ds4e4352a12451789b13243') // the accountId of the user in Jira/Confluence etc.
->get('/rest/api/2/myself')
;
return new Response([$issue, $user]);
}
}You could whitelist any licence by editing related row in table tenant and setting field is_white_listed to 1. If you will also set white_listed_until - you will be able to set whitelist expiration
In dev environment Tenant with id=1 would be used automatically. You could set configuration variable atlassian_connect.dev_tenant to false in order to disable it, or use another dev tenant id. It would allow you to test your plugin output for any tenant.
If you need to add more properties to tenant entity or reverse-side of your app entity relations - you could override default Tenant entity like
<?php
namespace AppBundle\Entity;
use Doctrine\ORM\Mapping as ORM;
use AtlassianConnectBundle\Entity\TenantTrait;
use AtlassianConnectBundle\Entity\TenantInterface;
use Symfony\Component\Security\Core\User\UserInterface;
/**
* JiraTenant
*
* @ORM\Table()
* @ORM\HasLifecycleCallbacks()
* @ORM\Entity()
*/
class JiraTenant implements UserInterface, TenantInterface
{
/**
* @ORM\OneToMany(type="MyEntity", mappedBy="jiraTenant")
*/
protected $myEntities;
use TenantTrait;
// getters/setters for your custom properties
}And override default one by setting parameter
atlassian_connect_tenant_entity_class: AppBundle\Entity\JiraTenantIn order to use it you will need to disable doctrine automapping
auto_mapping: false
mappings:
AppBundle: ~As soon as you will create your plugin - you will be able to access plugin manifest via url https://yourplugindomain.com/atlassian-connect.json
You will be able to setup it in "Manage Addons" section of your Jira Cloud using "Upload addon" interface. But right now AtlassianConnectBundle support only "paid via Atlassian" model, so you will not be able to start your trial.
Instead of using manifest url directly - you should add private listing of your plugin, create token and get manifest url like
https://marketplace.atlassian.com/files/1.0.0-AC/artifact/descriptor/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/atlassian-connect.json?access-token=xxxxxxxx
If you will use that url from marketplace - your trial will be started automatically.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent