Matrix bot: add labels to generated notes. (#210)

* Add label to the notes generated by matrix-bot.

* Allow using major version in labels string.

Author: tomusdrw

tools/matrix-bot/convert-to-notes.ts

@@ -18,7 +18,12 @@ type Message = {
   msg: string;
 };
 
-export async function convertToNotes(meta: Metadata, file: string, outputFile?: string) {
+export function saveNotes(notes: INotesEnvelopeV3, outputFilename: string) {
+  fs.writeFileSync(path.resolve(outputFilename), JSON.stringify(notes));
+  console.info(`💾 Saved ${notes.notes.length} notes to ${outputFilename}.`);
+}
+
+export async function convertToNotes(meta: Metadata, file: string, labels?: string[]) {
   const data = JSON.parse(readFileSync(path.resolve(file), "utf-8")) as Message[];
 
   const notes = new Map<string, INoteV3>();
@@ -46,7 +51,7 @@ export async function convertToNotes(meta: Metadata, file: string, outputFile?:
         date,
         author: msg.sender,
         ...linkData,
-        labels: [],
+        labels: labels ?? [],
       });
     }
   }
@@ -56,12 +61,8 @@ export async function convertToNotes(meta: Metadata, file: string, outputFile?:
     version: 3,
     notes: notesArray,
   };
-  if (outputFile) {
-    fs.writeFileSync(path.resolve(outputFile), JSON.stringify(envelope));
-    console.info(`💾 Saved ${notesArray.length} notes to ${outputFile}.`);
-  } else {
-    console.info(JSON.stringify(envelope, null, 2));
-  }
+
+  return envelope;
 }
 
 function findAndParseLink(content: string, meta: Metadata) {
@@ -81,7 +82,8 @@ function findAndParseLink(content: string, meta: Metadata) {
 
 async function main(inputFilename: string, outputFilename: string) {
   const meta = await fetchMetadata();
-  await convertToNotes(meta, inputFilename, outputFilename);
+  const notes = await convertToNotes(meta, inputFilename);
+  saveNotes(notes, outputFilename);
 }
 
 if (require.main === module) {

tools/matrix-bot/index.ts

@@ -6,14 +6,15 @@ dotenv.config();
 const homeserverUrl = "https://matrix.org";
 const accessToken = process.env.ACCESS_TOKEN;
 const userId = process.env.USER_ID;
+const notesLabel = process.env.NOTES_LABEL;
 const roomId = "!ddsEwXlCWnreEGuqXZ:polkadot.io";
 
 if (!accessToken || !userId) {
   throw new Error("Provide .env file or ENV variables `ACCESS_TOKEN` and `USER_ID`");
 }
 
-async function main(accessToken: string, userId: string) {
-  const logger = new MessagesLogger(roomId);
+async function main(accessToken: string, userId: string, notesLabel?: string) {
+  const logger = new MessagesLogger(roomId, notesLabel ? [notesLabel] : []);
   const client = await listenToMessages(homeserverUrl, accessToken, userId, roomId, logger);
 
   const cleanup = () => {
@@ -23,4 +24,4 @@ async function main(accessToken: string, userId: string) {
   process.once("SIGINT", cleanup);
 }
 
-main(accessToken, userId);
+main(accessToken, userId, notesLabel);

tools/matrix-bot/logger.ts

@@ -1,10 +1,13 @@
 import { readFileSync, writeFileSync } from "node:fs";
 import path from "node:path";
 import { fetchMetadata, findLinkToLatestVersion } from "@fluffylabs/links-metadata";
-import { convertToNotes } from "./convert-to-notes";
+import { convertToNotes, saveNotes } from "./convert-to-notes";
 
 export class MessagesLogger {
-  constructor(private readonly roomId: string) {}
+  constructor(
+    private readonly roomId: string,
+    private readonly notesLabels: string[],
+  ) {}
 
   private generatePermalink(eventId: string): string {
     return `https://matrix.to/#/${this.roomId}/${eventId}`;
@@ -26,6 +29,8 @@ export class MessagesLogger {
 
     const majorVersion = `${versionName.split(".").slice(0, 2).join(".")}.x`;
     const outputFilename = `output/messages-${majorVersion}.json`;
+    const notesOutputFilename = `output/notes-${majorVersion}.json`;
+    const labels = this.notesLabels.map((x) => x.replace("$MAJOR_VERSION", majorVersion));
 
     const link = this.generatePermalink(eventId);
     const newMessage = {
@@ -36,15 +41,18 @@ export class MessagesLogger {
     };
 
     let messages = [];
+    // read previous log file
     try {
       messages = JSON.parse(readFileSync(path.resolve(outputFilename), "utf-8"));
     } catch (e) {}
+
+    // append the new message and save.
     messages.push(newMessage);
     writeFileSync(outputFilename, JSON.stringify(messages));
 
-    const notesFilename = `output/notes-${majorVersion}.json`;
     try {
-      convertToNotes(meta, outputFilename, notesFilename);
+      const notes = await convertToNotes(meta, outputFilename, labels);
+      saveNotes(notes, notesOutputFilename);
     } catch (e) {
       console.error(e);
     }