DeployPlanDispatcher - Code Metrics - Inspection of "Deploy ui summary" - silverstripe/deploynaut - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#604)

by Stig

created 2016-08-17 21:53 UTC

DeployPlanDispatcher B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	326
Duplicated Lines	16.87 %

Coupling/Cohesion

Components	1
Dependencies	13

Importance

Changes	3
Bugs	0	Features	1

Metric	Value
wmc	36
c	3
b	0
f	1
lcom	1
cbo	13
dl	55
loc	326
rs	8.8

13 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	15	3
A	Link()	0	3	1
A	index()	0	6	1
A	gitupdate()	0	10	3
B	gitrefs()	0	38	3
A	getModel()	0	5	1
A	getFetch()	0	13	2
A	createFetch()	17	17	1
C	deploysummary()	15	58	11
A	getGitBranches()	0	10	2
A	getGitTags()	0	10	2
B	getGitPrevDeploys()	23	27	5
A	getAPIResponse()	0	12	1

How to fix Duplicated Code

<?php


class DeployPlanDispatcher extends Dispatcher {

	const ACTION_PLAN = 'plan';

	/**
	 * @var array
	 */
	private static $action_types = [
		self::ACTION_PLAN
	];

	/**
	 * @var array
	 */
	public static $allowed_actions = [
		'gitupdate',
		'gitrefs',
		'deploysummary'
	];

	/**
	 * @var \DNProject
	 */
	protected $project = null;

	/**
	 * @var \DNEnvironment
	 */
	protected $environment = null;

	public function init() {
		parent::init();

		$this->project = $this->getCurrentProject();

		if(!$this->project) {
			return $this->project404Response();
		}

		// Performs canView permission check by limiting visible projects
		$this->environment = $this->getCurrentEnvironment($this->project);
		if(!$this->environment) {
			return $this->environment404Response();
		}
	}

	/**
	 * @return string
	 */
	public function Link() {
		return \Controller::join_links($this->environment->Link(), self::ACTION_PLAN);
	}

	/**
	 *
	 * @param \SS_HTTPRequest $request
	 *
	 * @return \HTMLText|\SS_HTTPResponse
	 */
	public function index(\SS_HTTPRequest $request) {
		$this->setCurrentActionType(self::ACTION_PLAN);
		return $this->customise([
			'Environment' => $this->environment
		])->renderWith(['Plan', 'DNRoot']);
	}

	/**
	 * @param SS_HTTPRequest $request
	 * @return SS_HTTPResponse
	 */
	public function gitupdate(SS_HTTPRequest $request) {
		switch($request->httpMethod()) {
			case 'POST':
				return $this->createFetch();
			case 'GET':
				return $this->getFetch($this->getRequest()->param('ID'));
			default:
				return $this->getAPIResponse('Method not allowed, requires POST or GET/{id}', 405);
		}
	}

	/**
	 * @param SS_HTTPRequest $request
	 *
	 * @return string
	 */
	public function gitrefs(\SS_HTTPRequest $request) {

		$refs = [];
		$order = 0;
		$refs[] = [
			'id' => ++$order,
			'label' => "Branch version",
			"description" => "Deploy the latest version of a branch",
			"list" => $this->getGitBranches($this->project)
		];

		$refs[] = [
			'id' => ++$order,
			'label' => "Tag version",
			"description" => "Deploy a tagged release",
			"list" => $this->getGitTags($this->project)
		];

		// @todo: the original was a tree that was keyed by environment, the
		// front-end dropdown needs to be changed to support that. brrrr.
		$prevDeploys = [];
		foreach($this->getGitPrevDeploys($this->project) as $env) {
			foreach($env as $deploy) {
				$prevDeploys[] = $deploy;
			}
		}
		$refs[] = [
			'id' => ++$order,
			'label' => "Redeploy a release that was previously deployed (to any environment",
			"description" => "Deploy a previous release",
			"list" => $prevDeploys
		];

		$body = json_encode($refs, JSON_PRETTY_PRINT);
		$this->getResponse()->addHeader('Content-Type', 'application/json');
		$this->getResponse()->setBody($body);
		return $body;
	}

