Refactor Result type

dotcom-rendering/src/components/Discussion.tsx

@@ -388,7 +388,7 @@ export const Discussion = ({
 			signal: controller.signal,
 		})
 			.then((result) => {
-				if (result.kind === 'error') {
+				if (!result.ok) {
 					if (result.error !== 'AbortedSignal') {
 						console.error(`getDiscussion - error: ${result.error}`);
 					}
@@ -440,7 +440,7 @@ export const Discussion = ({
 				remapToValidFilters(filters, hashCommentId),
 			)
 				.then((context) => {
-					if (context.kind === 'ok') {
+					if (context.ok) {
 						dispatch({
 							type: 'updateCommentPage',
 							commentPage: context.value.page,

dotcom-rendering/src/components/Discussion/AbuseReportForm.tsx

@@ -205,7 +205,7 @@ export const AbuseReportForm = ({
 			commentId,
 		})
 			.then((response) => {
-				if (response.kind === 'error') {
+				if (!response.ok) {
 					// Fallback to errors returned from the API
 					setErrors({ ...errors, response: response.error });
 				} else {

dotcom-rendering/src/components/Discussion/Comment.stories.tsx

@@ -6,7 +6,7 @@ import type {
 	ReplyType,
 	Staff,
 } from '../../lib/discussion';
-import { ok } from '../../lib/result';
+import { error, ok, type Result } from '../../lib/result';
 import { Comment } from './Comment';
 
 type Props = Parameters<typeof Comment>[0];
@@ -113,10 +113,11 @@ const longBothReplyCommentData: ReplyType = {
 	},
 };
 
-const commentResponseError = {
-	kind: 'error',
-	error: 'NetworkError',
-} as const;
+const commentResponseError = function <A>(): Promise<
+	Result<'NetworkError', A>
+> {
+	return Promise.resolve(error('NetworkError'));
+};
 
 const user: Reader = {
 	kind: 'Reader',
@@ -134,8 +135,8 @@ const user: Reader = {
 			hasCommented: true,
 		},
 	},
-	onComment: () => Promise.resolve(commentResponseError),
-	onReply: () => Promise.resolve(commentResponseError),
+	onComment: commentResponseError,
+	onReply: commentResponseError,
 	onRecommend: () => Promise.resolve(true),
 	addUsername: () => Promise.resolve(ok(true)),
 	reportAbuse: () => Promise.resolve(ok(true)),
@@ -157,12 +158,12 @@ const staffUser: Staff = {
 			hasCommented: true,
 		},
 	},
-	onComment: () => Promise.resolve(commentResponseError),
-	onReply: () => Promise.resolve(commentResponseError),
+	onComment: commentResponseError,
+	onReply: commentResponseError,
 	onRecommend: () => Promise.resolve(true),
 	addUsername: () => Promise.resolve(ok(true)),
-	onPick: () => Promise.resolve(commentResponseError),
-	onUnpick: () => Promise.resolve(commentResponseError),
+	onPick: commentResponseError,
+	onUnpick: commentResponseError,
 	reportAbuse: () => Promise.resolve(ok(true)),
 };
 

dotcom-rendering/src/components/Discussion/Comment.tsx

@@ -342,7 +342,7 @@ export const Comment = ({
 	const pick = async (staffUser: Staff) => {
 		setPickError('');
 		const response = await staffUser.onPick(comment.id);
-		if (response.kind === 'error') {
+		if (!response.ok) {
 			setPickError(response.error);
 		} else {
 			setIsHighlighted(response.value);
@@ -352,7 +352,7 @@ export const Comment = ({
 	const unPick = async (staffUser: Staff) => {
 		setPickError('');
 		const response = await staffUser.onUnpick(comment.id);
-		if (response.kind === 'error') {
+		if (!response.ok) {
 			setPickError(response.error);
 		} else {
 			setIsHighlighted(response.value);

dotcom-rendering/src/components/Discussion/CommentContainer.stories.tsx

@@ -1,7 +1,7 @@
 import { splitTheme } from '../../../.storybook/decorators/splitThemeDecorator';
 import { ArticleDesign, ArticleDisplay, Pillar } from '../../lib/articleFormat';
 import type { CommentType, Reader, ReplyType } from '../../lib/discussion';
-import { ok } from '../../lib/result';
+import { error, ok, type Result } from '../../lib/result';
 import { CommentContainer } from './CommentContainer';
 
 export default { title: 'Discussion/CommentContainer' };
@@ -134,10 +134,11 @@ const commentDataWithLongThread: CommentType = {
 	},
 };
 
-const commentResponseError = {
-	kind: 'error',
-	error: 'NetworkError',
-} as const;
+const commentResponseError = function <A>(): Promise<
+	Result<'NetworkError', A>
+> {
+	return Promise.resolve(error('NetworkError'));
+};
 
 const aUser: Reader = {
 	kind: 'Reader',
@@ -155,8 +156,8 @@ const aUser: Reader = {
 			hasCommented: true,
 		},
 	},
-	onComment: () => Promise.resolve(commentResponseError),
-	onReply: () => Promise.resolve(commentResponseError),
+	onComment: commentResponseError,
+	onReply: commentResponseError,
 	onRecommend: () => Promise.resolve(true),
 	addUsername: () => Promise.resolve(ok(true)),
 	reportAbuse: () => Promise.resolve(ok(true)),

dotcom-rendering/src/components/Discussion/CommentContainer.tsx

@@ -120,7 +120,7 @@ export const CommentContainer = ({
 		setLoading(true);
 		getAllReplies(commentId)
 			.then((result) => {
-				if (result.kind === 'error') {
+				if (!result.ok) {
 					console.error(result.error);
 					return;
 				}

dotcom-rendering/src/components/Discussion/CommentForm.stories.tsx

@@ -2,7 +2,7 @@ import { useState } from 'react';
 import { splitTheme } from '../../../.storybook/decorators/splitThemeDecorator';
 import { ArticleDesign, ArticleDisplay, Pillar } from '../../lib/articleFormat';
 import type { CommentType, Reader } from '../../lib/discussion';
-import { ok } from '../../lib/result';
+import { error, ok, type Result } from '../../lib/result';
 import { CommentForm } from './CommentForm';
 
 export default { component: CommentForm, title: 'Discussion/CommentForm' };
@@ -15,10 +15,11 @@ const defaultFormat = {
 	theme: Pillar.News,
 };
 
-const commentResponseError = {
-	kind: 'error',
-	error: 'NetworkError',
-} as const;
+const commentResponseError = function <A>(): Promise<
+	Result<'NetworkError', A>
+> {
+	return Promise.resolve(error('NetworkError'));
+};
 
 const aUser: Reader = {
 	kind: 'Reader',
@@ -36,8 +37,8 @@ const aUser: Reader = {
 			hasCommented: true,
 		},
 	},
-	onComment: () => Promise.resolve(commentResponseError),
-	onReply: () => Promise.resolve(commentResponseError),
+	onComment: commentResponseError,
+	onReply: commentResponseError,
 	onRecommend: () => Promise.resolve(true),
 	addUsername: () => Promise.resolve(ok(true)),
 	reportAbuse: () => Promise.resolve(ok(true)),

dotcom-rendering/src/components/Discussion/CommentForm.tsx

@@ -313,7 +313,7 @@ export const CommentForm = ({
 		const preview = onPreview ?? defaultPreview;
 		const response = await preview(body);
 
-		if (response.kind === 'error') {
+		if (!response.ok) {
 			// If the preview fails, we handle the error and reset the preview body
 			handleError(response.error, false);
 			setPreviewBody('');
@@ -416,7 +416,7 @@ export const CommentForm = ({
 				? await user.onReply(shortUrl, body, commentBeingRepliedTo.id)
 				: await user.onComment(shortUrl, body);
 			// Check response message for error states
-			if (response.kind === 'error') {
+			if (!response.ok) {
 				handleError(response.error);
 			} else {
 				onAddComment(
@@ -447,7 +447,7 @@ export const CommentForm = ({
 		}
 
 		const response = await user.addUsername(userName);
-		if (response.kind === 'ok') {
+		if (response.ok) {
 			// If we are able to submit userName we should continue with submitting comment
 			void submitForm();
 			setUserNameMissing(false);

dotcom-rendering/src/components/Discussion/Comments.stories.tsx

@@ -12,7 +12,7 @@ import type {
 	Reader,
 } from '../../lib/discussion';
 import { discussionApiResponseSchema } from '../../lib/discussion';
-import { ok } from '../../lib/result';
+import { error, ok, type Result } from '../../lib/result';
 import { Comments } from './Comments';
 
 const meta = {
@@ -44,10 +44,11 @@ const discussionWithTwoComments = parse(
 );
 if (discussionWithTwoComments.status !== 'ok') throw new Error('Invalid mock');
 
-const commentResponseError = {
-	kind: 'error',
-	error: 'NetworkError',
-} as const;
+const commentResponseError = function <A>(): Promise<
+	Result<'NetworkError', A>
+> {
+	return Promise.resolve(error('NetworkError'));
+};
 
 const aUser: Reader = {
 	kind: 'Reader',
@@ -65,8 +66,8 @@ const aUser: Reader = {
 			hasCommented: true,
 		},
 	},
-	onComment: () => Promise.resolve(commentResponseError),
-	onReply: () => Promise.resolve(commentResponseError),
+	onComment: commentResponseError,
+	onReply: commentResponseError,
 	onRecommend: () => Promise.resolve(true),
 	addUsername: () => Promise.resolve(ok(true)),
 	reportAbuse: () => Promise.resolve(ok(true)),

dotcom-rendering/src/components/Discussion/Comments.tsx

@@ -228,7 +228,7 @@ export const Comments = ({
 
 	useEffect(() => {
 		void getPicks(shortUrl).then((result) => {
-			if (result.kind === 'error') {
+			if (!result.ok) {
 				console.error(result.error);
 				return;
 			}

dotcom-rendering/src/components/Discussion/RecommendationCount.stories.tsx

@@ -1,16 +1,17 @@
 import { splitTheme } from '../../../.storybook/decorators/splitThemeDecorator';
 import { ArticleDesign, ArticleDisplay, Pillar } from '../../lib/articleFormat';
 import type { SignedInUser } from '../../lib/discussion';
-import { ok } from '../../lib/result';
+import { error, ok, type Result } from '../../lib/result';
 import { palette as themePalette } from '../../palette';
 import { RecommendationCount } from './RecommendationCount';
 
 export default { title: 'Discussion/RecommendationCount' };
 
-const commentResponseError = {
-	kind: 'error',
-	error: 'NetworkError',
-} as const;
+const commentResponseError = function <A>(): Promise<
+	Result<'NetworkError', A>
+> {
+	return Promise.resolve(error('NetworkError'));
+};
 
 const aUser = {
 	kind: 'Reader',
@@ -28,8 +29,8 @@ const aUser = {
 			hasCommented: true,
 		},
 	},
-	onComment: () => Promise.resolve(commentResponseError),
-	onReply: () => Promise.resolve(commentResponseError),
+	onComment: commentResponseError,
+	onReply: commentResponseError,
 	onRecommend: () => Promise.resolve(true),
 	addUsername: () => Promise.resolve(ok(true)),
 	reportAbuse: () => Promise.resolve(ok(true)),

dotcom-rendering/src/components/Discussion/TopPick.stories.tsx

@@ -2,7 +2,7 @@ import { css } from '@emotion/react';
 import { splitTheme } from '../../../.storybook/decorators/splitThemeDecorator';
 import { ArticleDesign, ArticleDisplay, Pillar } from '../../lib/articleFormat';
 import type { ReplyType, SignedInUser } from '../../lib/discussion';
-import { ok } from '../../lib/result';
+import { error, ok, type Result } from '../../lib/result';
 import { TopPick } from './TopPick';
 
 export default { component: TopPick, title: 'Discussion/TopPick' };
@@ -78,10 +78,11 @@ const contributorCommentWithShortBody: ReplyType = {
 	body: "<p>It's still there FrankDeFord - and thanks, I will pass that on</p>",
 };
 
-const commentResponseError = {
-	kind: 'error',
-	error: 'NetworkError',
-} as const;
+const commentResponseError = function <A>(): Promise<
+	Result<'NetworkError', A>
+> {
+	return Promise.resolve(error('NetworkError'));
+};
 
 const aUser = {
 	kind: 'Reader',
@@ -99,8 +100,8 @@ const aUser = {
 			hasCommented: true,
 		},
 	},
-	onComment: () => Promise.resolve(commentResponseError),
-	onReply: () => Promise.resolve(commentResponseError),
+	onComment: commentResponseError,
+	onReply: commentResponseError,
 	onRecommend: () => Promise.resolve(true),
 	addUsername: () => Promise.resolve(ok(true)),
 	reportAbuse: () => Promise.resolve(ok(true)),

dotcom-rendering/src/components/Discussion/TopPicks.stories.tsx

@@ -1,7 +1,7 @@
 import { splitTheme } from '../../../.storybook/decorators/splitThemeDecorator';
 import { ArticleDesign, ArticleDisplay, Pillar } from '../../lib/articleFormat';
 import type { ReplyType, SignedInUser } from '../../lib/discussion';
-import { ok } from '../../lib/result';
+import { error, ok, type Result } from '../../lib/result';
 import { TopPicks } from './TopPicks';
 
 export default { component: TopPicks, title: 'Discussion/TopPicks' };
@@ -57,10 +57,11 @@ const commentWithShortBody: ReplyType = {
 	body: "<p>It's still there FrankDeFord - and thanks, I will pass that on</p>",
 };
 
-const commentResponseError = {
-	kind: 'error',
-	error: 'NetworkError',
-} as const;
+const commentResponseError = function <A>(): Promise<
+	Result<'NetworkError', A>
+> {
+	return Promise.resolve(error('NetworkError'));
+};
 
 const aUser = {
 	kind: 'Reader',
@@ -78,8 +79,8 @@ const aUser = {
 			hasCommented: true,
 		},
 	},
-	onComment: () => Promise.resolve(commentResponseError),
-	onReply: () => Promise.resolve(commentResponseError),
+	onComment: commentResponseError,
+	onReply: commentResponseError,
 	onRecommend: () => Promise.resolve(true),
 	addUsername: () => Promise.resolve(ok(true)),
 	reportAbuse: () => Promise.resolve(ok(true)),

dotcom-rendering/src/components/DiscussionApps.importable.tsx

@@ -31,7 +31,7 @@ const onComment = async (
 			const result = parseCommentResponse(
 				JSON.parse(apiResponse.response),
 			);
-			if (result.kind === 'error') {
+			if (!result.ok) {
 				window.guardian.modules.sentry.reportError(
 					Error(`Failed parseCommentResponse: ${result.error}`),
 					'discussion',
@@ -58,7 +58,7 @@ const onReply = async (
 			const result = parseCommentResponse(
 				JSON.parse(apiResponse.response),
 			);
-			if (result.kind === 'error') {
+			if (!result.ok) {
 				window.guardian.modules.sentry.reportError(
 					Error(`Failed parseCommentResponse: ${result.error}`),
 					'discussion',
@@ -83,7 +83,7 @@ const onRecommend = async (commentId: string): Promise<boolean> => {
 				JSON.parse(discussionApiResponse.response),
 			);
 
-			return result.kind === 'ok';
+			return result.ok;
 		});
 };
 
@@ -125,7 +125,7 @@ export const DiscussionApps = (props: Props) => {
 					JSON.parse(userProfile.response),
 				);
 
-				if (profileResult.kind !== 'ok') return setUser(undefined);
+				if (!profileResult.ok) return setUser(undefined);
 
 				setUser({
 					kind: 'Reader',