[AXON-412] Use correct client & metadata for cloud API tokens (#403)

sdzh-atlassian · web-flow · commit 04bf7aa7eb32 · 2025-05-27T14:14:39.000-07:00
* [AXON-412] Use correct client &amp; metadata for cloud API tokens

* [AXON-412] chore: remove `server` from names where appropriate

* [AXON-412] chore: rename &amp; clean up fetchSiteId

* [AXON-412] chore: various fixes towards E2E tests passing
diff --git a/e2e/README.md b/e2e/README.md
@@ -0,0 +1,42 @@
+### What is this?
+
+This is the WIP suite of end-to-end (E2E) tests we've implemented for Atlascode.
+
+How does it work? In summary:
+
+- We mock the various API calls made from the extension using wiremock
+- We spin up a browser-based extension and use playwright to perform various actions
+- All of that is run during the build in a docker container, with a supporting `wiremock` instance using docker-compose
+
+### How do I use it?
+
+To run the tests locally, it should be enough to do the following:
+
+1.  First, prepare mock certificates for wiremock, using
+
+```sh
+ npm run test:e2e:sslcerts
+```
+
+2.  Build a docker image that we use for testing:
+
+```sh
+npm run test:e2e:docker:build
+```
+
+3.  Run tests headless in a docker container:
+
+```sh
+npm run test:e2e:docker
+```
+
+4. Check the output, and the artifacts provided in `./test-results`
+
+---
+
+⚠️ **Note**: Please be aware that the tests leverage a `.vsix` artifact produced by the build
+To run E2E tests against changed code, you might need to re-build the extension by running
+
+```sh
+npm run extension:package
+```
diff --git a/e2e/compose.yml b/e2e/compose.yml
@@ -1,32 +1,32 @@
 networks:
-  e2e:
+    e2e:
 
-services: 
-  wiremock-mockedteams:
-    image: wiremock/wiremock
-    command: >
-      --https-port 443
-      --verbose
-      --https-keystore /home/wiremock_ssl_certs/wiremock-mockedteams.p12
-    volumes:
-      - ./wiremock-mappings/mockedteams:/home/wiremock/mappings
-      - ./sslcerts:/home/wiremock_ssl_certs
-    networks:
-      e2e:
-        aliases:
-          - mockedteams.atlassian.net
-    expose:
-      - 443
+services:
+    wiremock-mockedteams:
+        image: wiremock/wiremock
+        command: >
+            --https-port 443
+            --verbose
+            --https-keystore /home/wiremock_ssl_certs/wiremock-mockedteams.p12
+        volumes:
+            - ./wiremock-mappings/mockedteams:/home/wiremock/mappings
+            - ./sslcerts:/home/wiremock_ssl_certs
+        networks:
+            e2e:
+                aliases:
+                    - mockedteams.atlassian.net
+        expose:
+            - 443
 
-  atlascode-e2e:
-    image: atlascode-e2e
-    volumes:
-      - ${PWD}/..:/atlascode
-    environment:
-      - NODE_TLS_REJECT_UNAUTHORIZED=0
-    depends_on:
-      - wiremock-mockedteams
-    networks:
-      - e2e
-    ports:
-      - "9988:9988"
+    atlascode-e2e:
+        image: atlascode-e2e
+        volumes:
+            - ${PWD}/..:/atlascode
+        environment:
+            - NODE_TLS_REJECT_UNAUTHORIZED=0
+        depends_on:
+            - wiremock-mockedteams
+        networks:
+            - e2e
+        ports:
+            - '9988:9988'
diff --git a/e2e/wiremock-mappings/mockedteams/tenant_info.json b/e2e/wiremock-mappings/mockedteams/tenant_info.json
@@ -0,0 +1,13 @@
+{
+  "request": {
+    "method": "GET",
+    "urlPath": "/_edge/tenant_info"
+  },
+  "response": {
+    "status": 200,
+    "body": "{\"cloudId\":\"3036c423-78e7-442a-8bed-47870b5a7526\"}",
+    "headers": {
+      "Content-Type": "application/json"
+    }
+  }
+}
diff --git a/package.json b/package.json
@@ -64,7 +64,7 @@
         "test:unit": "jest -c jest.unit.config.ts",
         "test:react": "jest -c jest.react.config.ts",
         "test:e2e:sslcerts": "cd e2e/sslcerts && ./generate-certs.sh",
-        "test:e2e:docker": "cd e2e && docker compose run atlascode-e2e",
+        "test:e2e:docker": "cd e2e && docker compose run atlascode-e2e; docker compose down",
         "test:e2e:docker:build": "docker build --tag atlascode-e2e - <e2e/Dockerfile",
         "devcompile": "npm run clean && npm run devcompile:react && npm run devcompile:extension",
         "devcompile:react": "webpack --mode development --config webpack.react.dev.js --fail-on-warnings",
diff --git a/playwright.config.js b/playwright.config.js
@@ -5,6 +5,11 @@ export default defineConfig({
         viewport: {
             width: 1600,
             height: 800,
-        }
+        },
     },
-});
+    use: {
+        // Docs: https://playwright.dev/docs/videos
+        // To see all of the videos, change this to 'on'
+        video: 'retain-on-failure',
+    },
+});
diff --git a/src/atlclients/clientManager.ts b/src/atlclients/clientManager.ts
@@ -168,6 +168,14 @@ export class ClientManager implements Disposable {
                             jiraTokenAuthProvider(info.access),
                             getAgent,
                         );
