Refactors app commands to use getAppRegistrationByAppId util. Closes #5234

Author: nicodecleyre

src/m365/app/commands/app-get.spec.ts

@@ -11,12 +11,12 @@ import { session } from '../../../utils/session.js';
 import { sinonUtil } from '../../../utils/sinonUtil.js';
 import commands from '../commands.js';
 import command from './app-get.js';
+import { entraApp } from '../../../utils/entraApp.js';
 
 describe(commands.GET, () => {
   let log: string[];
   let logger: Logger;
   let loggerLogSpy: sinon.SinonSpy;
-  let loggerLogToStderrSpy: sinon.SinonSpy;
 
   before(() => {
     sinon.stub(auth, 'restoreAuth').resolves();
@@ -49,12 +49,12 @@ describe(commands.GET, () => {
       }
     };
     loggerLogSpy = sinon.spy(logger, 'log');
-    loggerLogToStderrSpy = sinon.spy(logger, 'logToStderr');
   });
 
   afterEach(() => {
     sinonUtil.restore([
-      request.get
+      request.get,
+      entraApp.getAppRegistrationByAppId
     ]);
   });
 
@@ -72,59 +72,30 @@ describe(commands.GET, () => {
   });
 
   it('handles error when the app specified with the appId not found', async () => {
-    sinon.stub(request, 'get').callsFake(async opts => {
-      if (opts.url === `https://graph.microsoft.com/v1.0/myorganization/applications?$filter=appId eq '9b1b1e42-794b-4c71-93ac-5ed92488b67f'&$select=id`) {
-        return { value: [] };
-      }
-
-      throw `Invalid request ${JSON.stringify(opts)}`;
-    });
-
-    await assert.rejects(command.action(logger, {
-      options: {
-        appId: '9b1b1e42-794b-4c71-93ac-5ed92488b67f'
-      }
-    }), new CommandError(`No Microsoft Entra application registration with ID 9b1b1e42-794b-4c71-93ac-5ed92488b67f found`));
-  });
-
-  it('handles error when retrieving information about app through appId failed', async () => {
-    sinon.stub(request, 'get').rejects(new Error('An error has occurred'));
+    const error = `App with appId '9b1b1e42-794b-4c71-93ac-5ed92488b67f' not found in Microsoft Entra ID`;
+    sinon.stub(entraApp, 'getAppRegistrationByAppId').rejects(new Error(error));
 
     await assert.rejects(command.action(logger, {
       options: {
         appId: '9b1b1e42-794b-4c71-93ac-5ed92488b67f'
       }
-    }), new CommandError(`An error has occurred`));
+    }), new CommandError(`App with appId '9b1b1e42-794b-4c71-93ac-5ed92488b67f' not found in Microsoft Entra ID`));
   });
 
   it(`gets an Microsoft Entra app registration by its app (client) ID.`, async () => {
-    sinon.stub(request, 'get').callsFake(async (opts) => {
-      if (opts.url === `https://graph.microsoft.com/v1.0/myorganization/applications?$filter=appId eq '9b1b1e42-794b-4c71-93ac-5ed92488b67f'&$select=id`) {
-        return {
-          value: [
-            {
-              "id": "340a4aa3-1af6-43ac-87d8-189819003952",
-              "appId": "9b1b1e42-794b-4c71-93ac-5ed92488b67f",
-              "createdDateTime": "2019-10-29T17:46:55Z",
-              "displayName": "My App",
-              "description": null
-            }
-          ]
-        };
-      }
-
-      if ((opts.url as string).indexOf('/v1.0/myorganization/applications/') > -1) {
-        return {
+    const appResponse = {
+      value: [
+        {
           "id": "340a4aa3-1af6-43ac-87d8-189819003952",
           "appId": "9b1b1e42-794b-4c71-93ac-5ed92488b67f",
           "createdDateTime": "2019-10-29T17:46:55Z",
           "displayName": "My App",
           "description": null
-        };
-      }
+        }
+      ]
+    };
 
-      throw 'Invalid request';
-    });
+    sinon.stub(entraApp, 'getAppRegistrationByAppId').resolves(appResponse.value[0]);
 
     await command.action(logger, {
       options: {
@@ -136,43 +107,4 @@ describe(commands.GET, () => {
     assert.strictEqual(call.args[0].appId, '9b1b1e42-794b-4c71-93ac-5ed92488b67f');
     assert.strictEqual(call.args[0].displayName, 'My App');
   });
-
-  it(`shows underlying debug information in debug mode`, async () => {
-    sinon.stub(request, 'get').callsFake(async (opts) => {
-      if (opts.url === `https://graph.microsoft.com/v1.0/myorganization/applications?$filter=appId eq '9b1b1e42-794b-4c71-93ac-5ed92488b67f'&$select=id`) {
-        return {
-          value: [
-            {
-              "id": "340a4aa3-1af6-43ac-87d8-189819003952",
-              "appId": "9b1b1e42-794b-4c71-93ac-5ed92488b67f",
-              "createdDateTime": "2019-10-29T17:46:55Z",
-              "displayName": "My App",
-              "description": null
-            }
-          ]
-        };
-      }
-
-      if ((opts.url as string).indexOf('/v1.0/myorganization/applications/') > -1) {
-        return {
-          "id": "340a4aa3-1af6-43ac-87d8-189819003952",
-          "appId": "9b1b1e42-794b-4c71-93ac-5ed92488b67f",
-          "createdDateTime": "2019-10-29T17:46:55Z",
-          "displayName": "My App",
-          "description": null
-        };
-      }
-
-      throw 'Invalid request';
-    });
-
-    await command.action(logger, {
-      options: {
-        appId: '9b1b1e42-794b-4c71-93ac-5ed92488b67f',
-        debug: true
-      }
-    });
-    const call: sinon.SinonSpyCall = loggerLogToStderrSpy.firstCall;
-    assert(call.args[0].includes('Executing command entra app get with options'));
-  });
 });

src/m365/app/commands/app-get.ts

@@ -1,9 +1,7 @@
-import { cli } from '../../../cli/cli.js';
 import { Logger } from '../../../cli/Logger.js';
-import Command from '../../../Command.js';
-import entraAppGetCommand, { Options as EntraAppGetCommandOptions } from '../../entra/commands/app/app-get.js';
 import AppCommand, { AppCommandArgs } from '../../base/AppCommand.js';
 import commands from '../commands.js';
+import { entraApp } from '../../../utils/entraApp.js';
 
 class AppGetCommand extends AppCommand {
   public get name(): string {
@@ -15,20 +13,9 @@ class AppGetCommand extends AppCommand {
   }
 
   public async commandAction(logger: Logger, args: AppCommandArgs): Promise<void> {
-    const options: EntraAppGetCommandOptions = {
-      appId: this.appId,
-      output: 'json',
-      debug: args.options.debug,
-      verbose: args.options.verbose
-    };
-
     try {
-      const appGetOutput = await cli.executeCommandWithOutput(entraAppGetCommand as Command, { options: { ...options, _: [] } });
-      if (this.verbose) {
-        await logger.logToStderr(appGetOutput.stderr);
-      }
-
-      await logger.log(JSON.parse(appGetOutput.stdout));
+      const app = await entraApp.getAppRegistrationByAppId(args.options.appId!);
+      await logger.log(app);
     }
     catch (err: any) {
       this.handleRejectedODataJsonPromise(err);