application.get: Add support for retrieving applications by uuid

Resolves: #1016 Change-type: minor Signed-off-by: Thodoris Greasidis <thodoris@balena.io>
balena-io · Dec 30, 2021 · 3374abe · 3374abe
1 parent 4acbde6
commit 3374abe
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 24 deletions.
diff --git a/lib/models/application.ts b/lib/models/application.ts
@@ -271,7 +271,7 @@ const getApplicationModel = function (
 		 * @function
 		 * @memberof balena.models.application
 		 *
-		 * @param {String|Number} slugOrId - application slug (string) or id (number)
+		 * @param {String|Number} slugOrUuidOrId - application slug (string), uuid (string) or id (number)
 		 * @param {Object} [options={}] - extra pine options to use
 		 * @param {String} [context] - extra access filters, undefined or 'directly_accessible'
 		 * @fulfil {Object} - application
@@ -283,6 +283,11 @@ const getApplicationModel = function (
 		 * });
 		 *
 		 * @example
+		 * balena.models.application.get('1bf99a68cf9e4266986e6dec7a6e8f46').then(function(application) {
+		 * 	console.log(application);
+		 * });
+		 *
+		 * @example
 		 * balena.models.application.get(123).then(function(application) {
 		 * 	console.log(application);
 		 * });
@@ -294,58 +299,52 @@ const getApplicationModel = function (
 		 * });
 		 */
 		async get(
-			slugOrId: string | number,
+			slugOrUuidOrId: string | number,
 			options?: PineOptions<Application>,
 			context?: 'directly_accessible',
 		): Promise<Application> {
-			if (options == null) {
-				options = {};
-			}
-
-			if (slugOrId == null) {
-				throw new errors.BalenaApplicationNotFound(slugOrId);
-			}
+			options ??= {};
 
 			const accessFilter =
 				context === 'directly_accessible'
 					? isDirectlyAccessibleByUserFilter
 					: null;
 
 			let application;
-			if (isId(slugOrId)) {
+			if (isId(slugOrUuidOrId)) {
 				application = await pine.get({
 					resource: 'application',
-					id: slugOrId,
+					id: slugOrUuidOrId,
 					options: mergePineOptions(
 						accessFilter != null ? { $filter: accessFilter } : {},
 						options,
 					),
 				});
-				if (application == null) {
-					throw new errors.BalenaApplicationNotFound(slugOrId);
-				}
-			} else {
+			} else if (typeof slugOrUuidOrId === 'string') {
+				const lowerCaseSlugOrUuid = slugOrUuidOrId.toLowerCase();
 				const applications = await pine.get({
 					resource: 'application',
 					options: mergePineOptions(
 						{
 							$filter: {
 								...accessFilter,
-								slug: slugOrId.toLowerCase(),
+								$or: {
+									slug: lowerCaseSlugOrUuid,
+									uuid: lowerCaseSlugOrUuid,
+								},
 							},
 						},
 						options,
 					),
 				});
-				if (applications.length === 0) {
-					throw new errors.BalenaApplicationNotFound(slugOrId);
-				}
-
 				if (applications.length > 1) {
-					throw new errors.BalenaAmbiguousApplication(slugOrId);
+					throw new errors.BalenaAmbiguousApplication(slugOrUuidOrId);
 				}
 				application = applications[0];
 			}
+			if (application == null) {
+				throw new errors.BalenaApplicationNotFound(slugOrUuidOrId);
+			}
 			return normalizeApplication(application);
 		},
 

diff --git a/tests/integration/models/application.spec.ts b/tests/integration/models/application.spec.ts
@@ -1764,7 +1764,7 @@ describe('Application Model', function () {
 		before(async function () {
 			const [app] = await balena.models.application.getAll({
 				$top: 1,
-				$select: ['id', 'app_name', 'slug', 'is_public'],
+				$select: ['id', 'app_name', 'slug', 'uuid', 'is_public'],
 				$filter: { is_public: true },
 			});
 			expect(app).to.have.property('is_public', true);
@@ -1901,7 +1901,7 @@ describe('Application Model', function () {
 							.get({
 								resource: 'application',
 								options: {
-									$select: ['id', 'app_name', 'slug', 'is_public'],
+									$select: ['id', 'app_name', 'slug', 'uuid', 'is_public'],
 								},
 							})
 							.then(function (apps) {
@@ -1914,6 +1914,7 @@ describe('Application Model', function () {
 									expect(app).to.have.property('id').that.is.a('number');
 									expect(app).to.have.property('app_name').that.is.a('string');
 									expect(app).to.have.property('slug').that.is.a('string');
+									expect(app).to.have.property('uuid').that.is.a('string');
 									expect(app).to.have.property('is_public', true);
 								});
 							});
@@ -1931,6 +1932,7 @@ describe('Application Model', function () {
 									expect(app).to.have.property('id').that.is.a('number');
 									expect(app).to.have.property('app_name').that.is.a('string');
 									expect(app).to.have.property('slug').that.is.a('string');
+									expect(app).to.have.property('uuid').that.is.a('string');
 									expect(app).to.have.property('is_public', true);
 								});
 						},

diff --git a/tests/integration/setup.ts b/tests/integration/setup.ts
@@ -623,5 +623,9 @@ export function givenASupervisorRelease(
 	});
 }
 
-export const applicationRetrievalFields = toWritable(['id', 'slug'] as const);
+export const applicationRetrievalFields = toWritable([
+	'id',
+	'slug',
+	'uuid',
+] as const);
 export const deviceUniqueFields = toWritable(['id', 'uuid'] as const);