fix(twitter): add X-Client-Transaction-Id

Author: 15cm

.npmrc

@@ -1,2 +1,3 @@
 package-lock=true
 package-manager-strict=false
+@jsr:registry=https://npm.jsr.io

lib/routes/twitter/api/developer-api/api.ts

@@ -230,14 +230,16 @@ const cacheTryGet = async (_id: string, params: Record<string, any> | undefined,
 
 const getUserTimeline = async (id: string, params?: Record<string, any>, options: Record<string, any> = {}) => {
     const client = await getAppClient();
-    const response = await client.v2.get(`users/${id}/tweets`, {
+    const { ...requestOptions } = options;
+    const requestParams = {
         max_results: params?.count ?? 20,
         expansions: 'author_id,attachments.media_keys,referenced_tweets.id,referenced_tweets.id.author_id',
         'tweet.fields': 'created_at,entities,conversation_id,referenced_tweets,author_id,in_reply_to_user_id',
         'user.fields': 'username,name,profile_image_url,description',
         'media.fields': 'preview_image_url,url,type,width,height,variants',
-        ...options,
-    });
+        ...requestOptions,
+    };
+    const response = await client.v2.get(`users/${id}/tweets`, requestParams);
     return mapTweetResponseToLegacy(response);
 };
 

lib/routes/twitter/api/mobile-api/api.ts

@@ -49,13 +49,14 @@ const twitterGot = async (url, params) => {
 };
 
 const paginationTweets = async (endpoint, userId, variables, path) => {
-    const { data } = await twitterGot(baseUrl + endpoint, {
+    const params = {
         variables: JSON.stringify({
             ...variables,
             rest_id: userId,
         }),
         features: gqlFeatures,
-    });
+    };
+    const { data } = await twitterGot(baseUrl + endpoint, params);
 
     let instructions;
     if (path) {

lib/routes/twitter/api/web-api/api.ts

@@ -41,20 +41,22 @@ const getUserData = (id) =>
         });
     });
 
