core: enable portable-mode #12690
core: enable portable-mode #12690
Conversation
There was a problem hiding this comment.
@msujew
Thank you for the review. I have changed all of the fs methods to their asynchronous version which makes more sense. However, I am running into a few issues I would like your thoughts on. Even after calling await this.makePortable() at the beginning of the start method in electron-main-application.ts, the Local State file gets written to the appdata under Theia Electron Example instead of being written to the data folder. Everything else seems to work fine, so I assume we are running into a race condition where Theia Electron Example gets created and written to before making the electron application portable. I will keep digging into it, but do you have any idea why this might be happening ?
|
@vladarama I see, I wasn't aware of that. I assume that the I'm fine with changing the |
|
@vladarama This is ready for a re-review, correct? |
|
@JonasHelming |
This commit aims to address the following review comments: - Switching `fs` methods from synchronous to asynchronous - Caching the `configDirUri` - Avoid using process.cwd() as the application path Issues: switching from sync to async fs methods possibly leads to a race condition where some files get written to the `appdata` before we have the chance to make that folder portable. TO FIX !!! Signed-off-by: Vlad Arama <[email protected]>
This commit reverts the changes from the previous commit to avoid running into a race condition where the electron app fires its `ready` event before we can make the application portable. Signed-off-by: Vlad Arama <[email protected]>
This commit caches the pathExistence of the data folder, the user folder.
This commit caches the pathExistence of the data folder and user data folder in order to avoid accessing the disk on every call of `createConfigDirUri`. This should prevent possible performance regressions. Signed-off-by: Vlad Arama <[email protected]>
msujew
force-pushed
the
portable-mode
branch
from
c22ea02
to
2a3c3e2
Compare
Portable Mode in Theia
Creating a
datafolder at the root of a Theia application will make it portable. So all of the app data and user data will get written to thedatafolder instead of their default locations.The
.theiafolder is moved from the user’s home directory (%userprofile%or~/) to a folder calleduser-datainside thedatafolder.user-datacontains all of the settings, preferences and extensions.In addition, all of the application data which is stored by default inside a
Theia App Name (Theia Electron Example)folder in (%appdata%or~/.config) is moved to a folder calledapp-datainside thedatafolder.app-datacontains all of the application’s cache and layout information.Please refer to the following PR to further understand how the Portable mode is implemented in Theia Blueprint:
eclipse-theia/theia-blueprint#276
How to test
The following changes should make the
user-dataportable (settings, preferences, recent workspace ...).It also makes the
app-dataportable so all of the electron cache and layout information will be stored indata/app-datainstead of the default location.You can test that the portable mode is functional using the Electron Example Application.
yarnandyarn electron builddatafolder inside/theia/examples/electron.yarn electron start.All of the
user-datawhich is stored by default inside the user's directory will be stored inside of/theia/examples/electron/data/user-data. In addition, all of theapp-datawhich is stored by default in~/.config/Theia Electron Example or %appdata%/Theia Electron Examplewill be stored inside of/theia/examples/electron/data/app-data.Review checklist
Reminder for reviewers