feat(patch): update()の第2引数から、Pageの全データを取り出せるようにした

Author: takker99

browser/websocket/_codeBlock.ts

@@ -1,6 +1,6 @@
 import { Change, Socket, wrap } from "../../deps/socket.ts";
+import {Page} from "../../deps/scrapbox-rest.ts";
 import { TinyCodeBlock } from "../../rest/getCodeBlocks.ts";
-import { HeadData } from "./pull.ts";
 import { getProjectId, getUserId } from "./id.ts";
 import { pushWithRetry } from "./_fetch.ts";
 
@@ -14,7 +14,7 @@ export interface CodeTitle {
 /** コミットを送信する一連の処理 */
 export const applyCommit = async (
   commits: Change[],
-  head: HeadData,
+  page: Page,
   projectName: string,
   pageTitle: string,
   socket: Socket,
@@ -26,9 +26,9 @@ export const applyCommit = async (
   ]);
   const { request } = wrap(socket);
   return await pushWithRetry(request, commits, {
-    parentId: head.commitId,
+    parentId: page.commitId,
     projectId: projectId,
-    pageId: head.pageId,
+    pageId: page.id,
     userId: userId_,
     project: projectName,
     title: pageTitle,

browser/websocket/deletePage.ts

@@ -20,7 +20,7 @@ export const deletePage = async (
   options?: DeletePageOptions,
 ): Promise<void> => {
   const [
-    { pageId, commitId: parentId, persistent },
+    { id: pageId, commitId: parentId, persistent },
     projectId,
     userId,
   ] = await Promise.all([

browser/websocket/makeChanges.ts

@@ -1,19 +1,18 @@
 import { diffToChanges } from "./diffToChanges.ts";
-import type { Line } from "../../deps/scrapbox.ts";
-import { Block, Node, parse } from "../../deps/scrapbox.ts";
+import { Block, Line, Node, parse } from "../../deps/scrapbox.ts";
+import { Page } from "../../deps/scrapbox-rest.ts";
 import type { Change } from "../../deps/socket.ts";
-import type { HeadData } from "./pull.ts";
 import { toTitleLc } from "../../title.ts";
 import { parseYoutube } from "../../parser/youtube.ts";
 
 export interface Init {
   userId: string;
-  head: HeadData;
+  page: Page;
 }
 export function* makeChanges(
   left: Pick<Line, "text" | "id">[],
   right: string[],
-  { userId, head }: Init,
+  { userId, page }: Init,
 ): Generator<Change, void, unknown> {
   // 改行文字が入るのを防ぐ
   const right_ = right.flatMap((text) => text.split("\n"));
@@ -24,7 +23,7 @@ export function* makeChanges(
 
   // titleの差分を入れる
   // 空ページの場合もタイトル変更commitを入れる
-  if (left[0].text !== right_[0] || !head.persistent) {
+  if (left[0].text !== right_[0] || !page.persistent) {
     yield { title: right_[0] };
   }
 
@@ -38,18 +37,18 @@ export function* makeChanges(
   // リンクと画像の差分を入れる
   const [links, projectLinks, image] = findLinksAndImage(right_.join("\n"));
   if (
-    head.links.length !== links.length ||
-    !head.links.every((link) => links.includes(link))
+    page.links.length !== links.length ||
+    !page.links.every((link) => links.includes(link))
   ) {
     yield { links };
   }
   if (
-    head.projectLinks.length !== projectLinks.length ||
-    !head.projectLinks.every((link) => projectLinks.includes(link))
+    page.projectLinks.length !== projectLinks.length ||
+    !page.projectLinks.every((link) => projectLinks.includes(link))
   ) {
     yield { projectLinks };
   }
-  if (head.image !== image) {
+  if (page.image !== image) {
     yield { image };
   }
 }

browser/websocket/patch.ts

@@ -2,14 +2,22 @@ import { Socket, socketIO, wrap } from "../../deps/socket.ts";
 import { connect, disconnect } from "./socket.ts";
 import { getProjectId, getUserId } from "./id.ts";
 import { makeChanges } from "./makeChanges.ts";
-import { HeadData, pull } from "./pull.ts";
-import type { Line } from "../../deps/scrapbox-rest.ts";
+import { pull } from "./pull.ts";
+import { Line, Page } from "../../deps/scrapbox-rest.ts";
 import { pushCommit, pushWithRetry } from "./_fetch.ts";
 
 export interface PatchOptions {
   socket?: Socket;
 }
 
+export interface PatchMetadata extends Page {
+  /** 書き換えを再試行した回数
+   *
+   * 初回は`0`で、再試行するたびに増える
+   */
+  retry: number;
+}
+
 /** ページ全体を書き換える
  *
  * serverには書き換え前後の差分だけを送信する
@@ -24,12 +32,12 @@ export const patch = async (
   title: string,
   update: (
     lines: Line[],
-    metadata: HeadData,
+    metadata: PatchMetadata,
   ) => string[] | undefined | Promise<string[] | undefined>,
   options?: PatchOptions,
 ): Promise<void> => {
   const [
-    head_,
+    page_,
     projectId,
     userId,
   ] = await Promise.all([
@@ -38,7 +46,7 @@ export const patch = async (
     getUserId(),
   ]);
 
-  let head = head_;
+  let page = page_;
 
   const injectedSocket = options?.socket;
   const socket = injectedSocket ?? await socketIO();
@@ -47,43 +55,43 @@ export const patch = async (
     const { request } = wrap(socket);
 
     // 3回retryする
-    for (let i = 0; i < 3; i++) {
+    for (let retry = 0; retry < 3; retry++) {
       try {
-        const pending = update(head.lines, head);
+        const pending = update(page.lines, { ...page, retry });
         const newLines = pending instanceof Promise ? await pending : pending;
 
         if (!newLines) return;
 
         if (newLines.length === 0) {
           await pushWithRetry(request, [{ deleted: true }], {
             projectId,
-            pageId: head.pageId,
-            parentId: head.commitId,
+            pageId: page.id,
+            parentId: page.commitId,
             userId,
             project,
             title,
           });
         }
 
         const changes = [
-          ...makeChanges(head.lines, newLines, { userId, head }),
+          ...makeChanges(page.lines, newLines, { userId, page }),
         ];
         await pushCommit(request, changes, {
-          parentId: head.commitId,
+          parentId: page.commitId,
           projectId,
-          pageId: head.pageId,
+          pageId: page.id,
           userId,
         });
         break;
       } catch (_e: unknown) {
-        if (i === 2) {
+        if (retry === 2) {
           throw Error("Faild to retry pushing.");
         }
         console.log(
           "Faild to push a commit. Retry after pulling new commits",
         );
         try {
-          head = await pull(project, title);
+          page = await pull(project, title);
         } catch (e: unknown) {
           throw e;
         }

browser/websocket/pin.ts

@@ -27,7 +27,7 @@ export const pin = async (
   options?: PinOptions,
 ): Promise<void> => {
   const [
-    head,
+    page,
     projectId,
     userId,
   ] = await Promise.all([
@@ -37,12 +37,12 @@ export const pin = async (
   ]);
 
   // 既にピン留めされている場合は何もしない
-  if (head.pin > 0 || (!head.persistent && !(options?.create ?? false))) return;
+  if (page.pin > 0 || (!page.persistent && !(options?.create ?? false))) return;
 
   const init = {
-    parentId: head.commitId,
+    parentId: page.commitId,
     projectId,
-    pageId: head.pageId,
+    pageId: page.id,
     userId,
     project,
     title,
@@ -53,7 +53,7 @@ export const pin = async (
   const { request } = wrap(socket);
 
   // タイトルのみのページを作る
-  if (!head.persistent) {
+  if (!page.persistent) {
     const commitId = await pushWithRetry(request, [{ title }], init);
     init.parentId = commitId;
   }
@@ -79,7 +79,7 @@ export const unpin = async (
   options: UnPinOptions,
 ): Promise<void> => {
   const [
-    head,
+    page,
     projectId,
     userId,
   ] = await Promise.all([
@@ -89,12 +89,12 @@ export const unpin = async (
   ]);
 
   // 既にピンが外れているか、そもそも存在しないページの場合は何もしない
-  if (head.pin == 0 || !head.persistent) return;
+  if (page.pin == 0 || !page.persistent) return;
 
   const init = {
-    parentId: head.commitId,
+    parentId: page.commitId,
     projectId,
-    pageId: head.pageId,
+    pageId: page.id,
     userId,
     project,
     title,

browser/websocket/pull.ts

@@ -1,37 +1,16 @@
-import type { Line } from "../../deps/scrapbox-rest.ts";
+import { Page } from "../../deps/scrapbox-rest.ts";
 import { getPage } from "../../rest/pages.ts";
 
-export interface HeadData {
-  commitId: string;
-  pageId: string;
-  persistent: boolean;
-  image: string | null;
-  pin: number;
-  links: string[];
-  projectLinks: string[];
-  lines: Line[];
-}
 export const pull = async (
   project: string,
   title: string,
-): Promise<HeadData> => {
+): Promise<Page> => {
   const result = await getPage(project, title);
 
   // TODO: 編集不可なページはStream購読だけ提供する
   if (!result.ok) {
     throw new Error(`You have no privilege of editing "/${project}/${title}".`);
   }
-  const { commitId, persistent, image, links, projectLinks, lines, id, pin } =
-    result.value;
 
-  return {
-    commitId,
-    pageId: id,
-    persistent,
-    image,
-    links,
-    projectLinks,
-    pin,
-    lines,
-  };
+  return result.value;
 };