-const cacheTryGet = async (_id, params, func) => {
+const cacheTryGet = async (_id, params, func, cacheKey = func.name) => {
     const userData: any = await getUserData(_id);
     const id = (userData.data?.user || userData.data?.user_result)?.result?.rest_id;
     if (id === undefined) {
         cache.set(`twitter-userdata-${_id}`, '', config.cache.contentExpire);
         throw new InvalidParameterError('User not found');
     }
-    const funcName = func.name;
     const paramsString = JSON.stringify(params);
-    return cache.tryGet(`twitter:${id}:${funcName}:${paramsString}`, () => func(id, params), config.cache.routeExpire, false);
+    return cache.tryGet(`twitter:${id}:${cacheKey}:${paramsString}`, () => func(id, params), config.cache.routeExpire, false);
 };
 
 const getUserTweets = (id: string, params?: Record<string, any>) =>
-    cacheTryGet(id, params, async (id, params = {}) =>
+    cacheTryGet(
+        id,
+        params,
+        async (id, params = {}) =>
         gatherLegacyFromData(
             await paginationTweets('UserTweets', id, {
                 ...params,
@@ -64,11 +66,15 @@ const getUserTweets = (id: string, params?: Record<string, any>) =>
                 withVoice: true,
                 withV2Timeline: true,
             })
-        )
+        ),
+        'getUserTweets'
     );
 
 const getUserTweetsAndReplies = (id: string, params?: Record<string, any>) =>
-    cacheTryGet(id, params, async (id, params = {}) =>
+    cacheTryGet(
+        id,
+        params,
+        async (id, params = {}) =>
         gatherLegacyFromData(
             await paginationTweets('UserTweetsAndReplies', id, {
                 ...params,
@@ -80,11 +86,15 @@ const getUserTweetsAndReplies = (id: string, params?: Record<string, any>) =>
             }),
             ['profile-conversation-'],
             id
-        )
+        ),
+        'getUserTweetsAndReplies'
     );
 
 const getUserMedia = (id: string, params?: Record<string, any>) =>
-    cacheTryGet(id, params, async (id, params = {}) =>
+    cacheTryGet(
+        id,
+        params,
+        async (id, params = {}) =>
         gatherLegacyFromData(
             await paginationTweets('UserMedia', id, {
                 ...params,
@@ -95,11 +105,15 @@ const getUserMedia = (id: string, params?: Record<string, any>) =>
                 withVoice: true,
                 withV2Timeline: true,
             })
-        )
+        ),
+        'getUserMedia'
     );
 
 const getUserLikes = (id: string, params?: Record<string, any>) =>
-    cacheTryGet(id, params, async (id, params = {}) =>
+    cacheTryGet(
+        id,
+        params,
+        async (id, params = {}) =>
         gatherLegacyFromData(
             await paginationTweets('Likes', id, {
                 ...params,
@@ -109,11 +123,15 @@ const getUserLikes = (id: string, params?: Record<string, any>) =>
                 withVoice: false,
                 withV2Timeline: true,
             })
-        )
+        ),
+        'getUserLikes'
     );
 
 const getUserTweet = (id: string, params?: Record<string, any>) =>
-    cacheTryGet(id, params, async (id, params = {}) =>
+    cacheTryGet(
+        id,
+        params,
+        async (id, params = {}) =>
         gatherLegacyFromData(
             await paginationTweets(
                 'TweetDetail',
@@ -129,7 +147,8 @@ const getUserTweet = (id: string, params?: Record<string, any>) =>
                 ['threaded_conversation_with_injections_v2']
             ),
             ['homeConversation-', 'conversationthread-']
-        )
+        ),
+        'getUserTweet'
     );
 
 const getSearch = async (keywords: string, params?: Record<string, any>) =>

lib/routes/twitter/api/web-api/client-transaction.ts

@@ -0,0 +1,19 @@
+import { ClientTransaction, handleXMigration } from '@lami/x-client-transaction-id';
+
+let clientTransactionPromise: Promise<ClientTransaction> | undefined;
+
+const buildClientTransaction = async () => ClientTransaction.create(await handleXMigration());
+
+const getClientTransaction = () => {
+    clientTransactionPromise ??= buildClientTransaction();
+    return clientTransactionPromise;
+};
+
+export const getClientTransactionId = async (method: string, path: string) => {
+    try {
+        const clientTransaction = await getClientTransaction();
+        return await clientTransaction.generateTransactionId(method, path);
+    } catch {
+        clientTransactionPromise = undefined;
+    }
+};

lib/routes/twitter/api/web-api/utils.ts

@@ -10,6 +10,7 @@ import logger from '@/utils/logger';
 import ofetch from '@/utils/ofetch';
 import proxy from '@/utils/proxy';
 
+import { getClientTransactionId } from './client-transaction';
 import { baseUrl, bearerToken, gqlFeatures, gqlMap, thirdPartySupportedAPI } from './constants';
 import login from './login';
 
@@ -80,6 +81,7 @@ export const twitterGot = async (
     params,
     options?: {
         allowNoAuth?: boolean;
+        headers?: Record<string, string>;
     }
 ) => {
     const auth = await getAuth(30);
@@ -171,6 +173,7 @@ export const twitterGot = async (
                 : {
                       'x-guest-token': jsonCookie.gt,
                   }),
+            ...options?.headers,
         },
         dispatcher: dispatchers?.agent,
     });
@@ -263,7 +266,14 @@ export const paginationTweets = async (endpoint: string, userId: number | undefi
             });
             return data;
         }
-        const { data } = await twitterGot(baseUrl + gqlMap[endpoint], params);
+        const transactionId = endpoint === 'UserTweetsAndReplies' ? await getClientTransactionId('GET', new URL(baseUrl + gqlMap[endpoint]).pathname) : undefined;
+        const { data } = await twitterGot(baseUrl + gqlMap[endpoint], params, {
+            headers: transactionId
+                ? {
+                      'x-client-transaction-id': transactionId,
+                  }
+                : undefined,
+        });
         return data;
     };
 

package.json

@@ -63,6 +63,7 @@
         "@hono/node-server": "1.19.14",
         "@hono/zod-openapi": "1.3.0",
         "@jocmp/mercury-parser": "3.0.7",
+        "@lami/x-client-transaction-id": "npm:@jsr/lami__x-client-transaction-id@^0.2.0",
         "@notionhq/client": "5.18.0",
         "@opentelemetry/api": "1.9.1",
         "@opentelemetry/exporter-prometheus": "0.214.0",