feat: Mention Mapping

.dockerignore

@@ -3,3 +3,8 @@ node_modules/
 deployment/
 docs/
 Dockerfile
+
+# Temporary files
+cache*.json
+cookies*.json
+mention-mapping*.json

.gitignore

@@ -14,3 +14,4 @@ coverage/
 # Temporary files
 cache*.json
 cookies*.json
+mention-mapping*.json

src/configuration/configuration.ts

@@ -1,3 +1,5 @@
+import { readFile } from "node:fs/promises";
+
 import { AtpAgent } from "@atproto/api";
 import { ResponseType, ResponseTypeNames } from "@atproto/xrpc";
 import pm2 from "@pm2/io";
@@ -13,6 +15,7 @@ import {
   BLUESKY_PASSWORD,
   MASTODON_ACCESS_TOKEN,
   MASTODON_INSTANCE,
+  MENTION_MAPPING_PATH,
   SYNC_BLUESKY,
   SYNC_DRY_RUN,
   SYNC_MASTODON,
@@ -25,6 +28,7 @@ import { getCachedPosts } from "../helpers/cache/get-cached-posts";
 import { runMigrations } from "../helpers/cache/run-migrations";
 import { TouitomamoutError } from "../helpers/error";
 import { oraPrefixer } from "../helpers/logs";
+import { MentionMapping } from "../types/mentionMapping";
 import { buildConfigurationRules } from "./build-configuration-rules";
 
 export const configuration = async (): Promise<{
@@ -33,6 +37,7 @@ export const configuration = async (): Promise<{
   twitterClient: Scraper;
   mastodonClient: null | mastodon.rest.Client;
   blueskyClient: null | AtpAgent;
+  mentionsMapping: MentionMapping[];
 }> => {
   // Error handling
   const rules = buildConfigurationRules();
@@ -160,11 +165,30 @@ export const configuration = async (): Promise<{
       });
   }
 
+  let mentionsMapping: MentionMapping[] = [];
+
+  try {
+    const content = (await readFile(MENTION_MAPPING_PATH)).toString();
+    mentionsMapping = JSON.parse(content) as MentionMapping[];
+  } catch (e) {
+    const log = ora({
+      color: "gray",
+      prefixText: oraPrefixer("mention-mapping"),
+    });
+    if (e instanceof Error && "code" in e && e.code == "ENOENT") {
+      log.warn(`No mention mapping file found (${MENTION_MAPPING_PATH})`);
+    } else {
+      log.fail(`Error when read ${MENTION_MAPPING_PATH}`);
+      console.error(e);
+    }
+  }
+
   return {
     mastodonClient,
     twitterClient,
     blueskyClient,
     synchronizedPostsCountAllTime,
     synchronizedPostsCountThisRun,
+    mentionsMapping,
   };
 };

src/constants.ts

@@ -44,6 +44,7 @@ export const INSTANCE_ID = (TWITTER_HANDLE ?? "instance")
 export const STORAGE_DIR = process.env.STORAGE_DIR ?? process.cwd();
 export const CACHE_PATH = `${STORAGE_DIR}/cache.${INSTANCE_ID}.json`;
 export const COOKIES_PATH = `${STORAGE_DIR}/cookies.${INSTANCE_ID}.json`;
+export const MENTION_MAPPING_PATH = `${STORAGE_DIR}/mention-mapping.${INSTANCE_ID}.json`;
 export const SYNC_MASTODON = (process.env.SYNC_MASTODON ?? "false") === "true";
 export const SYNC_BLUESKY = (process.env.SYNC_BLUESKY ?? "false") === "true";
 export const BACKDATE_BLUESKY_POSTS =

src/helpers/post/make-bluesky-post.ts

@@ -3,13 +3,15 @@ import { Tweet } from "@the-convocation/twitter-scraper";
 
 import { BLUESKY_IDENTIFIER } from "../../constants";
 import { BlueskyCacheChunk, Platform } from "../../types";