	/**
	 * Generate the data structure used by the frontend component.
	 *
	 * @param string $name of the component
	 *
	 * @return array
	 */
	public function getModel($name) {
		return [
			'APIEndpoint' => Director::absoluteBaseURL().$this->Link()
		];
	}

	/**
	 * @param int $ID
	 * @return SS_HTTPResponse
	 */
	protected function getFetch($ID) {
		$ping = DNGitFetch::get()->byID($ID);
		if(!$ping) {
			return $this->getAPIResponse('Fetch not found', 404);
		}
		$output = [
			'id' => $ID,
			'status' => $ping->ResqueStatus(),
			'message' => array_filter(explode(PHP_EOL, $ping->LogContent()))
		];

		return $this->getAPIResponse($output, 200);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
	}

	/**
	 * @return SS_HTTPResponse
	 */
	protected function createFetch() {

		/** @var DNGitFetch $fetch */
		$fetch = DNGitFetch::create();
		$fetch->ProjectID = $this->project->ID;
		$fetch->write();
		$fetch->start();

		$location = Director::absoluteBaseURL() . $this->Link() . '/gitupdate/' . $fetch->ID;
		$output = array(
			'message' => 'Fetch queued as job ' . $fetch->ResqueToken,
			'href' => $location,
		);

		$response = $this->getAPIResponse($output, 201);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		$response->addHeader('Location', $location);
		return $response;
	}

	/**
	 * @param SS_HTTPRequest $request
	 *
	 * @return SS_HTTPResponse
	 */
	public function deploysummary(SS_HTTPRequest $request) {

		// Performs canView permission check by limiting visible projects
		$project = $this->getCurrentProject();
		if(!$project) {
			return $this->project404Response();
		}

		// Performs canView permission check by limiting visible projects
		$environment = $this->getCurrentEnvironment($project);
		if(!$environment) {
			return $this->environment404Response();
		}

		if(!trim($request->getBody())) {
			return $this->getAPIResponse('no body was sent in the request', 400);
		}

		$jsonBody = json_decode($request->getBody(), true);
		if(empty($jsonBody)) {
			return $this->getAPIResponse('request did not contain a parsable JSON payload', 400);
		}

		$options = [
			'sha' => $jsonBody['sha']
		];

		// Plan the deployment.
		$strategy = $environment->Backend()->planDeploy($environment, $options);
		$data = $strategy->toArray();

		// Add in a URL for comparing from->to code changes. Ensure that we have
		// two proper 40 character SHAs, otherwise we can't show the compare link.
		$interface = $project->getRepositoryInterface();
		if(

			!empty($interface) && !empty($interface->URL)
			&& !empty($data['changes']['Code version']['from'])
			&& strlen($data['changes']['Code version']['from']) == '40'
			&& !empty($data['changes']['Code version']['to'])
			&& strlen($data['changes']['Code version']['to']) == '40'
		) {
			$compareurl = sprintf(
				'%s/compare/%s...%s',
				$interface->URL,
				$data['changes']['Code version']['from'],
				$data['changes']['Code version']['to']
			);
			$data['changes']['Code version']['compareUrl'] = $compareurl;
		}

		// Append json to response
		$token = SecurityToken::inst();
		$data['SecurityID'] = $token->getValue();

		$this->extend('updateDeploySummary', $data);

		return json_encode($data);
	}

	/**
	 * @param $project
	 *
	 * @return array
	 */
	protected function getGitBranches($project) {
		$branches = [];
		foreach($project->DNBranchList() as $branch) {
			$branches[] = [
				'key' => $branch->SHA(),
				'value' => $branch->Name(),
			];
		}
		return $branches;
	}

