第16回「CloudLaTeXをVSCodeで久々に開いたらエラーが出ました」

はじめに

僕はCloudLaTeXとVSCodeを連携して使えるようにしているのですが、久々に使おうとしたらエラーが発生しました。
以前のCloudLaTeXに関する記事はこちら

なにぶん初心者なので分からない事だらけですが、色々調べたりして一応解決したので、記録に残しておこうとお思います。

問題の背景

CloudLaTeXをVSCodeで利用する際、以下のようなエラーメッセージが表示されることがありました。

• ログイン関連のエラー
  CloudLaTeXのトークンが無効になった場合や、再認証が必要なときにエラーが発生する。
  
• 同期対象ディレクトリに関するエラー
  「ディレクトリにファイルが存在します。ファイルの上書きを防ぐため、同期を行うディレクトリは空である必要があります。」というエラーが出る。
  これは、既存のファイルがあると、CloudLaTeXがどのデータを優先すべきか判断できず、誤った上書きが発生するリスクを避けるためです。

という上記２つのエラーが発生しました。

ログインが出来ないというエラーと、同期するディレクトリが空ではないというエラーです。

どうやら、ログインする権限が切れたため出たようなのですが、最初は何が何だか分かりませんでした。

同期対象ディレクトリとその条件

CloudLaTeXの同期機能では、VSCodeで開いているプロジェクトのルートフォルダが基本的に同期対象のディレクトリとなります。

これはCloudLaTeXで新たにプロジェクトを作り、VSCodeでプロジェクトを指定して同期すると勝手にファイルが生成されるのですが、その保存先が対象となるディレクトリになるということみたいです。

このディレクトリは、CloudLaTeX側で管理されるソースファイルを配置する場所であり、初回の同期時には完全に空である必要があります。
もし、ファイルが存在していると、CloudLaTeXは上書きのリスクを回避するためにエラーを表示します。

つまり、上書きして元のファイルが消えないように警告してくれているわけですね。

解決までの手順

僕が問題を解決するために実施した手順は以下の通りです。

1. 問題の確認
   • VSCode側のプロジェクトに main.tex などのファイルが存在している状態で、CloudLaTeXから「空のディレクトリを使用してください」というエラーが出たことを確認しました。
     
2. ディレクトリの内容をチェック
   • 同期対象となるプロジェクトのルートフォルダが、CloudLaTeXと同期されるフォルダであると認識しました。
     
3. フォルダを完全に空にする
   • 重要なファイルがある場合は必ずバックアップを取り、プロジェクトフォルダ内の全ファイルを一時的に退避させました。
   • 対象フォルダを完全に空にし、初回同期時の条件を満たすようにしました。
     
4. 再同期の実行
   • 空の状態で同期処理を行ったところ、エラーが解消され、CloudLaTeXとの同期が正常に動作しました。

という流れです。

一応バックアップをとっていたのですが、試しに作ったテストファイルのみだったので、CloudLaTeX側で新たにプロジェクトファイルを作成し、元あったファイルは消してしまいました。

今後の注意点

• ファイル管理の徹底
  同期対象のフォルダはCloudLaTeX側で管理されるため、初回同期後は自動的に内容が反映されますが、手動でファイルを追加・編集する際は注意が必要です。
  競合や上書きのリスクがあるため、事前にバックアップを取ること。
  
• セッションやトークンの有効期限
  しばらく利用していないと、CloudLaTeX側でトークンやセッション情報がリセットされ、再度初回同期の条件が求められる可能性があります。その際は、再度空のディレクトリを用意して同期を行う必要があります。

というのが注意点かなと思うのですが、今回の問題は主にセッション情報がリセットされたことが起点だと思います。

つまり、どれくらいかは分かりませんが、ある程度使用していない、もしくはある程度の期間が経過すると再度初回の同期条件である対象ディレクトリが空で無くてはならない、という状態を求められるのでは無いかと。

この発生条件が定かではないので分かりませんが、もし重要なプロジェクトを用意していた場合、その度にバックアップをしなくてはならないということになるでしょうね。

頻繁に使用していれば、起こらないのかなぁ？

まとめ

僕は、VSCodeでCloudLaTeXを利用する際に、プロジェクトフォルダに既に存在するファイルが原因で同期エラーが発生していたことに気付きました。
解決策として、対象フォルダを完全に空にすることで、CloudLaTeX側の初回同期条件を満たし、正常に同期が行えるようになりました。

これを機会に色々な仕様も少し分かったので、良い経験にはなったかな？
実際に何かレポートを書いたりするようになったら、もっと理解をしていなくてはならないと思うので、活用してなれていこうと思います。

この記事が同じ問題に直面している方の参考になれば幸いです。

※追記

どうやら初回同期時の仕様が変わっていたようです。

というわけで、今回の挙動は仕様変更後に初めてそのエラーを出す条件を満たしたため発生したようです。
なので今後は出ないものと思われます。
とはいえ、バックアップをとっておくことは大切なので何か変更があればバックアップをとるのが良いのだろうと思います。