11523490149

Committed 25 Oct 2024 06:26PM UTC coverage: 31.384% (-0.2%) from 31.613%

Build # 11523490149

Build Type

Pull #9771

github

Committed by

b0b3rt

Commit Message

don't sanitize originalContents, but also don't use it in the editor

Pull Request Pull Request #9771: JargonBot (somewhat beta-gated)

Run Details

5026 of 42212 branches covered (11.91%)

Branch coverage included in aggregate %.

205 of 575 new or added lines in 47 files covered. (35.65%)

8 existing lines in 7 files now uncovered.

29607 of 68139 relevant lines covered (43.45%)

174.29 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

14.29

/packages/lesswrong/components/posts/PostsEditForm.tsx

import React, { useEffect, useRef, useState } from 'react';
import { Components, registerComponent, getFragment } from '../../lib/vulcan-lib';
import { useSingle } from '../../lib/crud/withSingle';
import { useMessages } from '../common/withMessages';
import { postGetPageUrl, postGetEditUrl, getPostCollaborateUrl, isNotHostedHere, canUserEditPostMetadata } from '../../lib/collections/posts/helpers';
import { useLocation } from '../../lib/routeUtil'
import { styles } from './PostsNewForm';
import { useDialog } from "../common/withDialog";
import {useCurrentUser} from "../common/withUser";
import { useUpdate } from "../../lib/crud/withUpdate";
import { afNonMemberSuccessHandling } from "../../lib/alignment-forum/displayAFNonMemberPopups";
import type { SubmitToFrontpageCheckboxProps } from './SubmitToFrontpageCheckbox';
import type { PostSubmitProps } from './PostSubmit';
import { userIsPodcaster } from '../../lib/vulcan-users/permissions';
import { SHARE_POPUP_QUERY_PARAM } from './PostsPage/PostsPage';
import { isEAForum } from '../../lib/instanceSettings';
import type { Editor } from '@ckeditor/ckeditor5-core';
import { useNavigate } from '../../lib/reactRouterWrapper';
import { preferredHeadingCase } from '../../themes/forumTheme';
import DeferRender from '../common/DeferRender';
import { useSingleWithPreload } from '@/lib/crud/useSingleWithPreload';
import { userCanCreateAndEditJargonTerms } from '@/lib/betas';

const editor: Editor | null = null
export const EditorContext = React.createContext<[Editor | null, (e: Editor) => void]>([editor, _ => {}]);

function getDraftLabel(post: PostsPage | null) {
  if (!post) return "Save Draft";
  if (!post.draft) return "Move to Drafts";
  return "Save Draft";
}

