Code coverage report for kobold-core/lib/storageAdapter/keyValueStorageAdapter.js

Statements: 6.52% (6 / 92)      Branches: 0% (0 / 18)      Functions: 0% (0 / 62)      Lines: 6.52% (6 / 92)      Ignored: none     

All files » kobold-core/lib/storageAdapter/ » keyValueStorageAdapter.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478      1 1 1   1                                                   1                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     1  
// Copyright 2014, Yahoo! Inc.
// Copyrights licensed under the Mit License. See the accompanying LICENSE file for terms.
 
var Promise = require('promise');
var uuid = require('uuid');
var PNGImage = require('pngjs-image');
 
var StorageAdapter = require('./storageAdapter');
 
/**
 * Key-Value storage adapter
 *
 * @class KeyValueStorageAdapter
 * @extends StorageAdapter
 * @constructor
 * @param {object} options
 * @param {ConnectionAdapter} options.connection
 * @param {string} options.company
 * @param {string} options.department
 * @param {string} options.project
 * @param {string} options.job
 *
 * @property {ConnectionAdapter} _connection
 * @property {string} _company
 * @property {object} _companyInfo
 * @property {string} _department
 * @property {object} _departmentInfo
 * @property {string} _project
 * @property {object} _projectInfo
 * @property {string} _job
 * @property {object} _jobInfo
 * @property {object} _buildInfo
 */
