Added the ability to nuke all comments of a post in comment-nuke app #157
Conversation
Signed-off-by: Nisarga <[email protected]>
Signed-off-by: Nisarga <[email protected]>
| subredditId: string; | ||
| }; | ||
|
|
||
| async function getAllCommentsInPost( |
There was a problem hiding this comment.
consider using a generator here. the current approach will attempt to get all comments. if there are too many comments, the platform will time out before any comments can be deleted and retries will likely have the same issue.
something like this untested code:
/** yield all replies under a comment depth-first excluding the root. */
async function* getAllCommentsInThread(comment: Comment): AsyncGenerator<Comment> {
const replies = await comment.replies.all();
for (const reply of replies) {
yield* getAllCommentsInThread(reply);
yield reply;
}
}
// fetch comments one level at a time and print depth first.
for await (const reply of getAllCommentsInThread(someComment)) {
console.log(reply.approve())
}
console.log(someComment)| const shouldLock = props.lock; | ||
| const shouldRemove = props.remove; | ||
| const skipDistinguished = props.skipDistinguished; | ||
|
|
||
| if (!shouldLock && !shouldRemove) { | ||
| return { message: 'You must select either lock or remove.', success: false }; | ||
| } |
There was a problem hiding this comment.
consider moving the input validation and error handling to the call site. here are the benefits I see:
- breaks up the responsibilities of this function which is a little long.
- moves user input handling closer to where input is collected; this reduces the chance of user input getting further into the program.
- makes the rest of the code reusable by the program without mimicking user input.
- allows the caller to decide how to handle errors.
- keeps the try block small clarifying failure handling intent (everything, in this case) without costing an indent.
- allows more flexible typing. in this case, we might ask for a parameter like
op: 'Lock' | 'Remove'and then it makes lock AND remove impossible for the rest of the function if that's wanted.
| const post = await context.reddit.getPostById(props.postId); | ||
| const user = await context.reddit.getCurrentUser(); |
There was a problem hiding this comment.
🔕 I think these can run in parallel if you like:
const [user, post] = await Promise.all([
context.reddit.getCurrentUser(),
context.reddit.getPostById(props.postId)
])|
|
||
| const allComments = await getAllCommentsInPost(post); | ||
| const comments = allComments.filter( | ||
| (eachComment: any) => !(skipDistinguished && eachComment.isDistinguished()) |
There was a problem hiding this comment.
we try hard to avoid any because it disables typechecking. I think the type here should infer as Comment if we don't force any.
| } | ||
|
|
||
| const allComments = await getAllCommentsInPost(post); | ||
| const comments = allComments.filter( |
There was a problem hiding this comment.
I think we can move the conditional outside of the loop like const actionableComments = skipDistinguished ? allComments.filter(comment => !comment.isDistinguished()) : comments. are we supposed to preserve the subtrees of distinguished comments? if so, consider moving the check into getAllCommentsInPost(post, skipDistinguished).
| const verbage = | ||
| shouldLock && shouldRemove ? 'removed and locked' : shouldLock ? 'locked' : 'removed'; | ||
|
|
||
| if (shouldRemove) { |
There was a problem hiding this comment.
this block here looks beefy enough to be its own function. maybe call it removeComment() or something like that?
| remove: boolean; | ||
| lock: boolean; |
There was a problem hiding this comment.
can a comment be both removed AND locked? I saw the conditional requiring at least one or the other but what if both are active?
| } ${verbage}! Refresh the page to see the cleanup.`; | ||
|
|
||
| const finishTime = new Date(); | ||
| const timeElapsed = (finishTime as any) - (startTime as any); |
There was a problem hiding this comment.
I think we can hold use Date.now() instead to get the toal number of milliseconds to avoid a cast down here.
| const finishTime = new Date(); | ||
| const timeElapsed = (finishTime as any) - (startTime as any); | ||
| console.info(`${comments.length} comment(s) handled in ${timeElapsed / 1000} seconds.`); | ||
| } catch (err: any) { |
There was a problem hiding this comment.
I don't think we need any typing for the caught error? if so, I think we can use unknown.
| } catch (err: any) { | ||
| success = false; | ||
| message = 'Mop failed! Please try again later.'; | ||
| console.error(`${err.toString()}`); |
There was a problem hiding this comment.
suggest just console.error(err) to include the stacktrace.
💸 TL;DR
Added the ability to remove & lock all comments of a post by introducing the
handleNukePostfunction.handleNukePostallows a moderator to lock or remove all comments in a post. It fetches a post using the provided post ID, checks if the current user has the necessary mod permissions, and then proceeds to lock or remove all comments in the post based on the provided properties. If theskipDistinguishedproperty is true, distinguished comments are skipped. The function logs any failed attempts to lock or remove comments and returns a success message along with the number of comments handled.Also added a separate form -
nukePostFormin main.ts for this purpose.Created this PR after discussing with @pl00h on Discord, the old PR #5 was closed due to changes in the repository structure.
✅ Checks