**BREAKING**: Drop auth.getUserActorId in favor of auth.getActorId

Change-type: major
balena-io · Aug 17, 2023 · b82bfb5 · b82bfb5
1 parent 4ee63a5
commit b82bfb5
Show file tree

Hide file tree

Showing 6 changed files with 4 additions and 107 deletions.
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
@@ -431,7 +431,6 @@ const sdk = fromSharedOptions();
         * [.getToken()](#balena.auth.getToken) ⇒ <code>Promise</code>
         * [.getUserInfo()](#balena.auth.getUserInfo) ⇒ <code>Promise</code>
         * [.getActorId()](#balena.auth.getActorId) ⇒ <code>Promise</code>
-        * [.getUserActorId()](#balena.auth.getUserActorId) ⇒ <code>Promise</code>
         * [.logout()](#balena.auth.logout) ⇒ <code>Promise</code>
         * [.register(credentials)](#balena.auth.register) ⇒ <code>Promise</code>
         * [.verifyEmail(verificationPayload)](#balena.auth.verifyEmail) ⇒ <code>Promise</code>
@@ -6485,7 +6484,6 @@ balena.models.billing.downloadInvoice(orgId, '0000').then(function(stream) {
     * [.getToken()](#balena.auth.getToken) ⇒ <code>Promise</code>
     * [.getUserInfo()](#balena.auth.getUserInfo) ⇒ <code>Promise</code>
     * [.getActorId()](#balena.auth.getActorId) ⇒ <code>Promise</code>
-    * [.getUserActorId()](#balena.auth.getUserActorId) ⇒ <code>Promise</code>
     * [.logout()](#balena.auth.logout) ⇒ <code>Promise</code>
     * [.register(credentials)](#balena.auth.register) ⇒ <code>Promise</code>
     * [.verifyEmail(verificationPayload)](#balena.auth.verifyEmail) ⇒ <code>Promise</code>
@@ -6770,21 +6768,6 @@ balena.auth.getActorId().then(function(actorId) {
 	console.log(actorId);
 });
 ```
-<a name="balena.auth.getUserActorId"></a>
-
-#### auth.getUserActorId() ⇒ <code>Promise</code>
-This will only work if you used [login](#balena.auth.login) to log in.
-
-**Kind**: static method of [<code>auth</code>](#balena.auth)  
-**Summary**: Get current logged in user's actor id  
-**Access**: public  
-**Fulfil**: <code>Number</code> - user id  
-**Example**  
-```js
-balena.auth.getUserActorId().then(function(userActorId) {
-	console.log(userActorId);
-});
-```
 <a name="balena.auth.logout"></a>
 
 #### auth.logout() ⇒ <code>Promise</code>

diff --git a/src/auth.ts b/src/auth.ts
@@ -332,35 +332,6 @@ const getAuth = function (
 		return (await getActorDetails()).id;
 	}
 
-	/**
-	 * @summary Get current logged in user's actor id
-	 * @name getUserActorId
-	 * @public
-	 * @function
-	 * @memberof balena.auth
-	 *
-	 * @description This will only work if you used {@link balena.auth.login} to log in.
-	 *
-	 * @fulfil {Number} - user id
-	 * @returns {Promise}
-	 *
-	 * @example
-	 * balena.auth.getUserActorId().then(function(userActorId) {
-	 * 	console.log(userActorId);
-	 * });
-	 */
-	async function getUserActorId(): Promise<number> {
-		const { id } = await getUserInfo();
-		const { actor } = (await pine.get({
-			resource: 'user',
-			id,
-			options: {
-				$select: 'actor',
-			},
-		}))!;
-		return actor;
-	}
-
 	/**
 	 * @summary Logout
 	 * @name logout
@@ -497,7 +468,6 @@ const getAuth = function (
 		isLoggedIn,
 		getToken,
 		getActorId,
-		getUserActorId,
 		getUserInfo,
 		logout,
 		register,

diff --git a/src/models/api-key.ts b/src/models/api-key.ts
@@ -138,7 +138,7 @@ const getApiKeysModel = function (
 				mergePineOptions(
 					{
 						$filter: {
-							is_of__actor: await sdkInstance.auth.getUserActorId(),
+							is_of__actor: await sdkInstance.auth.getActorId(),
 							// the only way to reason whether it's
 							// a named user api key vs a deprecated user api key
 							// is whether it has a name.

diff --git a/tests/integration/auth.spec.ts b/tests/integration/auth.spec.ts
@@ -109,16 +109,6 @@ describe('SDK authentication', function () {
 			});
 		});
 
-		describe('balena.auth.getUserActorId()', () => {
-			it('should be rejected with an error', async function () {
-				const promise = balena.auth.getUserActorId();
-				await expect(promise).to.be.rejected.and.eventually.have.property(
-					'code',
-					'BalenaNotLoggedIn',
-				);
-			});
-		});
-
 		describe.skip('balena.auth.register()', function () {
 			beforeEach(async () => {
 				await balena.auth.login({
@@ -224,16 +214,6 @@ describe('SDK authentication', function () {
 				);
 			});
 		});
-
-		describe('balena.auth.getUserActorId()', () => {
-			it('should be rejected with an error', async function () {
-				const promise = balena.auth.getUserActorId();
-				await expect(promise).to.be.rejected.and.eventually.have.property(
-					'code',
-					'BalenaNotLoggedIn',
-				);
-			});
-		});
 	});
 
 	describe('when logged in with credentials', function () {
@@ -277,14 +257,6 @@ describe('SDK authentication', function () {
 			});
 		});
 
-		describe('balena.auth.getUserActorId()', () => {
-			it('should eventually be a user id', async () => {
-				const userId = await balena.auth.getUserActorId();
-				expect(userId).to.be.a('number');
-				expect(userId).to.be.greaterThan(0);
-			});
-		});
-
 		describe('balena.auth.logout()', () => {
 			it('should logout the user', async () => {
 				await balena.auth.logout();
@@ -333,16 +305,6 @@ describe('SDK authentication', function () {
 			});
 		});
 
-		describe('balena.auth.getUserActorId()', () => {
-			it('should be rejected with an error', async () => {
-				const promise = balena.auth.getUserActorId();
-				await expect(promise).to.be.rejected.and.eventually.have.property(
-					'message',
-					'The authentication credentials in use are not of a user',
-				);
-			});
-		});
-
 		describe('balena.auth.logout()', function () {
 			it('should logout the user', async () => {
 				await balena.auth.logout();
@@ -399,16 +361,6 @@ describe('SDK authentication', function () {
 			});
 		});
 
-		describe('balena.auth.getUserActorId()', () => {
-			it('should be rejected with an error', async () => {
-				const promise = balena.auth.getUserActorId();
-				await expect(promise).to.be.rejected.and.eventually.have.property(
-					'message',
-					'The authentication credentials in use are not of a user',
-				);
-			});
-		});
-
 		describe('balena.auth.logout()', function () {
 			it('should logout the user', async () => {
 				await balena.auth.logout();
@@ -465,14 +417,6 @@ describe('SDK authentication', function () {
 			});
 		});
 
-		describe('balena.auth.getUserActorId()', () => {
-			it('should eventually be a user id', async () => {
-				const userId = await balena.auth.getUserActorId();
-				expect(userId).to.be.a('number');
-				expect(userId).to.be.greaterThan(0);
-			});
-		});
-
 		describe('balena.auth.logout()', function () {
 			it('should logout the user', async () => {
 				await balena.auth.logout();

diff --git a/tests/integration/models/api-key.spec.ts b/tests/integration/models/api-key.spec.ts
@@ -61,7 +61,7 @@ describe('API Key model', function () {
 			it('should retrieve an empty array', async function () {
 				const apiKeys = await balena.models.apiKey.getAll({
 					$filter: {
-						is_of__actor: await balena.auth.getUserActorId(),
+						is_of__actor: await balena.auth.getActorId(),
 						name: { $ne: null },
 					},
 				});
@@ -81,7 +81,7 @@ describe('API Key model', function () {
 			it('should be able to retrieve all api keys created', async function () {
 				const apiKeys = await balena.models.apiKey.getAll({
 					$filter: {
-						is_of__actor: await balena.auth.getUserActorId(),
+						is_of__actor: await balena.auth.getActorId(),
 						name: { $ne: null },
 					},
 				});

diff --git a/tests/integration/setup.ts b/tests/integration/setup.ts
@@ -137,7 +137,7 @@ export async function resetUser() {
 				// only delete named user api keys
 				options: {
 					$filter: {
-						is_of__actor: await balena.auth.getUserActorId(),
+						is_of__actor: await balena.auth.getActorId(),
 						name: {
 							$ne: null,
 						},