Batch network requests

Author: JesseWilliamson

src/anki-connect/client.ts

@@ -1,13 +1,15 @@
 import { requestUrl, RequestUrlParam, RequestUrlResponse } from "obsidian";
-import { AnkiActionResponse, CreateModelInput, Note, NoteFields } from "./types";
+import { AnkiActionResponse, AnkiMultiAction, CreateModelInput, Note, NoteFields } from "./types";
 
 const DEFAULT_ANKI_CONNECT_URL = "http://localhost:8765";
 const DEFAULT_ANKI_CONNECT_VERSION = 6;
+const REQUEST_LOG_PREFIX = "[anki-link][network]";
 
 type AnkiAction =
 	| "createDeck"
 	| "createModel"
 	| "addNote"
+	| "addNotes"
 	| "addTags"
 	| "changeDeck"
 	| "deckNames"
@@ -17,7 +19,8 @@ type AnkiAction =
 	| "findNotes"
 	| "deleteNotes"
 	| "notesInfo"
-	| "updateNoteFields";
+	| "updateNoteFields"
+	| "multi";
 
 interface AnkiConnectClientOptions {
 	url?: string;
@@ -42,8 +45,24 @@ export class AnkiConnectClient {
 	}
 
 	private async send<T>(action: AnkiAction, params?: unknown): Promise<AnkiActionResponse<T>> {
-		const response: RequestUrlResponse = await requestUrl(this.buildRequest(action, params));
-		return response.json as AnkiActionResponse<T>;
+		const request = this.buildRequest(action, params);
+		const startedAt = Date.now();
+		console.debug(`${REQUEST_LOG_PREFIX} -> ${request.method} ${request.url} action=${action}`);
+		try {
+			const response: RequestUrlResponse = await requestUrl(request);
+			const elapsedMs = Date.now() - startedAt;
+			const result = response.json as AnkiActionResponse<T>;
+			const status = result.error ? "error" : "ok";
+			console.debug(`${REQUEST_LOG_PREFIX} <- action=${action} status=${status} elapsedMs=${elapsedMs}`);
+			if (result.error) {
+				console.debug(`${REQUEST_LOG_PREFIX} !! action=${action} error="${result.error}"`);
+			}
+			return result;
+		} catch (error) {
+			const elapsedMs = Date.now() - startedAt;
+			console.debug(`${REQUEST_LOG_PREFIX} xx action=${action} threw elapsedMs=${elapsedMs}`);
+			throw error;
+		}
 	}
 
 	async deckNames(): Promise<AnkiActionResponse<string[]>> {
@@ -81,6 +100,10 @@ export class AnkiConnectClient {
 		return this.send<number>("addNote", { note });
 	}
 
+	async addNotes(notes: Note[]): Promise<AnkiActionResponse<(number | null)[]>> {
+		return this.send<(number | null)[]>("addNotes", { notes });
+	}
+
 	async addTags(notes: number[], tags: string): Promise<AnkiActionResponse<null>> {
 		return this.send<null>("addTags", { notes, tags });
 	}
@@ -104,6 +127,10 @@ export class AnkiConnectClient {
 	async changeDeck(cards: number[], deck: string): Promise<AnkiActionResponse<null>> {
 		return this.send<null>("changeDeck", { cards, deck });
 	}
+
+	async multi(actions: AnkiMultiAction[]): Promise<AnkiActionResponse<AnkiActionResponse<unknown>[]>> {
+		return this.send<AnkiActionResponse<unknown>[]>("multi", { actions });
+	}
 }
 
 export const defaultAnkiConnectClient = new AnkiConnectClient();

src/anki-connect/types.ts

@@ -3,6 +3,11 @@ export interface AnkiActionResponse<T> {
 	result: T;
 }
 
+export interface AnkiMultiAction {
+	action: string;
+	params?: unknown;
+}
+
 export interface NoteFields {
 	Front: string;
 	Back: string;

src/ankiConnectUtil.ts

@@ -1,8 +1,8 @@
 import { RequestUrlParam } from "obsidian";
 import { defaultAnkiConnectClient } from "./anki-connect/client";
-import { AnkiActionResponse, Note, NoteFields, NoteInfo } from "./anki-connect/types";
+import { AnkiActionResponse, AnkiMultiAction, Note, NoteFields, NoteInfo } from "./anki-connect/types";
 
-export type { Note, NoteFields, NoteInfo } from "./anki-connect/types";
+export type { AnkiMultiAction, Note, NoteFields, NoteInfo } from "./anki-connect/types";
 
 export enum DeckTypes {
 	BASIC = "basic",
@@ -48,6 +48,10 @@ export interface AddNoteResult extends ConnResult {
 	result: number;
 }
 
+export interface AddNotesResult extends ConnResult {
+	result: (number | null)[];
+}
+
 export interface AddTagsResult extends ConnResult {
 	result: null;
 }
@@ -72,6 +76,10 @@ export interface UpdateNoteFieldsResult extends ConnResult {
 	result: null;
 }
 
+export interface MultiResult extends ConnResult {
+	result: AnkiActionResponse<unknown>[];
+}
+
 /**
  * Check if a value from notesInfo is a valid note (and not an empty object
  * returned when the note was deleted in Anki).
@@ -219,6 +227,10 @@ export async function sendAddNoteRequest(note: Note): Promise<AddNoteResult> {
 	return toResult(defaultAnkiConnectClient.addNote(note));
 }
 
+export async function sendAddNotesRequest(notes: Note[]): Promise<AddNotesResult> {
+	return toResult(defaultAnkiConnectClient.addNotes(notes));
+}
+
 export async function sendNotesInfoRequest(notes: number[]): Promise<NotesInfoResult> {
 	return toResult(defaultAnkiConnectClient.notesInfo(notes));
 }
@@ -227,6 +239,10 @@ export async function sendUpdateNoteFieldsRequest(id: number, fields: NoteFields
 	return toResult(defaultAnkiConnectClient.updateNoteFields(id, fields));
 }
 
+export async function sendMultiRequest(actions: AnkiMultiAction[]): Promise<MultiResult> {
+	return toResult(defaultAnkiConnectClient.multi(actions));
+}
+
 export async function sendDeckNamesRequest(): Promise<DeckNamesResult> {
 	return toResult(defaultAnkiConnectClient.deckNames());
 }