	/**
	 * @param $project
	 *
	 * @return array
	 */
	protected function getGitTags($project) {
		$tags = [];
		foreach($project->DNTagList()->setLimit(null) as $tag) {
			$tags[] = [
				'key' => $tag->SHA(),
				'value' => $tag->Name(),
			];
		}
		return $tags;
	}

	/**
	 * @param $project
	 *
	 * @return array
	 */
	protected function getGitPrevDeploys($project) {
		$redeploy = [];
		foreach($project->DNEnvironmentList() as $dnEnvironment) {

			$envName = $dnEnvironment->Name;
			$perEnvDeploys = [];
			foreach($dnEnvironment->DeployHistory() as $deploy) {
				$sha = $deploy->SHA;

				// Check if exists to make sure the newest deployment date is used.
				if(!isset($perEnvDeploys[$sha])) {
					$pastValue = sprintf(
						"%s (deployed %s)",
						substr($sha, 0, 8),
						$deploy->obj('LastEdited')->Ago()
					);
					$perEnvDeploys[$sha] = [
						'key' => $sha,
						'value' => $pastValue
					];
				}
			}
			if(!empty($perEnvDeploys)) {
				$redeploy[$envName] = array_values($perEnvDeploys);
			}
		}
		return $redeploy;
	}

	/**
	 * Return a simple response with a message
	 *
	 * @param string $message
	 * @param int $statusCode
	 * @return SS_HTTPResponse
	 */
	protected function getAPIResponse($message, $statusCode) {
		$output = [
			'message' => $message,
			'status_code' => $statusCode
		];
		$body = json_encode($output, JSON_PRETTY_PRINT);
		$response = $this->getResponse();
		$response->addHeader('Content-Type', 'application/json');
		$response->setBody($body);
		$response->setStatusCode($statusCode);
		return $response;
	}
}


