Compare commits

...

18 Commits

Author SHA1 Message Date
FoxxMD
bc7eff8928 Merge branch 'edge' 2022-01-14 15:27:09 -05:00
FoxxMD
80c11b2c7f refactor(filter): Consolidate authorIs logic and add additional control to exclude logic
* Add excludeCondition to control how exclude sets are tested (and/or)
* Refactor authorIs logic from check/rule/action into standalone function (DRY)
* Simplify filter defaults -- don't need to specify automoderator since it is always a mod
2022-01-14 10:51:29 -05:00
FoxxMD
e6a2a86828 feat(config): Implement default filter criteria behavior
* Add default behavior config to operator and manager config
* Implement configurable behavior when filter is present on check
* Add defaults to exclude mods and automoderator from checks
2022-01-13 16:46:32 -05:00
FoxxMD
96749be571 refactor(polling): Simplify and cleanup all polling logic
* Remove unused clearProcessing code
* Use same data structures (Map) for storing polling objects in both Manager and Bot to reduce cognitive load and re-use some logic
* Rename "mod" streams to "shared" streams
* Implement detection and updating of polling when manager config changes
* Implement detection and updating of shared streams on manager config update
* Use shared retry handler for manager polling to better handle general reddit api issues (all polling stops faster)
* Move initial polling buffer into polling object (instead of in manager) for better logic encapsulation and add debug logging for it
* Add more debug logging for manager/bot poll building
2022-01-13 11:39:16 -05:00
FoxxMD
6b7e8e7749 feat(polling): Implement shared streams for all polling sources
* Refactor polling config to use new 'shared' string list of polling sources and deprecate 'sharedMod' property
* Refactor how shared sources are built to look for shared intention in manager polling options before creating
* Implement continuity check for comment/submission polling to ensure no activities are missed
* Add debug logging to polling
2022-01-12 15:47:43 -05:00
FoxxMD
43b29432a2 refactor(auth): Refactor auth data structures to consolidate logic
* Add abstract user class with auth methods with implementations for client/server
* Refactor client/server logic to use class methods instead of inline auth checks

Closes #71
2022-01-12 09:57:38 -05:00
FoxxMD
ff84946068 feat(regex): Experimental support for parsing regex expressions from fetched URL
* Support fetching from reddit wiki
* Support fetching from raw URL
* Support parsing and fetching from gist, github blob, and regexr (very experimental)
2022-01-11 14:05:57 -05:00
FoxxMD
7cdde99864 fix(recent): Potential fix for reddit ACID issues on history retrieval 2022-01-11 13:00:51 -05:00
FoxxMD
8eee1fe2e1 fix(recent): Remove code that should have been deleted during refactor
Refactored recent to use batch subreddit testing but forgot to remove old, individual subreddit testing, code so activities were being counted twice
2022-01-11 10:15:16 -05:00
FoxxMD
6fc09864f6 fix: Don't delete property from object
Object passed by ref, duh
2022-01-11 10:13:48 -05:00
FoxxMD
1510980ce3 fix(util): Ensure provided state description is reattached to strong sub state 2022-01-11 10:13:14 -05:00
FoxxMD
56005f0f28 fix(bot): Fix own profile detection when building managers 2022-01-11 09:52:44 -05:00
FoxxMD
03b655515c fix(server): Fix logs not persisting for managers
* Change manager acquisition so all managers belong to a bot before they start logging so all logs are captured correctly
* Fix log capture logic that prevented all subreddits from being populated
2022-01-11 09:45:25 -05:00
FoxxMD
edd874f356 fix(server): Correctly filter bots and managers on auth on server 2022-01-11 09:15:52 -05:00
FoxxMD
7f13debe3b fix(client): Make sure all moderated subreddits are fetched 2022-01-10 16:17:24 -05:00
Matt Foxx
1565bdbf1a Merge pull request #67 from rysie/feature/dry-run-buttons
Run/Dry run buttons
2022-01-10 14:54:42 -05:00
FoxxMD
ec4cee8c77 refactor(ui): Fix and simplify button logic
* Fix url query selector to constrain to sub
* Use shared class between run buttons to simplify class modification and click event
2022-01-10 14:54:17 -05:00
Marcin Macinski
c5b27628b0 feat(ui): Run/Dry run buttons 2022-01-07 23:32:12 +01:00
36 changed files with 1653 additions and 615 deletions

View File