const PostsEditForm = ({ documentId, version, classes }: {
  documentId: string,
  version?: string | null,
  classes: ClassesType,
}) => {
  const { WrappedSmartForm, PostSubmit, SubmitToFrontpageCheckbox, HeadTags, ForeignCrosspostEditForm, DialogueSubmit, RateLimitWarning, DynamicTableOfContents } = Components

  const { query, params } = useLocation();
  const navigate = useNavigate();
  const { flash } = useMessages();
  const { openDialog } = useDialog();
  const currentUser = useCurrentUser();

  const [editorState, setEditorState] = useState<Editor | null>(editor);

  const { bestResult: document, fetchedResult: { loading } } = useSingleWithPreload({
    documentId,
    collectionName: "Posts",
    fragmentName: 'PostsPage',
    preloadFragmentName: 'PostsPage',
  });

  const { document: userWithRateLimit } = useSingle({
    documentId: currentUser?._id,
    collectionName: "Users",
    fragmentName: "UsersCurrentPostRateLimit",
    skip: !currentUser,
    extraVariables: { eventForm: 'Boolean' },
    extraVariablesValues: { eventForm: document?.isEvent }
  });

  const { mutate: updatePost } = useUpdate({
    collectionName: "Posts",
    fragmentName: 'SuggestAlignmentPost',
  });

  const saveDraftLabel = getDraftLabel(document);

  // If we've been redirected from PostsNewForm because of the post being autosaved, have the WrappedSmartForm try to fetch from the apollo cache first, since we should have prefetched to hydrate it before redirecting.
  const editFormFetchPolicy = query.autosaveRedirect ? 'cache-first' : undefined;

  const rateLimitNextAbleToPost = userWithRateLimit?.rateLimitNextAbleToPost;

  const isDraft = document && document.draft;
  const wasEverDraft = useRef(isDraft);

  useEffect(() => {
    if (wasEverDraft.current === undefined && isDraft !== undefined) {
      wasEverDraft.current = isDraft;
    }
  }, [isDraft]);
  
  if (!document && loading) {
    return <Components.Loading/>
  }

  // If we only have read access to this post, but it's shared with us,
  // redirect to the collaborative editor.
  if (document && !canUserEditPostMetadata(currentUser, document) && !userIsPodcaster(currentUser)) {
    return <Components.PermanentRedirect url={getPostCollaborateUrl(documentId, false, query.key)} status={302}/>
  }
  
  // If we don't have access at all but a link-sharing key was provided, redirect to the
  // collaborative editor
  if (!document && !loading && query?.key) {
    return <Components.PermanentRedirect url={getPostCollaborateUrl(documentId, false, query.key)} status={302}/>
  }
  
  // If the post has a link-sharing key which is not in the URL, redirect to add
  // the link-sharing key to the URL. (linkSharingKey has field-level
  // permissions so it will only be present if we've either already used the
  // link-sharing key, or have access through something other than link-sharing.)
  if (document?.linkSharingKey && !(query?.key)) {
    return <Components.PermanentRedirect url={postGetEditUrl(document._id, false, document.linkSharingKey)} status={302}/>
  }
  
  // If we don't have the post and none of the earlier cases applied, we either
  // have an invalid post ID or the post is a draft that we don't have access
  // to.
  if (!document) {
    return <Components.Error404/>
  }

  if (isNotHostedHere(document)) {
    return <ForeignCrosspostEditForm post={document} />;
  }
  
  // FIXME: Unstable component will lose state on rerender
  // eslint-disable-next-line react/no-unstable-nested-components
  const EditPostsSubmit = (props: SubmitToFrontpageCheckboxProps & PostSubmitProps) => {
    return <div className={classes.formSubmit}>
      {!document.isEvent && <SubmitToFrontpageCheckbox {...props} />}
      <PostSubmit
        saveDraftLabel={saveDraftLabel}
        feedbackLabel={"Get Feedback"}
        {...props}
      />
    </div>
  }

  const addFields: string[] = [];

  /*
  * addFields includes tagRelevance because the field permissions on
  * the schema say the user can't edit this field, but the widget
  * "edits" the tag list via indirect operations (upvoting/downvoting
  * relevance scores).
  */
  if (!(document.isEvent || !!document.collabEditorDialogue)) {
    addFields.push('tagRelevance');
  }

  // This is a resolver-only field, so we need to add it to the addFields array to get it to show up in the form
  if (userCanCreateAndEditJargonTerms(currentUser)) {
    addFields.push('glossary');
  }

  return (
    <DynamicTableOfContents title={document.title}>
      <div className={classes.postForm}>
        <HeadTags title={document.title} />
        {currentUser && <Components.PostsAcceptTos currentUser={currentUser} />}
        {rateLimitNextAbleToPost && <RateLimitWarning lastRateLimitExpiry={rateLimitNextAbleToPost.nextEligible} rateLimitMessage={rateLimitNextAbleToPost.rateLimitMessage}  />}
        <DeferRender ssr={false}>
          <EditorContext.Provider value={[editorState, setEditorState]}>
            <WrappedSmartForm
              collectionName="Posts"
              documentId={documentId}
              queryFragment={getFragment('PostsEditQueryFragment')}
              mutationFragment={getFragment('PostsEditMutationFragment')}
              successCallback={(post: any, options: any) => {
                const alreadySubmittedToAF = post.suggestForAlignmentUserIds && post.suggestForAlignmentUserIds.includes(post.userId)
                if (!post.draft && !alreadySubmittedToAF) afNonMemberSuccessHandling({currentUser, document: post, openDialog, updateDocument: updatePost})
                if (options?.submitOptions?.redirectToEditor) {
                  navigate(postGetEditUrl(post._id, false, post.linkSharingKey));
                } else {
                  // If they are publishing a draft, show the share popup
                  // Note: we can't use isDraft here because it gets updated to true when they click "Publish"
                  const showSharePopup = isEAForum && wasEverDraft.current && !post.draft
                  const sharePostQuery = `?${SHARE_POPUP_QUERY_PARAM}=true`
                  navigate({pathname: postGetPageUrl(post), search: showSharePopup ? sharePostQuery : ''})

                  if (!showSharePopup) {
                    flash({ messageString: `Post "${post.title}" edited`, type: 'success'});
                  }
                }
              }}
              eventForm={document.isEvent}
              removeSuccessCallback={({ documentId, documentTitle }: { documentId: string; documentTitle: string; }) => {
                // post edit form is being included from a single post, redirect to index
                // note: this.props.params is in the worst case an empty obj (from react-router)
                if (params._id) {
                  navigate('/');
                }

                flash({ messageString: `Post "${documentTitle}" deleted.`, type: 'success'});
                // todo: handle events in collection callbacks
                // this.context.events.track("post deleted", {_id: documentId});
              }}
              showRemove={true}
              collabEditorDialogue={!!document.collabEditorDialogue}
              submitLabel={preferredHeadingCase(isDraft ? "Publish" : "Publish Changes")}
              formComponents={{FormSubmit: !!document.collabEditorDialogue ? DialogueSubmit : EditPostsSubmit}}
              extraVariables={{
                version: 'String'
              }}
              extraVariablesValues={{
                version: version ?? 'draft'
              }}
              noSubmitOnCmdEnter
              repeatErrors
              
              addFields={addFields}

              editFormFetchPolicy={editFormFetchPolicy}
            />
          </EditorContext.Provider>
        </DeferRender>
      </div>
    </DynamicTableOfContents>
  );
}