var KeyValueStorageAdapter = StorageAdapter.extend(
 
	/** @lends KeyValueStorageAdapter.prototype */
	{
		/**
		 * Initializes the source-adapter
		 *
		 * @method initialize
		 */
		initialize: function () {
			this.__super();
 
			this._connection = this._options.connection;
			this._company = this._options.company;
			this._department = this._options.department;
			this._project = this._options.project;
			this._job = this._options.job;
 
			this.setPromise(this._prepareCompanyBucket());
			this.setPromise(this._prepareDepartmentBucket());
			this.setPromise(this._prepareProjectBucket());
			this.setPromise(this._prepareJobBucket());
			this.setPromise(this._prepareBuildBucket());
		},
 
 
		/**
		 * Prepare a bucket
		 *
		 * @method _prepareBucket
		 * @return {Promise}
		 * @private
		 */
		_prepareBucket: function (bucketName, key, initialValue, failWhenExist) {
 
			return this.getPromise().then(function () {
 
				return this._connection.hasBucket(bucketName).then(function (hasBucket) {
 
					if (!hasBucket) {
						throw new Error('The ' + bucketName + ' bucket is not available in the key-value instance.');
					}
				});
 
			}.bind(this)).then(function () {
 
				return this._connection.hasBucketKey(bucketName, key, this._bucketKeyFilter).then(function (hasBucketKey) {
 
					if (hasBucketKey) {
						if (failWhenExist) {
							throw new Error('The ' + bucketName + ' bucket with key ' + key + ' is already available in the key-value instance.');
						}
					} else {
						return this._connection.setObjectFromJSON(bucketName, key, initialValue);
					}
				}.bind(this));
 
			}.bind(this));
		},
 
 
		/**
		 * Prepare the companies bucket
		 *
		 * @method _prepareCompanyBucket
		 * @return {Promise}
		 * @private
		 */
		_prepareCompanyBucket: function () {
			var id = 'company_' + uuid.v4();
			return this._prepareBucket('companies', this._company, {
				id: id
			}).then(function () {
				return this._connection.getObjectAsJSON('companies', this._company).then(function (info) {
					this._companyInfo = info;
				}.bind(this));
			}.bind(this));
		},
 
		/**
		 * Prepare the departments bucket
		 *
		 * @method _prepareDepartmentBucket
		 * @return {Promise}
		 * @private
		 */
		_prepareDepartmentBucket: function () {
			var id = 'department_' + uuid.v4();
			return this._prepareBucket('departments', this._department, {
				id: id
			}).then(function () {
				return this._connection.getObjectAsJSON('departments', this._department).then(function (info) {
					this._departmentInfo = info;
				}.bind(this));
			}.bind(this));
		},
 
		/**
		 * Prepare the projects bucket
		 *
		 * @method _prepareProjectBucket
		 * @return {Promise}
		 * @private
		 */
		_prepareProjectBucket: function () {
			var id = 'project_' + uuid.v4();
			return this._prepareBucket('projects', this._project, {
				id: id
			}).then(function () {
				return this._connection.getObjectAsJSON('projects', this._project).then(function (info) {
					this._projectInfo = info;
				}.bind(this));
			}.bind(this));
		},
 
		/**
		 * Prepare the jobs bucket
		 *
		 * @method _prepareJobBucket
		 * @return {Promise}
		 * @private
		 */
		_prepareJobBucket: function () {
			var id = 'job_' + uuid.v4();
			return this._prepareBucket('jobs', this._job, {
				id: id,
				approvedScreensBucket: this._getCurrentApprovedScreenBucket(id)
			}).then(function () {
				return this._connection.getObjectAsJSON('jobs', this._job).then(function (info) {
					this._jobInfo = info;
				}.bind(this));
			}.bind(this));
		},
 
		/**
		 * Prepare the build bucket
		 *
		 * @method _prepareBuildBucket
		 * @return {Promise}
		 * @private
		 */
		_prepareBuildBucket: function () {
			var id = 'build_' + uuid.v4();
			this._buildInfo = {
				id: id,
				creationTime: +(new Date()),
				approvedScreensBucket: this._getApprovedScreenBucket(id),
				highlightScreensBucket: this._getHighlightScreenBucket(id),
				buildScreensBucket: this._getBuildScreenBucket(id)
			};
			return this._prepareBucket('builds', this._build, this._buildInfo, true);
		},
 
 
		/**
		 * Loads an image blob and returns a promise for it
		 *
		 * @method _loadImage
		 * @param {Buffer} blob
		 * @returns {Promise} With {PNGImage} Image
		 * @private
		 */
		_loadImage: function (blob) {
			return new Promise(function (resolve, reject) {
				PNGImage.loadImage(blob, function (err, image) {
					if (err) {
						reject(err);
					} else {
						resolve(image);
					}
				});
			})
		},
 
		/**
		 * Saves an image to a blob and returns a promise for it
		 *
		 * @method _blobImage
		 * @param {PNGImage} image
		 * @returns {Promise} With {Buffer} Blob
		 * @private
		 */
		_blobImage: function (image) {
			return new Promise(function (resolve, reject) {
				image.toBlob(function (err, blob) {
					if (err) {
						reject(err);
					} else {
						resolve(blob);
					}
				});
			})
		},
 
 
		/**
		 * Gets the current approved-screen bucket
		 *
		 * @method _getCurrentApprovedScreenBucket
		 * @param {string} [id]
		 * @return {string}
		 * @private
		 */
		_getCurrentApprovedScreenBucket: function (id) {
			return (id || this._jobInfo.id) + '_approved';
		},
 
		/**
		 * Gets the approved-screen bucket
		 *
		 * @method _getApprovedScreenBucket
		 * @param {string} [id]
		 * @return {string}
		 * @private
		 */
		_getApprovedScreenBucket: function (id) {
			return (id || this._buildInfo.id) + '_approved';
		},
 
		/**
		 * Gets the highlight-screen bucket
		 *
		 * @method _getHighlightScreenBucket
		 * @param {string} [id]
		 * @return {string}
		 * @private
		 */
		_getHighlightScreenBucket: function (id) {
			return (id || this._buildInfo.id) + '_highlight';
		},
 
		/**
		 * Gets the build-screen bucket
		 *
		 * @method _getBuildScreenBucket
		 * @param {string} [id]
		 * @return {string}
		 * @private
		 */
		_getBuildScreenBucket: function (id) {
			return (id || this._buildInfo.id) + '_build';
		},
 
 
		/**
		 * Key filter for bucket keys
		 *
		 * @method _bucketKeyFilter
		 * @param {string} key
		 * @return {boolean}
		 * @private
		 */
		_bucketKeyFilter: function (key) {
			return (key.substr(0, 1) !== '_');
		},
 
 
		/**
		 * Gets a list of currently approve screen names
		 *
		 * @method getCurrentApprovedScreenNames
		 * @return {Promise} With {string[]} List of approved screen names
		 */
		getCurrentApprovedScreenNames: function () {
			return this.getPromise().then(function () {
				return this._connection.getBucketKeys(this._getCurrentApprovedScreenBucket());
			}.bind(this));
		},
 
		/**
		 * Gets a specific currently approved screen
		 *
		 * @method getCurrentApprovedScreen
		 * @param {string} name Name of approved screen
		 * @return {Promise} With {PNGImage} Approved screen
		 */
		getCurrentApprovedScreen: function (name) {
			return this.getPromise().then(function () {
				return this._connection.getObject(this._getCurrentApprovedScreenBucket(), name);
			}.bind(this)).then(function (blob) {
				return this._loadImage(blob);
			});
		},
 
		/**
		 * Archives a specific currently approved screen
		 *
		 * @method archiveCurrentApprovedScreen
		 * @param {string} name Name of approved screen
		 * @param {PNGImage} image Screen to archive
		 * @return {Promise}
		 */
		archiveCurrentApprovedScreen: function (name, image) {
			return this.getPromise().then(function () {
				return this._blobImage(image);
			}.bind(this)).then(function (blob) {
				return this._connection.setObject(this._getCurrentApprovedScreenBucket(), name, blob, 'image/png');
			}.bind(this));
		},
 
 
		/**
		 * Gets a list of approve screen names
		 *
		 * @method getApprovedScreenNames
		 * @return {Promise} With {string[]} List of approved screen names
		 */
		getApprovedScreenNames: function () {
			return this.getPromise().then(function () {
				return this._connection.getBucketKeys(this._getApprovedScreenBucket());
			}.bind(this));
		},
 
		/**
		 * Gets a specific approved screen
		 *
		 * @method getApprovedScreen
		 * @param {string} name Name of approved screen
		 * @return {Promise} With {PNGImage} Approved screen
		 */
		getApprovedScreen: function (name) {
			return this.getPromise().then(function () {
				return this._connection.getObject(this._getApprovedScreenBucket(), name);
			}.bind(this)).then(function (blob) {
				return this._loadImage(blob);
			});
		},
 
		/**
		 * Archives a specific approved screen
		 *
		 * @method archiveApprovedScreen
		 * @param {string} name Name of approved screen
		 * @param {PNGImage} image Screen to archive
		 * @return {Promise}
		 */
		archiveApprovedScreen: function (name, image) {
			return this.getPromise().then(function () {
				return this._blobImage(image);
			}.bind(this)).then(function (blob) {
				return this._connection.setObject(this._getApprovedScreenBucket(), name, blob, 'image/png');
			}.bind(this));
		},
 
 
		/**
		 * Gets a list of build screen names
		 *
		 * @method getBuildScreenNames
		 * @return {Promise} With {string[]} List of build screen names
		 */
		getBuildScreenNames: function () {
			return this.getPromise().then(function () {
				return this._connection.getBucketKeys(this._getBuildScreenBucket());
			}.bind(this));
		},
 
		/**
		 * Gets a specific build screen
		 *
		 * @method getBuildScreen
		 * @param {string} name Name of build screen
		 * @return {Promise} With {PNGImage}
		 */
		getBuildScreen: function (name) {
			return this.getPromise().then(function () {
				return this._connection.getObject(this._getBuildScreenBucket(), name);
			}.bind(this)).then(function (blob) {
				return this._loadImage(blob);
			});
		},
 
		/**
		 * Archives a specific build screen
		 *
		 * @method archiveBuildScreen
		 * @param {string} name Name of build screen
		 * @param {PNGImage} image Screen to archive
		 * @return {Promise}
		 */
		archiveBuildScreen: function (name, image) {
			return this.getPromise().then(function () {
				return this._blobImage(image);
			}.bind(this)).then(function (blob) {
				return this._connection.setObject(this._getBuildScreenBucket(), name, blob, 'image/png');
			}.bind(this));
		},
 
 
		/**
		 * Gets a list of build highlight names
		 *
		 * @method getHighlightScreenNames
		 * @return {Promise} With {string[]} List of build screen names
		 */
		getHighlightScreenNames: function () {
			return this.getPromise().then(function () {
				return this._connection.getBucketKeys(this._getHighlightScreenBucket());
			}.bind(this));
		},
 
		/**
		 * Gets a specific highlight screen
		 *
		 * @method getHighlightScreen
		 * @param {string} name Name of build screen
		 * @return {Promise} With {PNGImage} Build screen
		 */
		getHighlightScreen: function (name) {
			return this.getPromise().then(function () {
				return this._connection.getObject(this._getHighlightScreenBucket(), name);
			}.bind(this)).then(function (blob) {
				return this._loadImage(blob);
			});
		},
 
		/**
		 * Archives a specific highlight screen
		 *
		 * @method archiveHighlightScreen
		 * @param {string} name Name of highlight screen
		 * @param {PNGImage} image Screen to archive
		 * @return {Promise}
		 */
		archiveHighlightScreen: function (name, image) {
			return this.getPromise().then(function () {
				return this._blobImage(image);
			}.bind(this)).then(function (blob) {
				return this._connection.setObject(this._getHighlightScreenBucket(), name, blob, 'image/png');
			}.bind(this));
		}
	},
 
	{
		/**
		 * Type of class
		 *
		 * @property TYPE
		 * @type string
		 */
		TYPE: 'KeyValueStorageAdapter'
	});
 
module.exports = KeyValueStorageAdapter;