Merge pull request #116 from amazon-ospo/addNameField

feat: Adding name field in installation API responses

Author: RBose-amzn

src/packages/app-framework/package.json

@@ -104,6 +104,7 @@ export const handlerImpl: Handler = async ({
             appId: appId,
             nodeId: installation.account ? installation.account.node_id : '',
             targetType: installation.target_type,
+            name: installation.account ? installation.account.login : '',
           };
         }),
       );

src/packages/app-framework/src/credential-manager/installation-tracker/index.handler.ts

@@ -87,6 +87,7 @@ export const refreshCachedDataImpl: RefreshCachedData = async ({
               appId: appId,
               nodeId: installation.account ? installation.account.node_id : '',
               targetType: installation.target_type,
+              name: installation.account ? installation.account.login : '',
             };
           }),
         );

src/packages/app-framework/src/credential-manager/refresh/refreshCachedData.ts

@@ -15,6 +15,7 @@ export type InstallationRecord = {
   installationId: number;
   nodeId: string;
   targetType: string;
+  name: string;
 };
 
 type AppInstallations = {
@@ -118,13 +119,15 @@ export type PutInstallation = ({
   nodeId,
   installationId,
   targetType,
+  name,
   lastRefreshed,
 }: {
   tableName: string;
   appId: number;
   nodeId: string;
   installationId: number;
   targetType: string;
+  name: string;
   lastRefreshed?: string;
 }) => Promise<void>;
 
@@ -134,6 +137,7 @@ export const putInstallationImpl: PutInstallation = async ({
   nodeId,
   installationId,
   targetType,
+  name,
   lastRefreshed,
 }): Promise<void> => {
   const tableOperations = new TableOperations({
@@ -145,6 +149,7 @@ export const putInstallationImpl: PutInstallation = async ({
     NodeId: { S: nodeId },
     InstallationId: { N: installationId.toString() },
     TargetType: { S: targetType },
+    Name: { S: name },
     LastRefreshed: { S: lastRefreshed || '' },
   };
 
@@ -248,12 +253,14 @@ export const getInstallationsImpl: GetInstallations = async ({ tableName }) => {
     const appId: number = item.AppId;
     const installationId: number = item.InstallationId;
     const targetType: string = item.targetType;
+    const name: string = item.Name ?? '';
     const nodeId: string = item.NodeId ?? '';
     result.push({
       appId,
       nodeId,
       installationId,
       targetType,
+      name,
     });
   });
   return result;
@@ -286,12 +293,14 @@ export const getInstallationsDataByNodeId: GetInstallationsByNodeId = async ({
     const appId: number = item.AppId;
     const itemNodeId: string = item.NodeId;
     const installationId: number = item.InstallationId;
-    const targetType: string = item.targetType;
+    const targetType: string = item.TargetType;
+    const name: string = item.Name ?? '';
     result.push({
       appId,
       nodeId: itemNodeId,
       installationId,
       targetType,
+      name,
     });
   });
 
@@ -353,13 +362,16 @@ export const getPaginatedInstallationsImpl: GetPaginatedInstallations = async ({
     const appId: number = item.AppId;
     const installationId: number = item.InstallationId;
     const targetType: string = item.TargetType;
+    const name: string = item.Name ?? '';
     const nodeId: string = item.NodeId ?? '';
     installations.push({
       appId,
       nodeId,
       installationId,
       targetType,
+      name,
     });
   });
+  console.log(installations);
   return { installations, LastEvaluatedKey };
 };

src/packages/app-framework/src/data.ts

@@ -28,6 +28,7 @@ const mockInstallationId = 123456;
 const mockAppId2 = 12346;
 const mockInstallationId2 = 123457;
 const mockTargetType = 'Organization';
+const mockName = 'test-org';
 const mockArn = 'arn:aws:kms:region:account:key/mock-key-id';
 describe('getKeyArnByID', () => {
   it('should successfully retrieve KMS ARN from DynamoDB', async () => {
@@ -229,6 +230,7 @@ describe('getInstallationId', () => {
         installationId: mockInstallationId,
         nodeId: mockNodeId,
         targetType: mockTargetType,
+        name: mockName,
       });
 
       expect(TableOperations).toHaveBeenCalledWith({
@@ -240,6 +242,7 @@ describe('getInstallationId', () => {
         LastRefreshed: { S: '' },
         NodeId: { S: mockNodeId },
         TargetType: { S: mockTargetType },
+        Name: { S: mockName },
       });
     });
 
@@ -255,6 +258,7 @@ describe('getInstallationId', () => {
           installationId: mockInstallationId,
           nodeId: mockNodeId,
           targetType: mockTargetType,
+          name: mockName,
         }),
       ).rejects.toThrow('DynamoDB service error');
     });
@@ -308,6 +312,8 @@ describe('getInstallationId', () => {
           appId: mockAppId,
           nodeId: mockNodeId,
           installationId: mockInstallationId,
+          targetType: undefined,
+          name: '',
         },
       ]);
       expect(TableOperations).toHaveBeenCalledWith({
@@ -351,11 +357,15 @@ describe('getInstallationId', () => {
           appId: mockAppId,
           nodeId: mockNodeId,
           installationId: mockInstallationId,
+          targetType: undefined,
+          name: '',
         },
         {
           appId: mockAppId2,
           nodeId: mockNodeId,
           installationId: mockInstallationId2,
+          targetType: undefined,
+          name: '',
         },
       ]);
       expect(TableOperations).toHaveBeenCalledWith({
@@ -457,12 +467,14 @@ describe('getInstallationId', () => {
           nodeId: '',
           installationId: mockInstallationId,
           targetType: mockTargetType,
+          name: '',
         },
         {
           appId: mockAppId2,
           nodeId: mockNodeId,
           installationId: mockInstallationId2,
           targetType: mockTargetType,
+          name: '',
         },
       ]);
       expect(TableOperations).toHaveBeenCalledWith({

src/packages/app-framework/test/data.test.ts

@@ -15,12 +15,14 @@ describe('getInstallationsDataImpl', () => {
       installationId: 67890,
       nodeId: mockNodeId,
       targetType: 'Organization',
+      name: 'test-org-1',
     },
     {
       appId: 54321,
       installationId: 98765,
       nodeId: mockNodeId,
       targetType: 'Organization',
+      name: 'test-org-2',
     },
   ];
 
@@ -97,18 +99,21 @@ describe('getInstallationsDataImpl', () => {
         installationId: 67890,
         nodeId: mockNodeId,
         targetType: 'Organization',
+        name: 'test-org-1',
       },
       {
         appId: 54321,
         installationId: 98765,
         nodeId: mockNodeId,
         targetType: 'Organization',
+        name: 'test-org-2',
       },
       {
         appId: 11111,
         installationId: 22222,
         nodeId: mockNodeId,
         targetType: 'Organization',
+        name: 'test-org-3',
       },
     ];
     const mockGetInstallationsDataByNodeId = jest

src/packages/app-framework/test/get-installation-data/getInstallationData.test.ts

@@ -14,12 +14,14 @@ describe('getInstallationRecordsImpl', () => {
       installationId: 67890,
       nodeId: mockNodeId,
       targetType: 'Organization',
+      name: 'test-org-1',
     },
     {
       appId: 54321,
       installationId: 98765,
       nodeId: mockNodeId,
       targetType: 'Organization',
+      name: 'test-org-2',
     },
   ];