const PostsEditFormComponent = registerComponent('PostsEditForm', PostsEditForm, {styles});

declare global {
  interface ComponentTypes {
    PostsEditForm: typeof PostsEditFormComponent
  }
}

1	import React, { useEffect, useRef, useState } from 'react';	3✔
2	import { Components, registerComponent, getFragment } from '../../lib/vulcan-lib';	1✔
3	import { useSingle } from '../../lib/crud/withSingle';	1✔
4	import { useMessages } from '../common/withMessages';	1✔
5	import { postGetPageUrl, postGetEditUrl, getPostCollaborateUrl, isNotHostedHere, canUserEditPostMetadata } from '../../lib/collections/posts/helpers';	1✔
6	import { useLocation } from '../../lib/routeUtil'	1✔
7	import { styles } from './PostsNewForm';	1✔
8	import { useDialog } from "../common/withDialog";	1✔
9	import {useCurrentUser} from "../common/withUser";	1✔
10	import { useUpdate } from "../../lib/crud/withUpdate";	1✔
11	import { afNonMemberSuccessHandling } from "../../lib/alignment-forum/displayAFNonMemberPopups";	1✔
12	import type { SubmitToFrontpageCheckboxProps } from './SubmitToFrontpageCheckbox';
13	import type { PostSubmitProps } from './PostSubmit';
14	import { userIsPodcaster } from '../../lib/vulcan-users/permissions';	1✔
15	import { SHARE_POPUP_QUERY_PARAM } from './PostsPage/PostsPage';	1✔
16	import { isEAForum } from '../../lib/instanceSettings';	1✔
17	import type { Editor } from '@ckeditor/ckeditor5-core';
18	import { useNavigate } from '../../lib/reactRouterWrapper';	1✔
19	import { preferredHeadingCase } from '../../themes/forumTheme';	1✔
20	import DeferRender from '../common/DeferRender';	1✔
21	import { useSingleWithPreload } from '@/lib/crud/useSingleWithPreload';	1✔
22	import { userCanCreateAndEditJargonTerms } from '@/lib/betas';	1✔
23
24	const editor: Editor \| null = null	1✔
25	export const EditorContext = React.createContext<[Editor \| null, (e: Editor) => void]>([editor, _ => {}]);	1✔
26
27	function getDraftLabel(post: PostsPage \| null) {
28	if (!post) return "Save Draft";	×
29	if (!post.draft) return "Move to Drafts";	×
30	return "Save Draft";	×
31	}
32
33	const PostsEditForm = ({ documentId, version, classes }: {	1✔
34	documentId: string,
35	version?: string \| null,
36	classes: ClassesType,
37	}) => {
38	const { WrappedSmartForm, PostSubmit, SubmitToFrontpageCheckbox, HeadTags, ForeignCrosspostEditForm, DialogueSubmit, RateLimitWarning, DynamicTableOfContents } = Components	×
39
40	const { query, params } = useLocation();	×
41	const navigate = useNavigate();	×
42	const { flash } = useMessages();	×
43	const { openDialog } = useDialog();	×
44	const currentUser = useCurrentUser();	×
45
46	const [editorState, setEditorState] = useState<Editor \| null>(editor);	×
47
48	const { bestResult: document, fetchedResult: { loading } } = useSingleWithPreload({	×
49	documentId,
50	collectionName: "Posts",
51	fragmentName: 'PostsPage',
52	preloadFragmentName: 'PostsPage',
53	});
54
55	const { document: userWithRateLimit } = useSingle({	×
56	documentId: currentUser?._id,	×
57	collectionName: "Users",
58	fragmentName: "UsersCurrentPostRateLimit",
59	skip: !currentUser,
60	extraVariables: { eventForm: 'Boolean' },
61	extraVariablesValues: { eventForm: document?.isEvent }	×
62	});
63
64	const { mutate: updatePost } = useUpdate({	×
65	collectionName: "Posts",
66	fragmentName: 'SuggestAlignmentPost',
67	});
68
69	const saveDraftLabel = getDraftLabel(document);	×
70
71	// If we've been redirected from PostsNewForm because of the post being autosaved, have the WrappedSmartForm try to fetch from the apollo cache first, since we should have prefetched to hydrate it before redirecting.
72	const editFormFetchPolicy = query.autosaveRedirect ? 'cache-first' : undefined;	×
73
74	const rateLimitNextAbleToPost = userWithRateLimit?.rateLimitNextAbleToPost;	×
75
76	const isDraft = document && document.draft;	×
77	const wasEverDraft = useRef(isDraft);	×
78
79	useEffect(() => {	×
80	if (wasEverDraft.current === undefined && isDraft !== undefined) {	×
81	wasEverDraft.current = isDraft;	×
82	}
83	}, [isDraft]);
84
85	if (!document && loading) {	×
86	return <Components.Loading/>	×
87	}
88
89	// If we only have read access to this post, but it's shared with us,
90	// redirect to the collaborative editor.
91	if (document && !canUserEditPostMetadata(currentUser, document) && !userIsPodcaster(currentUser)) {	×
92	return <Components.PermanentRedirect url={getPostCollaborateUrl(documentId, false, query.key)} status={302}/>	×
93	}
94
95	// If we don't have access at all but a link-sharing key was provided, redirect to the
96	// collaborative editor
97	if (!document && !loading && query?.key) {	×
98	return <Components.PermanentRedirect url={getPostCollaborateUrl(documentId, false, query.key)} status={302}/>	×
99	}
100
101	// If the post has a link-sharing key which is not in the URL, redirect to add
102	// the link-sharing key to the URL. (linkSharingKey has field-level
103	// permissions so it will only be present if we've either already used the
104	// link-sharing key, or have access through something other than link-sharing.)
105	if (document?.linkSharingKey && !(query?.key)) {	×
106	return <Components.PermanentRedirect url={postGetEditUrl(document._id, false, document.linkSharingKey)} status={302}/>	×
107	}
108
109	// If we don't have the post and none of the earlier cases applied, we either
110	// have an invalid post ID or the post is a draft that we don't have access
111	// to.
112	if (!document) {	×
113	return <Components.Error404/>	×
114	}
115
116	if (isNotHostedHere(document)) {	×
117	return <ForeignCrosspostEditForm post={document} />;	×
118	}
119
120	// FIXME: Unstable component will lose state on rerender
121	// eslint-disable-next-line react/no-unstable-nested-components
122	const EditPostsSubmit = (props: SubmitToFrontpageCheckboxProps & PostSubmitProps) => {	×
123	return <div className={classes.formSubmit}>	×
124	{!document.isEvent && <SubmitToFrontpageCheckbox {...props} />}	×
125	<PostSubmit
126	saveDraftLabel={saveDraftLabel}
127	feedbackLabel={"Get Feedback"}
128	{...props}
129	/>
130	</div>
131	}
132
NEW 133	const addFields: string[] = [];	×
134
135	/*
136	* addFields includes tagRelevance because the field permissions on
137	* the schema say the user can't edit this field, but the widget
138	* "edits" the tag list via indirect operations (upvoting/downvoting
139	* relevance scores).
140	*/
NEW 141	if (!(document.isEvent \|\| !!document.collabEditorDialogue)) {	×
NEW 142	addFields.push('tagRelevance');	×
143	}
144
145	// This is a resolver-only field, so we need to add it to the addFields array to get it to show up in the form
NEW 146	if (userCanCreateAndEditJargonTerms(currentUser)) {	×
NEW 147	addFields.push('glossary');	×
148	}
149
UNCOV 150	return (	×
151	<DynamicTableOfContents title={document.title}>
152	<div className={classes.postForm}>
153	<HeadTags title={document.title} />
154	{currentUser && <Components.PostsAcceptTos currentUser={currentUser} />}	×
155	{rateLimitNextAbleToPost && <RateLimitWarning lastRateLimitExpiry={rateLimitNextAbleToPost.nextEligible} rateLimitMessage={rateLimitNextAbleToPost.rateLimitMessage} />}	×
156	<DeferRender ssr={false}>
157	<EditorContext.Provider value={[editorState, setEditorState]}>
158	<WrappedSmartForm
159	collectionName="Posts"
160	documentId={documentId}
161	queryFragment={getFragment('PostsEditQueryFragment')}
162	mutationFragment={getFragment('PostsEditMutationFragment')}
163	successCallback={(post: any, options: any) => {
164	const alreadySubmittedToAF = post.suggestForAlignmentUserIds && post.suggestForAlignmentUserIds.includes(post.userId)	×
165	if (!post.draft && !alreadySubmittedToAF) afNonMemberSuccessHandling({currentUser, document: post, openDialog, updateDocument: updatePost})	×
166	if (options?.submitOptions?.redirectToEditor) {	×
167	navigate(postGetEditUrl(post._id, false, post.linkSharingKey));	×
168	} else {
169	// If they are publishing a draft, show the share popup
170	// Note: we can't use isDraft here because it gets updated to true when they click "Publish"
171	const showSharePopup = isEAForum && wasEverDraft.current && !post.draft	×
172	const sharePostQuery = `?${SHARE_POPUP_QUERY_PARAM}=true`	×
173	navigate({pathname: postGetPageUrl(post), search: showSharePopup ? sharePostQuery : ''})	×
174
175	if (!showSharePopup) {	×
176	flash({ messageString: `Post "${post.title}" edited`, type: 'success'});	×
177	}
178	}
179	}}
180	eventForm={document.isEvent}
181	removeSuccessCallback={({ documentId, documentTitle }: { documentId: string; documentTitle: string; }) => {
182	// post edit form is being included from a single post, redirect to index
183	// note: this.props.params is in the worst case an empty obj (from react-router)
184	if (params._id) {	×
185	navigate('/');	×
186	}
187
188	flash({ messageString: `Post "${documentTitle}" deleted.`, type: 'success'});	×
189	// todo: handle events in collection callbacks
190	// this.context.events.track("post deleted", {_id: documentId});
191	}}
192	showRemove={true}
193	collabEditorDialogue={!!document.collabEditorDialogue}
194	submitLabel={preferredHeadingCase(isDraft ? "Publish" : "Publish Changes")}	×
195	formComponents={{FormSubmit: !!document.collabEditorDialogue ? DialogueSubmit : EditPostsSubmit}}	×
196	extraVariables={{
197	version: 'String'
198	}}
199	extraVariablesValues={{
200	version: version ?? 'draft'	×
201	}}
202	noSubmitOnCmdEnter
203	repeatErrors
204
205	addFields={addFields}
206
207	editFormFetchPolicy={editFormFetchPolicy}
208	/>
209	</EditorContext.Provider>
210	</DeferRender>
211	</div>
212	</DynamicTableOfContents>
213	);
214	}
215
216	const PostsEditFormComponent = registerComponent('PostsEditForm', PostsEditForm, {styles});	1✔
217
218	declare global {
219	interface ComponentTypes {
220	PostsEditForm: typeof PostsEditFormComponent
221	}
222	}

ForumMagnum / ForumMagnum / 11523490149

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous