Implement gitpod auth and settings sync

[jeanp413]

related gitpod-io/gitpod#9136

Telemetry Events:

Common properties:

'common.extname': 'gitpod.gitpod-desktop',
'common.extversion': '0.0.29',
'common.nodeArch': 'x64',
'common.os': 'linux',
'common.platformversion': '5.13.0',
'common.product': 'desktop',
'common.uikind': 'desktop',
'common.vscodemachineid': '0d34d9a02c8981a664b756b27f73587b165f6c17b020744a3f2f5167081e1682',
'common.vscodesessionid': '859abcd9-0bb7-4b3d-a33c-574ac0ff2a631650380562678',
'common.vscodeversion': '1.67.0-insider',

• gitpod_desktop_auth
  • Properties:
    • kind: login or logout or login_cancelled or login_failed or logout_failed
    • scopes: '["function:accessCodeSyncStorage","function:getGitpodTokenScopes","function:getLoggedInUser","resource:default"]'
• gitpod_desktop_settings_sync
  • Properties:
    • enabled: 'true' or 'false'
• gitpod_desktop_installation
  • Properties:
    • kind: install

[akosyakov]

I think we can do analytics with another PR?

[akosyakov]

Let's change it to:

• Restart VS Code for the new Setting Sync configuration take effect.
• Reload this window

[akosyakov]

Wow, code looks so well-structured ❤️ and you seem to address all important concerns.

[jeanp413]

Let's change it to:

• Restart VS Code for the new Setting Sync configuration take effect.
• Reload this window

reload it not enough, you need to close all windows

[jeanp413]

I think we can do analytics with another PR?

telemetry is done just needed a few 💄, I'll upload another vsix

[jeanp413]

Added vsix file updated with telemetry (telemetry key added manually before creating the vsix for now, asked @jakobhero if it's Ok to push it to github or not, MS does commit it in it's extensions)

Telemetry event can be viewed here

[akosyakov]

reload it not enough, you need to close all windows

yes, that's why I wrote Restart in message and reload this window. As far as I understand close this window does not close it but reload?

[jeanp413]

@akosyakov added telemetry event description at the PR description

[akosyakov]

It seems that code validating token was dropped, why? We should make sure that if a token gets expired on server side or we modify an extension to add more scopes then token should be invalidated.

[akosyakov]

@jeanp413 @filiptronicek Could you rephrase UI facing messages to avoid Gitpod Code Sync Provider. It should be called Setting Sync with Gitpod. I see user facing error messages like Error setting up Gitpod Code Sync Provider and so on. Please scan source code of destkop extension and replace it with talking about enabling/disabling Settings Sync with Gitpod.

[akosyakov]

@jeanp413 It looks like we will produce a lot of tables with such analytics events. Can we rather have only 3 events with different properties and timestamp to indicate progress:

• gitpod_desktop_installation to track when extension is installed/uninstalled
• gitpod_desktop_settings_sync to track enablement
• gitpod_desktop_auth to track progress with Gitpod auth

These events thought won't be enough still to understand whether a user is really synching with us. Is there a way to track it from VS Code extension or we need to track in server then? machine ids are propagated with sync requests as headers?

[jeanp413]

gitpod_desktop_installation to track when extension is installed/uninstalled

I think there's no API to know from within the extension when it was installed the first time or uninstalled

These events thought won't be enough still to understand whether a user is really synching with us. Is there a way to track it from VS Code extension or we need to track in server then? machine ids are propagated with sync requests as headers?

We'll need to do it in the server, no API for that

[jeanp413]

Added gitpod_desktop_installation event on first install

[filiptronicek]

LGTM 🎉

[akosyakov]

it looks good to me, besides #337 (comment)

@filiptronicek Could you double check following:

• switching between Gitpod host does not require auth again because we delete token unnecessary
• opening with VS Code Desktop still works

[jeanp413]

@filiptronicek can you test and if everything looks good to you too approve it so we can merge this and release 🚀

• switching between Gitpod host does not require auth again because we delete token unnecessary

P.S.: updated vsix file in the PR description

[akosyakov]

It worked nicely for me. I left some comments about user facing naming casing. It does not match to how other commands are named.

[filiptronicek]

opening with VS Code Desktop still works

Yes it does! All looking good.

For some reason I also wanted to try installing extensions not on OpenVSX. It looks like it is behaving correctly by not removing it, just skipping it from sync in places where it is not available...

[2022-04-28 18:47:33.081] [settingssync] [info] Extensions: Skipped synchronizing extension because the extension is not found. github.copilot