fix: Make Gaia hub profile fetching and uploading in makeAuthResponse optional

Author: janniks

package-lock.json

@@ -13,14 +13,20 @@ import {
 } from '@stacks/encryption';
 import { NetworkParam, StacksNetwork, StacksNetworkName } from '@stacks/network';
 import { getAddressFromPrivateKey } from '@stacks/transactions';
-import { connectToGaiaHubWithConfig, getHubInfo, makeGaiaAssociationToken } from '../utils';
+import {
+  HubInfo,
+  connectToGaiaHubWithConfig,
+  getHubInfo,
+  makeGaiaAssociationToken,
+} from '../utils';
 import { Account, HARDENED_OFFSET } from './common';
 import {
   DEFAULT_PROFILE,
   fetchAccountProfileUrl,
   fetchProfileFromUrl,
   signAndUploadProfile,
 } from './profile';
+import { PublicProfileBase } from '@stacks/profile';
 
 export function getStxAddress(
   account: Account,
@@ -76,6 +82,28 @@ export const getAppPrivateKey = ({
   return bytesToHex(appKeychain.privateKey);
 };
 
+/** @internal helper */
+async function optionalGaiaProfileData({
+  gaiaHubUrl,
+  fetchFn,
+  account,
+}: {
+  gaiaHubUrl: string;
+  fetchFn: FetchFn;
+  account: Account;
+}): Promise<{
+  hubInfo?: HubInfo;
+  profileUrl?: string;
+  profile?: PublicProfileBase | null;
+}> {
+  const hubInfo = await getHubInfo(gaiaHubUrl, fetchFn).catch(() => undefined);
+  if (!hubInfo) return {}; // keep data undefined if hub is not available
+
+  const profileUrl = await fetchAccountProfileUrl({ account, gaiaHubUrl: hubInfo.read_url_prefix });
+  const profile = (await fetchProfileFromUrl(profileUrl, fetchFn)) || DEFAULT_PROFILE;
+  return { hubInfo, profileUrl, profile };
+}
+
 export const makeAuthResponse = async ({
   account,
   appDomain,
@@ -96,10 +124,14 @@ export const makeAuthResponse = async ({
   fetchFn?: FetchFn;
 }) => {
   const appPrivateKey = getAppPrivateKey({ account, appDomain });
-  const hubInfo = await getHubInfo(gaiaHubUrl, fetchFn);
-  const profileUrl = await fetchAccountProfileUrl({ account, gaiaHubUrl: hubInfo.read_url_prefix });
-  const profile = (await fetchProfileFromUrl(profileUrl, fetchFn)) || DEFAULT_PROFILE;
-  if (scopes.includes('publish_data')) {
+
+  const { hubInfo, profileUrl, profile } = await optionalGaiaProfileData({
+    gaiaHubUrl,
+    fetchFn,
+    account,
+  });
+
+  if (scopes.includes('publish_data') && hubInfo && profile) {
     if (!profile.apps) {
       profile.apps = {};
     }
@@ -138,9 +170,7 @@ export const makeAuthResponse = async ({
       },
       ...additionalData,
     },
-    {
-      profileUrl,
-    },
+    profileUrl ? { profileUrl } : null,
     undefined,
     appPrivateKey,
     undefined,

packages/wallet-sdk/src/models/account.ts

@@ -34,7 +34,8 @@ export const getProfileURLFromZoneFile = async (
   return;
 };
 
-interface HubInfo {
+/** @internal */
+export interface HubInfo {
   challenge_text?: string;
   read_url_prefix: string;
 }

packages/wallet-sdk/src/utils.ts

@@ -26,7 +26,7 @@ test('generates the correct app private key', () => {
   expect(appPrivateKey).toEqual(expectedKey);
 });
 
-describe(makeAuthResponse, () => {
+describe(makeAuthResponse.name, () => {
   test('generates an auth response', async () => {
     const account = mockAccount;
     const appDomain = 'https://banter.pub';
@@ -128,4 +128,96 @@ describe(makeAuthResponse, () => {
     expect(appPrivateKey).toEqual(expectedKey);
     expect(payload.appPrivateKeyFromWalletSalt).toEqual(appPrivateKeyFromWalletSalt);
   });
+
+  describe('Gaia optional functionality', () => {
+    const TEST_CASES = [
+      {
+        mock: () => fetchMock.mockRejectOnce(new Error('Network error')),
+        opts: {},
+      },
+      {
+        mock: () => fetchMock.mockResponseOnce('Internal Server Error', { status: 500 }),
+        opts: {},
+      },
+      {
+        mock: () => fetchMock.mockRejectOnce(new Error('Connection timeout')),
+        opts: { scopes: ['publish_data'] },
+      },
+      {
+        mock: () => fetchMock.mockResponseOnce('Not Found', { status: 404 }),
+        opts: { scopes: ['publish_data'] },
+      },
+      {
+        mock: () =>
+          fetchMock.mockImplementationOnce(() => Promise.reject(new Error('Request timeout'))),
+        opts: { scopes: ['read_write'] },
+      },
+    ];
+    test.each(TEST_CASES)(makeAuthResponse.name, async ({ mock, opts }) => {
+      mock();
+
+      const account = mockAccount;
+      const transitPrivateKey = makeECPrivateKey();
+      const transitPublicKey = getPublicKeyFromPrivate(transitPrivateKey);
+
+      const authResponse = await makeAuthResponse({
+        appDomain: 'https://banter.pub',
+        gaiaHubUrl,
+        transitPublicKey,
+        account,
+        ...opts,
+      });
+
+      // Common verifications
+      expect(authResponse).toBeTruthy();
+      const decoded = decodeToken(authResponse);
+      const { payload } = decoded as Decoded;
+
+      expect(payload.profile_url).toBeNull();
+      expect(payload.profile).toBeDefined();
+      expect(payload.profile.stxAddress).toBeDefined();
+      expect(payload.profile.stxAddress.testnet).toBeDefined();
+      expect(payload.profile.stxAddress.mainnet).toBeDefined();
+
+      expect(fetchMock.mock.calls.length).toEqual(1);
+    });
+
+    test('makeAuthResponse handles mixed success/failure gracefully', async () => {
+      const account = mockAccount;
+      const transitPrivateKey = makeECPrivateKey();
+      const transitPublicKey = getPublicKeyFromPrivate(transitPrivateKey);
+
+      // First call succeeds with hub info, second call (profile fetch) fails
+      fetchMock
+        .mockResponseOnce(mockGaiaHubInfo)
+        .mockResponseOnce('', { status: 404 }) // profile fetch fails
+        .mockResponseOnce(JSON.stringify({ publicUrl: 'asdf' })); // profile upload succeeds
+
+      const authResponse = await makeAuthResponse({
+        appDomain: 'https://banter.pub',
+        gaiaHubUrl,
+        transitPublicKey,
+        account,
+        scopes: ['publish_data'],
+      });
+
+      // Verify auth response is generated successfully
+      expect(authResponse).toBeTruthy();
+      const decoded = decodeToken(authResponse);
+      const { payload } = decoded as Decoded;
+
+      // Verify we get profile_url since hub info succeeded
+      expect(payload.profile_url).toEqual(
+        `https://gaia.blockstack.org/hub/${getGaiaAddress(account)}/profile.json`
+      );
+
+      // Verify profile upload was successful and profile apps were added
+      expect(payload.profile).toBeDefined();
+      expect(payload.profile.apps).toBeDefined();
+      expect(payload.profile.apps['https://banter.pub']).toBeDefined();
+
+      // Verify three fetch calls were made (hub info, profile fetch, profile upload)
+      expect(fetchMock.mock.calls.length).toEqual(3);
+    });
+  });
 });