+                    } else if (isBasicAuthInfo(info) && site.isCloud) {
+                        Logger.debug(`${tag}: creating cloud client for ${site.baseApiUrl}`);
+                        client = new JiraCloudClient(
+                            site,
+                            basicJiraTransportFactory(site),
+                            jiraBasicAuthProvider(info.username, info.password),
+                            getAgent,
+                        );
                     } else if (isBasicAuthInfo(info)) {
                         client = new JiraServerClient(
                             site,
diff --git a/src/atlclients/loginManager.test.ts b/src/atlclients/loginManager.test.ts
@@ -162,7 +162,7 @@ describe('LoginManager', () => {
 
     describe('userInitiatedServerLogin', () => {
         it.each([ProductJira, ProductBitbucket])(
-            'should call saveDetailsForServerSite with correct parameters for BasicAuthInfo',
+            'should call saveDetailsForSite with correct parameters for BasicAuthInfo',
             async (product: Product) => {
                 const site: SiteInfo = { host: `${product.key}.atlassian.com`, product };
                 const user = forceCastTo<UserInfo>({ id: 'user' });
@@ -174,35 +174,33 @@ describe('LoginManager', () => {
                 };
                 const siteDetails = forceCastTo<DetailedSiteInfo>({ host: `${product.key}.atlassian.com`, product });
 
-                jest.spyOn(loginManager as any, 'saveDetailsForServerSite').mockResolvedValue(
-                    Promise.resolve(siteDetails),
-                );
+                jest.spyOn(loginManager as any, 'saveDetailsForSite').mockResolvedValue(Promise.resolve(siteDetails));
                 jest.spyOn(authInfo, 'isBasicAuthInfo').mockReturnValue(true);
                 jest.spyOn(authInfo, 'isPATAuthInfo').mockReturnValue(false);
                 jest.spyOn(loginManager['_analyticsClient'], 'sendTrackEvent');
 
                 await loginManager.userInitiatedServerLogin(site, authInfoData);
 
-                expect(loginManager['saveDetailsForServerSite']).toHaveBeenCalledWith(site, authInfoData);
+                expect(loginManager['saveDetailsForSite']).toHaveBeenCalledWith(site, authInfoData);
                 expect(loginManager['_analyticsClient'].sendTrackEvent).toHaveBeenCalled();
             },
         );
 
         it.each([ProductJira, ProductBitbucket])(
-            'should call saveDetailsForServerSite with correct parameters for PATAuthInfo',
+            'should call saveDetailsForSite with correct parameters for PATAuthInfo',
             async (product: Product) => {
                 const site: SiteInfo = { host: `${product.key}.atlassian.com`, product };
                 const authInfoData = { token: 'token' } as unknown as PATAuthInfo;
                 const siteDetails = forceCastTo<DetailedSiteInfo>({ host: `${product.key}.atlassian.com`, product });
 
-                jest.spyOn(loginManager as any, 'saveDetailsForServerSite').mockResolvedValue(siteDetails);
+                jest.spyOn(loginManager as any, 'saveDetailsForSite').mockResolvedValue(siteDetails);
                 jest.spyOn(authInfo, 'isBasicAuthInfo').mockReturnValue(false);
                 jest.spyOn(authInfo, 'isPATAuthInfo').mockReturnValue(true);
                 jest.spyOn(loginManager['_analyticsClient'], 'sendTrackEvent');
 
                 await loginManager.userInitiatedServerLogin(site, authInfoData);
 
-                expect(loginManager['saveDetailsForServerSite']).toHaveBeenCalledWith(site, authInfoData);
+                expect(loginManager['saveDetailsForSite']).toHaveBeenCalledWith(site, authInfoData);
                 expect(loginManager['_analyticsClient'].sendTrackEvent).toHaveBeenCalled();
             },
         );
@@ -219,7 +217,7 @@ describe('LoginManager', () => {
                     state: AuthInfoState.Valid,
                 };
 
-                jest.spyOn(loginManager as any, 'saveDetailsForServerSite').mockRejectedValue(
+                jest.spyOn(loginManager as any, 'saveDetailsForSite').mockRejectedValue(
                     new Error('Authentication failed'),
                 );
                 jest.spyOn(authInfo, 'isBasicAuthInfo').mockReturnValue(true);
@@ -256,7 +254,7 @@ describe('LoginManager', () => {
     });
 
     describe('updatedServerInfo', () => {
-        it('should call saveDetailsForServerSite with correct parameters for BasicAuthInfo', async () => {
+        it('should call saveDetailsForSite with correct parameters for BasicAuthInfo', async () => {
             const site: SiteInfo = { host: 'jira.atlassian.com', product: ProductJira };
             const user = forceCastTo<UserInfo>({ id: 'user' });
             const authInfoData: BasicAuthInfo = {
@@ -266,13 +264,13 @@ describe('LoginManager', () => {
                 state: AuthInfoState.Valid,
             };
 
-            jest.spyOn(loginManager as any, 'saveDetailsForServerSite').mockResolvedValue(site);
+            jest.spyOn(loginManager as any, 'saveDetailsForSite').mockResolvedValue(site);
             jest.spyOn(authInfo, 'isBasicAuthInfo').mockReturnValue(true);
             jest.spyOn(loginManager['_analyticsClient'], 'sendTrackEvent');
 
-            await loginManager.updatedServerInfo(site, authInfoData);
+            await loginManager.updateInfo(site, authInfoData);
 
-            expect(loginManager['saveDetailsForServerSite']).toHaveBeenCalledWith(site, authInfoData);
+            expect(loginManager['saveDetailsForSite']).toHaveBeenCalledWith(site, authInfoData);
             expect(loginManager['_analyticsClient'].sendTrackEvent).toHaveBeenCalled();
         });
 
@@ -286,12 +284,10 @@ describe('LoginManager', () => {
                 state: AuthInfoState.Valid,
             };
 
-            jest.spyOn(loginManager as any, 'saveDetailsForServerSite').mockRejectedValue(
-                new Error('Authentication failed'),
-            );
+            jest.spyOn(loginManager as any, 'saveDetailsForSite').mockRejectedValue(new Error('Authentication failed'));
             jest.spyOn(authInfo, 'isBasicAuthInfo').mockReturnValue(true);
 
-            await expect(loginManager.updatedServerInfo(site, authInfoData)).rejects.toEqual(
+            await expect(loginManager.updateInfo(site, authInfoData)).rejects.toEqual(
                 'Error authenticating with Jira: Error: Authentication failed',
             );
         });
diff --git a/src/atlclients/loginManager.ts b/src/atlclients/loginManager.ts
@@ -28,6 +28,8 @@ import { BitbucketAuthenticator } from './bitbucketAuthenticator';
 import { JiraAuthentictor as JiraAuthenticator } from './jiraAuthenticator';
 import { OAuthDancer } from './oauthDancer';
 
+const CLOUD_TLD = '.atlassian.net';
+
 export class LoginManager {
     private _dancer: OAuthDancer = OAuthDancer.Instance;
     private _jiraAuthenticator: JiraAuthenticator;
@@ -123,7 +125,7 @@ export class LoginManager {
     public async userInitiatedServerLogin(site: SiteInfo, authInfo: AuthInfo, isOnboarding?: boolean): Promise<void> {
         if (isBasicAuthInfo(authInfo) || isPATAuthInfo(authInfo)) {
             try {
-                const siteDetails = await this.saveDetailsForServerSite(site, authInfo);
+                const siteDetails = await this.saveDetailsForSite(site, authInfo);
 
                 authenticatedEvent(siteDetails, isOnboarding).then((e) => {
                     this._analyticsClient.sendTrackEvent(e);
@@ -135,10 +137,10 @@ export class LoginManager {
         }
     }
 
-    public async updatedServerInfo(site: SiteInfo, authInfo: AuthInfo): Promise<void> {
+    public async updateInfo(site: SiteInfo, authInfo: AuthInfo): Promise<void> {
         if (isBasicAuthInfo(authInfo)) {
             try {
-                const siteDetails = await this.saveDetailsForServerSite(site, authInfo);
+                const siteDetails = await this.saveDetailsForSite(site, authInfo);
                 editedEvent(siteDetails).then((e) => {
                     this._analyticsClient.sendTrackEvent(e);
                 });
@@ -159,7 +161,7 @@ export class LoginManager {
         return '';
     }
 
-    private async saveDetailsForServerSite(
+    private async saveDetailsForSite(
         site: SiteInfo,
         credentials: BasicAuthInfo | PATAuthInfo,
     ): Promise<DetailedSiteInfo> {
@@ -233,6 +235,13 @@ export class LoginManager {
             pfxPassphrase: site.pfxPassphrase,
         };
 
+        if (site.host.endsWith(CLOUD_TLD)) {
+            // Special case to accomodate for API key login to cloud instances
+            siteDetails.isCloud = true;
+            siteDetails.userId = json.accountId;
+            siteDetails.id = await this.fetchCloudSiteId(siteDetails.host);
+        }
+
         if (site.product.key === ProductJira.key) {
             credentials.user = {
                 displayName: json.displayName,
@@ -255,4 +264,10 @@ export class LoginManager {
 
         return siteDetails;
     }
+
+    private async fetchCloudSiteId(host: string): Promise<string> {
+        const response = await fetch(`https://${host}/_edge/tenant_info`);
+        const data = await response.json();
+        return data.cloudId;
+    }
 }
