GetAuthenticatedUser in Dashboard #19142

AlexTugarev · 2023-11-27T08:06:42Z

Description

This PR introduces UserService.GetAuthenticatedUser RPC in dashboard.

The scope of this PR:

enable the FE shim
refactor the dashboard components to work with gRPC User type for rendering

Out of scope, primarily to keep this PR reviewable at all:

NO migrating the mutations, the API proto is WIP
NO implementation on server yet

Summary generated by Copilot

`🤖[deprecated] Generated by Copilot at 8e41547`

This pull request adds a new way to fetch the current user data from the public API using a custom React Query hook and a new user service. It also updates the cache version and exports a workspace autostart option interface from the gitpod-protocol. These changes improve the dashboard data loading and user preferences management.

Related Issue(s)

Fixes #

How to test

Ensure the FF is disabled (shim version only!)
Sign in first time
- Onboard
- Update your profile details in Settings
Start a workspace, but first change some settings
- Try to start a workspace on the same repo in a new tab, verify you see the settings saved previously

Documentation

Preview status

Gitpod was successfully deployed to your preview environment.

🏷️ Name - at-user-geb0763b1589
🔗 URL - at-user-geb0763b1589.preview.gitpod-dev.com/workspaces.
📚 Documentation - See our internal documentation for information on how to interact with your preview environment.
📦 Version - at-user-getauthenticated-dashboard-gha.20827
🗒️ Logs - GCP Logs Explorer

Build Options

Build

/werft with-werft
Run the build with werft instead of GHA
leeway-no-cache
/werft no-test
Run Leeway with --dont-test

Publish

/werft publish-to-npm
/werft publish-to-jb-marketplace

Installer

analytics=segment
with-dedicated-emulation
workspace-feature-flags
Add desired feature flags to the end of the line above, space separated

Preview Environment / Integration Tests

/werft with-local-preview
If enabled this will build install/preview
/werft with-preview
/werft with-large-vm
/werft with-gce-vm
If enabled this will create the environment on GCE infra
/werft preemptible
Saves cost. Untick this only if you're really sure you need a non-preemtible machine.
with-integration-tests=all
Valid options are all, workspace, webapp, ide, jetbrains, vscode, ssh. If enabled, with-preview and with-large-vm will be enabled.
with-monitoring

/hold

components/gitpod-protocol/src/public-api-converter.ts

components/dashboard/src/onboarding/StepOrgInfo.tsx

components/dashboard/src/service/service.tsx

components/dashboard/src/user-context.tsx

components/public-api/typescript-common/src/user-utils.ts

AlexTugarev · 2023-12-05T14:22:57Z

@akosyakov and @mustard-mh, I think everything is addressed now. Pray for another round of tests.

components/gitpod-protocol/src/protocol.ts

akosyakov · 2023-12-05T14:48:54Z

components/dashboard/src/user-settings/SelectIDE.tsx

