|
| 1 | +/** |
| 2 | + * Copyright (c) 2021 Gitpod GmbH. All rights reserved. |
| 3 | + * Licensed under the GNU Affero General Public License (AGPL). |
| 4 | + * See License-AGPL.txt in the project root for license information. |
| 5 | + */ |
| 6 | + |
| 7 | +import { User } from "@gitpod/gitpod-protocol"; |
| 8 | +import { hoursBefore, isDateSmaller } from "@gitpod/gitpod-protocol/lib/util/timeutil"; |
| 9 | +import React, { useContext, useState } from "react"; |
| 10 | +import Alert from "../components/Alert"; |
| 11 | +import CodeText from "../components/CodeText"; |
| 12 | +import Modal from "../components/Modal"; |
| 13 | +import { getGitpodService } from "../service/service"; |
| 14 | +import { UserContext } from "../user-context"; |
| 15 | +import { isGitpodIo } from "../utils"; |
| 16 | + |
| 17 | +export namespace ProfileState { |
| 18 | + export interface ProfileState { |
| 19 | + name: string; |
| 20 | + email: string; |
| 21 | + company?: string; |
| 22 | + avatarURL?: string; |
| 23 | + } |
| 24 | + |
| 25 | + export function getProfileState(user: User): ProfileState { |
| 26 | + return { |
| 27 | + name: User.getName(user!) || "", |
| 28 | + email: User.getPrimaryEmail(user!) || "", |
| 29 | + company: user?.additionalData?.companyName, |
| 30 | + avatarURL: user?.avatarUrl, |
| 31 | + }; |
| 32 | + } |
| 33 | + |
| 34 | + export function setProfileState(user: User, profileState: ProfileState): User { |
| 35 | + user.fullName = profileState.name; |
| 36 | + user.avatarUrl = profileState.avatarURL; |
| 37 | + |
| 38 | + if (!user.additionalData) { |
| 39 | + user.additionalData = {}; |
| 40 | + } |
| 41 | + user.additionalData.emailAddress = profileState.email; |
| 42 | + user.additionalData.companyName = profileState.company; |
| 43 | + user.additionalData.lastUpdatedDetailsNudge = new Date().toISOString(); |
| 44 | + |
| 45 | + return user; |
| 46 | + } |
| 47 | + |
| 48 | + export function hasChanges(before: ProfileState, after: ProfileState) { |
| 49 | + return ( |
| 50 | + before.name !== after.name || |
| 51 | + before.email !== after.email || |
| 52 | + before.company !== after.company || |
| 53 | + before.avatarURL !== after.avatarURL |
| 54 | + ); |
| 55 | + } |
| 56 | + |
| 57 | + function shouldNudgeForUpdate(user: User): boolean { |
| 58 | + if (!isGitpodIo()) { |
| 59 | + return false; |
| 60 | + } |
| 61 | + if (!user.additionalData) { |
| 62 | + // never updated profile information and account is older than 24 hours (i.e. ask on second day). |
| 63 | + return !isDateSmaller(hoursBefore(new Date().toISOString(), 24), user.creationDate); |
| 64 | + } |
| 65 | + // if the profile wasn't updated for 12 months ask again. |
| 66 | + return !( |
| 67 | + !!user.additionalData.lastUpdatedDetailsNudge && |
| 68 | + isDateSmaller(hoursBefore(new Date().toISOString(), 24 * 365), user.additionalData.lastUpdatedDetailsNudge) |
| 69 | + ); |
| 70 | + } |
| 71 | + |
| 72 | + /** |
| 73 | + * @param state |
| 74 | + * @returns error message or empty string when valid |
| 75 | + */ |
| 76 | + export function validate(state: ProfileState): string { |
| 77 | + if (state.name.trim() === "") { |
| 78 | + return "Name must not be empty."; |
| 79 | + } |
| 80 | + if (state.email.trim() === "") { |
| 81 | + return "Email must not be empty."; |
| 82 | + } |
| 83 | + if ( |
| 84 | + !/^(([^<>()[\]\\.,;:\s@\"]+(\.[^<>()[\]\\.,;:\s@\"]+)*)|(\".+\"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/.test( |
| 85 | + state.email.trim(), |
| 86 | + ) |
| 87 | + ) { |
| 88 | + return "Please enter a valid email."; |
| 89 | + } |
| 90 | + return ""; |
| 91 | + } |
| 92 | + |
| 93 | + export function NudgeForProfileUpdateModal() { |
| 94 | + const { user, setUser } = useContext(UserContext); |
| 95 | + const original = ProfileState.getProfileState(user!); |
| 96 | + const [profileState, setProfileState] = useState(original); |
| 97 | + const [errorMessage, setErrorMessage] = useState(""); |
| 98 | + const [visible, setVisible] = useState(shouldNudgeForUpdate(user!)); |
| 99 | + |
| 100 | + const saveProfileState = () => { |
| 101 | + const error = ProfileState.validate(profileState); |
| 102 | + setErrorMessage(error); |
| 103 | + if (error) { |
| 104 | + return; |
| 105 | + } |
| 106 | + const updatedUser = ProfileState.setProfileState(user!, profileState); |
| 107 | + setUser(updatedUser); |
| 108 | + getGitpodService().server.updateLoggedInUser(updatedUser); |
| 109 | + setVisible(shouldNudgeForUpdate(updatedUser!)); |
| 110 | + }; |
| 111 | + |
| 112 | + const cancelProfileUpdate = () => { |
| 113 | + setProfileState(original); |
| 114 | + saveProfileState(); |
| 115 | + }; |
| 116 | + |
| 117 | + return ( |
| 118 | + <Modal |
| 119 | + title="Update Profile Information" |
| 120 | + visible={visible} |
| 121 | + onClose={cancelProfileUpdate} |
| 122 | + closeable={true} |
| 123 | + className="_max-w-xl" |
| 124 | + buttons={ |
| 125 | + <div> |
| 126 | + <button className="secondary" onClick={cancelProfileUpdate}> |
| 127 | + Dismiss |
| 128 | + </button> |
| 129 | + <button className="ml-2" onClick={saveProfileState}> |
| 130 | + Update Profile |
| 131 | + </button> |
| 132 | + </div> |
| 133 | + } |
| 134 | + > |
| 135 | + <ProfileInformation |
| 136 | + profileState={profileState} |
| 137 | + errorMessage={errorMessage} |
| 138 | + updated={false} |
| 139 | + setProfileState={setProfileState} |
| 140 | + /> |
| 141 | + </Modal> |
| 142 | + ); |
| 143 | + } |
| 144 | +} |
| 145 | + |
| 146 | +export default function ProfileInformation(props: { |
| 147 | + profileState: ProfileState.ProfileState; |
| 148 | + setProfileState: (newState: ProfileState.ProfileState) => void; |
| 149 | + errorMessage: string; |
| 150 | + updated: boolean; |
| 151 | + children?: React.ReactChild[] | React.ReactChild; |
| 152 | +}) { |
| 153 | + return ( |
| 154 | + <div> |
| 155 | + <p className="text-base text-gray-500 pb-4 max-w-xl"> |
| 156 | + The following information will be used to set up Git configuration. You can override Git author name and |
| 157 | + email per project by using the default environment variables <CodeText>GIT_AUTHOR_NAME</CodeText>,{" "} |
| 158 | + <CodeText>GIT_COMMITTER_NAME</CodeText>, <CodeText>GIT_AUTHOR_EMAIL</CodeText> and{" "} |
| 159 | + <CodeText>GIT_COMMITTER_EMAIL</CodeText>. |
| 160 | + </p> |
| 161 | + {props.errorMessage.length > 0 && ( |
| 162 | + <Alert type="error" closable={true} className="mb-2 max-w-xl rounded-md"> |
| 163 | + {props.errorMessage} |
| 164 | + </Alert> |
| 165 | + )} |
| 166 | + {props.updated && ( |
| 167 | + <Alert type="message" closable={true} className="mb-2 max-w-xl rounded-md"> |
| 168 | + Profile information has been updated. |
| 169 | + </Alert> |
| 170 | + )} |
| 171 | + <div className="flex flex-col lg:flex-row"> |
| 172 | + <div> |
| 173 | + <div className="mt-4"> |
| 174 | + <h4>Name</h4> |
| 175 | + <input |
| 176 | + type="text" |
| 177 | + value={props.profileState.name} |
| 178 | + onChange={(e) => props.setProfileState({ ...props.profileState, name: e.target.value })} |
| 179 | + /> |
| 180 | + </div> |
| 181 | + <div className="mt-4"> |
| 182 | + <h4>Email</h4> |
| 183 | + <input |
| 184 | + type="text" |
| 185 | + value={props.profileState.email} |
| 186 | + onChange={(e) => props.setProfileState({ ...props.profileState, email: e.target.value })} |
| 187 | + /> |
| 188 | + </div> |
| 189 | + <div className="mt-4"> |
| 190 | + <h4>Company</h4> |
| 191 | + <input |
| 192 | + type="text" |
| 193 | + value={props.profileState.company} |
| 194 | + onChange={(e) => props.setProfileState({ ...props.profileState, company: e.target.value })} |
| 195 | + /> |
| 196 | + </div> |
| 197 | + </div> |
| 198 | + <div className="lg:pl-14"> |
| 199 | + <div className="mt-4"> |
| 200 | + <h4>Avatar</h4> |
| 201 | + <img |
| 202 | + className="rounded-full w-24 h-24" |
| 203 | + src={props.profileState.avatarURL} |
| 204 | + alt={props.profileState.name} |
| 205 | + /> |
| 206 | + </div> |
| 207 | + </div> |
| 208 | + </div> |
| 209 | + {props.children || null} |
| 210 | + </div> |
| 211 | + ); |
| 212 | +} |
0 commit comments