Update the error message when you run out of workspace credits.

[Harry-Hopkinson]

Description

Before the error message was very vague when one ran out of workspace hours. With this change it makes the error message clearer for the user.

Changes

Not enough credits. Please book more.

To

Not enough monthly workspace hours. Please upgrade your account to get more hours for your workspaces.

[andrew-farries]

Thanks for contributing, @Harry-Hopkinson 🧡

The changes look good.

You'll also need to sign a Contributor License Agreement (CLA)[1] once before merging your first contribution. Looping in @meysholdt to reach out about the CLA. 🏓

[andrew-farries]

/hold

[andrew-farries]

/werft run

👍 started the job as gitpod-build-main-fork.27

[andrew-farries]

/release-note-none

[andrew-farries]

Rebasing this against upstream main should fix the build error.

[csweichel]

/werft run

👍 started the job as gitpod-build-main-fork.28

[jankeromnes]

Hi @Harry-Hopkinson, many thanks for improving this error message! Your proposed new phrasing looks much better to me as well. 🎯

Also, thank you @andrew-farries for reviewing this excellent community contribution, and pushing it through the various hurdles! 🙏

---

Adding just a bit more context here in case you're interested:

When you create a new workspace, the error NOT_ENOUGH_CREDIT has special handling that shows a nice "Limit Reached" modal with an "Upgrade" button:

gitpod/components/dashboard/src/start/CreateWorkspace.tsx

Lines 182 to 186 in b2d07b8

	case ErrorCodes.NOT_ENOUGH_CREDIT:
	// HACK: Hide the error (behind the modal)
	error = undefined;
	phase = StartPhase.Stopped;
	statusMessage = <LimitReachedOutOfHours />;

gitpod/components/dashboard/src/start/CreateWorkspace.tsx

Lines 328 to 333 in b2d07b8

	<LimitReachedModal>
	<p className="mt-1 mb-2 text-base dark:text-gray-400">
	You have reached the limit of monthly workspace hours for your account. Please upgrade to get more hours
	for your workspaces.
	</p>
	</LimitReachedModal>

Unfortunately, we don't handle it the same way when starting an existing workspace: we simply pass the error along to <StartPage> which then displays it as is without much handling:

gitpod/components/dashboard/src/start/StartWorkspace.tsx

Lines 648 to 650 in b2d07b8

	<StartPage phase={phase} error={error} title={title} showLatestIdeWarning={useLatest}>
	{statusMessage}
	</StartPage>

gitpod/components/dashboard/src/start/StartPage.tsx

Lines 124 to 130 in b2d07b8

	function StartError(props: { error: StartWorkspaceError }) {
	const { error } = props;
	if (!error) {
	return null;
	}
	return <p className="text-base text-gitpod-red w-96">{error.message}</p>;
	}

In the future, I think it could be nice to centralize error handling between CreateWorkspace.tsx and StartWorkspace.tsx, so that, for example, a NOT_ENOUGH_CREDIT error would always result in showing the nice "Limit Reached" modal. 💭

But that's definitely a topic for a future Pull Request. 😁 Many thanks again for improving the error message in all the cases where it cannot be handled specifically! 🏀

[meysholdt]

hi @Harry-Hopkinson, to get the CLA signed, can you please let me know your email address by sending an email to [email protected]? I will then respond with the CLA which you can sign via DocuSign.

[Harry-Hopkinson]

@meysholdt I have sent an email.

[meysholdt]

I have received the signed CLA. Thank you, @Harry-Hopkinson.

[andrew-farries]

/unhold