1		<?php
2
3
4		class DeployPlanDispatcher extends Dispatcher {
5
6		const ACTION_PLAN = 'plan';
7
8		/**
9		* @var array
10		*/
11		private static $action_types = [
12		self::ACTION_PLAN
13		];
14
15		/**
16		* @var array
17		*/
18		public static $allowed_actions = [
19		'gitupdate',
20		'gitrefs',
21		'deploysummary'
22		];
23
24		/**
25		* @var \DNProject
26		*/
27		protected $project = null;
28
29		/**
30		* @var \DNEnvironment
31		*/
32		protected $environment = null;
33
34		public function init() {
35		parent::init();
36
37		$this->project = $this->getCurrentProject();
38
39		if(!$this->project) {
40		return $this->project404Response();
41		}
42
43		// Performs canView permission check by limiting visible projects
44		$this->environment = $this->getCurrentEnvironment($this->project);
45		if(!$this->environment) {
46		return $this->environment404Response();
47		}
48		}
49
50		/**
51		* @return string
52		*/
53		public function Link() {
54		return \Controller::join_links($this->environment->Link(), self::ACTION_PLAN);
55		}
56
57		/**
58		*
59		* @param \SS_HTTPRequest $request
60		*
61		* @return \HTMLText\|\SS_HTTPResponse
62		*/
63		public function index(\SS_HTTPRequest $request) {
64		$this->setCurrentActionType(self::ACTION_PLAN);
65		return $this->customise([
66		'Environment' => $this->environment
67		])->renderWith(['Plan', 'DNRoot']);
68		}
69
70		/**
71		* @param SS_HTTPRequest $request
72		* @return SS_HTTPResponse
73		*/
74		public function gitupdate(SS_HTTPRequest $request) {
75		switch($request->httpMethod()) {
76		case 'POST':
77		return $this->createFetch();
78		case 'GET':
79		return $this->getFetch($this->getRequest()->param('ID'));
80		default:
81		return $this->getAPIResponse('Method not allowed, requires POST or GET/{id}', 405);
82		}
83		}
84
85		/**
86		* @param SS_HTTPRequest $request
87		*
88		* @return string
89		*/
90		public function gitrefs(\SS_HTTPRequest $request) {
91
92		$refs = [];
93		$order = 0;
94		$refs[] = [
95		'id' => ++$order,
96		'label' => "Branch version",
97		"description" => "Deploy the latest version of a branch",
98		"list" => $this->getGitBranches($this->project)
99		];
100
101		$refs[] = [
102		'id' => ++$order,
103		'label' => "Tag version",
104		"description" => "Deploy a tagged release",
105		"list" => $this->getGitTags($this->project)
106		];
107
108		// @todo: the original was a tree that was keyed by environment, the
109		// front-end dropdown needs to be changed to support that. brrrr.
110		$prevDeploys = [];
111		foreach($this->getGitPrevDeploys($this->project) as $env) {
112		foreach($env as $deploy) {
113		$prevDeploys[] = $deploy;
114		}
115		}
116		$refs[] = [
117		'id' => ++$order,
118		'label' => "Redeploy a release that was previously deployed (to any environment",
119		"description" => "Deploy a previous release",
120		"list" => $prevDeploys
121		];
122
123		$body = json_encode($refs, JSON_PRETTY_PRINT);
124		$this->getResponse()->addHeader('Content-Type', 'application/json');
125		$this->getResponse()->setBody($body);
126		return $body;
127		}
128
129		/**
130		* Generate the data structure used by the frontend component.
131		*
132		* @param string $name of the component
133		*
134		* @return array
135		*/
136		public function getModel($name) {
137		return [
138		'APIEndpoint' => Director::absoluteBaseURL().$this->Link()
139		];
140		}
141
142		/**
143		* @param int $ID
144		* @return SS_HTTPResponse
145		*/
146		protected function getFetch($ID) {
147		$ping = DNGitFetch::get()->byID($ID);
148		if(!$ping) {
149		return $this->getAPIResponse('Fetch not found', 404);
150		}
151		$output = [
152		'id' => $ID,
153		'status' => $ping->ResqueStatus(),
154		'message' => array_filter(explode(PHP_EOL, $ping->LogContent()))
155		];
156
157		return $this->getAPIResponse($output, 200);
		0 ignored issues – show Documentation introduced 2016-08-15 03:51 UTC by Report Bug Copy Issue Report `$output` is of type `array<string,?,{"id":"in..."?","message":"array"}>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
158		}
159
160		/**
161		* @return SS_HTTPResponse
162		*/
163	View Code Duplication	protected function createFetch() {
		0 ignored issues – show Duplication introduced 2016-08-15 03:51 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
164		/** @var DNGitFetch $fetch */
165		$fetch = DNGitFetch::create();
166		$fetch->ProjectID = $this->project->ID;
167		$fetch->write();
168		$fetch->start();
169
170		$location = Director::absoluteBaseURL() . $this->Link() . '/gitupdate/' . $fetch->ID;
171		$output = array(
172		'message' => 'Fetch queued as job ' . $fetch->ResqueToken,
173		'href' => $location,
174		);
175
176		$response = $this->getAPIResponse($output, 201);
		0 ignored issues – show Documentation introduced 2016-08-15 03:51 UTC by Report Bug Copy Issue Report `$output` is of type `array<string,string,{"me...ring","href":"string"}>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
177		$response->addHeader('Location', $location);
178		return $response;
179		}
180
181		/**
182		* @param SS_HTTPRequest $request
183		*
184		* @return SS_HTTPResponse
185		*/
186		public function deploysummary(SS_HTTPRequest $request) {
187
188		// Performs canView permission check by limiting visible projects
189		$project = $this->getCurrentProject();
190		if(!$project) {
191		return $this->project404Response();
192		}
193
194		// Performs canView permission check by limiting visible projects
195		$environment = $this->getCurrentEnvironment($project);
196		if(!$environment) {
197		return $this->environment404Response();
198		}
199
200		if(!trim($request->getBody())) {
201		return $this->getAPIResponse('no body was sent in the request', 400);
202		}
203
204		$jsonBody = json_decode($request->getBody(), true);
205		if(empty($jsonBody)) {
206		return $this->getAPIResponse('request did not contain a parsable JSON payload', 400);
207		}
208
209		$options = [
210		'sha' => $jsonBody['sha']
211		];
212
213		// Plan the deployment.
214		$strategy = $environment->Backend()->planDeploy($environment, $options);
215		$data = $strategy->toArray();
216
217		// Add in a URL for comparing from->to code changes. Ensure that we have
218		// two proper 40 character SHAs, otherwise we can't show the compare link.
219		$interface = $project->getRepositoryInterface();
220	View Code Duplication	if(
		0 ignored issues – show Duplication introduced 2016-08-17 02:46 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
221		!empty($interface) && !empty($interface->URL)
222		&& !empty($data['changes']['Code version']['from'])
223		&& strlen($data['changes']['Code version']['from']) == '40'
224		&& !empty($data['changes']['Code version']['to'])
225		&& strlen($data['changes']['Code version']['to']) == '40'
226		) {
227		$compareurl = sprintf(
228		'%s/compare/%s...%s',
229		$interface->URL,
230		$data['changes']['Code version']['from'],
231		$data['changes']['Code version']['to']
232		);
233		$data['changes']['Code version']['compareUrl'] = $compareurl;
234		}
235
236		// Append json to response
237		$token = SecurityToken::inst();
238		$data['SecurityID'] = $token->getValue();
239
240		$this->extend('updateDeploySummary', $data);
241
242		return json_encode($data);
243		}
244
245		/**
246		* @param $project
247		*
248		* @return array
249		*/
250		protected function getGitBranches($project) {
251		$branches = [];
252		foreach($project->DNBranchList() as $branch) {
253		$branches[] = [
254		'key' => $branch->SHA(),
255		'value' => $branch->Name(),
256		];
257		}
258		return $branches;
259		}
260
261		/**
262		* @param $project
263		*
264		* @return array
265		*/
266		protected function getGitTags($project) {
267		$tags = [];
268		foreach($project->DNTagList()->setLimit(null) as $tag) {
269		$tags[] = [
270		'key' => $tag->SHA(),
271		'value' => $tag->Name(),
272		];
273		}
274		return $tags;
275		}
276
277		/**
278		* @param $project
279		*
280		* @return array
281		*/
282		protected function getGitPrevDeploys($project) {
283		$redeploy = [];
284	View Code Duplication	foreach($project->DNEnvironmentList() as $dnEnvironment) {
		0 ignored issues – show Duplication introduced 2016-08-11 03:56 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
285		$envName = $dnEnvironment->Name;
286		$perEnvDeploys = [];
287		foreach($dnEnvironment->DeployHistory() as $deploy) {
288		$sha = $deploy->SHA;
289
290		// Check if exists to make sure the newest deployment date is used.
291		if(!isset($perEnvDeploys[$sha])) {
292		$pastValue = sprintf(
293		"%s (deployed %s)",
294		substr($sha, 0, 8),
295		$deploy->obj('LastEdited')->Ago()
296		);
297		$perEnvDeploys[$sha] = [
298		'key' => $sha,
299		'value' => $pastValue
300		];
301		}
302		}
303		if(!empty($perEnvDeploys)) {
304		$redeploy[$envName] = array_values($perEnvDeploys);
305		}
306		}
307		return $redeploy;
308		}
309
310		/**
311		* Return a simple response with a message
312		*
313		* @param string $message
314		* @param int $statusCode
315		* @return SS_HTTPResponse
316		*/
317		protected function getAPIResponse($message, $statusCode) {
318		$output = [
319		'message' => $message,
320		'status_code' => $statusCode
321		];
322		$body = json_encode($output, JSON_PRETTY_PRINT);
323		$response = $this->getResponse();
324		$response->addHeader('Content-Type', 'application/json');
325		$response->setBody($body);
326		$response->setStatusCode($statusCode);
327		return $response;
328		}
329		}
330

silverstripe / deploynaut

Pull Request — master (#604)

DeployPlanDispatcher B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

13 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like