@@ -1,7 +1,7 @@
import {Comment, Submission} from "snoowrap";
import {Logger} from "winston";
import {RuleResult} from "../Rule";
import {SubredditResources} from "../Subreddit/SubredditResources";
import {checkAuthorFilter, SubredditResources} from "../Subreddit/SubredditResources";
import {ActionProcessResult, ActionResult, ChecksActivityState, TypedActivityStates} from "../Common/interfaces";
import Author, {AuthorOptions} from "../Author/Author";
import {mergeArr} from "../util";
@@ -28,6 +28,7 @@ export abstract class Action {
subredditName,
dryRun = false,
authorIs: {
excludeCondition = 'OR',
include = [],
exclude = [],
} = {},
@@ -42,6 +43,7 @@ export abstract class Action {
this.logger = logger.child({labels: [`Action ${this.getActionUniqueName()}`]}, mergeArr);
this.authorIs = {
excludeCondition,
exclude: exclude.map(x => new Author(x)),
include: include.map(x => new Author(x)),
}
@@ -72,27 +74,10 @@ export abstract class Action {
actRes.runReason = `Activity did not pass 'itemIs' test, Action not run`;
return actRes;
}
if (this.authorIs.include !== undefined && this.authorIs.include.length > 0) {
for (const auth of this.authorIs.include) {
if (await this.resources.testAuthorCriteria(item, auth)) {
actRes.run = true;
const results = await this.process(item, ruleResults, runtimeDryrun);
return {...actRes, ...results};
}
}
this.logger.verbose('Inclusive author criteria not matched, Action not run');
actRes.runReason = 'Inclusive author criteria not matched';
return actRes;
} else if (this.authorIs.exclude !== undefined && this.authorIs.exclude.length > 0) {
for (const auth of this.authorIs.exclude) {
if (await this.resources.testAuthorCriteria(item, auth, false)) {
actRes.run = true;
const results = await this.process(item, ruleResults, runtimeDryrun);
return {...actRes, ...results};
}
}
this.logger.verbose('Exclusive author criteria not matched, Action not run');
actRes.runReason = 'Exclusive author criteria not matched';
const [authFilterResult, authFilterType] = await checkAuthorFilter(item, this.authorIs, this.resources, this.logger);
if(!authFilterResult) {
this.logger.verbose(`${authFilterType} author criteria not matched, Action not run`);
actRes.runReason = `${authFilterType} author criteria not matched`;
return actRes;
}

View File

@@ -1,5 +1,5 @@
import {UserNoteCriteria} from "../Rule";
import {CompareValue, CompareValueOrPercent, DurationComparor} from "../Common/interfaces";
import {CompareValue, CompareValueOrPercent, DurationComparor, JoinOperands} from "../Common/interfaces";
import {parseStringToRegex} from "../util";
/**
@@ -12,7 +12,17 @@ export interface AuthorOptions {
* */
include?: AuthorCriteria[];
/**
* Only runs if `include` is not present. Will "pass" if any of set of the AuthorCriteria **does not** pass
* * OR => if ANY exclude condition "does not" pass then the exclude test passes
* * AND => if ALL exclude conditions "do not" pass then the exclude test passes
*
* Defaults to OR
* @default OR
* */
excludeCondition?: JoinOperands
/**
* Only runs if `include` is not present. Each AuthorCriteria is comprised of conditions that the Author being checked must "not" pass. See excludeCondition for set behavior
*
* EX: `isMod: true, name: Automoderator` => Will pass if the Author IS NOT a mod and IS NOT named Automoderator
* */
exclude?: AuthorCriteria[];
}

View File

@@ -3,20 +3,30 @@ import {Logger} from "winston";
import dayjs, {Dayjs} from "dayjs";
import {Duration} from "dayjs/plugin/duration";
import EventEmitter from "events";
import {BotInstanceConfig, Invokee, PAUSED, RUNNING, STOPPED, SYSTEM, USER} from "../Common/interfaces";
import {
BotInstanceConfig,
FilterCriteriaDefaults,
Invokee,
PAUSED,
PollOn,
RUNNING,
STOPPED,
SYSTEM,
USER
} from "../Common/interfaces";
import {
createRetryHandler,
formatNumber,
mergeArr,
parseBool,
parseDuration,
parseSubredditName,
parseSubredditName, RetryOptions,
sleep,
snooLogWrapper
} from "../util";
import {Manager} from "../Subreddit/Manager";
import {ExtendedSnoowrap, ProxiedSnoowrap} from "../Utils/SnoowrapClients";
import {ModQueueStream, UnmoderatedStream} from "../Subreddit/Streams";
import {CommentStream, ModQueueStream, SPoll, SubmissionStream, UnmoderatedStream} from "../Subreddit/Streams";
import {BotResourcesManager} from "../Subreddit/SubredditResources";
import LoggedError from "../Utils/LoggedError";
import pEvent from "p-event";
@@ -33,6 +43,7 @@ class Bot {
running: boolean = false;
subreddits: string[];
excludeSubreddits: string[];
filterCriteriaDefaults?: FilterCriteriaDefaults
subManagers: Manager[] = [];
heartbeatInterval: number;
nextHeartbeat: Dayjs = dayjs();
@@ -43,6 +54,7 @@ class Bot {
nannyMode?: 'soft' | 'hard';
nannyRunning: boolean = false;
nextNannyCheck: Dayjs = dayjs().add(10, 'second');
sharedStreamRetryHandler: Function;
nannyRetryHandler: Function;
managerRetryHandler: Function;
nextExpiration: Dayjs = dayjs();
@@ -51,7 +63,7 @@ class Bot {
botAccount?: string;
maxWorkers: number;
startedAt: Dayjs = dayjs();
sharedModqueue: boolean = false;
sharedStreams: PollOn[] = [];
streamListedOnce: string[] = [];
stagger: number;
@@ -78,6 +90,7 @@ class Bot {
const {
notifications,
name,
filterCriteriaDefaults,
subreddits: {
names = [],
exclude = [],
@@ -98,7 +111,7 @@ class Bot {
debug,
},
polling: {
sharedMod,
shared = [],
stagger = 2000,
},
queue: {
@@ -123,7 +136,8 @@ class Bot {
this.hardLimit = hardLimit;
this.wikiLocation = wikiConfig;
this.heartbeatInterval = heartbeatInterval;
this.sharedModqueue = sharedMod;
this.filterCriteriaDefaults = filterCriteriaDefaults;
this.sharedStreams = shared;
if(name !== undefined) {
this.botName = name;
}
@@ -190,56 +204,12 @@ class Bot {
}
}
const retryHandler = createRetryHandler({maxRequestRetry: 8, maxOtherRetry: 2}, this.logger);
this.sharedStreamRetryHandler = createRetryHandler({maxRequestRetry: 8, maxOtherRetry: 2}, this.logger);
this.nannyRetryHandler = createRetryHandler({maxRequestRetry: 5, maxOtherRetry: 1}, this.logger);
this.managerRetryHandler = createRetryHandler({maxRequestRetry: 8, maxOtherRetry: 8, waitOnRetry: false, clearRetryCountAfter: 2}, this.logger);
this.stagger = stagger ?? 2000;
const modStreamErrorListener = (name: string) => async (err: any) => {
this.logger.error(`Polling error occurred on stream ${name.toUpperCase()}`, err);
const shouldRetry = await retryHandler(err);
if(shouldRetry) {
defaultUnmoderatedStream.startInterval();
} else {
for(const m of this.subManagers) {
if(m.modStreamCallbacks.size > 0) {
m.notificationManager.handle('runStateChanged', `${name.toUpperCase()} Polling Stopped`, 'Encountered too many errors from Reddit while polling. Will try to restart on next heartbeat.');
}
}
this.logger.error(`Mod stream ${name.toUpperCase()} encountered too many errors while polling. Will try to restart on next heartbeat.`);
}
}
const modStreamListingListener = (name: string) => async (listing: (Comment|Submission)[]) => {
// dole out in order they were received
if(!this.streamListedOnce.includes(name)) {
this.streamListedOnce.push(name);
return;
}
for(const i of listing) {
const foundManager = this.subManagers.find(x => x.subreddit.display_name === i.subreddit.display_name && x.modStreamCallbacks.get(name) !== undefined);
if(foundManager !== undefined) {
foundManager.modStreamCallbacks.get(name)(i);
if(stagger !== undefined) {
await sleep(stagger);
}
}
}
}
const defaultUnmoderatedStream = new UnmoderatedStream(this.client, {subreddit: 'mod', limit: 100, clearProcessed: { size: 100, retain: 100 }});
// @ts-ignore
defaultUnmoderatedStream.on('error', modStreamErrorListener('unmoderated'));
defaultUnmoderatedStream.on('listing', modStreamListingListener('unmoderated'));
const defaultModqueueStream = new ModQueueStream(this.client, {subreddit: 'mod', limit: 100, clearProcessed: { size: 100, retain: 100 }});
// @ts-ignore
defaultModqueueStream.on('error', modStreamErrorListener('modqueue'));
defaultModqueueStream.on('listing', modStreamListingListener('modqueue'));
this.cacheManager.modStreams.set('unmoderated', defaultUnmoderatedStream);
this.cacheManager.modStreams.set('modqueue', defaultModqueueStream);
process.on('uncaughtException', (e) => {
this.error = e;
});
@@ -263,6 +233,38 @@ class Bot {
});
}
createSharedStreamErrorListener = (name: string) => async (err: any) => {
this.logger.error(`Polling error occurred on stream ${name.toUpperCase()}`, err);
const shouldRetry = await this.sharedStreamRetryHandler(err);
if(shouldRetry) {
(this.cacheManager.modStreams.get(name) as SPoll<any>).startInterval(false);
} else {
for(const m of this.subManagers) {
if(m.sharedStreamCallbacks.size > 0) {
m.notificationManager.handle('runStateChanged', `${name.toUpperCase()} Polling Stopped`, 'Encountered too many errors from Reddit while polling. Will try to restart on next heartbeat.');
}
}
this.logger.error(`Mod stream ${name.toUpperCase()} encountered too many errors while polling. Will try to restart on next heartbeat.`);
}
}
createSharedStreamListingListener = (name: string) => async (listing: (Comment|Submission)[]) => {
// dole out in order they were received
if(!this.streamListedOnce.includes(name)) {
this.streamListedOnce.push(name);
return;
}
for(const i of listing) {
const foundManager = this.subManagers.find(x => x.subreddit.display_name === i.subreddit.display_name && x.sharedStreamCallbacks.get(name) !== undefined);
if(foundManager !== undefined) {
foundManager.sharedStreamCallbacks.get(name)(i);
if(this.stagger !== undefined) {
await sleep(this.stagger);
}
}
}
}
async onTerminate(reason = 'The application was shutdown') {
for(const m of this.subManagers) {
await m.notificationManager.handle('runStateChanged', 'Application Shutdown', reason);
@@ -316,7 +318,7 @@ class Bot {
while(!subListing.isFinished) {
subListing = await subListing.fetchMore({amount: 100});
}
availSubs = subListing;
availSubs = subListing.filter(x => x.display_name !== `u_${user.name}`);
this.logger.info(`u/${user.name} is a moderator of these subreddits: ${availSubs.map(x => x.display_name_prefixed).join(', ')}`);
@@ -336,38 +338,164 @@ class Bot {
}
} else {
if(this.excludeSubreddits.length > 0) {
this.logger.info(`Will run on all moderated subreddits but user-defined excluded: ${this.excludeSubreddits.join(', ')}`);
this.logger.info(`Will run on all moderated subreddits but own profile and user-defined excluded: ${this.excludeSubreddits.join(', ')}`);
const normalExcludes = this.excludeSubreddits.map(x => x.toLowerCase());
subsToRun = availSubs.filter(x => !normalExcludes.includes(x.display_name.toLowerCase()));
} else {
this.logger.info(`No user-defined subreddit constraints detected, will run on all moderated subreddits EXCEPT own profile (${this.botAccount})`);
subsToRun = availSubs.filter(x => x.display_name_prefixed !== this.botAccount);
subsToRun = availSubs;
}
}
// get configs for subs we want to run on and build/validate them
for (const sub of subsToRun) {
try {
this.subManagers.push(await this.createManager(sub));
this.subManagers.push(this.createManager(sub));
} catch (err: any) {
}
}
for(const m of this.subManagers) {
try {
await this.initManager(m);
} catch (err: any) {
}
}
this.parseSharedStreams();
}
async createManager(sub: Subreddit): Promise<Manager> {
const manager = new Manager(sub, this.client, this.logger, this.cacheManager, {dryRun: this.dryRun, sharedModqueue: this.sharedModqueue, wikiLocation: this.wikiLocation, botName: this.botName as string, maxWorkers: this.maxWorkers});
parseSharedStreams() {
const sharedCommentsSubreddits = !this.sharedStreams.includes('newComm') ? [] : this.subManagers.filter(x => x.isPollingShared('newComm')).map(x => x.subreddit.display_name);
if (sharedCommentsSubreddits.length > 0) {
const stream = this.cacheManager.modStreams.get('newComm');
if (stream === undefined || stream.subreddit !== sharedCommentsSubreddits.join('+')) {
let processed;
if (stream !== undefined) {
this.logger.info('Restarting SHARED COMMENT STREAM due to a subreddit config change');
stream.end();
processed = stream.processed;
}
if (sharedCommentsSubreddits.length > 100) {
this.logger.warn(`SHARED COMMENT STREAM => Reddit can only combine 100 subreddits for getting new Comments but this bot has ${sharedCommentsSubreddits.length}`);
}
const defaultCommentStream = new CommentStream(this.client, {
subreddit: sharedCommentsSubreddits.join('+'),
limit: 100,
enforceContinuity: true,
logger: this.logger,
processed,
label: 'Shared Polling'
});
// @ts-ignore
defaultCommentStream.on('error', this.createSharedStreamErrorListener('newComm'));
defaultCommentStream.on('listing', this.createSharedStreamListingListener('newComm'));
this.cacheManager.modStreams.set('newComm', defaultCommentStream);
}
} else {
const stream = this.cacheManager.modStreams.get('newComm');
if (stream !== undefined) {
stream.end();
}
}
const sharedSubmissionsSubreddits = !this.sharedStreams.includes('newSub') ? [] : this.subManagers.filter(x => x.isPollingShared('newSub')).map(x => x.subreddit.display_name);
if (sharedSubmissionsSubreddits.length > 0) {
const stream = this.cacheManager.modStreams.get('newSub');
if (stream === undefined || stream.subreddit !== sharedSubmissionsSubreddits.join('+')) {
let processed;
if (stream !== undefined) {
this.logger.info('Restarting SHARED SUBMISSION STREAM due to a subreddit config change');
stream.end();
processed = stream.processed;
}
if (sharedSubmissionsSubreddits.length > 100) {
this.logger.warn(`SHARED SUBMISSION STREAM => Reddit can only combine 100 subreddits for getting new Submissions but this bot has ${sharedSubmissionsSubreddits.length}`);
}
const defaultSubStream = new SubmissionStream(this.client, {
subreddit: sharedSubmissionsSubreddits.join('+'),
limit: 100,
enforceContinuity: true,
logger: this.logger,
processed,
label: 'Shared Polling'
});
// @ts-ignore
defaultSubStream.on('error', this.createSharedStreamErrorListener('newSub'));
defaultSubStream.on('listing', this.createSharedStreamListingListener('newSub'));
this.cacheManager.modStreams.set('newSub', defaultSubStream);
}
} else {
const stream = this.cacheManager.modStreams.get('newSub');
if (stream !== undefined) {
stream.end();
}
}
const isUnmoderatedShared = !this.sharedStreams.includes('unmoderated') ? false : this.subManagers.some(x => x.isPollingShared('unmoderated'));
const unmoderatedstream = this.cacheManager.modStreams.get('unmoderated');
if (isUnmoderatedShared && unmoderatedstream === undefined) {
const defaultUnmoderatedStream = new UnmoderatedStream(this.client, {
subreddit: 'mod',
limit: 100,
logger: this.logger,
label: 'Shared Polling'
});
// @ts-ignore
defaultUnmoderatedStream.on('error', this.createSharedStreamErrorListener('unmoderated'));
defaultUnmoderatedStream.on('listing', this.createSharedStreamListingListener('unmoderated'));
this.cacheManager.modStreams.set('unmoderated', defaultUnmoderatedStream);
} else if (!isUnmoderatedShared && unmoderatedstream !== undefined) {
unmoderatedstream.end();
}
const isModqueueShared = !this.sharedStreams.includes('modqueue') ? false : this.subManagers.some(x => x.isPollingShared('modqueue'));
const modqueuestream = this.cacheManager.modStreams.get('modqueue');
if (isModqueueShared && modqueuestream === undefined) {
const defaultModqueueStream = new ModQueueStream(this.client, {
subreddit: 'mod',
limit: 100,
logger: this.logger,
label: 'Shared Polling'
});
// @ts-ignore
defaultModqueueStream.on('error', this.createSharedStreamErrorListener('modqueue'));
defaultModqueueStream.on('listing', this.createSharedStreamListingListener('modqueue'));
this.cacheManager.modStreams.set('modqueue', defaultModqueueStream);
} else if (isModqueueShared && modqueuestream !== undefined) {
modqueuestream.end();
}
}
async initManager(manager: Manager) {
try {
await manager.parseConfiguration('system', true, {suppressNotification: true});
await manager.parseConfiguration('system', true, {suppressNotification: true, suppressChangeEvent: true});
} catch (err: any) {
if (!(err instanceof LoggedError)) {
this.logger.error(`Config was not valid:`, {subreddit: sub.display_name_prefixed});
this.logger.error(err, {subreddit: sub.display_name_prefixed});
this.logger.error(`Config was not valid:`, {subreddit: manager.subreddit.display_name_prefixed});
this.logger.error(err, {subreddit: manager.subreddit.display_name_prefixed});
err.logged = true;
}
}
}
createManager(sub: Subreddit): Manager {
const manager = new Manager(sub, this.client, this.logger, this.cacheManager, {
dryRun: this.dryRun,
sharedStreams: this.sharedStreams,
wikiLocation: this.wikiLocation,
botName: this.botName as string,
maxWorkers: this.maxWorkers,
filterCriteriaDefaults: this.filterCriteriaDefaults,
});
// all errors from managers will count towards bot-level retry count
manager.on('error', async (err) => await this.panicOnRetries(err));
manager.on('configChange', async () => {
this.parseSharedStreams();
await this.runSharedStreams(false);
});
return manager;
}
@@ -404,11 +532,12 @@ class Bot {
const sub = await this.client.getSubreddit(name);
this.logger.info(`Attempting to add manager for r/${name}`);
try {
const manager = await this.createManager(sub);
const manager = this.createManager(sub);
this.logger.info(`Starting manager for r/${name}`);
this.subManagers.push(manager);
await this.initManager(manager);
await manager.start('system', {reason: 'Caused by creation due to moderator invite'});
await this.runModStreams();
await this.runSharedStreams();
} catch (err: any) {
if (!(err instanceof LoggedError)) {
this.logger.error(err);
@@ -426,14 +555,14 @@ class Bot {
}
}
async runModStreams(notify = false) {
async runSharedStreams(notify = false) {
for(const [k,v] of this.cacheManager.modStreams) {
if(!v.running && this.subManagers.some(x => x.modStreamCallbacks.get(k) !== undefined)) {
if(!v.running && this.subManagers.some(x => x.sharedStreamCallbacks.get(k) !== undefined)) {
v.startInterval();
this.logger.info(`Starting default ${k.toUpperCase()} mod stream`);
this.logger.info(`Starting ${k.toUpperCase()} shared polling`);
if(notify) {
for(const m of this.subManagers) {
if(m.modStreamCallbacks.size > 0) {
if(m.sharedStreamCallbacks.size > 0) {
await m.notificationManager.handle('runStateChanged', `${k.toUpperCase()} Polling Started`, 'Polling was successfully restarted on heartbeat.');
}
}
@@ -457,7 +586,7 @@ class Bot {
}
}
await this.runModStreams();
await this.runSharedStreams();
this.nextNannyCheck = dayjs().add(10, 'second');
this.nextHeartbeat = dayjs().add(this.heartbeatInterval, 'second');
@@ -547,7 +676,7 @@ class Bot {
}
}
}
await this.runModStreams(true);
await this.runSharedStreams(true);
}
async runApiNanny() {

View File

@@ -28,7 +28,7 @@ import * as RuleSchema from '../Schema/Rule.json';
import * as RuleSetSchema from '../Schema/RuleSet.json';
import * as ActionSchema from '../Schema/Action.json';
import {ActionObjectJson, RuleJson, RuleObjectJson, ActionJson as ActionTypeJson} from "../Common/types";
import {SubredditResources} from "../Subreddit/SubredditResources";
import {checkAuthorFilter, SubredditResources} from "../Subreddit/SubredditResources";
import {Author, AuthorCriteria, AuthorOptions} from '..';
import {ExtendedSnoowrap} from '../Utils/SnoowrapClients';
@@ -43,10 +43,7 @@ export abstract class Check implements ICheck {
rules: Array<RuleSet | Rule> = [];
logger: Logger;
itemIs: TypedActivityStates;
authorIs: {
include: AuthorCriteria[],
exclude: AuthorCriteria[]
};
authorIs: AuthorOptions;
cacheUserResult: Required<UserResultCacheOptions>;
dryRun?: boolean;
notifyOnTrigger: boolean;
@@ -69,6 +66,7 @@ export abstract class Check implements ICheck {
itemIs = [],
authorIs: {
include = [],
excludeCondition = 'OR',
exclude = [],
} = {},
dryRun,
@@ -89,6 +87,7 @@ export abstract class Check implements ICheck {
this.condition = condition;
this.itemIs = itemIs;
this.authorIs = {
excludeCondition,
exclude: exclude.map(x => new Author(x)),
include: include.map(x => new Author(x)),
}
@@ -159,7 +158,7 @@ export abstract class Check implements ICheck {
runStats.push(`${this.actions.length} Actions`);
// not sure if this should be info or verbose
this.logger.info(`=${this.enabled ? 'Enabled' : 'Disabled'}= ${type.toUpperCase()} (${this.condition})${this.notifyOnTrigger ? ' ||Notify on Trigger|| ' : ''} => ${runStats.join(' | ')}${this.description !== undefined ? ` => ${this.description}` : ''}`);
if (this.rules.length === 0 && this.itemIs.length === 0 && this.authorIs.exclude.length === 0 && this.authorIs.include.length === 0) {
if (this.rules.length === 0 && this.itemIs.length === 0 && this.authorIs.exclude?.length === 0 && this.authorIs.include?.length === 0) {
this.logger.warn('No rules, item tests, or author test found -- this check will ALWAYS PASS!');
}
let ruleSetIndex = 1;
@@ -202,30 +201,9 @@ export abstract class Check implements ICheck {
this.logger.verbose(`${FAIL} => Item did not pass 'itemIs' test`);
return [false, allRuleResults];
}
let authorPass = null;
if (this.authorIs.include !== undefined && this.authorIs.include.length > 0) {
for (const auth of this.authorIs.include) {
if (await this.resources.testAuthorCriteria(item, auth)) {
authorPass = true;
break;
}
}
if (!authorPass) {
this.logger.verbose(`${FAIL} => Inclusive author criteria not matched`);
return Promise.resolve([false, allRuleResults]);
}
}
if (authorPass === null && this.authorIs.exclude !== undefined && this.authorIs.exclude.length > 0) {
for (const auth of this.authorIs.exclude) {
if (await this.resources.testAuthorCriteria(item, auth, false)) {
authorPass = true;
break;
}
}
if (!authorPass) {
this.logger.verbose(`${FAIL} => Exclusive author criteria not matched`);
return Promise.resolve([false, allRuleResults]);
}
const [authFilterResult, authFilterType] = await checkAuthorFilter(item, this.authorIs, this.resources, this.logger);
if(!authFilterResult) {
return Promise.resolve([false, allRuleResults]);
}
if (this.rules.length === 0) {

View File

@@ -1,4 +1,4 @@
import {HistoricalStats} from "./interfaces";
import {HistoricalStats, FilterCriteriaDefaults} from "./interfaces";
export const cacheOptDefaults = {ttl: 60, max: 500, checkPeriod: 600};
export const cacheTTLDefaults = {authorTTL: 60, userNotesTTL: 300, wikiTTL: 300, submissionTTL: 60, commentTTL: 60, filterCriteriaTTL: 60, subredditTTL: 600, selfTTL: 60};
@@ -29,3 +29,13 @@ export const createHistoricalDefaults = (): HistoricalStats => {
actionsRun: new Map(),
};
}
export const filterCriteriaDefault: FilterCriteriaDefaults = {
authorIs: {
exclude: [
{
isMod: true
}
]
}
}

View File

@@ -8,6 +8,7 @@ import {IncomingMessage} from "http";
import Submission from "snoowrap/dist/objects/Submission";
import Comment from "snoowrap/dist/objects/Comment";
import RedditUser from "snoowrap/dist/objects/RedditUser";
import {AuthorOptions} from "../Author/Author";
/**
* An ISO 8601 Duration
@@ -489,38 +490,6 @@ export type PollOn = 'unmoderated' | 'modqueue' | 'newSub' | 'newComm';
export interface PollingOptionsStrong extends PollingOptions {
limit: number,
interval: number,
clearProcessed: ClearProcessedOptions
}
/**
* For very long-running, high-volume subreddits clearing the list of processed activities helps manage memory bloat
*
* All of these options have default values based on the limit and/or interval set for polling options on each subreddit stream. They only need to modified if the defaults are not sufficient.
*
* If both `after` and `size` are defined whichever is hit first will trigger the list to clear. `after` will be reset after ever clear.
* */
export interface ClearProcessedOptions {
/**
* An interval the processed list should be cleared after.
*
* * EX `9 days`
* * EX `3 months`
* * EX `5 minutes`
* @pattern ^\s*(?<time>\d+)\s*(?<unit>days?|weeks?|months?|years?|hours?|minutes?|seconds?|milliseconds?)\s*$
* */
after?: string,
/**
* Number of activities found in processed list after which the list should be cleared.
*
* Defaults to the `limit` value from `PollingOptions`
* */
size?: number,
/**
* The number of activities to retain in processed list after clearing.
*
* Defaults to `limit` value from `PollingOptions`
* */
retain?: number,
}
export interface PollingDefaults {
@@ -594,8 +563,6 @@ export interface PollingOptions extends PollingDefaults {
*
* */
pollOn: 'unmoderated' | 'modqueue' | 'newSub' | 'newComm'
clearProcessed?: ClearProcessedOptions
}
export interface TTLConfig {
@@ -855,6 +822,13 @@ export interface ManagerOptions {
notifications?: NotificationConfig
credentials?: ThirdPartyCredentialsJsonConfig
/**
* Set the default filter criteria for all checks. If this property is specified it will override any defaults passed from the bot's config
*
* Default behavior is to exclude all mods and automoderator from checks
* */
filterCriteriaDefaults?: FilterCriteriaDefaults
}
/**
@@ -1220,6 +1194,7 @@ export interface Notifier {
export interface ManagerStateChangeOption {
reason?: string
suppressNotification?: boolean
suppressChangeEvent?: boolean
}
/**
@@ -1351,6 +1326,27 @@ export interface SnoowrapOptions {
debug?: boolean,
}
export type FilterCriteriaDefaultBehavior = 'replace' | 'merge';
export interface FilterCriteriaDefaults {
itemIs?: TypedActivityStates
/**
* Determine how itemIs defaults behave when itemIs is present on the check
*
* * merge => adds defaults to check's itemIs
* * replace => check itemIs will replace defaults (no defaults used)
* */
itemIsBehavior?: FilterCriteriaDefaultBehavior
/**
* Determine how authorIs defaults behave when authorIs is present on the check
*
* * merge => merges defaults with check's authorIs
* * replace => check authorIs will replace defaults (no defaults used)
* */
authorIs?: AuthorOptions
authorIsBehavior?: FilterCriteriaDefaultBehavior
}
/**
* The configuration for an **individual reddit account** ContextMod will run as a bot.
*
@@ -1379,6 +1375,13 @@ export interface BotInstanceJsonConfig {
* */
snoowrap?: SnoowrapOptions
/**
* Define the default behavior for all filter criteria on all checks in all subreddits
*
* Defaults to exclude mods and automoderator from checks
* */
filterCriteriaDefaults?: FilterCriteriaDefaults
/**
* Settings related to bot behavior for subreddits it is managing
* */
@@ -1446,18 +1449,31 @@ export interface BotInstanceJsonConfig {
* */
polling?: PollingDefaults & {
/**
* If set to `true` all subreddits polling unmoderated/modqueue with default polling settings will share a request to "r/mod"
* otherwise each subreddit will poll its own mod view
* DEPRECATED: See `shared`
*
* Using the ENV or ARG will sett `unmoderated` and `modqueue` on `shared`
*
* * ENV => `SHARE_MOD`
* * ARG => `--shareMod`
*
* @default false
* @deprecated
* */
sharedMod?: boolean,
/**
* If sharing a mod stream stagger pushing relevant Activities to individual subreddits.
* Set which polling sources should be shared among subreddits using default polling settings for that source
*
* * For `unmoderated and `modqueue` the bot will poll on **r/mod** for new activities
* * For `newSub` and `newComm` all subreddits sharing the source will be combined to poll like **r/subreddit1+subreddit2/new**
*
* If set to `true` all polling sources will be shared, otherwise specify which sourcs should be shared as a list
*
* */
shared?: PollOn[] | true,
/**
* If sharing a stream staggers pushing relevant Activities to individual subreddits.
*
* Useful when running many subreddits and rules are potentially cpu/memory/traffic heavy -- allows spreading out load
* */
@@ -1769,7 +1785,7 @@ export interface BotInstanceConfig extends BotInstanceJsonConfig {
heartbeatInterval: number,
},
polling: {
sharedMod: boolean,
shared: PollOn[],
stagger?: number,
limit: number,
interval: number,

View File

@@ -31,7 +31,11 @@ import {
CacheOptions,
BotInstanceJsonConfig,
BotInstanceConfig,
RequiredWebRedditCredentials, RedditCredentials, BotCredentialsJsonConfig, BotCredentialsConfig
RequiredWebRedditCredentials,
RedditCredentials,
BotCredentialsJsonConfig,
BotCredentialsConfig,
FilterCriteriaDefaults, TypedActivityStates
} from "./Common/interfaces";
import {isRuleSetJSON, RuleSetJson, RuleSetObjectJson} from "./Rule/RuleSet";
import deepEqual from "fast-deep-equal";
@@ -42,8 +46,9 @@ import {GetEnvVars} from 'env-cmd';
import {operatorConfig} from "./Utils/CommandConfig";
import merge from 'deepmerge';
import * as process from "process";
import {cacheOptDefaults, cacheTTLDefaults} from "./Common/defaults";
import {cacheOptDefaults, cacheTTLDefaults, filterCriteriaDefault} from "./Common/defaults";
import objectHash from "object-hash";
import {AuthorCriteria, AuthorOptions} from "./Author/Author";
export interface ConfigBuilderOptions {
logger: Logger,
@@ -115,22 +120,45 @@ export class ConfigBuilder {
return validConfig as JSONConfig;
}
parseToStructured(config: JSONConfig): CheckStructuredJson[] {
parseToStructured(config: JSONConfig, filterCriteriaDefaultsFromBot?: FilterCriteriaDefaults): CheckStructuredJson[] {
let namedRules: Map<string, RuleObjectJson> = new Map();
let namedActions: Map<string, ActionObjectJson> = new Map();
const {checks = []} = config;
const {checks = [], filterCriteriaDefaults} = config;
for (const c of checks) {
const {rules = []} = c;
namedRules = extractNamedRules(rules, namedRules);
namedActions = extractNamedActions(c.actions, namedActions);
}
const filterDefs = filterCriteriaDefaults ?? filterCriteriaDefaultsFromBot;
const {
authorIsBehavior = 'merge',
itemIsBehavior = 'merge',
authorIs: authorIsDefault = {},
itemIs: itemIsDefault = []
} = filterDefs || {};
const structuredChecks: CheckStructuredJson[] = [];
for (const c of checks) {
const {rules = []} = c;
const {rules = [], authorIs = {}, itemIs = []} = c;
const strongRules = insertNamedRules(rules, namedRules);
const strongActions = insertNamedActions(c.actions, namedActions);
const strongCheck = {...c, rules: strongRules, actions: strongActions} as CheckStructuredJson;
let derivedAuthorIs: AuthorOptions = authorIsDefault;
if(authorIsBehavior === 'merge') {
derivedAuthorIs = merge.all([authorIs, authorIsDefault], {arrayMerge: overwriteMerge});
} else if(Object.keys(authorIs).length > 0) {
derivedAuthorIs = authorIs;
}
let derivedItemIs: TypedActivityStates = itemIsDefault;
if(itemIsBehavior === 'merge') {
derivedItemIs = [...itemIs, ...itemIsDefault];
} else if(itemIs.length > 0) {
derivedItemIs = itemIs;
}
const strongCheck = {...c, authorIs: derivedAuthorIs, itemIs: derivedItemIs, rules: strongRules, actions: strongActions} as CheckStructuredJson;
structuredChecks.push(strongCheck);
}
@@ -146,10 +174,6 @@ export const buildPollingOptions = (values: (string | PollingOptions)[]): Pollin
pollOn: v as PollOn,
interval: DEFAULT_POLLING_INTERVAL,
limit: DEFAULT_POLLING_LIMIT,
clearProcessed: {
size: DEFAULT_POLLING_LIMIT,
retain: DEFAULT_POLLING_LIMIT,
}
});
} else {
const {
@@ -157,14 +181,12 @@ export const buildPollingOptions = (values: (string | PollingOptions)[]): Pollin
interval = DEFAULT_POLLING_INTERVAL,
limit = DEFAULT_POLLING_LIMIT,
delayUntil,
clearProcessed = {size: limit, retain: limit},
} = v;
opts.push({
pollOn: p as PollOn,
interval,
limit,
delayUntil,
clearProcessed
});
}
}
@@ -299,7 +321,7 @@ export const parseDefaultBotInstanceFromArgs = (args: any): BotInstanceJsonConfi
heartbeatInterval: heartbeat,
},
polling: {
sharedMod,
shared: sharedMod ? ['unmoderated','modqueue'] : undefined,
},
nanny: {
softLimit,
@@ -402,7 +424,7 @@ export const parseDefaultBotInstanceFromEnv = (): BotInstanceJsonConfig => {
heartbeatInterval: process.env.HEARTBEAT !== undefined ? parseInt(process.env.HEARTBEAT) : undefined,
},
polling: {
sharedMod: parseBool(process.env.SHARE_MOD),
shared: parseBool(process.env.SHARE_MOD) ? ['unmoderated','modqueue'] : undefined,
},
nanny: {
softLimit: process.env.SOFT_LIMIT !== undefined ? parseInt(process.env.SOFT_LIMIT) : undefined,
@@ -507,6 +529,16 @@ export const parseOperatorConfigFromSources = async (args: any): Promise<Operato
}
try {
configFromFile = validateJson(rawConfig, operatorSchema, initLogger) as OperatorJsonConfig;
const {bots = []} = configFromFile || {};
for(const b of bots) {
const {polling: {
sharedMod
} = {}} = b;
if(sharedMod !== undefined) {
initLogger.warn(`'sharedMod' bot config property is DEPRECATED and will be removed in next minor version. Use 'shared' property instead (see docs)`);
break;
}
}
} catch (err: any) {
initLogger.error('Cannot continue app startup because operator config file was not valid.');
throw err;
@@ -627,8 +659,10 @@ export const buildOperatorConfigWithDefaults = (data: OperatorJsonConfig): Opera
let hydratedBots: BotInstanceConfig[] = bots.map(x => {
const {
name: botName,
filterCriteriaDefaults = filterCriteriaDefault,
polling: {
sharedMod = false,
sharedMod,
shared = [],
stagger,
limit = 100,
interval = 30,
@@ -743,9 +777,16 @@ export const buildOperatorConfigWithDefaults = (data: OperatorJsonConfig): Opera
botCache.provider.prefix = buildCachePrefix([botCache.provider.prefix, 'bot', (botName || objectHash.sha1(botCreds))]);
}
let realShared = shared === true ? ['unmoderated','modqueue','newComm','newSub'] : shared;
if(sharedMod === true) {
realShared.push('unmoderated');
realShared.push('modqueue');
}
return {
name: botName,
snoowrap,
filterCriteriaDefaults,
subreddits: {
names,
exclude,
@@ -756,7 +797,7 @@ export const buildOperatorConfigWithDefaults = (data: OperatorJsonConfig): Opera
credentials: botCreds,
caching: botCache,
polling: {
sharedMod,
shared: [...new Set(realShared)] as PollOn[],
stagger,
limit,
interval,

View File

@@ -1,6 +1,7 @@
import {Rule, RuleJSONConfig, RuleOptions, RulePremise, RuleResult} from "./index";
import {Comment, VoteableContent} from "snoowrap";
import {VoteableContent} from "snoowrap";
import Submission from "snoowrap/dist/objects/Submission";
import Comment from "snoowrap/dist/objects/Comment";
import as from 'async';
import pMap from 'p-map';
// @ts-ignore
@@ -23,7 +24,7 @@ import {
parseSubredditName,
parseUsableLinkIdentifier,
PASS, sleep,
toStrongSubredditState
toStrongSubredditState, windowToActivityWindowCriteria
} from "../util";
import {
ActivityWindow,
@@ -115,15 +116,42 @@ export class RecentActivityRule extends Rule {
async process(item: Submission | Comment): Promise<[boolean, RuleResult]> {
let activities;
// ACID is a bitch
// reddit may not return the activity being checked in the author's recent history due to availability/consistency issues or *something*
// so make sure we add it in if config is checking the same type and it isn't included
// TODO refactor this for SubredditState everywhere branch
let shouldIncludeSelf = true;
const strongWindow = windowToActivityWindowCriteria(this.window);
const {
subreddits: {
include = [],
exclude = []
} = {}
} = strongWindow;
if (include.length > 0 && !include.some(x => x.toLocaleLowerCase() === item.subreddit.display_name.toLocaleLowerCase())) {
shouldIncludeSelf = false;
} else if (exclude.length > 0 && exclude.some(x => x.toLocaleLowerCase() === item.subreddit.display_name.toLocaleLowerCase())) {
shouldIncludeSelf = false;
}
switch (this.lookAt) {
case 'comments':
activities = await this.resources.getAuthorComments(item.author, {window: this.window});
if (shouldIncludeSelf && item instanceof Comment && !activities.some(x => x.name === item.name)) {
activities.unshift(item);
}
break;
case 'submissions':
activities = await this.resources.getAuthorSubmissions(item.author, {window: this.window});
if (shouldIncludeSelf && item instanceof Submission && !activities.some(x => x.name === item.name)) {
activities.unshift(item);
}
break;
default:
activities = await this.resources.getAuthorActivities(item.author, {window: this.window});
if (shouldIncludeSelf && !activities.some(x => x.name === item.name)) {
activities.unshift(item);
}
break;
}
@@ -316,34 +344,6 @@ export class RecentActivityRule extends Rule {
}
}
for (const activity of viableActivity) {
if (asSubmission(activity) && submissionState !== undefined) {
if (!(await this.resources.testItemCriteria(activity, [submissionState]))) {
continue;
}
} else if (commentState !== undefined) {
if (!(await this.resources.testItemCriteria(activity, [commentState]))) {
continue;
}
}
let inSubreddits = false;
for (const ss of subStates) {
const res = await this.resources.testSubredditCriteria(activity, ss);
if (res) {
inSubreddits = true;
break;
}
}
if (inSubreddits) {
currCount++;
combinedKarma += activity.score;
const pSub = getActivitySubredditName(activity);
if (!presentSubs.includes(pSub)) {
presentSubs.push(pSub);
}
}
}
const {operator, value, isPercent} = parseGenericValueOrPercentComparison(threshold);
let sum = {
subsWithActivity: presentSubs,

View File

@@ -152,7 +152,8 @@ export class RegexRule extends Rule {
}, []);
// check regex
const reg = parseStringToRegex(regex, 'g');
const regexContent = await this.resources.getContent(regex);
const reg = parseStringToRegex(regexContent, 'g');
if(reg === undefined) {
throw new SimpleError(`Value given for regex on Criteria ${name} was not valid: ${regex}`);
}
@@ -257,7 +258,7 @@ export class RegexRule extends Rule {
const critResults = {
criteria: {
name,
regex,
regex: regex !== regexContent ? `${regex} from ${regexContent}` : regex,
testOn,
matchThreshold,
activityMatchThreshold,

View File

@@ -2,7 +2,7 @@ import Snoowrap, {Comment} from "snoowrap";
import Submission from "snoowrap/dist/objects/Submission";
import {Logger} from "winston";
import {findResultByPremise, mergeArr} from "../util";
import {SubredditResources} from "../Subreddit/SubredditResources";
import {checkAuthorFilter, SubredditResources} from "../Subreddit/SubredditResources";
import {ChecksActivityState, TypedActivityStates} from "../Common/interfaces";
import Author, {AuthorOptions} from "../Author/Author";
@@ -65,6 +65,7 @@ export abstract class Rule implements IRule, Triggerable {
name = this.getKind(),
logger,
authorIs: {
excludeCondition = 'OR',
include = [],
exclude = [],
} = {},
@@ -78,6 +79,7 @@ export abstract class Rule implements IRule, Triggerable {
this.client = client;
this.authorIs = {
excludeCondition,
exclude: exclude.map(x => new Author(x)),
include: include.map(x => new Author(x)),
}
@@ -99,23 +101,10 @@ export abstract class Rule implements IRule, Triggerable {
this.logger.verbose(`(Skipped) Item did not pass 'itemIs' test`);
return Promise.resolve([null, this.getResult(null, {result: `Item did not pass 'itemIs' test`})]);
}
if (this.authorIs.include !== undefined && this.authorIs.include.length > 0) {
for (const auth of this.authorIs.include) {
if (await this.resources.testAuthorCriteria(item, auth)) {
return this.process(item);
}
}
this.logger.verbose('(Skipped) Inclusive author criteria not matched');
return Promise.resolve([null, this.getResult(null, {result: 'Inclusive author criteria not matched'})]);
}
if (this.authorIs.exclude !== undefined && this.authorIs.exclude.length > 0) {
for (const auth of this.authorIs.exclude) {
if (await this.resources.testAuthorCriteria(item, auth, false)) {
return this.process(item);
}
}
this.logger.verbose('(Skipped) Exclusive author criteria not matched');
return Promise.resolve([null, this.getResult(null, {result: 'Exclusive author criteria not matched'})]);
const [authFilterResult, authFilterType] = await checkAuthorFilter(item, this.authorIs, this.resources, this.logger);
if(!authFilterResult) {
this.logger.verbose(`(Skipped) ${authFilterType} Author criteria not matched`);
return Promise.resolve([null, this.getResult(null, {result: `${authFilterType} author criteria not matched`})]);
}
} catch (err: any) {
this.logger.error('Error occurred during Rule pre-process checks');

View File

@@ -131,12 +131,21 @@
],
"properties": {
"exclude": {
"description": "Only runs if `include` is not present. Will \"pass\" if any of set of the AuthorCriteria **does not** pass",
"description": "Only runs if `include` is not present. Each AuthorCriteria is comprised of conditions that the Author being checked must \"not\" pass. See excludeCondition for set behavior\n\nEX: `isMod: true, name: Automoderator` => Will pass if the Author IS NOT a mod and IS NOT named Automoderator",
"items": {
"$ref": "#/definitions/AuthorCriteria"
},
"type": "array"
},
"excludeCondition": {
"default": "OR",
"description": "* OR => if ANY exclude condition \"does not\" pass then the exclude test passes\n* AND => if ALL exclude conditions \"do not\" pass then the exclude test passes\n\nDefaults to OR",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"include": {
"description": "Will \"pass\" if any set of AuthorCriteria passes",
"items": {

View File

@@ -586,12 +586,21 @@
],
"properties": {
"exclude": {
"description": "Only runs if `include` is not present. Will \"pass\" if any of set of the AuthorCriteria **does not** pass",
"description": "Only runs if `include` is not present. Each AuthorCriteria is comprised of conditions that the Author being checked must \"not\" pass. See excludeCondition for set behavior\n\nEX: `isMod: true, name: Automoderator` => Will pass if the Author IS NOT a mod and IS NOT named Automoderator",
"items": {
"$ref": "#/definitions/AuthorCriteria"
},
"type": "array"
},
"excludeCondition": {
"default": "OR",
"description": "* OR => if ANY exclude condition \"does not\" pass then the exclude test passes\n* AND => if ALL exclude conditions \"do not\" pass then the exclude test passes\n\nDefaults to OR",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"include": {
"description": "Will \"pass\" if any set of AuthorCriteria passes",
"items": {
@@ -981,25 +990,6 @@
],
"type": "string"
},
"ClearProcessedOptions": {
"description": "For very long-running, high-volume subreddits clearing the list of processed activities helps manage memory bloat\n\nAll of these options have default values based on the limit and/or interval set for polling options on each subreddit stream. They only need to modified if the defaults are not sufficient.\n\nIf both `after` and `size` are defined whichever is hit first will trigger the list to clear. `after` will be reset after ever clear.",
"properties": {
"after": {
"description": "An interval the processed list should be cleared after.\n\n* EX `9 days`\n* EX `3 months`\n* EX `5 minutes`",
"pattern": "^\\s*(?<time>\\d+)\\s*(?<unit>days?|weeks?|months?|years?|hours?|minutes?|seconds?|milliseconds?)\\s*$",
"type": "string"
},
"retain": {
"description": "The number of activities to retain in processed list after clearing.\n\nDefaults to `limit` value from `PollingOptions`",
"type": "number"
},
"size": {
"description": "Number of activities found in processed list after which the list should be cleared.\n\nDefaults to the `limit` value from `PollingOptions`",
"type": "number"
}
},
"type": "object"
},
"CommentActionJson": {
"description": "Reply to the Activity. For a submission the reply will be a top-level comment.",
"properties": {
@@ -1436,6 +1426,61 @@
},
"type": "object"
},
"FilterCriteriaDefaults": {
"properties": {
"authorIs": {
"$ref": "#/definitions/AuthorOptions",
"description": "Determine how authorIs defaults behave when authorIs is present on the check\n\n* merge => merges defaults with check's authorIs\n* replace => check authorIs will replace defaults (no defaults used)",
"examples": [
{
"include": [
{
"flairText": [
"Contributor",
"Veteran"
]
},
{
"isMod": true
}
]
}
]
},
"authorIsBehavior": {
"enum": [
"merge",
"replace"
],
"type": "string"
},
"itemIs": {
"anyOf": [
{
"items": {
"$ref": "#/definitions/SubmissionState"
},
"type": "array"
},
{
"items": {
"$ref": "#/definitions/CommentState"
},
"type": "array"
}
]
},
"itemIsBehavior": {
"description": "Determine how itemIs defaults behave when itemIs is present on the check\n\n* merge => adds defaults to check's itemIs\n* replace => check itemIs will replace defaults (no defaults used)",
"enum": [
"merge",
"replace"
],
"type": "string"
}
},
"type": "object"
},
"FlairActionJson": {
"description": "Flair the Submission",
"properties": {
@@ -2110,10 +2155,6 @@
}
],
"properties": {
"clearProcessed": {
"$ref": "#/definitions/ClearProcessedOptions",
"description": "For very long-running, high-volume subreddits clearing the list of processed activities helps manage memory bloat\n\nAll of these options have default values based on the limit and/or interval set for polling options on each subreddit stream. They only need to modified if the defaults are not sufficient.\n\nIf both `after` and `size` are defined whichever is hit first will trigger the list to clear. `after` will be reset after ever clear."
},
"delayUntil": {
"description": "Delay processing Activity until it is `N` seconds old\n\nUseful if there are other bots that may process an Activity and you want this bot to run first/last/etc.\n\nIf the Activity is already `N` seconds old when it is initially retrieved no refresh of the Activity occurs (no API request is made) and it is immediately processed.",
"type": "number"
@@ -3798,6 +3839,10 @@
],
"type": "boolean"
},
"filterCriteriaDefaults": {
"$ref": "#/definitions/FilterCriteriaDefaults",
"description": "Set the default filter criteria for all checks. If this property is specified it will override any defaults passed from the bot's config\n\nDefault behavior is to exclude all mods and automoderator from checks"
},
"footer": {
"anyOf": [
{

View File

@@ -1,6 +1,161 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"AuthorCriteria": {
"additionalProperties": false,
"description": "Criteria with which to test against the author of an Activity. The outcome of the test is based on:\n\n1. All present properties passing and\n2. If a property is a list then any value from the list matching",
"examples": [
{
"flairText": [
"Contributor",
"Veteran"
],
"isMod": true,
"name": [
"FoxxMD",
"AnotherUser"
]
}
],
"minProperties": 1,
"properties": {
"age": {
"description": "Test the age of the Author's account (when it was created) against this comparison\n\nThe syntax is `(< OR > OR <= OR >=) <number> <unit>`\n\n* EX `> 100 days` => Passes if Author's account is older than 100 days\n* EX `<= 2 months` => Passes if Author's account is younger than or equal to 2 months\n\nUnit must be one of [DayJS Duration units](https://day.js.org/docs/en/durations/creating)\n\n[See] https://regexr.com/609n8 for example",
"pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(days?|weeks?|months?|years?|hours?|minutes?|seconds?|milliseconds?)\\s*$",
"type": "string"
},
"commentKarma": {
"description": "A string containing a comparison operator and a value to compare karma against\n\nThe syntax is `(< OR > OR <= OR >=) <number>[percent sign]`\n\n* EX `> 100` => greater than 100 comment karma\n* EX `<= 75%` => comment karma is less than or equal to 75% of **all karma**",
"pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
"type": "string"
},
"description": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "An (array of) string/regular expression to test contents of an Author's profile description against\n\nIf no flags are specified then the **insensitive** flag is used by default\n\nIf using an array then if **any** value in the array passes the description test passes",
"examples": [
[
"/test$/i",
"look for this string literal"
]
]
},
"flairCssClass": {
"description": "A list of (user) flair css class values from the subreddit to match against",
"examples": [
"red"
],
"items": {
"type": "string"
},
"type": "array"
},
"flairText": {
"description": "A list of (user) flair text values from the subreddit to match against",
"examples": [
"Approved"
],
"items": {
"type": "string"
},
"type": "array"
},
"isMod": {
"description": "Is the author a moderator?",
"type": "boolean"
},
"linkKarma": {
"description": "A string containing a comparison operator and a value to compare link karma against\n\nThe syntax is `(< OR > OR <= OR >=) <number>[percent sign]`\n\n* EX `> 100` => greater than 100 link karma\n* EX `<= 75%` => link karma is less than or equal to 75% of **all karma**",
"pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
"type": "string"
},
"name": {
"description": "A list of reddit usernames (case-insensitive) to match against. Do not include the \"u/\" prefix\n\n EX to match against /u/FoxxMD and /u/AnotherUser use [\"FoxxMD\",\"AnotherUser\"]",
"examples": [
"FoxxMD",
"AnotherUser"
],
"items": {
"type": "string"
},
"type": "array"
},
"shadowBanned": {
"description": "Is the author shadowbanned?\n\nThis is determined by trying to retrieve the author's profile. If a 404 is returned it is likely they are shadowbanned",
"type": "boolean"
},
"totalKarma": {
"description": "A string containing a comparison operator and a value to compare against\n\nThe syntax is `(< OR > OR <= OR >=) <number>`\n\n* EX `> 100` => greater than 100",
"pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
"type": "string"
},
"userNotes": {
"description": "A list of UserNote properties to check against the User Notes attached to this Author in this Subreddit (must have Toolbox enabled and used User Notes at least once)",
"items": {
"$ref": "#/definitions/UserNoteCriteria"
},
"type": "array"
},
"verified": {
"description": "Does Author's account have a verified email?",
"type": "boolean"
}
},
"type": "object"
},
"AuthorOptions": {
"description": "If present then these Author criteria are checked before running the rule. If criteria fails then the rule is skipped.",
"examples": [
{
"include": [
{
"flairText": [
"Contributor",
"Veteran"
]
},
{
"isMod": true
}
]
}
],
"properties": {
"exclude": {
"description": "Only runs if `include` is not present. Each AuthorCriteria is comprised of conditions that the Author being checked must \"not\" pass. See excludeCondition for set behavior\n\nEX: `isMod: true, name: Automoderator` => Will pass if the Author IS NOT a mod and IS NOT named Automoderator",
"items": {
"$ref": "#/definitions/AuthorCriteria"
},
"type": "array"
},
"excludeCondition": {
"default": "OR",
"description": "* OR => if ANY exclude condition \"does not\" pass then the exclude test passes\n* AND => if ALL exclude conditions \"do not\" pass then the exclude test passes\n\nDefaults to OR",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"include": {
"description": "Will \"pass\" if any set of AuthorCriteria passes",
"items": {
"$ref": "#/definitions/AuthorCriteria"
},
"type": "array"
}
},
"type": "object"
},
"BotConnection": {
"description": "Configuration required to connect to a CM Server",
"properties": {
@@ -58,6 +213,10 @@
}
]
},
"filterCriteriaDefaults": {
"$ref": "#/definitions/FilterCriteriaDefaults",
"description": "Define the default behavior for all filter criteria on all checks in all subreddits\n\nDefaults to exclude mods and automoderator from checks"
},
"name": {
"type": "string"
},
@@ -94,13 +253,36 @@
},
{
"properties": {
"shared": {
"anyOf": [
{
"items": {
"enum": [
"modqueue",
"newComm",
"newSub",
"unmoderated"
],
"type": "string"
},
"type": "array"
},
{
"enum": [
true
],
"type": "boolean"
}
],
"description": "Set which polling sources should be shared among subreddits using default polling settings for that source\n\n* For `unmoderated and `modqueue` the bot will poll on **r/mod** for new activities\n* For `newSub` and `newComm` all subreddits sharing the source will be combined to poll like **r/subreddit1+subreddit2/new**\n\nIf set to `true` all polling sources will be shared, otherwise specify which sourcs should be shared as a list"
},
"sharedMod": {
"default": false,
"description": "If set to `true` all subreddits polling unmoderated/modqueue with default polling settings will share a request to \"r/mod\"\notherwise each subreddit will poll its own mod view\n\n* ENV => `SHARE_MOD`\n* ARG => `--shareMod`",
"description": "DEPRECATED: See `shared`\n\n Using the ENV or ARG will sett `unmoderated` and `modqueue` on `shared`\n\n* ENV => `SHARE_MOD`\n* ARG => `--shareMod`",
"type": "boolean"
},
"stagger": {
"description": "If sharing a mod stream stagger pushing relevant Activities to individual subreddits.\n\nUseful when running many subreddits and rules are potentially cpu/memory/traffic heavy -- allows spreading out load",
"description": "If sharing a stream staggers pushing relevant Activities to individual subreddits.\n\nUseful when running many subreddits and rules are potentially cpu/memory/traffic heavy -- allows spreading out load",
"type": "number"
}
},
@@ -253,6 +435,73 @@
],
"type": "string"
},
"CommentState": {
"description": "Different attributes a `Comment` can be in. Only include a property if you want to check it.",
"examples": [
{
"op": true,
"removed": false
}
],
"properties": {
"age": {
"description": "A duration and how to compare it against a value\n\nThe syntax is `(< OR > OR <= OR >=) <number> <unit>` EX `> 100 days`, `<= 2 months`\n\n* EX `> 100 days` => Passes if the date being compared is before 100 days ago\n* EX `<= 2 months` => Passes if the date being compared is after or equal to 2 months\n\nUnit must be one of [DayJS Duration units](https://day.js.org/docs/en/durations/creating)\n\n[See] https://regexr.com/609n8 for example",
"pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(days|weeks|months|years|hours|minutes|seconds|milliseconds)\\s*$",
"type": "string"
},
"approved": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"depth": {
"description": "The (nested) level of a comment.\n\n* 0 mean the comment is at top-level (replying to submission)\n* non-zero, Nth value means the comment has N parent comments",
"pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(days|weeks|months|years|hours|minutes|seconds|milliseconds)\\s*$",
"type": "string"
},
"distinguished": {
"type": "boolean"
},
"filtered": {
"type": "boolean"
},
"locked": {
"type": "boolean"
},
"op": {
"description": "Is this Comment Author also the Author of the Submission this comment is in?",
"type": "boolean"
},
"removed": {
"type": "boolean"
},
"reports": {
"description": "A string containing a comparison operator and a value to compare against\n\nThe syntax is `(< OR > OR <= OR >=) <number>`\n\n* EX `> 2` => greater than 2 total reports\n\nDefaults to TOTAL reports on an Activity. Suffix the value with the report type to check that type:\n\n* EX `> 3 mod` => greater than 3 mod reports\n* EX `>= 1 user` => greater than 1 user report",
"pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
"type": "string"
},
"score": {
"description": "A string containing a comparison operator and a value to compare against\n\nThe syntax is `(< OR > OR <= OR >=) <number>`\n\n* EX `> 100` => greater than 100",
"pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
"type": "string"
},
"spam": {
"type": "boolean"
},
"stickied": {
"type": "boolean"
},
"submissionState": {
"description": "A list of SubmissionState attributes to test the Submission this comment is in",
"items": {
"$ref": "#/definitions/SubmissionState"
},
"type": "array"
}
},
"type": "object"
},
"DiscordProviderConfig": {
"properties": {
"name": {
@@ -275,6 +524,61 @@
],
"type": "object"
},
"FilterCriteriaDefaults": {
"properties": {
"authorIs": {
"$ref": "#/definitions/AuthorOptions",
"description": "Determine how authorIs defaults behave when authorIs is present on the check\n\n* merge => merges defaults with check's authorIs\n* replace => check authorIs will replace defaults (no defaults used)",
"examples": [
{
"include": [
{
"flairText": [
"Contributor",
"Veteran"
]
},
{
"isMod": true
}
]
}
]
},
"authorIsBehavior": {
"enum": [
"merge",
"replace"
],
"type": "string"
},
"itemIs": {
"anyOf": [
{
"items": {
"$ref": "#/definitions/SubmissionState"
},
"type": "array"
},
{
"items": {
"$ref": "#/definitions/CommentState"
},
"type": "array"
}
]
},
"itemIsBehavior": {
"description": "Determine how itemIs defaults behave when itemIs is present on the check\n\n* merge => adds defaults to check's itemIs\n* replace => check itemIs will replace defaults (no defaults used)",
"enum": [
"merge",
"replace"
],
"type": "string"
}
},
"type": "object"
},
"NotificationConfig": {
"properties": {
"events": {
@@ -543,6 +847,80 @@
},
"type": "object"
},
"SubmissionState": {
"description": "Different attributes a `Submission` can be in. Only include a property if you want to check it.",
"examples": [
{
"over_18": true,
"removed": false
}
],
"properties": {
"age": {
"description": "A duration and how to compare it against a value\n\nThe syntax is `(< OR > OR <= OR >=) <number> <unit>` EX `> 100 days`, `<= 2 months`\n\n* EX `> 100 days` => Passes if the date being compared is before 100 days ago\n* EX `<= 2 months` => Passes if the date being compared is after or equal to 2 months\n\nUnit must be one of [DayJS Duration units](https://day.js.org/docs/en/durations/creating)\n\n[See] https://regexr.com/609n8 for example",
"pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(days|weeks|months|years|hours|minutes|seconds|milliseconds)\\s*$",
"type": "string"
},
"approved": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"distinguished": {
"type": "boolean"
},
"filtered": {
"type": "boolean"
},
"is_self": {
"type": "boolean"
},
"link_flair_css_class": {
"type": "string"
},
"link_flair_text": {
"type": "string"
},
"locked": {
"type": "boolean"
},
"over_18": {
"description": "NSFW",
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"removed": {
"type": "boolean"
},
"reports": {
"description": "A string containing a comparison operator and a value to compare against\n\nThe syntax is `(< OR > OR <= OR >=) <number>`\n\n* EX `> 2` => greater than 2 total reports\n\nDefaults to TOTAL reports on an Activity. Suffix the value with the report type to check that type:\n\n* EX `> 3 mod` => greater than 3 mod reports\n* EX `>= 1 user` => greater than 1 user report",
"pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
"type": "string"
},
"score": {
"description": "A string containing a comparison operator and a value to compare against\n\nThe syntax is `(< OR > OR <= OR >=) <number>`\n\n* EX `> 100` => greater than 100",
"pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
"type": "string"
},
"spam": {
"type": "boolean"
},
"spoiler": {
"type": "boolean"
},
"stickied": {
"type": "boolean"
},
"title": {
"description": "A valid regular expression to match against the title of the submission",
"type": "string"
}
},
"type": "object"
},
"ThirdPartyCredentialsJsonConfig": {
"additionalProperties": {
},
@@ -561,6 +939,43 @@
},
"type": "object"
},
"UserNoteCriteria": {
"properties": {
"count": {
"default": ">= 1",
"description": "Number of occurrences of this type. Ignored if `search` is `current`\n\nA string containing a comparison operator and/or a value to compare number of occurrences against\n\nThe syntax is `(< OR > OR <= OR >=) <number>[percent sign] [ascending|descending]`",
"examples": [
">= 1"
],
"pattern": "^\\s*(?<opStr>>|>=|<|<=)\\s*(?<value>\\d+)\\s*(?<percent>%?)\\s*(?<extra>asc.*|desc.*)*$",
"type": "string"
},
"search": {
"default": "current",
"description": "How to test the notes for this Author:\n\n### current\n\nOnly the most recent note is checked for `type`\n\n### total\n\nThe `count` comparison of `type` must be found within all notes\n\n* EX `count: > 3` => Must have more than 3 notes of `type`, total\n* EX `count: <= 25%` => Must have 25% or less of notes of `type`, total\n\n### consecutive\n\nThe `count` **number** of `type` notes must be found in a row.\n\nYou may also specify the time-based order in which to search the notes by specifying `ascending (asc)` or `descending (desc)` in the `count` value. Default is `descending`\n\n* EX `count: >= 3` => Must have 3 or more notes of `type` consecutively, in descending order\n* EX `count: < 2` => Must have less than 2 notes of `type` consecutively, in descending order\n* EX `count: > 4 asc` => Must have greater than 4 notes of `type` consecutively, in ascending order",
"enum": [
"consecutive",
"current",
"total"
],
"examples": [
"current"
],
"type": "string"
},
"type": {
"description": "User Note type key to search for",
"examples": [
"spamwarn"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"WebCredentials": {
"description": "Separate credentials for the web interface can be provided when also running the api.\n\nAll properties not specified will default to values given in ENV/ARG credential properties\n\nRefer to the [required credentials table](https://github.com/FoxxMD/context-mod/blob/master/docs/operatorConfiguration.md#minimum-required-configuration) to see what is necessary for the web interface.",
"examples": [

View File

@@ -535,12 +535,21 @@
],
"properties": {
"exclude": {
"description": "Only runs if `include` is not present. Will \"pass\" if any of set of the AuthorCriteria **does not** pass",
"description": "Only runs if `include` is not present. Each AuthorCriteria is comprised of conditions that the Author being checked must \"not\" pass. See excludeCondition for set behavior\n\nEX: `isMod: true, name: Automoderator` => Will pass if the Author IS NOT a mod and IS NOT named Automoderator",
"items": {
"$ref": "#/definitions/AuthorCriteria"
},
"type": "array"
},
"excludeCondition": {
"default": "OR",
"description": "* OR => if ANY exclude condition \"does not\" pass then the exclude test passes\n* AND => if ALL exclude conditions \"do not\" pass then the exclude test passes\n\nDefaults to OR",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"include": {
"description": "Will \"pass\" if any set of AuthorCriteria passes",
"items": {

View File

@@ -509,12 +509,21 @@
],
"properties": {
"exclude": {
"description": "Only runs if `include` is not present. Will \"pass\" if any of set of the AuthorCriteria **does not** pass",
"description": "Only runs if `include` is not present. Each AuthorCriteria is comprised of conditions that the Author being checked must \"not\" pass. See excludeCondition for set behavior\n\nEX: `isMod: true, name: Automoderator` => Will pass if the Author IS NOT a mod and IS NOT named Automoderator",
"items": {
"$ref": "#/definitions/AuthorCriteria"
},
"type": "array"
},
"excludeCondition": {
"default": "OR",
"description": "* OR => if ANY exclude condition \"does not\" pass then the exclude test passes\n* AND => if ALL exclude conditions \"do not\" pass then the exclude test passes\n\nDefaults to OR",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"include": {
"description": "Will \"pass\" if any set of AuthorCriteria passes",
"items": {

View File

@@ -18,17 +18,15 @@ import {
totalFromMapStats,
triggeredIndicator,
} from "../util";
import {Poll} from "snoostorm";
import pEvent from "p-event";
import {RuleResult} from "../Rule";
import {ConfigBuilder, buildPollingOptions} from "../ConfigBuilder";
import {
ActionedEvent,
ActionResult,
DEFAULT_POLLING_INTERVAL,
DEFAULT_POLLING_LIMIT, Invokee,
DEFAULT_POLLING_LIMIT, FilterCriteriaDefaults, Invokee,
ManagerOptions, ManagerStateChangeOption, ManagerStats, PAUSED,
PollingOptionsStrong, ResourceStats, RUNNING, RunState, STOPPED, SYSTEM, USER
PollingOptionsStrong, PollOn, RUNNING, RunState, STOPPED, SYSTEM, USER
} from "../Common/interfaces";
import Submission from "snoowrap/dist/objects/Submission";
import {activityIsRemoved, itemContentPeek} from "../Utils/SnoowrapUtils";
@@ -48,7 +46,6 @@ import {queue, QueueObject} from 'async';
import {JSONConfig} from "../JsonConfig";
import {CheckStructuredJson} from "../Check";
import NotificationManager from "../Notification/NotificationManager";
import action from "../Web/Server/routes/authenticated/user/action";
import {createHistoricalDefaults, historicalDefaults} from "../Common/defaults";
import {ExtendedSnoowrap} from "../Utils/SnoowrapClients";
import {isRateLimitError, isStatusError} from "../Utils/Errors";
@@ -73,7 +70,7 @@ export interface CheckTask {
}
export interface RuntimeManagerOptions extends ManagerOptions {
sharedModqueue?: boolean;
sharedStreams?: PollOn[];
wikiLocation?: string;
botName: string;
maxWorkers: number;
@@ -98,13 +95,14 @@ export class Manager extends EventEmitter {
lastWikiRevision?: DayjsObj
lastWikiCheck: DayjsObj = dayjs();
wikiFormat: ('yaml' | 'json') = 'yaml';
filterCriteriaDefaults?: FilterCriteriaDefaults
//wikiUpdateRunning: boolean = false;
streamListedOnce: string[] = [];
streams: SPoll<Snoowrap.Submission | Snoowrap.Comment>[] = [];
modStreamCallbacks: Map<string, any> = new Map();
streams: Map<string, SPoll<Snoowrap.Submission | Snoowrap.Comment>> = new Map();
sharedStreamCallbacks: Map<string, any> = new Map();
pollingRetryHandler: Function;
dryRun?: boolean;
sharedModqueue: boolean;
sharedStreams: PollOn[];
cacheManager: BotResourcesManager;
globalDryRun?: boolean;
queue: QueueObject<CheckTask>;
@@ -198,7 +196,7 @@ export class Manager extends EventEmitter {
constructor(sub: Subreddit, client: ExtendedSnoowrap, logger: Logger, cacheManager: BotResourcesManager, opts: RuntimeManagerOptions = {botName: 'ContextMod', maxWorkers: 1}) {
super();
const {dryRun, sharedModqueue = false, wikiLocation = 'botconfig/contextbot', botName, maxWorkers} = opts;
const {dryRun, sharedStreams = [], wikiLocation = 'botconfig/contextbot', botName, maxWorkers, filterCriteriaDefaults} = opts;
this.displayLabel = opts.nickname || `${sub.display_name_prefixed}`;
const getLabels = this.getCurrentLabels;
const getDisplay = this.getDisplay;
@@ -214,7 +212,9 @@ export class Manager extends EventEmitter {
}, mergeArr);
this.globalDryRun = dryRun;
this.wikiLocation = wikiLocation;
this.sharedModqueue = sharedModqueue;
this.filterCriteriaDefaults = filterCriteriaDefaults;
this.sharedStreams = sharedStreams;
this.pollingRetryHandler = createRetryHandler({maxRequestRetry: 3, maxOtherRetry: 2}, this.logger);
this.subreddit = sub;
this.client = client;
this.botName = botName;
@@ -359,7 +359,7 @@ export class Manager extends EventEmitter {
return q;
}
protected async parseConfigurationFromObject(configObj: object) {
protected async parseConfigurationFromObject(configObj: object, suppressChangeEvent: boolean = false) {
try {
const configBuilder = new ConfigBuilder({logger: this.logger});
const validJson = configBuilder.validateJson(configObj);
@@ -419,7 +419,7 @@ export class Manager extends EventEmitter {
const commentChecks: Array<CommentCheck> = [];
const subChecks: Array<SubmissionCheck> = [];
const structuredChecks = configBuilder.parseToStructured(validJson);
const structuredChecks = configBuilder.parseToStructured(validJson, this.filterCriteriaDefaults);
// TODO check that bot has permissions for subreddit for all specified actions
// can find permissions in this.subreddit.mod_permissions
@@ -449,6 +449,19 @@ export class Manager extends EventEmitter {
this.logger.info(checkSummary);
}
this.validConfigLoaded = true;
if(!suppressChangeEvent) {
this.emit('configChange');
}
if(this.eventsState.state === RUNNING) {
// need to update polling, potentially
await this.buildPolling();
for(const stream of this.streams.values()) {
if(!stream.running) {
this.logger.debug(`Starting Polling for ${stream.name.toUpperCase()} ${stream.frequency / 1000}s interval`);
stream.startInterval();
}
}
}
} catch (err: any) {
this.validConfigLoaded = false;
throw err;
@@ -456,7 +469,7 @@ export class Manager extends EventEmitter {
}
async parseConfiguration(causedBy: Invokee = 'system', force: boolean = false, options?: ManagerStateChangeOption) {
const {reason, suppressNotification = false} = options || {};
const {reason, suppressNotification = false, suppressChangeEvent = false} = options || {};
//this.wikiUpdateRunning = true;
this.lastWikiCheck = dayjs();
@@ -564,7 +577,7 @@ export class Manager extends EventEmitter {
throw new ConfigParseError('Could not parse wiki page contents as JSON or YAML')
}
await this.parseConfigurationFromObject(configObj);
await this.parseConfigurationFromObject(configObj, suppressChangeEvent);
this.logger.info('Checks updated');
if(!suppressNotification) {
@@ -768,132 +781,197 @@ export class Manager extends EventEmitter {
}
}
async buildPolling() {
// give current handle() time to stop
//await sleep(1000);
isPollingShared(streamName: string): boolean {
const pollOption = this.pollOptions.find(x => x.pollOn === streamName);
return pollOption !== undefined && pollOption.limit === DEFAULT_POLLING_LIMIT && pollOption.interval === DEFAULT_POLLING_INTERVAL && this.sharedStreams.includes(streamName as PollOn);
}
const retryHandler = createRetryHandler({maxRequestRetry: 3, maxOtherRetry: 1}, this.logger);
async buildPolling() {
const sources: PollOn[] = ['unmoderated', 'modqueue', 'newComm', 'newSub'];
const subName = this.subreddit.display_name;
for (const pollOpt of this.pollOptions) {
const {
pollOn,
limit,
interval,
delayUntil,
clearProcessed,
} = pollOpt;
let stream: SPoll<Snoowrap.Submission | Snoowrap.Comment>;
let modStreamType: string | undefined;
for (const source of sources) {
switch (pollOn) {
case 'unmoderated':
if (limit === DEFAULT_POLLING_LIMIT && interval === DEFAULT_POLLING_INTERVAL && this.sharedModqueue) {
modStreamType = 'unmoderated';
// use default mod stream from resources
stream = this.cacheManager.modStreams.get('unmoderated') as SPoll<Snoowrap.Submission | Snoowrap.Comment>;
} else {
stream = new UnmoderatedStream(this.client, {
subreddit: this.subreddit.display_name,
limit: limit,
pollTime: interval * 1000,
clearProcessed,
});
}
break;
case 'modqueue':
if (limit === DEFAULT_POLLING_LIMIT && interval === DEFAULT_POLLING_INTERVAL) {
modStreamType = 'modqueue';
// use default mod stream from resources
stream = this.cacheManager.modStreams.get('modqueue') as SPoll<Snoowrap.Submission | Snoowrap.Comment>;
} else {
stream = new ModQueueStream(this.client, {
subreddit: this.subreddit.display_name,
limit: limit,
pollTime: interval * 1000,
clearProcessed
});
}
break;
case 'newSub':
stream = new SubmissionStream(this.client, {
subreddit: this.subreddit.display_name,
limit: limit,
pollTime: interval * 1000,
clearProcessed
});
break;
case 'newComm':
stream = new CommentStream(this.client, {
subreddit: this.subreddit.display_name,
limit: limit,
pollTime: interval * 1000,
clearProcessed
});
break;
if (!sources.includes(source)) {
this.logger.error(`'${source}' is not a valid polling source. Valid sources: unmoderated | modqueue | newComm | newSub`);
continue;
}
stream.once('listing', async (listing) => {
if (!this.streamListedOnce.includes(pollOn)) {
// warning if poll event could potentially miss activities
if (this.commentChecks.length === 0 && ['unmoderated', 'modqueue', 'newComm'].some(x => x === pollOn)) {
this.logger.warn(`Polling '${pollOn}' may return Comments but no comments checks were configured.`);
}
if (this.submissionChecks.length === 0 && ['unmoderated', 'modqueue', 'newSub'].some(x => x === pollOn)) {
this.logger.warn(`Polling '${pollOn}' may return Submissions but no submission checks were configured.`);
}
this.streamListedOnce.push(pollOn);
const pollOpt = this.pollOptions.find(x => x.pollOn.toLowerCase() === source.toLowerCase());
if (pollOpt === undefined) {
if(this.sharedStreamCallbacks.has(source)) {
this.logger.debug(`Removing listener for shared polling on ${source.toUpperCase()} because it no longer exists in config`);
this.sharedStreamCallbacks.delete(source);
}
});
const onItem = async (item: Comment | Submission) => {
if (!this.streamListedOnce.includes(pollOn)) {
return;
const existingStream = this.streams.get(source);
if (existingStream !== undefined) {
this.logger.debug(`Stopping polling on ${source.toUpperCase()} because it no longer exists in config`);
existingStream.end();
this.streams.delete(source);
}
if (item.subreddit.display_name !== subName || this.eventsState.state !== RUNNING) {
return;
}
let checkType: 'Submission' | 'Comment' | undefined;
if (item instanceof Submission) {
if (this.submissionChecks.length > 0) {
checkType = 'Submission';
}
} else if (this.commentChecks.length > 0) {
checkType = 'Comment';
}
if (checkType !== undefined) {
this.firehose.push({checkType, activity: item, options: {delayUntil}})
}
};
if (modStreamType !== undefined) {
this.modStreamCallbacks.set(pollOn, onItem);
} else {
stream.on('item', onItem);
// @ts-ignore
stream.on('error', async (err: any) => {
this.emit('error', err);
const {
limit,
interval,
delayUntil,
} = pollOpt;
let stream: SPoll<Snoowrap.Submission | Snoowrap.Comment>;
let modStreamType: string | undefined;
if(isRateLimitError(err)) {
this.logger.error('Encountered rate limit while polling! Bot is all out of requests :( Stopping subreddit queue and polling.');
await this.stop();
switch (source) {
case 'unmoderated':
if (limit === DEFAULT_POLLING_LIMIT && interval === DEFAULT_POLLING_INTERVAL && this.sharedStreams.includes(source)) {
modStreamType = 'unmoderated';
// use default mod stream from resources
stream = this.cacheManager.modStreams.get('unmoderated') as SPoll<Snoowrap.Submission | Snoowrap.Comment>;
} else {
stream = new UnmoderatedStream(this.client, {
subreddit: this.subreddit.display_name,
limit: limit,
pollTime: interval * 1000,
logger: this.logger,
});
}
break;
case 'modqueue':
if (limit === DEFAULT_POLLING_LIMIT && interval === DEFAULT_POLLING_INTERVAL && this.sharedStreams.includes(source)) {
modStreamType = 'modqueue';
// use default mod stream from resources
stream = this.cacheManager.modStreams.get('modqueue') as SPoll<Snoowrap.Submission | Snoowrap.Comment>;
} else {
stream = new ModQueueStream(this.client, {
subreddit: this.subreddit.display_name,
limit: limit,
pollTime: interval * 1000,
logger: this.logger,
});
}
break;
case 'newSub':
if (limit === DEFAULT_POLLING_LIMIT && interval === DEFAULT_POLLING_INTERVAL && this.sharedStreams.includes(source)) {
modStreamType = 'newSub';
// use default mod stream from resources
stream = this.cacheManager.modStreams.get('newSub') as SPoll<Snoowrap.Submission | Snoowrap.Comment>;
} else {
stream = new SubmissionStream(this.client, {
subreddit: this.subreddit.display_name,
limit: limit,
pollTime: interval * 1000,
logger: this.logger,
});
}
break;
case 'newComm':
if (limit === DEFAULT_POLLING_LIMIT && interval === DEFAULT_POLLING_INTERVAL && this.sharedStreams.includes(source)) {
modStreamType = 'newComm';
// use default mod stream from resources
stream = this.cacheManager.modStreams.get('newComm') as SPoll<Snoowrap.Submission | Snoowrap.Comment>;
} else {
stream = new CommentStream(this.client, {
subreddit: this.subreddit.display_name,
limit: limit,
pollTime: interval * 1000,
logger: this.logger,
});
}
break;
}
if (stream === undefined) {
this.logger.error(`Should have found polling source for '${source}' but it did not exist for some reason!`);
continue;
}
const onItem = async (item: Comment | Submission) => {
if (item.subreddit.display_name !== subName || this.eventsState.state !== RUNNING) {
return;
}
this.logger.error('Polling error occurred', err);
const shouldRetry = await retryHandler(err);
if (shouldRetry) {
stream.startInterval();
let checkType: 'Submission' | 'Comment' | undefined;
if (item instanceof Submission) {
if (this.submissionChecks.length > 0) {
checkType = 'Submission';
}
} else if (this.commentChecks.length > 0) {
checkType = 'Comment';
}
if (checkType !== undefined) {
this.firehose.push({checkType, activity: item, options: {delayUntil}})
}
};
if (modStreamType !== undefined) {
let removedOwn = false;
const existingStream = this.streams.get(source);
if(existingStream !== undefined) {
existingStream.end();
this.streams.delete(source);
removedOwn = true;
}
if(!this.sharedStreamCallbacks.has(source)) {
stream.once('listing', this.noChecksWarning(source));
this.sharedStreamCallbacks.set(source, onItem);
this.logger.debug(`${removedOwn ? 'Stopped own polling and replace with ' : 'Set '}listener on shared polling ${source}`);
}
} else {
let ownPollingMsgParts: string[] = [];
let removedShared = false;
if(this.sharedStreamCallbacks.has(source)) {
removedShared = true;
this.sharedStreamCallbacks.delete(source);
ownPollingMsgParts.push('removed shared polling listener');
}
const existingStream = this.streams.get(source);
let processed;
if (existingStream !== undefined) {
ownPollingMsgParts.push('replaced existing');
processed = existingStream.processed;
existingStream.end();
} else {
this.logger.warn('Stopping subreddit processing/polling due to too many errors');
await this.stop();
ownPollingMsgParts.push('create new');
stream.once('listing', this.noChecksWarning(source));
}
});
this.streams.push(stream);
this.logger.debug(`Polling ${source.toUpperCase()} => ${ownPollingMsgParts.join('and')} dedicated stream`);
stream.on('item', onItem);
// @ts-ignore
stream.on('error', async (err: any) => {
this.emit('error', err);
if (isRateLimitError(err)) {
this.logger.error('Encountered rate limit while polling! Bot is all out of requests :( Stopping subreddit queue and polling.');
await this.stop();
}
this.logger.error('Polling error occurred', err);
const shouldRetry = await this.pollingRetryHandler(err);
if (shouldRetry) {
stream.startInterval(false);
} else {
this.logger.warn('Stopping subreddit processing/polling due to too many errors');
await this.stop();
}
});
this.streams.set(source, stream);
}
}
}
}
noChecksWarning = (source: PollOn) => (listing: any) => {
if (this.commentChecks.length === 0 && ['modqueue', 'newComm'].some(x => x === source)) {
this.logger.warn(`Polling '${source.toUpperCase()}' may return Comments but no comments checks were configured.`);
}
if (this.submissionChecks.length === 0 && ['unmoderated', 'modqueue', 'newSub'].some(x => x === source)) {
this.logger.warn(`Polling '${source.toUpperCase()}' may return Submissions but no submission checks were configured.`);
}
}
startQueue(causedBy: Invokee = 'system', options?: ManagerStateChangeOption) {
const {reason, suppressNotification = false} = options || {};
if(this.queueState.state === RUNNING) {
@@ -1019,7 +1097,10 @@ export class Manager extends EventEmitter {
this.logger.warn('No submission or comment checks found!');
}
for (const s of this.streams) {
if (this.streams.size > 0) {
this.logger.debug(`Starting own streams => ${[...this.streams.values()].map(x => `${x.name.toUpperCase()} ${x.frequency / 1000}s interval`).join(' | ')}`)
}
for (const s of this.streams.values()) {
s.startInterval();
}
this.startedAt = dayjs();
@@ -1044,7 +1125,7 @@ export class Manager extends EventEmitter {
state: PAUSED,
causedBy
};
for(const s of this.streams) {
for(const s of this.streams.values()) {
s.end();
}
if(causedBy === USER) {
@@ -1061,15 +1142,11 @@ export class Manager extends EventEmitter {
stopEvents(causedBy: Invokee = 'system', options?: ManagerStateChangeOption) {
const {reason, suppressNotification = false} = options || {};
if(this.eventsState.state !== STOPPED) {
for (const s of this.streams) {
for (const s of this.streams.values()) {
s.end();
}
this.streams = [];
// for (const [k, v] of this.modStreamCallbacks) {
// const stream = this.cacheManager.modStreams.get(k) as Poll<Snoowrap.Submission | Snoowrap.Comment>;
// stream.removeListener('item', v);
// }
this.modStreamCallbacks = new Map();
this.streams = new Map();
this.sharedStreamCallbacks = new Map();
this.startedAt = undefined;
this.logger.info(`Events STOPPED by ${causedBy}`);
this.eventsState = {

View File

@@ -2,20 +2,22 @@ import {Poll, SnooStormOptions} from "snoostorm"
import Snoowrap from "snoowrap";
import {EventEmitter} from "events";
import {PollConfiguration} from "snoostorm/out/util/Poll";
import {ClearProcessedOptions, DEFAULT_POLLING_INTERVAL} from "../Common/interfaces";
import dayjs, {Dayjs} from "dayjs";
import { Duration } from "dayjs/plugin/duration";
import {parseDuration, random} from "../util";
import {DEFAULT_POLLING_INTERVAL} from "../Common/interfaces";
import {mergeArr, parseDuration, random} from "../util";
import { Logger } from "winston";
type Awaitable<T> = Promise<T> | T;
interface RCBPollingOptions extends SnooStormOptions {
interface RCBPollingOptions<T> extends SnooStormOptions {
subreddit: string,
clearProcessed?: ClearProcessedOptions
enforceContinuity?: boolean
logger: Logger
name?: string,
processed?: Set<T[keyof T]>
label?: string
}
interface RCBPollConfiguration<T> extends PollConfiguration<T> {
clearProcessed?: ClearProcessedOptions
interface RCBPollConfiguration<T> extends PollConfiguration<T>,RCBPollingOptions<T> {
}
export class SPoll<T extends object> extends Poll<T> {
@@ -23,30 +25,43 @@ export class SPoll<T extends object> extends Poll<T> {
getter: () => Awaitable<T[]>;
frequency;
running: boolean = false;
clearProcessedDuration?: Duration;
clearProcessedSize?: number;
clearProcessedAfter?: Dayjs;
retainProcessed: number = 0;
// intention of newStart is to make polling behavior such that only "new" items AFTER polling has started get emitted
// -- that is, we don't want to emit the items we immediately fetch on a fresh poll start since they existed "before" polling started
newStart: boolean = true;
enforceContinuity: boolean;
randInterval?: { clear: () => void };
name: string = 'Reddit Stream';
logger: Logger;
subreddit: string;
constructor(options: RCBPollConfiguration<T>) {
super(options);
this.identifier = options.identifier;
this.getter = options.get;
this.frequency = options.frequency;
const {
after,
size,
retain = 0,
} = options.clearProcessed || {};
if(after !== undefined) {
this.clearProcessedDuration = parseDuration(after);
}
this.clearProcessedSize = size;
this.retainProcessed = retain;
if (this.clearProcessedDuration !== undefined) {
this.clearProcessedAfter = dayjs().add(this.clearProcessedDuration.asSeconds(), 's');
identifier,
get,
frequency,
enforceContinuity = false,
logger,
name,
subreddit,
label = 'Polling',
processed
} = options;
this.subreddit = subreddit;
this.name = name !== undefined ? name : this.name;
this.logger = logger.child({labels: [label, this.name]}, mergeArr)
this.identifier = identifier;
this.getter = get;
this.frequency = frequency;
this.enforceContinuity = enforceContinuity;
// if we pass in processed on init the intention is to "continue" from where the previous stream left off
// WITHOUT new start behavior
if (processed !== undefined) {
this.processed = processed;
this.newStart = false;
}
clearInterval(this.interval);
}
@@ -54,21 +69,47 @@ export class SPoll<T extends object> extends Poll<T> {
this.interval = setTimeout((function (self) {
return async () => {
try {
const batch = await self.getter();
self.logger.debug('Polling...');
let batch = await self.getter();
const newItems: T[] = [];
for (const item of batch) {
const id = item[self.identifier];
if (self.processed.has(id)) continue;
let anyAlreadySeen = false;
let page = 1;
// initial iteration should always run
// but only continue iterating if stream enforces continuity and we've only seen new items so far
while(page === 1 || (self.enforceContinuity && !self.newStart && !anyAlreadySeen)) {
if(page !== 1) {
self.logger.debug(`Did not find any already seen activities and continuity is enforced. This probably means there were more new items than 1 api call can return. Fetching next page (${page})...`);
// @ts-ignore
batch = await batch.fetchMore({amount: 100});
}
for (const item of batch) {
const id = item[self.identifier];
if (self.processed.has(id)) {
anyAlreadySeen = true;
continue;
}
// Emit for new items and add it to the list
newItems.push(item);
self.processed.add(id);
self.emit("item", item);
// Emit for new items and add it to the list
newItems.push(item);
self.processed.add(id);
// but don't emit on new start since we are "buffering" already existing activities
if(!self.newStart) {
self.emit("item", item);
}
}
page++;
}
// Emit the new listing of all new items
self.emit("listing", newItems);
const newItemMsg = `Found ${newItems.length} new items`;
if(self.newStart) {
self.logger.debug(`${newItemMsg} but will ignore all on first start.`);
self.emit("listing", []);
} else {
self.logger.debug(newItemMsg);
// Emit the new listing of all new items
self.emit("listing", newItems);
}
// no longer new start on n+1 interval
self.newStart = false;
// if everything succeeded then create a new timeout
self.createInterval();
} catch (err: any) {
@@ -78,13 +119,18 @@ export class SPoll<T extends object> extends Poll<T> {
})(this), random(this.frequency - 1, this.frequency + 1));
}
startInterval = () => {
// allow controlling newStart state
startInterval = (newStartState?: boolean) => {
this.running = true;
if(newStartState !== undefined) {
this.newStart = newStartState;
}
this.createInterval();
}
end = () => {
this.running = false;
this.newStart = true;
super.end();
}
}
@@ -92,12 +138,13 @@ export class SPoll<T extends object> extends Poll<T> {
export class UnmoderatedStream extends SPoll<Snoowrap.Submission | Snoowrap.Comment> {
constructor(
client: Snoowrap,
options: RCBPollingOptions) {
options: RCBPollingOptions<Snoowrap.Submission | Snoowrap.Comment>) {
super({
frequency: options.pollTime || DEFAULT_POLLING_INTERVAL * 1000,
get: async () => client.getSubreddit(options.subreddit).getUnmoderated(options),
identifier: "id",
clearProcessed: options.clearProcessed
name: 'Unmoderated',
...options,
});
}
}
@@ -105,12 +152,13 @@ export class UnmoderatedStream extends SPoll<Snoowrap.Submission | Snoowrap.Comm
export class ModQueueStream extends SPoll<Snoowrap.Submission | Snoowrap.Comment> {
constructor(
client: Snoowrap,
options: RCBPollingOptions) {
options: RCBPollingOptions<Snoowrap.Submission | Snoowrap.Comment>) {
super({
frequency: options.pollTime || DEFAULT_POLLING_INTERVAL * 1000,
get: async () => client.getSubreddit(options.subreddit).getModqueue(options),
identifier: "id",
clearProcessed: options.clearProcessed
name: 'Modqueue',
...options,
});
}
}
@@ -118,12 +166,13 @@ export class ModQueueStream extends SPoll<Snoowrap.Submission | Snoowrap.Comment
export class SubmissionStream extends SPoll<Snoowrap.Submission | Snoowrap.Comment> {
constructor(
client: Snoowrap,
options: RCBPollingOptions) {
options: RCBPollingOptions<Snoowrap.Submission | Snoowrap.Comment>) {
super({
frequency: options.pollTime || DEFAULT_POLLING_INTERVAL * 1000,
get: async () => client.getNew(options.subreddit, options),
identifier: "id",
clearProcessed: options.clearProcessed
name: 'Submission',
...options,
});
}
}
@@ -131,12 +180,13 @@ export class SubmissionStream extends SPoll<Snoowrap.Submission | Snoowrap.Comme
export class CommentStream extends SPoll<Snoowrap.Submission | Snoowrap.Comment> {
constructor(
client: Snoowrap,
options: RCBPollingOptions) {
options: RCBPollingOptions<Snoowrap.Submission | Snoowrap.Comment>) {
super({
frequency: options.pollTime || DEFAULT_POLLING_INTERVAL * 1000,
get: async () => client.getNewComments(options.subreddit, options),
identifier: "id",
clearProcessed: options.clearProcessed
name: 'Comment',
...options,
});
}
}

View File

@@ -13,12 +13,27 @@ import as from 'async';
import fetch from 'node-fetch';
import {
asSubmission,
buildCacheOptionsFromProvider, buildCachePrefix,
cacheStats, compareDurationValue, comparisonTextOp, createCacheManager, createHistoricalStatsDisplay,
formatNumber, getActivityAuthorName, getActivitySubredditName, isStrongSubredditState,
mergeArr, parseDurationComparison,
parseExternalUrl, parseGenericValueComparison, parseRedditEntity,
parseWikiContext, shouldCacheSubredditStateCriteriaResult, subredditStateIsNameOnly, toStrongSubredditState
buildCacheOptionsFromProvider,
buildCachePrefix,
cacheStats,
compareDurationValue,
comparisonTextOp,
createCacheManager,
createHistoricalStatsDisplay, FAIL,
fetchExternalUrl,
formatNumber,
getActivityAuthorName,
getActivitySubredditName,
isStrongSubredditState,
mergeArr,
parseDurationComparison,
parseExternalUrl,
parseGenericValueComparison,
parseRedditEntity,
parseWikiContext, PASS,
shouldCacheSubredditStateCriteriaResult,
subredditStateIsNameOnly,
toStrongSubredditState
} from "../util";
import LoggedError from "../Utils/LoggedError";
import {
@@ -45,7 +60,7 @@ import {
import UserNotes from "./UserNotes";
import Mustache from "mustache";
import he from "he";
import {AuthorCriteria} from "../Author/Author";
import {AuthorCriteria, AuthorOptions} from "../Author/Author";
import {SPoll} from "./Streams";
import {Cache} from 'cache-manager';
import {Submission, Comment, Subreddit} from "snoowrap/dist/objects";
@@ -593,8 +608,7 @@ export class SubredditResources {
}
} else {
try {
const response = await fetch(extUrl as string);
wikiContent = await response.text();
wikiContent = await fetchExternalUrl(extUrl as string, this.logger);
} catch (err: any) {
const msg = `Error occurred while trying to fetch the url ${extUrl}`;
this.logger.error(msg, err);
@@ -781,8 +795,8 @@ export class SubredditResources {
return await this.isItem(i, activityStates, this.logger);
}
async isSubreddit (subreddit: Subreddit, stateCriteria: SubredditState | StrongSubredditState, logger: Logger) {
delete stateCriteria.stateDescription;
async isSubreddit (subreddit: Subreddit, stateCriteriaRaw: SubredditState | StrongSubredditState, logger: Logger) {
const {stateDescription, ...stateCriteria} = stateCriteriaRaw;
if (Object.keys(stateCriteria).length === 0) {
return true;
@@ -1277,3 +1291,50 @@ export class BotResourcesManager {
return;
}
}
export const checkAuthorFilter = async (item: (Submission | Comment), filter: AuthorOptions, resources: SubredditResources, logger: Logger): Promise<[boolean, ('inclusive' | 'exclusive' | undefined)]> => {
const authLogger = logger.child({labels: ['Author Filter']}, mergeArr);
const {
include = [],
excludeCondition = 'OR',
exclude = [],
} = filter;
let authorPass = null;
if (include.length > 0) {
for (const auth of include) {
if (await resources.testAuthorCriteria(item, auth)) {
authLogger.verbose(`${PASS} => Inclusive author criteria matched`);
authLogger.debug(`Inclusive is always OR => At least one of ${include.length} matched`);
return [true, 'inclusive'];
}
}
authLogger.verbose(`${FAIL} => Inclusive author criteria not matched`);
authLogger.debug(`Inclusive is always OR => None of ${include.length} criteria matched`);
return [false, 'inclusive'];
}
if (exclude.length > 0) {
for (const auth of exclude) {
const excludePass = await resources.testAuthorCriteria(item, auth, false);
if (excludePass && excludeCondition === 'OR') {
authorPass = true;
break;
} else if (!excludePass && excludeCondition === 'AND') {
authorPass = false;
break;
}
}
if (authorPass !== true) {
authLogger.verbose(`${FAIL} => Exclusive author criteria not matched`);
if(exclude.length > 1) {
authLogger.debug(excludeCondition === 'OR' ? `Exclusive OR => No criteria from set of ${exclude.length} matched` : `Exclusive AND => At least one of ${exclude.length} criteria did not match`)
}
return [false, 'exclusive']
}
authLogger.verbose(`${PASS} => Exclusive author criteria matched`);
if(exclude.length > 1) {
authLogger.debug(excludeCondition === 'OR' ? `Exclusive OR => At least 1 in set of ${exclude.length} matched` : `Exclusive AND => All ${exclude.length} matched`)
}
return [true, 'exclusive'];
}
return [true, undefined];
}

View File

@@ -46,6 +46,7 @@ import {MESSAGE} from "triple-beam";
import Autolinker from "autolinker";
import path from "path";
import {ExtendedSnoowrap} from "../../Utils/SnoowrapClients";
import ClientUser from "../Common/User/ClientUser";
const emitter = new EventEmitter();
@@ -89,19 +90,6 @@ declare module 'express-session' {
}
}
// declare global {
// namespace Express {
// interface User {
// name: string
// subreddits: string[]
// machine?: boolean
// isOperator?: boolean
// realManagers?: string[]
// moderatedManagers?: string[]
// }
// }
// }
interface ConnectedUserInfo {
level?: string,
user?: string,
@@ -202,8 +190,9 @@ const webClient = async (options: OperatorConfig) => {
done(null, { subreddits: subreddits.map((x: Subreddit) => x.display_name), isOperator: webOps.includes(user.toLowerCase()), name: user, scope, token, tokenExpiresAt: dayjs().unix() + (60 * 60) });
});
passport.deserializeUser(async function (obj, done) {
done(null, obj as Express.User);
passport.deserializeUser(async function (obj: any, done) {
const user = new ClientUser(obj.name, obj.subreddits, {token: obj.token, scope: obj.scope, webOperator: obj.isOperator, tokenExpiresAt: obj.tokenExpiresAt});
done(null, user);
// const data = await webCache.get(`userSession-${obj}`) as object;
// if (data === undefined) {
// done('Not Found');
@@ -236,7 +225,10 @@ const webClient = async (options: OperatorConfig) => {
code: code as string,
});
const user = await client.getMe().name as string;
const subs = await client.getModeratedSubreddits();
let subs = await client.getModeratedSubreddits({count: 100});
while(!subs.isFinished) {
subs = await subs.fetchMore({amount: 100});
}
io.to(req.session.id).emit('authStatus', {canSaveWiki: req.session.scope?.includes('wikiedit')});
return done(null, {user, subreddits: subs, scope: req.session.scope, token: client.accessToken});
}
@@ -417,7 +409,7 @@ const webClient = async (options: OperatorConfig) => {
'<div>or as an argument: <span class="font-mono">--operator YourRedditUsername</span></div>'});
}
// or if there is an operator and current user is operator
if(req.user.isOperator) {
if(req.user?.clientData?.webOperator) {
return next();
} else {
return res.render('error', {error: 'You must be an <b>Operator</b> to access this route.'});
@@ -429,7 +421,7 @@ const webClient = async (options: OperatorConfig) => {
redirectUri,
clientId,
clientSecret,
token: req.isAuthenticated() && req.user.isOperator ? token : undefined
token: req.isAuthenticated() && req.user?.clientData?.webOperator ? token : undefined
});
});
@@ -626,20 +618,16 @@ const webClient = async (options: OperatorConfig) => {
return res.status(404).render('error', {error: msg});
}
const user = req.user as Express.User;
const isOperator = instance.operators.includes(user.name);
const canAccessBot = isOperator || intersect(user.subreddits, instance.subreddits).length > 0;
if (!user.isOperator && !canAccessBot) {
if (!req.user?.clientData?.webOperator && !req.user?.canAccessInstance(instance)) {
return res.status(404).render('error', {error: msg});
}
if (req.params.subreddit !== undefined && !isOperator && !user.subreddits.includes(req.params.subreddit)) {
if (req.params.subreddit !== undefined && !req.user?.isInstanceOperator(instance) && !req.user?.subreddits.includes(req.params.subreddit)) {
return res.status(404).render('error', {error: msg});
}
req.instance = instance;
req.session.botId = instance.friendly;
if(canAccessBot) {
if(req.user?.canAccessInstance(instance)) {
req.session.authBotId = instance.friendly;
}
return next();
@@ -664,15 +652,11 @@ const webClient = async (options: OperatorConfig) => {
return res.status(404).render('error', {error: msg});
}
const user = req.user as Express.User;
const isOperator = instance.operators.includes(user.name);
const canAccessBot = isOperator || intersect(user.subreddits, botInstance.subreddits.map(x => x.replace(/\\*r\/*/,''))).length > 0;
if (!user.isOperator && !canAccessBot) {
if (!req.user?.clientData?.webOperator && !req.user?.canAccessBot(botInstance)) {
return res.status(404).render('error', {error: msg});
}
if (req.params.subreddit !== undefined && !isOperator && !user.subreddits.includes(req.params.subreddit)) {
if (req.params.subreddit !== undefined && !req.user?.isInstanceOperator(instance) && !req.user?.subreddits.includes(req.params.subreddit)) {
return res.status(404).render('error', {error: msg});
}
req.bot = botInstance;
@@ -772,12 +756,12 @@ const webClient = async (options: OperatorConfig) => {
const level = req.session.level;
const shownInstances = cmInstances.reduce((acc: CMInstance[], curr) => {
const isBotOperator = curr.operators.map(x => x.toLowerCase()).includes(user.name.toLowerCase());
if(user.isOperator) {
const isBotOperator = req.user?.isInstanceOperator(curr);
if(user?.clientData?.webOperator) {
// @ts-ignore
return acc.concat({...curr, canAccessLocation: true, isOperator: isBotOperator});
}
if(!isBotOperator && intersect(user.subreddits, curr.subreddits).length === 0) {
if(!isBotOperator && !req.user?.canAccessInstance(curr)) {
return acc;
}
// @ts-ignore
@@ -804,7 +788,7 @@ const webClient = async (options: OperatorConfig) => {
return res.render('offline', {
instances: shownInstances,
instanceId: (req.instance as CMInstance).friendly,
isOperator: instance.operators.includes((req.user as Express.User).name),
isOperator: req.user?.isInstanceOperator(instance),
// @ts-ignore
logs: filterLogBySubreddit(instanceLogMap, [instance.friendly], {limit, sort, level, allLogName: 'web', allLogsParser: parseInstanceLogInfoName }).get(instance.friendly),
logSettings: {
@@ -837,7 +821,7 @@ const webClient = async (options: OperatorConfig) => {
bots: resp.bots,
botId: (req.instance as CMInstance).friendly,
instanceId: (req.instance as CMInstance).friendly,
isOperator: instance.operators.includes((req.user as Express.User).name),
isOperator: req.user?.isInstanceOperator(instance),
operators: instance.operators.join(', '),
operatorDisplay: instance.operatorDisplay,
logSettings: {
@@ -859,7 +843,7 @@ const webClient = async (options: OperatorConfig) => {
res.render('config', {
title: `Configuration Editor`,
format,
canSave: req.user?.scope?.includes('wikiedit') && req.user?.tokenExpiresAt !== undefined && dayjs.unix(req.user?.tokenExpiresAt).isAfter(dayjs())
canSave: req.user?.clientData?.scope?.includes('wikiedit') && req.user?.clientData?.tokenExpiresAt !== undefined && dayjs.unix(req.user?.clientData.tokenExpiresAt).isAfter(dayjs())
});
});
@@ -871,7 +855,7 @@ const webClient = async (options: OperatorConfig) => {
userAgent,
clientId,
clientSecret,
accessToken: req.user?.token
accessToken: req.user?.clientData?.token
});
try {
@@ -1024,7 +1008,7 @@ const webClient = async (options: OperatorConfig) => {
// setup general web log event
const webLogListener = (log: string) => {
const subName = parseSubredditLogName(log);
if((subName === undefined || user.isOperator) && isLogLineMinLevel(log, session.level as string)) {
if((subName === undefined || user.clientData?.webOperator === true) && isLogLineMinLevel(log, session.level as string)) {
io.to(session.id).emit('webLog', formatLogLineToHtml(log));
}
}
@@ -1120,7 +1104,7 @@ const webClient = async (options: OperatorConfig) => {
if(lastCheck > 15) {
shouldCheck = true;
}
} else if(lastCheck > 300) {
} else if(lastCheck > 60) {
shouldCheck = true;
}
}
@@ -1155,7 +1139,9 @@ const webClient = async (options: OperatorConfig) => {
}
}).json() as CMInstance;
botStat = {...botStat, ...resp, online: true};
const {bots, ...restResp} = resp;
botStat = {...botStat, ...restResp, bots: bots.map(x => ({...x, instance: botStat})), online: true};
const sameNameIndex = cmInstances.findIndex(x => x.friendly === botStat.friendly);
if(sameNameIndex > -1 && sameNameIndex !== existingClientIndex) {
logger.warn(`Client returned a friendly name that is not unique (${botStat.friendly}), will fallback to host as friendly (${botStat.normalUrl})`);

View File

@@ -0,0 +1,23 @@
import {IUser} from "../interfaces";
export interface ClientUserData {
token?: string
tokenExpiresAt?: number
scope?: string[]
webOperator?: boolean
}
abstract class CMUser<Instance, Bot, SubredditEntity> implements IUser {
constructor(public name: string, public subreddits: string[], public clientData: ClientUserData = {}) {
}
public abstract isInstanceOperator(val: Instance): boolean;
public abstract canAccessInstance(val: Instance): boolean;
public abstract canAccessBot(val: Bot): boolean;
public abstract accessibleBots(bots: Bot[]): Bot[]
public abstract canAccessSubreddit(val: Bot, name: string): boolean;
public abstract accessibleSubreddits(bot: Bot): SubredditEntity[]
}
export default CMUser;

View File

@@ -0,0 +1,41 @@
import {BotInstance, CMInstance} from "../../interfaces";
import CMUser from "./CMUser";
import {intersect, parseRedditEntity} from "../../../util";
class ClientUser extends CMUser<CMInstance, BotInstance, string> {
isInstanceOperator(val: CMInstance): boolean {
return val.operators.map(x=> x.toLowerCase()).includes(this.name.toLowerCase());
}
canAccessInstance(val: CMInstance): boolean {
return this.isInstanceOperator(val) || intersect(this.subreddits, val.subreddits.map(x => parseRedditEntity(x).name)).length > 0;
}
canAccessBot(val: BotInstance): boolean {
return this.isInstanceOperator(val.instance) || intersect(this.subreddits, val.subreddits.map(x => parseRedditEntity(x).name)).length > 0;
}
canAccessSubreddit(val: BotInstance, name: string): boolean {
return this.isInstanceOperator(val.instance) || this.subreddits.map(x => x.toLowerCase()).includes(parseRedditEntity(name).name.toLowerCase());
}
accessibleBots(bots: BotInstance[]): BotInstance[] {
if (bots.length === 0) {
return bots;
}
return bots.filter(x => {
if (this.isInstanceOperator(x.instance)) {
return true;
}
return intersect(this.subreddits, x.subreddits.map(y => parseRedditEntity(y).name)).length > 0
});
}
accessibleSubreddits(bot: BotInstance): string[] {
return this.isInstanceOperator(bot.instance) ? bot.subreddits.map(x => parseRedditEntity(x).name) : intersect(this.subreddits, bot.subreddits.map(x => parseRedditEntity(x).name));
}
}
export default ClientUser;

View File

@@ -0,0 +1,39 @@
import {BotInstance, CMInstance} from "../../interfaces";
import CMUser from "./CMUser";
import {intersect, parseRedditEntity} from "../../../util";
import {App} from "../../../App";
import Bot from "../../../Bot";
import {Manager} from "../../../Subreddit/Manager";
class ServerUser extends CMUser<App, Bot, Manager> {
constructor(public name: string, public subreddits: string[], public machine: boolean, public isOperator: boolean) {
super(name, subreddits);
}
isInstanceOperator(): boolean {
return this.isOperator;
}
canAccessInstance(val: App): boolean {
return this.isOperator || val.bots.filter(x => intersect(this.subreddits, x.subManagers.map(y => y.subreddit.display_name))).length > 0;
}
canAccessBot(val: Bot): boolean {
return this.isOperator || intersect(this.subreddits, val.subManagers.map(y => y.subreddit.display_name)).length > 0;
}
accessibleBots(bots: Bot[]): Bot[] {
return this.isOperator ? bots : bots.filter(x => intersect(this.subreddits, x.subManagers.map(y => y.subreddit.display_name)).length > 0);
}
canAccessSubreddit(val: Bot, name: string): boolean {
return this.isOperator || this.subreddits.includes(parseRedditEntity(name).name) && val.subManagers.some(y => y.subreddit.display_name.toLowerCase() === parseRedditEntity(name).name.toLowerCase());
}
accessibleSubreddits(bot: Bot): Manager[] {
return this.isOperator ? bot.subManagers : bot.subManagers.filter(x => intersect(this.subreddits, [x.subreddit.display_name]).length > 0);
}
}
export default ServerUser;

View File

@@ -59,3 +59,17 @@ export interface BotStatusResponse {
}
subreddits: SubredditDataResponse[]
}
export interface IUser {
name: string
subreddits: string[]
machine?: boolean
isOperator?: boolean
realManagers?: string[]
moderatedManagers?: string[]
realBots?: string[]
moderatedBots?: string[]
scope?: string[]
token?: string
tokenExpiresAt?: number
}

View File

@@ -1,27 +0,0 @@
import { Request } from "express";
import {App} from "../../App";
import Bot from "../../Bot";
// export interface ServerRequest extends Request {
// botApp: App
// bot?: Bot
// //user?: AuthenticatedUser
// }
//
// export interface ServerRequestRedditor extends ServerRequest {
// user?: AuthenticatedRedditUser
// }
//
// export interface AuthenticatedUser extends Express.User {
// machine: boolean
// }
//
// export interface AuthenticatedRedditUser extends AuthenticatedUser {
// name: string
// subreddits: string[]
// isOperator: boolean
// realManagers: string[]
// moderatedManagers: string[]
// realBots: string[]
// moderatedBots: string[]
// }

View File

@@ -1,9 +1,10 @@
import {Request, Response} from "express";
import {Request, Response, NextFunction} from "express";
import Bot from "../../Bot";
import ServerUser from "../Common/User/ServerUser";
export const authUserCheck = (userRequired: boolean = true) => async (req: Request, res: Response, next: Function) => {
if (req.isAuthenticated()) {
if (userRequired && req.user.machine) {
if (userRequired && (req.user as ServerUser).machine) {
return res.status(403).send('Must be authenticated as a user to access this route');
}
return next();
@@ -23,10 +24,15 @@ export const botRoute = (required = true) => async (req: Request, res: Response,
const botStr = botVal as string;
if(req.user !== undefined) {
if (req.user.realBots === undefined || !req.user.realBots.map(x => x.toLowerCase()).includes(botStr.toLowerCase())) {
const serverBot = req.botApp.bots.find(x => x.botName === botStr) as Bot;
if(serverBot === undefined) {
return res.status(404).send(`Bot named ${botStr} does not exist or you do not have permission to access it.`);
}
req.serverBot = req.botApp.bots.find(x => x.botName === botStr) as Bot;
if (!req.user?.canAccessBot(serverBot)) {
return res.status(404).send(`Bot named ${botStr} does not exist or you do not have permission to access it.`);
}
req.serverBot = serverBot;
return next();
}
return next();
@@ -37,18 +43,20 @@ export const subredditRoute = (required = true) => async (req: Request, res: Res
const bot = req.serverBot;
const {subreddit} = req.query as any;
if(subreddit === undefined && required === false) {
if(subreddit === undefined && !required) {
next();
} else {
const {name: userName, realManagers = [], isOperator} = req.user as Express.User;
if (!isOperator && !realManagers.includes(subreddit)) {
return res.status(400).send('Cannot access route for subreddit you do not manage or is not run by the bot')
}
//const {name: userName} = req.user as Express.User;
const manager = bot.subManagers.find(x => x.displayLabel === subreddit);
if (manager === undefined) {
return res.status(400).send('Cannot access route for subreddit you do not manage or is not run by the bot')
}
if (!req.user?.canAccessSubreddit(bot, subreddit)) {
return res.status(400).send('Cannot access route for subreddit you do not manage or is not run by the bot')
}
req.manager = manager;
next();

View File

@@ -1,29 +1,23 @@
import express, {Request, Response} from 'express';
import {Request, Response} from 'express';
import {RUNNING, USER} from "../../../../../Common/interfaces";
import Submission from "snoowrap/dist/objects/Submission";
import LoggedError from "../../../../../Utils/LoggedError";
import winston from "winston";
import {authUserCheck, botRoute} from "../../../middleware";
import {booleanMiddle} from "../../../../Common/middleware";
import {Manager} from "../../../../../Subreddit/Manager";
import {parseRedditEntity} from "../../../../../util";
const action = async (req: express.Request, res: express.Response) => {
const action = async (req: Request, res: Response) => {
const bot = req.serverBot;
const {type, action, subreddit, force = false} = req.query as any;
const {name: userName, realManagers = [], isOperator} = req.user as Express.User;
let subreddits: string[] = [];
if (subreddit === 'All') {
subreddits = realManagers;
} else if (realManagers.includes(subreddit)) {
subreddits = [subreddit];
const userName = req.user?.name;
let subreddits: Manager[] = req.user?.accessibleSubreddits(bot) as Manager[];
if (subreddit !== 'All') {
subreddits = subreddits.filter(x => x.subreddit.display_name === parseRedditEntity(subreddit).name);
}
for (const s of subreddits) {
const manager = bot.subManagers.find(x => x.displayLabel === s);
if (manager === undefined) {
winston.loggers.get('app').warn(`Manager for ${s} does not exist`, {subreddit: `/u/${userName}`});
continue;
}
for (const manager of subreddits) {
const mLogger = manager.logger;
mLogger.info(`/u/${userName} invoked '${action}' action for ${type} on ${manager.displayLabel}`);
try {

View File

@@ -12,7 +12,7 @@ const addBot = () => {
const response = async (req: Request, res: Response) => {
if (!(req.user as Express.User).isOperator) {
if (!req.user?.isInstanceOperator(req.app)) {
return res.status(401).send("Must be an Operator to use this route");
}

View File

@@ -66,7 +66,7 @@ const actionedEvents = async (req: Request, res: Response) => {
managers.push(manager);
} else {
for(const manager of req.serverBot.subManagers) {
if((req.user?.realManagers as string[]).includes(manager.displayLabel)) {
if(req.user?.canAccessSubreddit(req.serverBot, manager.subreddit.display_name)) {
managers.push(manager);
}
}
@@ -89,7 +89,7 @@ const action = async (req: Request, res: Response) => {
const bot = req.serverBot;
const {url, dryRun = false, subreddit} = req.query as any;
const {name: userName, realManagers = [], isOperator} = req.user as Express.User;
const {name: userName} = req.user as Express.User;
let a;
const commentId = commentReg(url);
@@ -115,7 +115,7 @@ const action = async (req: Request, res: Response) => {
let manager = subreddit === 'All' ? bot.subManagers.find(x => x.subreddit.display_name === sub) : bot.subManagers.find(x => x.displayLabel === subreddit);
if (manager === undefined || (!realManagers.includes(manager.displayLabel))) {
if (manager === undefined || !req.user?.canAccessSubreddit(req.serverBot, manager.subreddit.display_name)) {
let msg = 'Activity does not belong to a subreddit you moderate or the bot runs on.';
if (subreddit === 'All') {
msg = `${msg} If you want to test an Activity against a Subreddit\'s config it does not belong to then switch to that Subreddit's tab first.`

View File

@@ -24,7 +24,9 @@ const logs = (subLogMap: Map<string, LogEntry[]>) => {
const logger = winston.loggers.get('app');
const {name: userName, realManagers = [], isOperator} = req.user as Express.User;
const userName = req.user?.name as string;
const isOperator = req.user?.isInstanceOperator(req.botApp);
const realManagers = req.botApp.bots.map(x => req.user?.accessibleSubreddits(x).map(x => x.displayLabel)).flat() as string[];
const {level = 'verbose', stream, limit = 200, sort = 'descending', streamObjects = false} = req.query;
if (stream) {
const origin = req.header('X-Forwarded-For') ?? req.header('host');

View File

@@ -41,17 +41,14 @@ const status = () => {
if(req.serverBot !== undefined) {
bots = [req.serverBot];
} else {
bots = (req.user as Express.User).isOperator ? req.botApp.bots : req.botApp.bots.filter(x => {
const i = intersect(req.user?.subreddits as string[], x.subManagers.map(y => y.subreddit.display_name));
return i.length > 0;
});
bots = req.user?.accessibleBots(req.botApp.bots) as Bot[];
}
const botResponses: BotStatusResponse[] = [];
for(const b of bots) {
botResponses.push(await botStatResponse(b, req, botLogMap));
}
const system: any = {};
if((req.user as Express.User).isOperator) {
if(req.user?.isInstanceOperator(req.botApp)) {
// @ts-ignore
system.logs = filterLogBySubreddit(new Map([['app', systemLogs]]), [], {level, sort, limit, operator: true}).get('app');
}
@@ -72,14 +69,11 @@ const status = () => {
lastCheck
} = req.query;
const {name: userName, realManagers = [], isOperator} = req.user as Express.User;
const user = userName as string;
const subreddits = realManagers;
//const isOperator = opNames.includes(user.toLowerCase())
const user = req.user?.name as string;
const logs = filterLogBySubreddit(botLogMap.get(bot.botName as string) || new Map(), realManagers, {
const logs = filterLogBySubreddit(botLogMap.get(bot.botName as string) || new Map(), req.user?.accessibleSubreddits(bot).map(x => x.displayLabel) as string[], {
level: (level as string),
operator: isOperator,
operator: req.user?.isInstanceOperator(req.botApp),
user,
// @ts-ignore
sort,
@@ -87,18 +81,11 @@ const status = () => {
});
const subManagerData = [];
for (const s of subreddits) {
const m = bot.subManagers.find(x => x.displayLabel === s) as Manager;
if(m === undefined) {
continue;
}
if(!(req.user as Express.User).isOperator && !(req.user?.subreddits as string[]).includes(m.subreddit.display_name)) {
continue;
}
for (const m of req.user?.accessibleSubreddits(bot) as Manager[]) {
const sd = {
name: s,
name: m.displayLabel,
//linkName: s.replace(/\W/g, ''),
logs: logs.get(s) || [], // provide a default empty value in case we truly have not logged anything for this subreddit yet
logs: logs.get(m.displayLabel) || [], // provide a default empty value in case we truly have not logged anything for this subreddit yet
botState: m.botState,
eventsState: m.eventsState,
queueState: m.queueState,

View File

@@ -1,5 +1,5 @@
import {addAsync, Router} from '@awaitjs/express';
import express, {Request, Response} from 'express';
import express, {Request, Response, NextFunction, RequestHandler} from 'express';
import bodyParser from 'body-parser';
import {App} from "../../App";
import {Transform} from "stream";
@@ -29,6 +29,7 @@ import {opStats} from "../Common/util";
import Bot from "../../Bot";
import addBot from "./routes/authenticated/user/addBot";
import dayjs from "dayjs";
import ServerUser from "../Common/User/ServerUser";
const server = addAsync(express());
server.use(bodyParser.json());
@@ -87,7 +88,7 @@ const rcbServer = async function (options: OperatorConfig) {
botLog.set('app', appLogs.slice(0, 200 + 1));
} else {
let botSubs = botSubreddits.get(botName) || [];
if(botSubs.length === 0 && app !== undefined) {
if(app !== undefined && (botSubs.length === 0 || !botSubs.includes(subName))) {
const b = app.bots.find(x => x.botName === botName);
if(b !== undefined) {
botSubs = b.subManagers.map(x => x.displayLabel);
@@ -128,31 +129,35 @@ const rcbServer = async function (options: OperatorConfig) {
}, function (jwtPayload, done) {
const {name, subreddits = [], machine = true} = jwtPayload.data;
if (machine) {
return done(null, {machine});
const user = new ServerUser(name, subreddits, true, false);
return done(null, user);
//return done(null, {machine});
}
const isOperator = opNames.includes(name.toLowerCase());
let moderatedBots: string[] = [];
let moderatedManagers: string[] = [];
let realBots: string[] = [];
let realManagers: string[] = [];
if(app !== undefined) {
const modBots = app.bots.filter(x => intersect(subreddits, x.subManagers.map(y => y.subreddit.display_name)));
moderatedBots = modBots.map(x => x.botName as string);
moderatedManagers = [...new Set(modBots.map(x => x.subManagers.map(y => y.displayLabel)).flat())];
realBots = isOperator ? app.bots.map(x => x.botName as string) : moderatedBots;
realManagers = isOperator ? [...new Set(app.bots.map(x => x.subManagers.map(y => y.displayLabel)).flat())] : moderatedManagers
}
// let moderatedBots: string[] = [];
// let moderatedManagers: string[] = [];
// let realBots: string[] = [];
// let realManagers: string[] = [];
// if(app !== undefined) {
// const modBots = app.bots.filter(x => intersect(subreddits, x.subManagers.map(y => y.subreddit.display_name)).length > 0);
// moderatedBots = modBots.map(x => x.botName as string);
// moderatedManagers = [...new Set(modBots.map(x => x.subManagers).flat().filter(x => subreddits.includes(x.subreddit.display_name)).map(x => x.displayLabel))];
// realBots = isOperator ? app.bots.map(x => x.botName as string) : moderatedBots;
// realManagers = isOperator ? [...new Set(app.bots.map(x => x.subManagers.map(y => y.displayLabel)).flat())] : moderatedManagers
// }
return done(null, {
name,
subreddits,
isOperator,
machine: false,
moderatedManagers,
realManagers,
moderatedBots,
realBots,
});
const user = new ServerUser(name, subreddits, false, isOperator);
return done(null, user);
// return done(null, {
// name,
// subreddits,
// isOperator,
// machine: false,
// moderatedManagers,
// realManagers,
// moderatedBots,
// realBots,
// });
}));
server.use(passport.authenticate('jwt', {session: false}));
@@ -169,8 +174,8 @@ const rcbServer = async function (options: OperatorConfig) {
let bots: Bot[] = [];
if(req.serverBot !== undefined) {
bots = [req.serverBot];
} else {
bots = (req.user as Express.User).isOperator ? req.botApp.bots : req.botApp.bots.filter(x => intersect(req.user?.subreddits as string[], x.subManagers.map(y => y.subreddit.display_name)));
} else if(req.user !== undefined) {
bots = req.user.accessibleBots(req.botApp.bots);
}
const resp = [];
for(const b of bots) {

View File

@@ -611,12 +611,9 @@
<input data-subreddit="<%= data.name %>" style="min-width: 420px;"
class="border-gray-50 placeholder-gray-500 rounded mt-2 mb-3 p-2 text-black checkUrl"
placeholder="<%= data.name === 'All' ? 'Run Bot on a permalink from any moderated Subreddit' : `Run Bot on a permalink using this Subreddit's config` %>"/>
<span class="mx-2">
<input type="checkbox" class="dryrunCheck" data-subreddit="<%= data.name %>"
name="dryrunCheck">
<label for="dryrunCheck">Dry Run?</label>
</span>
<a class="runCheck" data-subreddit="<%= data.name %>" href="">Run</a>
<a class="hover:bg-gray-700 pointer-events-none opacity-20 no-underline rounded-md mx-4 py-2 px-3 border checkActions dryRunCheck" data-subreddit="<%= data.name %>" href="">Dry Run</a>
<a class="hover:bg-gray-700 pointer-events-none opacity-20 no-underline rounded-md py-2 px-3 border checkActions runCheck" data-subreddit="<%= data.name %>" href="">Run</a>
</div>
<%- include('partials/logSettings') %>
</div>
@@ -658,23 +655,42 @@
});
})
document.querySelectorAll(".runCheck").forEach(el => {
document.querySelectorAll(".checkUrl").forEach(el => {
const toggleButtons = (e) => {
const subFilter = `.sub[data-subreddit="${e.target.dataset.subreddit}"]`;
const inputVal = document.querySelector(`${subFilter} .checkUrl`).value;
if (inputVal.length > 0) {
document.querySelectorAll(`${subFilter} .checkActions`).forEach(el => {
el.classList.remove('pointer-events-none', 'opacity-20');
});
} else {
document.querySelectorAll(`${subFilter} .checkActions`).forEach(el => {
el.classList.add('pointer-events-none', 'opacity-20');
});
}
}
el.addEventListener('keyup', toggleButtons, false);
el.addEventListener('change', toggleButtons, false);
});
document.querySelectorAll(".checkActions").forEach(el => {
el.addEventListener('click', e => {
e.preventDefault();
const subreddit = e.target.dataset.subreddit;
const urlInput = document.querySelector(`[data-subreddit="${subreddit}"].checkUrl`);
const dryRunCheck = document.querySelector(`[data-subreddit="${subreddit}"].dryrunCheck`);
const subFilter = `.sub[data-subreddit="${subreddit}"]`;
const urlInput = document.querySelector(`${subFilter} .checkUrl`);
const isDryun = e.target.classList.contains('dryRunCheck');
const subSection = e.target.closest('div.sub');
bot = subSection.dataset.bot;
const url = urlInput.value;
const dryRun = dryRunCheck.checked ? 1 : 0;
const fetchUrl = `/api/check?instance=<%= instanceId %>&bot=${bot}&url=${url}&dryRun=${dryRun}&subreddit=${subreddit}`;
const fetchUrl = `/api/check?instance=<%= instanceId %>&bot=${bot}&url=${url}&dryRun=${isDryun ? 1 : 0}&subreddit=${subreddit}`;
fetch(fetchUrl);
urlInput.value = '';
dryRunCheck.checked = false;
urlInput.dispatchEvent(new Event('change'));
});
});

View File

@@ -8,6 +8,7 @@ export interface BotInstance {
subreddits: string[]
nanny?: string
running: boolean
instance: CMInstance
}
export interface CMInstance extends BotConnection {

View File

@@ -2,6 +2,7 @@ import {App} from "../../../App";
import Bot from "../../../Bot";
import {BotInstance, CMInstance} from "../../interfaces";
import {Manager} from "../../../Subreddit/Manager";
import CMUser from "../../Common/User/CMUser";
declare global {
declare namespace Express {
@@ -13,18 +14,7 @@ declare global {
serverBot: Bot,
manager?: Manager,
}
interface User {
name: string
subreddits: string[]
machine?: boolean
isOperator?: boolean
realManagers?: string[]
moderatedManagers?: string[]
realBots?: string[]
moderatedBots?: string[]
scope?: string[]
token?: string
tokenExpiresAt?: number
class User extends CMUser<any, any, any> {
}
}
}

View File

@@ -662,6 +662,126 @@ export const parseExternalUrl = (val: string) => {
return (matches.groups as any).url as string;
}
export const dummyLogger = {
debug: (v: any) => null,
error: (v: any) => null,
warn: (v: any) => null,
info: (v: any) => null
}
const GIST_REGEX = new RegExp(/.*gist\.github\.com\/.+\/(.+)/i)
const GH_BLOB_REGEX = new RegExp(/.*github\.com\/(.+)\/(.+)\/blob\/(.+)/i);
const REGEXR_REGEX = new RegExp(/^.*((regexr\.com)\/[\w\d]+).*$/i);
const REGEXR_PAGE_REGEX = new RegExp(/(.|[\n\r])+"expression":"(.+)","text"/g);
export const fetchExternalUrl = async (url: string, logger: (any) = dummyLogger): Promise<string> => {
let hadError = false;
logger.debug(`Attempting to detect resolvable URL for ${url}`);
let match = url.match(GIST_REGEX);
if (match !== null) {
const gistApiUrl = `https://api.github.com/gists/${match[1]}`;
logger.debug(`Looks like a non-raw gist URL! Trying to resolve ${gistApiUrl}`);
try {
const response = await fetch(gistApiUrl);
if (!response.ok) {
logger.error(`Response was not OK from Gist API (${response.statusText}) -- will return response from original URL instead`);
if (response.size > 0) {
logger.error(await response.text())
}
hadError = true;
} else {
const data = await response.json();
// get first found file
const fileKeys = Object.keys(data.files);
if (fileKeys.length === 0) {
logger.error(`No files found in gist!`);
} else {
if (fileKeys.length > 1) {
logger.warn(`More than one file found in gist! Using first found: ${fileKeys[0]}`);
} else {
logger.debug(`Using file ${fileKeys[0]}`);
}
const file = data.files[fileKeys[0]];
if (file.truncated === false) {
return file.content;
}
const rawUrl = file.raw_url;
logger.debug(`File contents was truncated, retrieving full contents from ${rawUrl}`);
try {
const rawUrlResponse = await fetch(rawUrl);
return await rawUrlResponse.text();
} catch (err: any) {
logger.error('Gist Raw URL Response returned an error, will return response from original URL instead');
logger.error(err);
}
}
}
} catch (err: any) {
logger.error('Response returned an error, will return response from original URL instead');
logger.error(err);
}
}
match = url.match(GH_BLOB_REGEX);
if (match !== null) {
const rawUrl = `https://raw.githubusercontent.com/${match[1]}/${match[2]}/${match[3]}`
logger.debug(`Looks like a single file github URL! Resolving to ${rawUrl}`);
try {
const response = await fetch(rawUrl);
if (!response.ok) {
logger.error(`Response was not OK (${response.statusText}) -- will return response from original URL instead`);
if (response.size > 0) {
logger.error(await response.text())
}
hadError = true;
} else {
return await response.text();
}
} catch (err: any) {
logger.error('Response returned an error, will return response from original URL instead');
logger.error(err);
}
}
match = url.match(REGEXR_REGEX);
if(match !== null) {
logger.debug(`Looks like a Regexr URL! Trying to get expression from page HTML`);
try {
const response = await fetch(url);
if (!response.ok) {
if (response.size > 0) {
logger.error(await response.text())
}
throw new Error(`Response was not OK: ${response.statusText}`);
} else {
const page = await response.text();
const pageMatch = [...page.matchAll(REGEXR_PAGE_REGEX)];
if(pageMatch.length > 0) {
const unescaped = JSON.parse(`{"value": "${pageMatch[0][2]}"}`)
return unescaped.value;
} else {
throw new Error('Could not parse regex expression from page HTML');
}
}
} catch (err: any) {
logger.error('Response returned an error');
throw err;
}
}
if(!hadError) {
logger.debug('URL was not special (gist, github blob, etc...) so will retrieve plain contents');
}
const response = await fetch(url);
if(!response.ok) {
if (response.size > 0) {
logger.error(await response.text())
}
throw new Error(`Response was not OK: ${response.statusText}`);
}
return await response.text();
}
export interface RetryOptions {
maxRequestRetry: number,
maxOtherRetry: number,
@@ -996,6 +1116,8 @@ export const toStrongSubredditState = (s: SubredditState, opts?: StrongSubreddit
if (generateDescription && stateDescription === undefined) {
strongState.stateDescription = objectToStringSummary(strongState);
} else {
strongState.stateDescription = stateDescription;
}
return strongState;

View File

@@ -3,7 +3,10 @@
"compilerOptions": {
"sourceMap": true,
"resolveJsonModule": true,
"typeRoots": ["./src/Web/types"]
"typeRoots": [
"./node_modules/@types",
"./src/Web/types"
]
},
// "compilerOptions": {
// "module": "es6",