家族用の新聞を作っています。日々の記事と一緒に、一週間の勤務や、家で昼ごはんを食べる予定も載せるものです。可愛い新聞で予定を眺めて、そこから別の話も始まってほしい。
その週間予定の実装を読み直して、気になったのがUndoでした。月曜号で「水曜は出社」に変えた。その操作を取り消したのに、共有予定の水曜は出社のままになる場合があります。
後から火曜号でも予定を決めていたら、どこまで戻してよいのか。一つの操作で、日別のデータと共有データの両方を更新するアプリの話です。共通テンプレートをコピーした文書から、テンプレートにも書き戻せるエディタでも、同じ問いが生まれます。
以下の予定は架空です。既存実装の説明と、勤務欄だけに縮めた公開用JavaScriptモデルをもとに追います。日別の編集データを扱う話で、発行済みPDFを戻す話ではありません。
号はコピーを持ち、共有予定へも書き戻す
編集用のデータには、日別の「号」と、その週の「共有予定」があります。
共有予定は、次に作る号へ引き継ぐ土台です。新しい号を作るときにコピーします。保存済みの号を開くときは、その号に保存した内容を読みます。共有予定を更新しても、すでにある号が全部書き換わるわけではありません。
一方、各号から週間予定を保存すると、共有側も更新されます。内容を変えたら共有側の採用フラグをfalseにし、予定を確認して採用する操作でtrueにする。同じ内容を保存しただけなら、採用状態は保ちます。
号は自分のコピーを持ちながら、次の号が使う土台も更新できる。この二つをUndoでどう戻すかが、今回の焦点です。
火曜の休みを残すと、水曜の出社も残る
一人分の水曜・木曜の勤務だけを取り出します。
| 呼び名 | 水曜 | 木曜 |
|---|---|---|
| A | 在宅 | 在宅 |
| B | 出社 | 在宅 |
| C | 出社 | 休み |
月曜号にはAが保存され、共有Aも採用済みだったとします。そこから、次の順で操作します。
- 月曜号で、水曜を「在宅」から「出社」へ変えて保存する。月曜号も共有予定もBになり、共有は未採用になる。
- ここで初めて火曜号を作る。Bを引き継いだ週表の、木曜を「休み」へ変えて保存し、採用する。共有予定はC・採用済みになる。
- 月曜号へ戻り、最初の変更をUndoする。
下の操作台は、そのUndoの直前から始まります。「月曜号をUndo」を一度押すと、号と共有予定のどちらが戻るでしょう。
戻る号。残る共有予定。
架空の予定を使う、このページだけの説明模型です。月曜号へ戻って、一度取り消します。
月曜号
B
- 水曜
- 出社
- 木曜
- 在宅
- 見出し
- 今週の予定
現在の共有を基準にした採用表示:false
Undo前:月曜号はB、共有予定はC・採用済みです。
操作の順番と、この模型の条件
- 月曜号の水曜を出社へ。共有はB・未採用。
- 新しい火曜号で木曜を休みへ変更し、Cを採用。
- 月曜号の、最後の保存をUndoする直前。
勤務二欄と見出しに縮め、昼食・天気などは固定、見本データの印も外した条件です。実アプリの画面や保存を再現するものではありません。
順番に書き込みが成功した場合の復元条件と採用表示を扱います。実サービスの保存や同時編集を保証する模型ではありません。詳しい結果表示は、この模型に入れた改善案です。
火曜号でCを採用した最初の条件では、月曜号の水曜は「在宅」へ戻りました。でも、共有予定の水曜は「出社」のまま。木曜の「休み」と一緒に残っています。
この最初の条件では、月曜のA→Bの後に、月曜号で別の保存を挟んでいません。Undoは名前付きの変更を探す機能ではなく、その日付の最後の保存を戻します。水曜を出社にした後で月曜号の見出しを保存していたら、そちらが先に戻ります。操作台の「同じ月曜号で見出しも保存」で、その違いも試せます。
共有側は、内容と採用フラグの両方で判定する
履歴には、号の変更前データと、共有予定・採用フラグの変更前後が残ります。Undoは号を戻したうえで、共有側について次を調べます。
現在の共有予定と採用フラグが、その操作直後の値と両方同じなら、共有側も変更前へ戻す。
公開用モデルの判定部分です。sharedAfterは取り消す操作の直後、sharedBeforeはその直前の共有データを指します。
workspace.issues[day] = structuredClone(entry.issueBefore);
const sameContent = sameWeek(
workspace.shared.week,
entry.sharedAfter.week
);
const sameAdoption =
workspace.shared.adopted === entry.sharedAfter.adopted;
if (sameContent && sameAdoption) {
workspace.shared = structuredClone(entry.sharedBefore);
}月曜の操作直後はB・false。現在はC・trueなので、共有側は戻しません。ここでAへ戻すと、火曜に決めた木曜の休みまで消えるからです。
内容がBのままでも、その後に採用されてtrueになっていれば、採用フラグの不一致で共有の復元を止めます。操作台の「Bのまま、あとから採用」がこの条件です。「内容が変わったか」だけを比べると、その採用を見落としてしまいます。
この例では、後の変更を残せました。でも、共有Cには月曜に入れた「水曜は出社」が含まれています。月曜号を復元することと、月曜の操作の影響を共有側から取り除くことには、ここで差が出ます。
水曜だけ戻すと、未採用の組合せができる
水曜だけを共有予定から戻せば、こうなります。
水曜:在宅 / 木曜:休み
月曜の「水曜は出社」を取り除き、火曜の「木曜は休み」を残す。二つの操作を、一欄ずつ尊重できそうです。
ただ、火曜に採用した組合せは「水曜は出社、木曜は休み」でした。いま作った組合せは、まだ採用していません。勤務と昼食人数が結びついていれば、一欄を戻すだけでも、別の欄との整合を考える必要があります。
ここは私なら、差分を逆向きに適用する処理を書く前に、できあがった週表をもう一度見せたいところです。変更を取り除けたとしても、その結果を採用済みにしてよいかは残るからです。
手元のUndoの表示は「この日の直前の版へ戻しました」。号の復元という範囲には合っていますが、共有側が戻ったかは分かりません。
改善するなら、共有を残した場合も結果として伝える。共有から変更を取り除く操作も用意するなら、できあがる週表を新しい案として見せ、採用し直す。どちらも、ここでは未実装の案です。
号の「採用済み」は、現在の共有予定との一致
月曜号はA、共有予定はC・採用済みになりました。月曜号まで採用済みに見えたら、内容が違うのに確認済みと読めてしまいます。
そこで号の採用状態は、取得時に次の条件で計算します。
return workspace.shared.adopted === true &&
sameWeek(workspace.issues[day].week, workspace.shared.week);共有が採用済みで、かつ、その号の週表が現在の共有予定と一致する。 AとCは違うので、月曜号の採用表示はfalseになります。
この条件なら、現在の共有予定との関係を示せます。ただし、後日、共有がAに戻って採用されれば、月曜号を触らなくてもtrueになります。
「この号を、そのとき確認した」という記録が欲しいなら、採用した版や出来事を別に残す必要があります。現在の一致を示す印に、過去の確認まで背負わせることはできません。
Bへ戻ってきたら、途中の採用を見つけられない
共有側を戻す条件にも、もう一段あります。
共有予定がA・採用済みから、月曜の変更でB・未採用になった。その後、別の日の号からCに変えて採用し、さらに別の日にBと完全に同じ内容へ戻したとします。内容が変わるので、採用フラグもfalseに戻ります。
操作台の「Cを採用した後、別の号でBへ戻す」を選ぶと、この順番になります。Undo直前のB・falseは、月曜の操作直後と一致しています。この時点で月曜の変更をUndoすると、共有側もA・採用済みへ戻ります。途中でCを採用したことも、その後Bを選び直したことも、値の比較だけでは検出できません。いわゆるABAの形です。
一人で案を試し、元に戻しただけなら、この挙動が自然なこともあります。途中の採用を受けて別の予定を調整したなら、古いAが採用済みとして復活してよいかは考え直したい。したがって、この条件を「後の編集を必ず守る」とは説明できません。
変更の世代番号も比べれば、途中の更新は検出できます。ただ、更新が一度でもあれば止めるのか、採用という判断を挟んだときだけ止めるのかは、仕様として選ぶ必要があります。番号を足しても、その選択までは代わってくれません。
なお、実装の比較対象は、天気や見本データの印を含む週表全体です。勤務だけ同じでも、ほかの項目が違えば共有の復元を止める場合があります。判定対象を狭めるなら、どの項目を一組の予定として扱うかも決め直します。
版番号とETagによる書き込みの競合検査はUndoにもかかりますが、ここで扱ったのは、書き込みが順番に成功した場合です。公開用モデルで確かめられるのも、組み立てた状態に対する復元条件と採用表示まで。実サービスの保存や同時編集の保証には広げません。
自分のアプリで確かめるなら、最初の操作を取り消せる状態をそれぞれ用意し、二通り試します。
- A→B→Cから、最初のA→BをUndoする。 後から選んだCを残すか、共有までAへ戻すかを見る。
- A→B→C→Bから、最初のA→BをUndoする。 途中の採用などがあっても、現在値の一致でAへ戻すかを見る。
C以降の変更は別の編集対象から行います。同じ対象へ保存を重ねると、Undoの対象も変わるからです。後者まで見ると、現在値で守れる範囲と、途中の判断を残したい範囲を分けられます。採用済みの印があるなら、共有をAへ戻すときに、その印まで復元してよいかも確かめます。
画面には、今回の結果をそのまま出すなら「月曜号は戻しました。共有予定は現在の内容を残しています」。これもまだ改善案です。操作台の結果表示には入れましたが、実アプリへ実装済みという意味ではありません。どこまで戻ったかを知るために、使う人がBやCの履歴までたどる必要はないはずです。