+import { MentionMapping } from "../../types/mentionMapping";
 import { BlueskyPost } from "../../types/post";
 import { getCachedPostChunk } from "../cache/get-cached-post-chunk";
 import { splitTextForBluesky } from "../tweet/split-tweet-text";
 
 export const makeBlueskyPost = async (
   client: AtpAgent,
   tweet: Tweet,
+  mentionsMapping: MentionMapping[],
 ): Promise<BlueskyPost> => {
   const username = await client
     .getProfile({ actor: BLUESKY_IDENTIFIER })
@@ -57,7 +59,7 @@ export const makeBlueskyPost = async (
   await post.detectFacets(client); // automatically detects mentions and links
 
   return {
-    chunks: await splitTextForBluesky(tweet),
+    chunks: await splitTextForBluesky(tweet, mentionsMapping),
     username,
     replyPost,
     quotePost,

src/helpers/post/make-mastodon-post.ts

@@ -2,13 +2,15 @@ import { Tweet } from "@the-convocation/twitter-scraper";
 import { mastodon } from "masto";
 
 import { Platform } from "../../types";
+import { MentionMapping } from "../../types/mentionMapping";
 import { MastodonPost } from "../../types/post";
 import { getCachedPosts } from "../cache/get-cached-posts";
 import { splitTextForMastodon } from "../tweet/split-tweet-text";
 
 export const makeMastodonPost = async (
   client: mastodon.rest.Client,
   tweet: Tweet,
+  mentionsMapping: MentionMapping[],
 ): Promise<MastodonPost> => {
   const cachedPosts = await getCachedPosts();
 
@@ -17,7 +19,7 @@ export const makeMastodonPost = async (
     .then((account) => account.username);
 
   // Get post chunks (including quote in first one when needed)
-  const chunks = await splitTextForMastodon(tweet, username);
+  const chunks = await splitTextForMastodon(tweet, mentionsMapping, username);
 
   // Get in reply post references
   let inReplyToId = undefined;

src/helpers/post/make-post.ts

@@ -4,6 +4,7 @@ import { mastodon } from "masto";
 import { Ora } from "ora";
 
 import { VOID } from "../../constants";
+import { MentionMapping } from "../../types/mentionMapping";
 import { BlueskyPost, MastodonPost, Post } from "../../types/post";
 import { oraProgress } from "../logs";
 import { getPostExcerpt } from "./get-post-excerpt";
@@ -39,6 +40,7 @@ export const makePost = async (
   blueskyClient: AtpAgent | null,
   log: Ora,
   counters: { current: number; total: number },
+  mentionsMapping: MentionMapping[],
 ): Promise<Post> => {
   const postExcerpt = getPostExcerpt(tweet.text ?? VOID).padEnd(32, " ");
   log.color = "magenta";
@@ -52,13 +54,17 @@ export const makePost = async (
   // Mastodon post
   let mastodonPost = null;
   if (mastodonClient) {
-    mastodonPost = await makeMastodonPost(mastodonClient, tweet);
+    mastodonPost = await makeMastodonPost(
+      mastodonClient,
+      tweet,
+      mentionsMapping,
+    );
   }
 
   // Bluesky post
   let blueskyPost = null;
   if (blueskyClient) {
-    blueskyPost = await makeBlueskyPost(blueskyClient, tweet);
+    blueskyPost = await makeBlueskyPost(blueskyClient, tweet, mentionsMapping);
   }
 
   const chunksByPlatform = {

src/helpers/tweet/__tests__/split-tweet-text.spec.ts

@@ -1,6 +1,8 @@
 import { Tweet } from "@the-convocation/twitter-scraper";
+import { describe, expect, it, vi } from "vitest";
 
 import { MASTODON_INSTANCE } from "../../../constants";
+import { MentionMapping } from "../../../types/mentionMapping";
 import {
   splitTextForBluesky,
   splitTextForMastodon,
@@ -63,9 +65,10 @@ describe("splitTweetText", () => {
         } as Tweet;
         const mastodonStatuses = await splitTextForMastodon(
           tweet,
+          [],
           MASTODON_USERNAME,
         );
-        const blueskyStatuses = await splitTextForBluesky(tweet);
+        const blueskyStatuses = await splitTextForBluesky(tweet, []);
 
         checkChunksLengthExpectations(mastodonStatuses, blueskyStatuses);
         expect(mastodonStatuses).toEqual([
@@ -85,9 +88,10 @@ describe("splitTweetText", () => {
         } as unknown as Tweet;
         const mastodonStatuses = await splitTextForMastodon(
           tweet,
+          [],
           MASTODON_USERNAME,
         );
-        const blueskyStatuses = await splitTextForBluesky(tweet);
+        const blueskyStatuses = await splitTextForBluesky(tweet, []);
 
         checkChunksLengthExpectations(mastodonStatuses, blueskyStatuses);
         expect(mastodonStatuses).toEqual([POST_99_CHARS]);
@@ -103,9 +107,10 @@ describe("splitTweetText", () => {
         } as unknown as Tweet;
         const mastodonStatuses = await splitTextForMastodon(
           tweet,
+          [],
           MASTODON_USERNAME,
         );
-        const blueskyStatuses = await splitTextForBluesky(tweet);
+        const blueskyStatuses = await splitTextForBluesky(tweet, []);
 
         checkChunksLengthExpectations(mastodonStatuses, blueskyStatuses);
         expect(mastodonStatuses).toEqual([
@@ -124,9 +129,10 @@ describe("splitTweetText", () => {
         } as Tweet;
         const mastodonStatuses = await splitTextForMastodon(
           tweet,
+          [],
           MASTODON_USERNAME,
         );
-        const blueskyStatuses = await splitTextForBluesky(tweet);
+        const blueskyStatuses = await splitTextForBluesky(tweet, []);
 
         checkChunksLengthExpectations(mastodonStatuses, blueskyStatuses);
         expect(mastodonStatuses).toEqual([POST_299_CHARS]);
@@ -142,9 +148,10 @@ describe("splitTweetText", () => {
         } as unknown as Tweet;
         const mastodonStatuses = await splitTextForMastodon(
           tweet,
+          [],
           MASTODON_USERNAME,
         );
-        const blueskyStatuses = await splitTextForBluesky(tweet);
+        const blueskyStatuses = await splitTextForBluesky(tweet, []);
 
         checkChunksLengthExpectations(mastodonStatuses, blueskyStatuses);
         expect(mastodonStatuses).toEqual([
@@ -164,9 +171,10 @@ describe("splitTweetText", () => {
         } as unknown as Tweet;
         const mastodonStatuses = await splitTextForMastodon(
           tweet,
+          [],
           MASTODON_USERNAME,
         );
-        const blueskyStatuses = await splitTextForBluesky(tweet);
+        const blueskyStatuses = await splitTextForBluesky(tweet, []);
 
         checkChunksLengthExpectations(mastodonStatuses, blueskyStatuses);
         expect(mastodonStatuses).toStrictEqual([
@@ -191,9 +199,10 @@ describe("splitTweetText", () => {
         } as unknown as Tweet;
         const mastodonStatuses = await splitTextForMastodon(
           tweet,
+          [],
           MASTODON_USERNAME,
         );
-        const blueskyStatuses = await splitTextForBluesky(tweet);
+        const blueskyStatuses = await splitTextForBluesky(tweet, []);
 
         checkChunksLengthExpectations(mastodonStatuses, blueskyStatuses);
 
@@ -223,9 +232,10 @@ describe("splitTweetText", () => {
         } as Tweet;
         const mastodonStatuses = await splitTextForMastodon(
           tweet,
+          [],
           MASTODON_USERNAME,
         );
-        const blueskyStatuses = await splitTextForBluesky(tweet);
+        const blueskyStatuses = await splitTextForBluesky(tweet, []);
 
         checkChunksLengthExpectations(mastodonStatuses, blueskyStatuses);
         expect(mastodonStatuses).toEqual([
@@ -244,9 +254,10 @@ describe("splitTweetText", () => {
       } as Tweet;
       const mastodonStatuses = await splitTextForMastodon(
         tweet,
+        [],
         MASTODON_USERNAME,
       );
-      const blueskyStatuses = await splitTextForBluesky(tweet);
+      const blueskyStatuses = await splitTextForBluesky(tweet, []);
 
       checkChunksLengthExpectations(mastodonStatuses, blueskyStatuses);
       expect(mastodonStatuses).toEqual([
@@ -271,9 +282,10 @@ describe("splitTweetText", () => {
       } as Tweet;
       const mastodonStatuses = await splitTextForMastodon(
         tweet,
+        [],
         MASTODON_USERNAME,
       );
-      const blueskyStatuses = await splitTextForBluesky(tweet);
+      const blueskyStatuses = await splitTextForBluesky(tweet, []);
 
       checkChunksLengthExpectations(mastodonStatuses, blueskyStatuses);
       expect(mastodonStatuses).toEqual([
@@ -294,9 +306,10 @@ describe("splitTweetText", () => {
       } as Tweet;
       const mastodonStatuses = await splitTextForMastodon(
         tweet,
+        [],
         MASTODON_USERNAME,
       );
-      const blueskyStatuses = await splitTextForBluesky(tweet);
+      const blueskyStatuses = await splitTextForBluesky(tweet, []);
 
       checkChunksLengthExpectations(mastodonStatuses, blueskyStatuses);
       expect(mastodonStatuses).toEqual([
@@ -308,4 +321,32 @@ describe("splitTweetText", () => {
       ]);
     });
   });
+
+  describe("when mention user with existing mention mapping", () => {
+    it("should return text with the replaced mention", async () => {
+      const tweet = {
+        text: "Hello @ralmn45 how are you?",
+        mentions: [{ id: "12345", username: "ralmn45", name: "ralmn" }],
+      } as Tweet;
+      const mentionsMapping: MentionMapping[] = [
+        {
+          twitter: "ralmn45",
+          mastodon: "[email protected]",
+          bluesky: "ralmn.fr",
+        },
+      ];
+
+      const mastodonStatuses = await splitTextForMastodon(
+        tweet,
+        mentionsMapping,
+        MASTODON_USERNAME,
+      );
+      const blueskyStatuses = await splitTextForBluesky(tweet, mentionsMapping);
+
+      expect(mastodonStatuses).toEqual([
+        `Hello @[email protected] how are you?`,
+      ]);
+      expect(blueskyStatuses).toEqual([`Hello @ralmn.fr how are you?`]);
+    });
+  });
 });