@@ -21,37 +20,24 @@ export default function SelectIDE(props: SelectIDEProps) {
    const { user, setUser } = useContext(UserContext);
    const updateUser = useUpdateCurrentUserMutation();

-    // Only exec once when we access this component
-    useEffect(() => {


it is not required anymore? cc @mustard-mh

AlexTugarev · 2023-12-06T08:14:53Z

Updating the email address on Account page was broken. 5faa671 should fix and clean up more.

That said, I need another test round. Going to use the the recorded tests of @akosyakov for the first time 🎉

AlexTugarev · 2023-12-06T08:29:27Z

components/server/src/user/user-service.ts

@@ -312,3 +313,53 @@ export class UserService {
        log.info("User verified", { userId: user.id });
    }
 }
+
+// TODO: refactor where this is referenced so it's more clearly tied to just analytics-tracking
+// Let other places rely on the ProfileDetails type since that's what we store


need to remove this comment 🙈
but that describes exactly what was done here, the flat shape for analytics is not to be used on dashboard, as we already have ProfileDetails. especially, during the actual task of adapting new API this broke silently, as ProfileDetails and this one are not 100% compatible.

components/gitpod-db/package.json

components/gitpod-db/src/typeorm/team-db-impl.ts

also fix toDurationString call

akosyakov

it works well, i reviewed code and tested usual flow, i did not test dedicated setup and then a user is owner of installation.

Also it would be good not introducing a dependency on API from db, only keep it in server.

AlexTugarev · 2023-12-06T15:42:04Z

/unhold

mustard-mh · 2023-12-06T21:47:20Z

components/gitpod-db/src/typeorm/team-db-impl.ts

@@ -101,7 +100,6 @@ export class TeamDBImpl extends TransactionalDBImpl<TeamDB> implements TeamDB {
            return {
                userId: u.id,
                fullName: u.fullName || u.name,
-                primaryEmail: User.getPrimaryEmail(u),


@AlexTugarev spec.ts file not updated so main build was failed.

Is it safe to remove? Since there're lots of places will use findMembersByTeam function

lots of places will use findMembersByTeam

@mustard-mh, that's a problem actually. We're only using the full version of MemberInfos in one place, when listing members. All other places just need to know the user id of members.

Fixed in #19207

roboquat added do-not-merge/hold do-not-merge/work-in-progress size/L labels Nov 27, 2023

AlexTugarev force-pushed the at/user-getauthenticated-dashboard branch from 8e41547 to 3c3480d Compare November 27, 2023 08:57

AlexTugarev commented Nov 27, 2023

View reviewed changes

components/gitpod-protocol/src/public-api-converter.ts Outdated Show resolved Hide resolved

AlexTugarev force-pushed the at/user-getauthenticated-dashboard branch from 3c3480d to 21fd862 Compare November 27, 2023 11:23

roboquat added size/XXL and removed size/L labels Nov 27, 2023

AlexTugarev commented Nov 27, 2023

View reviewed changes

components/dashboard/src/onboarding/StepOrgInfo.tsx Outdated Show resolved Hide resolved

Base automatically changed from at/user.proto to main November 28, 2023 10:42

AlexTugarev force-pushed the at/user-getauthenticated-dashboard branch 4 times, most recently from e44ab89 to f3a1cc4 Compare November 29, 2023 09:01

AlexTugarev mentioned this pull request Nov 29, 2023

[papi] Add UserService/UpdateUser to proto #19163

Merged

15 tasks

AlexTugarev force-pushed the at/user-getauthenticated-dashboard branch from b0bfab8 to 0881a30 Compare November 29, 2023 10:40

gitpod-io deleted a comment from github-actions bot Nov 29, 2023

AlexTugarev changed the title ~~At/user-getauthenticated-dashboard~~ GetAuthenticatedUser in Dashboard Nov 29, 2023

AlexTugarev force-pushed the at/user-getauthenticated-dashboard branch from c71ddd7 to 79b52fc Compare November 29, 2023 15:44

AlexTugarev commented Nov 30, 2023

View reviewed changes

components/dashboard/src/service/service.tsx Show resolved Hide resolved

AlexTugarev commented Nov 30, 2023

View reviewed changes

components/dashboard/src/user-context.tsx Outdated Show resolved Hide resolved

AlexTugarev force-pushed the at/user-getauthenticated-dashboard branch 3 times, most recently from 996e47a to 9155f4d Compare December 4, 2023 13:17

AlexTugarev marked this pull request as ready for review December 4, 2023 13:21

AlexTugarev requested a review from a team as a code owner December 4, 2023 13:21

roboquat removed the do-not-merge/work-in-progress label Dec 4, 2023

github-actions bot added the team: team-experience label Dec 4, 2023

akosyakov reviewed Dec 4, 2023

View reviewed changes

components/public-api/typescript-common/src/user-utils.ts Outdated Show resolved Hide resolved

akosyakov reviewed Dec 4, 2023

View reviewed changes

components/public-api/typescript-common/src/user-utils.ts Outdated Show resolved Hide resolved

akosyakov reviewed Dec 5, 2023

View reviewed changes

components/gitpod-protocol/src/protocol.ts Show resolved Hide resolved

akosyakov reviewed Dec 5, 2023

View reviewed changes

AlexTugarev force-pushed the at/user-getauthenticated-dashboard branch 3 times, most recently from 2091f1f to 7664094 Compare December 5, 2023 16:23

AlexTugarev commented Dec 6, 2023

View reviewed changes

[dashboard] remove unused service mock

6dd745d

akosyakov reviewed Dec 6, 2023

View reviewed changes

components/gitpod-db/package.json Outdated Show resolved Hide resolved

[dashboard] use GetAuthenticatedUser instead of getLoggedInUser

ab37461

akosyakov reviewed Dec 6, 2023

View reviewed changes

components/gitpod-db/src/typeorm/team-db-impl.ts Outdated Show resolved Hide resolved

AlexTugarev added 9 commits December 6, 2023 11:03

fixup: override workspaceAutostartOptions

ea9051c

also fix toDurationString call

fixup: move isOnboardingUser to dashboard

1037a9f

fixup: move getProfile from protocol to common

47dd751

fixup fromWorkspaceAutostartOption

e770692

move getPrimaryEmail to common and clean up

da87c48

rm getProfile from protocol, use ProfileDetails

d6e1ace

fixup missing leeway dependencies

7007259

fix getPrimaryEmail

6cc550b

fix resetting workspace timeout

6071bd0

AlexTugarev force-pushed the at/user-getauthenticated-dashboard branch from 9afce3a to 6071bd0 Compare December 6, 2023 11:03

akosyakov approved these changes Dec 6, 2023

View reviewed changes

AlexTugarev added 2 commits December 6, 2023 14:53

[gitpod-db] remove dependency to @gitpod/public-api-common

ba3410a

cleanup BUILD.yaml

538c31b

roboquat removed the do-not-merge/hold label Dec 6, 2023

roboquat merged commit e4ccbf0 into main Dec 6, 2023
16 checks passed

roboquat deleted the at/user-getauthenticated-dashboard branch December 6, 2023 15:42

mustard-mh reviewed Dec 6, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GetAuthenticatedUser in Dashboard #19142

GetAuthenticatedUser in Dashboard #19142

AlexTugarev commented Nov 27, 2023 •

edited

Loading

AlexTugarev commented Dec 5, 2023

akosyakov Dec 5, 2023

AlexTugarev commented Dec 6, 2023

AlexTugarev Dec 6, 2023

akosyakov left a comment

AlexTugarev commented Dec 6, 2023

mustard-mh Dec 6, 2023

AlexTugarev Dec 7, 2023

AlexTugarev Dec 7, 2023

GetAuthenticatedUser in Dashboard #19142

GetAuthenticatedUser in Dashboard #19142

Conversation

AlexTugarev commented Nov 27, 2023 • edited Loading

Description

🤖[deprecated] Generated by Copilot at 8e41547

Related Issue(s)

How to test

Documentation

Preview status

Build Options

AlexTugarev commented Dec 5, 2023

akosyakov Dec 5, 2023

Choose a reason for hiding this comment

AlexTugarev commented Dec 6, 2023

AlexTugarev Dec 6, 2023

Choose a reason for hiding this comment

akosyakov left a comment

Choose a reason for hiding this comment

AlexTugarev commented Dec 6, 2023

mustard-mh Dec 6, 2023

Choose a reason for hiding this comment

AlexTugarev Dec 7, 2023

Choose a reason for hiding this comment

AlexTugarev Dec 7, 2023

Choose a reason for hiding this comment

AlexTugarev commented Nov 27, 2023 •

edited

Loading

`🤖[deprecated] Generated by Copilot at 8e41547`