feat: Add dns lookup caching

Reduces dns traffic by 95%

docs/operator/configuration.md

@@ -36,7 +36,7 @@ configuration.
 * **FILE** -- Values specified in a YAML/JSON configuration file using the structure [in the schema](https://json-schema.app/view/%23?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FOperatorConfig.json)
   * When reading the **schema** if the variable is available at a level of configuration other than **FILE** it will be
     noted with the same symbol as above. The value shown is the default.
-* **ARG** -- Values specified as CLI arguments to the program (see [ClI Usage](#cli-usage) below)
+* **ARG** -- Values specified as CLI arguments to the program (see [CLI Usage](#cli-usage) below)
 
 ## File Configuration (Recommended)
 

docs/subreddit-configuration/actionTemplating.md

@@ -61,13 +61,14 @@ All Actions with `content` have access to this data:
 
 Additionally, `author` has these properties accessible:
 
-|      Name      |             Description             | Example  |
-|----------------|-------------------------------------|----------|
-| `age`          | (Approximate) Age of account        | 3 months |
-| `linkKarma`    | Amount of link karma                | 10       |
-| `commentKarma` | Amount of comment karma             | 3        |
-| `totalKarma`   | Combined link+comment karma         | 13       |
-| `verified`     | Does account have a verified email? | true     |
+| Name           | Description                                                                       | Example    |
+|----------------|-----------------------------------------------------------------------------------|------------|
+| `age`          | (Approximate) Age of account                                                      | 3 months   |
+| `linkKarma`    | Amount of link karma                                                              | 10         |
+| `commentKarma` | Amount of comment karma                                                           | 3          |
+| `totalKarma`   | Combined link+comment karma                                                       | 13         |
+| `verified`     | Does account have a verified email?                                               | true       |
+| `flairText`    | The text of the Flair assigned to the Author in this subreddit, if one is present | Test Flair |
 
 NOTE: Accessing these properties may require an additional API call so use sparingly on high-volume comments
 
@@ -84,13 +85,14 @@ Produces:
 
 If the **Activity** is a Submission these additional properties are accessible:
 
-| Name          | Description                                                     | Example                 |
-|---------------|-----------------------------------------------------------------|-------------------------|
-| `upvoteRatio` | The upvote ratio                                                | 100%                    |
-| `nsfw`        | If the submission is marked as NSFW                             | true                    |
-| `spoiler`     | If the submission is marked as a spoiler                        | true                    |
-| `url`         | If the submission was a link then this is the URL for that link | http://example.com      |
-| `title`       | The title of the submission                                     | Test post please ignore |
+| Name              | Description                                                     | Example                 |
+|-------------------|-----------------------------------------------------------------|-------------------------|
+| `upvoteRatio`     | The upvote ratio                                                | 100%                    |
+| `nsfw`            | If the submission is marked as NSFW                             | true                    |
+| `spoiler`         | If the submission is marked as a spoiler                        | true                    |
+| `url`             | If the submission was a link then this is the URL for that link | http://example.com      |
+| `title`           | The title of the submission                                     | Test post please ignore |
+| `link_flair_text` | The flair text assigned to this submission                      | Test Flair              |
 
 ### Comments
 

package-lock.json

@@ -31,6 +31,7 @@
         "body-parser": "^1.19.0",
         "cache-manager": "^3.4.4",
         "cache-manager-redis-store": "^2.0.0",
+        "cacheable-lookup": "^6.1.0",
         "command-exists": "^1.2.9",
         "commander": "^8.0.0",
         "comment-json": "^4.1.1",
@@ -2395,9 +2396,9 @@
       }
     },
     "node_modules/cacheable-lookup": {
-      "version": "5.0.4",
-      "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-5.0.4.tgz",
-      "integrity": "sha512-2/kNscPhpcxrOigMZzbiWF7dz8ilhb/nIHU3EyZiXWXpeq/au8qJ8VhdftMkty3n7Gj6HIGalQG8oiBNB3AJgA==",
+      "version": "6.1.0",
+      "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-6.1.0.tgz",
+      "integrity": "sha512-KJ/Dmo1lDDhmW2XDPMo+9oiy/CeqosPguPCrgcVzKyZrL6pM1gU2GmPY/xo6OQPTUaA/c0kwHuywB4E6nmT9ww==",
       "engines": {
         "node": ">=10.6.0"
       }
@@ -4421,6 +4422,14 @@
         "url": "https://github.com/sindresorhus/got?sponsor=1"
       }
     },
+    "node_modules/got/node_modules/cacheable-lookup": {
+      "version": "5.0.4",
+      "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-5.0.4.tgz",
+      "integrity": "sha512-2/kNscPhpcxrOigMZzbiWF7dz8ilhb/nIHU3EyZiXWXpeq/au8qJ8VhdftMkty3n7Gj6HIGalQG8oiBNB3AJgA==",
+      "engines": {
+        "node": ">=10.6.0"
+      }
+    },
     "node_modules/graceful-fs": {
       "version": "4.2.10",
       "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz",
@@ -12324,9 +12333,9 @@
       }
     },
     "cacheable-lookup": {
-      "version": "5.0.4",
-      "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-5.0.4.tgz",
-      "integrity": "sha512-2/kNscPhpcxrOigMZzbiWF7dz8ilhb/nIHU3EyZiXWXpeq/au8qJ8VhdftMkty3n7Gj6HIGalQG8oiBNB3AJgA=="
+      "version": "6.1.0",
+      "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-6.1.0.tgz",
+      "integrity": "sha512-KJ/Dmo1lDDhmW2XDPMo+9oiy/CeqosPguPCrgcVzKyZrL6pM1gU2GmPY/xo6OQPTUaA/c0kwHuywB4E6nmT9ww=="
     },
     "cacheable-request": {
       "version": "7.0.2",
@@ -13900,6 +13909,13 @@
         "lowercase-keys": "^2.0.0",
         "p-cancelable": "^2.0.0",
         "responselike": "^2.0.0"
+      },
+      "dependencies": {
+        "cacheable-lookup": {
+          "version": "5.0.4",
+          "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-5.0.4.tgz",
+          "integrity": "sha512-2/kNscPhpcxrOigMZzbiWF7dz8ilhb/nIHU3EyZiXWXpeq/au8qJ8VhdftMkty3n7Gj6HIGalQG8oiBNB3AJgA=="
+        }
       }
     },
     "graceful-fs": {

package.json

@@ -53,6 +53,7 @@
     "body-parser": "^1.19.0",
     "cache-manager": "^3.4.4",
     "cache-manager-redis-store": "^2.0.0",
+    "cacheable-lookup": "^6.1.0",
     "command-exists": "^1.2.9",
     "commander": "^8.0.0",
     "comment-json": "^4.1.1",

src/Action/BanAction.ts

@@ -67,13 +67,15 @@ export class BanAction extends Action {
             // @ts-ignore
             const fetchedSub = await item.subreddit.fetch();
             const fetchedName = await item.author.name;
-            const bannedUser = await fetchedSub.banUser({
+            const banData = {
                 name: fetchedName,
                 banMessage: renderedContent === undefined ? undefined : renderedContent,
                 banReason: renderedReason,
                 banNote: renderedNote,
                 duration: this.duration
-            });
+            };
+            const bannedUser = await fetchedSub.banUser(banData);
+            await this.resources.addUserToSubredditBannedUserCache(banData)
             touchedEntities.push(bannedUser);
         }
         return {

src/Action/ModNoteAction.ts

@@ -57,8 +57,18 @@ export class ModNoteAction extends Action {
             // nothing to do!
             noteCheckResult = 'existingNoteCheck=false so no existing note checks were performed.';
         } else {
+            const contextualCheck = {...this.existingNoteCheck};
+            let contextualNotes: string[] | undefined = undefined;
+            if(this.existingNoteCheck.note !== undefined && this.existingNoteCheck.note !== null) {
+                contextualNotes = [];
+                const notes = Array.isArray(this.existingNoteCheck.note) ? this.existingNoteCheck.note : [this.existingNoteCheck.note];
+                for(const n of notes) {
+                    contextualNotes.push((await this.renderContent(n, item, ruleResults, actionResults) as string))
+                }
+                contextualCheck.note = contextualNotes;
+            }
             const noteCheckCriteriaResult = await this.resources.isAuthor(item, {
-                modActions: [this.existingNoteCheck]
+                modActions: [contextualCheck]
             });
             noteCheckPassed = noteCheckCriteriaResult.passed;
             const {details} = buildFilterCriteriaSummary(noteCheckCriteriaResult);

src/Action/UserNoteAction.ts

@@ -54,8 +54,18 @@ export class UserNoteAction extends Action {
             // nothing to do!
             noteCheckResult = 'existingNoteCheck=false so no existing note checks were performed.';
         } else {
+            const contextualCheck = {...this.existingNoteCheck};
+            let contextualNotes: string[] | undefined = undefined;
+            if(this.existingNoteCheck.note !== undefined && this.existingNoteCheck.note !== null) {
+                contextualNotes = [];
+                const notes = Array.isArray(this.existingNoteCheck.note) ? this.existingNoteCheck.note : [this.existingNoteCheck.note];
+                for(const n of notes) {
+                    contextualNotes.push((await this.renderContent(n, item, ruleResults, actionResults) as string))
+                }
+                contextualCheck.note = contextualNotes;
+            }
             const noteCheckCriteriaResult = await this.resources.isAuthor(item, {
-                userNotes: [this.existingNoteCheck]
+                userNotes: [contextualCheck]
             });
             noteCheckPassed = noteCheckCriteriaResult.passed;
             const {details} = buildFilterCriteriaSummary(noteCheckCriteriaResult);

src/Common/Infrastructure/Atomic.ts

@@ -408,3 +408,9 @@ export interface RuleResultsTemplateData {
 export interface GenericContentTemplateData extends BaseTemplateData, Partial<RuleResultsTemplateData>, Partial<ActionResultsTemplateData> {
     item?: (SubmissionTemplateData | CommentTemplateData)
 }
+
+export type SubredditPlaceholderType = '{{subreddit}}';
+export const subredditPlaceholder: SubredditPlaceholderType = '{{subreddit}}';
+export const asSubredditPlaceholder = (val: any): val is SubredditPlaceholderType => {
+    return typeof val === 'string' && val.toLowerCase() === '{{subreddit}}';
+}

src/Common/Infrastructure/Filters/FilterCriteria.ts

@@ -4,7 +4,7 @@ import {
     DurationComparor,
     ModeratorNameCriteria,
     ModeratorNames, ModActionType,
-    ModUserNoteLabel, RelativeDateTimeMatch
+    ModUserNoteLabel, RelativeDateTimeMatch, SubredditPlaceholderType
 } from "../Atomic";
 import {ActivityType, MaybeActivityType} from "../Reddit";
 import {GenericComparison, parseGenericValueComparison} from "../Comparisons";
@@ -57,7 +57,7 @@ export interface SubredditCriteria {
 }
 
 export interface StrongSubredditCriteria extends SubredditCriteria {
-    name?: RegExp
+    name?: RegExp | SubredditPlaceholderType
 }
 
 export const defaultStrongSubredditCriteriaOptions = {

src/Common/Infrastructure/Reddit.ts

@@ -1,4 +1,5 @@
 import {Comment, RedditUser, Submission, Subreddit} from "snoowrap/dist/objects";
+import { BannedUser } from "snoowrap/dist/objects/Subreddit";
 import { ValueOf } from "ts-essentials";
 import {CMError} from "../../Utils/Errors";
 
@@ -166,3 +167,14 @@ export interface RedditRemovalMessageOptions {
     title?: string
     lock?: boolean
 }
+
+export interface CMBannedUser extends SnoowrapBannedUser {
+    user: RedditUser
+}
+
+export interface SnoowrapBannedUser extends Omit<BannedUser, 'id'> {
+    days_left: number | null
+    rel_id?: string
+
+    id?: string
+}

src/Rule/HistoryRule.ts

@@ -311,21 +311,24 @@ export class HistoryRule extends Rule {
 
         let criteriaMet = false;
         let failCriteriaResult: string = '';
+
+        const criteriaResultsSummary = criteriaResults.map(x => this.generateResultDataFromCriteria(x, true).result).join(this.condition === 'OR' ? ' OR ' : ' AND ');
+
         if (this.condition === 'OR') {
             criteriaMet = criteriaResults.some(x => x.triggered);
             if(!criteriaMet) {
-                failCriteriaResult = `${FAIL} No criteria was met`;
+                failCriteriaResult = `${FAIL} No criteria was met => ${criteriaResultsSummary}`;
             }
         } else {
             criteriaMet = criteriaResults.every(x => x.triggered);
             if(!criteriaMet) {
                 if(criteriaResults.some(x => x.triggered)) {
                     const met = criteriaResults.filter(x => x.triggered);
-                    failCriteriaResult = `${FAIL} ${met.length} out of ${criteriaResults.length} criteria met but Rule required all be met. Set log level to debug to see individual results`;
+                    failCriteriaResult = `${FAIL} ${met.length} out of ${criteriaResults.length} criteria met but Rule required all be met => ${criteriaResultsSummary}`;
                     const results = criteriaResults.map(x => this.generateResultDataFromCriteria(x, true));
                     this.logger.debug(`\r\n ${results.map(x => x.result).join('\r\n')}`);
                 } else {
-                    failCriteriaResult = `${FAIL} No criteria was met`;
+                    failCriteriaResult = `${FAIL} No criteria was met => ${criteriaResultsSummary}`;
                 }
             }
         }
@@ -335,8 +338,8 @@ export class HistoryRule extends Rule {
             const refCriteriaResults = criteriaResults.find(x => x.triggered);
             const resultData = this.generateResultDataFromCriteria(refCriteriaResults);
 
-            this.logger.verbose(`${PASS} ${resultData.result}`);
-            return Promise.resolve([true, this.getResult(true, resultData)]);
+            this.logger.verbose(`${PASS} ${criteriaResultsSummary}`);
+            return Promise.resolve([true, this.getResult(true, {data: resultData.data, result: criteriaResultsSummary})]);
         } else {
             // log failures for easier debugging
             for(const res of criteriaResults) {

src/Rule/MHSRule.ts

@@ -241,6 +241,8 @@ export class MHSRule extends Rule {
             res = await this.callMHS(content);
             if(res.response.toLowerCase() === 'success') {
                 await this.resources.cache.set(key, res, {ttl: this.resources.ttl.wikiTTL});
+            } else if(res.response.toLowerCase().includes('authentication failure')) {
+                throw new CMError(`MHS Request failed with Authentication failure. You most likely need to generate a new API key.`);
             }
             return res;
         }

src/Subreddit/ModNotes/ModNote.ts

@@ -167,7 +167,15 @@ export class ModNote {
             if (referenceItem === undefined) {
                 throw new CMError('Criteria wants to check if mod note references activity but not activity was given.');
             }
-            const isCurrentActivity = this.action.actedOn !== undefined && referenceItem !== undefined && this.action.actedOn.name === referenceItem.name;
+            let isCurrentActivity = false;
+            if(referenceItem !== undefined) {
+                if(this.action.actedOn !== undefined) {
+                    isCurrentActivity = this.action.actedOn.name === referenceItem.name;
+                }
+                if(isCurrentActivity === false && this.note !== undefined && this.note.actedOn !== undefined) {
+                    isCurrentActivity = this.note.actedOn.name === referenceItem.name;
+                }
+            }
             if ((referencesCurrentActivity === true && !isCurrentActivity) || (referencesCurrentActivity === false && isCurrentActivity)) {
                 return false;
             }

src/Subreddit/ModNotes/ModUserNote.ts

@@ -33,9 +33,19 @@ export class ModUserNote {
     }
 
     toRaw(): ModUserNoteRaw {
+        let id = undefined;
+        if(this.actedOn !== undefined) {
+            if(this.actedOn instanceof Submission) {
+                id = `t3_${this.actedOn.id}`;
+            } else if(this.actedOn instanceof Comment) {
+                id = `t1_${this.actedOn.id}`;
+            } else if(this.actedOn instanceof RedditUser) {
+                id = `t2_${this.actedOn.id}`;
+            }
+        }
         return {
             note: this.note,
-            reddit_id: this.actedOn !== undefined ? this.actedOn.id : undefined,
+            reddit_id: id,
             label: this.label
         }
     }

src/Subreddit/SubredditResources.ts

@@ -56,7 +56,7 @@ import {
 } from "../util";
 import {
     ActivityDispatch,
-    CacheConfig,
+    CacheConfig, CacheOptions,
     Footer,
     HistoricalStatsDisplay,
     ResourceStats, StrongTTLConfig,
@@ -104,7 +104,7 @@ import {
     UserNoteCriteria
 } from "../Common/Infrastructure/Filters/FilterCriteria";
 import {
-    ActivitySourceValue,
+    ActivitySourceValue, asSubredditPlaceholder,
     ConfigFragmentParseFunc,
     DurationVal,
     EventRetentionPolicyRange,
@@ -115,7 +115,7 @@ import {
     ModUserNoteLabel,
     RelativeDateTimeMatch,
     statFrequencies,
-    StatisticFrequencyOption,
+    StatisticFrequencyOption, SubredditPlaceholderType,
     WikiContext
 } from "../Common/Infrastructure/Atomic";
 import {
@@ -136,9 +136,9 @@ import {Duration} from "dayjs/plugin/duration";
 import {
     ActivityType,
     AuthorHistorySort,
-    CachedFetchedActivitiesResult,
+    CachedFetchedActivitiesResult, CMBannedUser,
     FetchedActivitiesResult, MaybeActivityType, RedditUserLike,
-    SnoowrapActivity,
+    SnoowrapActivity, SnoowrapBannedUser,
     SubredditLike,
     SubredditRemovalReason
 } from "../Common/Infrastructure/Reddit";
@@ -161,7 +161,8 @@ import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
 import {ActivitySource} from "../Common/ActivitySource";
 import {SubredditResourceOptions} from "../Common/Subreddit/SubredditResourceInterfaces";
 import {SubredditStats} from "./Stats";
-import {CMCache} from "../Common/Cache";
+import {CMCache, createCacheManager} from "../Common/Cache";
+import {BannedUser, BanOptions} from "snoowrap/dist/objects/Subreddit";
 
 export const DEFAULT_FOOTER = '\r\n*****\r\nThis action was performed by [a bot.]({{botLink}}) Mention a moderator or [send a modmail]({{modmailLink}}) if you have any ideas, questions, or concerns about this action.';
 
@@ -187,6 +188,7 @@ export class SubredditResources {
     database: DataSource
     client: ExtendedSnoowrap
     cache: CMCache
+    memoryCache: CMCache
     cacheSettingsHash?: string;
     thirdPartyCredentials: ThirdPartyCredentialsJsonConfig;
     delayedItems: ActivityDispatch[] = [];
@@ -244,6 +246,12 @@ export class SubredditResources {
         }
         this.cache = cache;
         this.cache.setLogger(this.logger);
+        const memoryCacheOpts: CacheOptions = {
+            store: 'memory',
+            max: 10,
+            ttl: 10
+        };
+        this.memoryCache = new CMCache(createCacheManager(memoryCacheOpts), memoryCacheOpts, false, undefined, {}, this.logger);
 
         this.subredditStats = new SubredditStats(database, managerEntity, cache, statFrequency, this.logger);
 
@@ -861,6 +869,47 @@ export class SubredditResources {
         }
     }
 
+    async getSubredditBannedUser(val: string | RedditUser): Promise<CMBannedUser | undefined> {
+        const subName = this.subreddit.display_name;
+        const name = getActivityAuthorName(val);
+        const hash = `sub-${subName}-banned-${name}`;
+
+        if (this.ttl.authorTTL !== false) {
+            const cachedBanData = (await this.cache.get(hash)) as undefined | null | false | SnoowrapBannedUser;
+            if (cachedBanData !== undefined && cachedBanData !== null) {
+                this.logger.debug(`Cache Hit: Subreddit Banned User ${subName} ${name}`);
+                if(cachedBanData === false) {
+                    return undefined;
+                }
+                return {...cachedBanData, user: new RedditUser({name: cachedBanData.name}, this.client, false)};
+            }
+        }
+
+        let bannedUsers = await this.subreddit.getBannedUsers({name});
+        let bannedUser: CMBannedUser | undefined;
+        if(bannedUsers.length > 0) {
+            const banData = bannedUsers[0] as SnoowrapBannedUser;
+            bannedUser = {...banData,  user: new RedditUser({name: banData.name}, this.client, false)};
+        }
+
+        if (this.ttl.authorTTL !== false) {
+            // @ts-ignore
+            await this.cache.set(hash, bannedUsers.length > 0 ? bannedUsers[0] as SnoowrapBannedUser : false, {ttl: this.ttl.subredditTTL});
+        }
+
+        return bannedUser;
+    }
+
+    async addUserToSubredditBannedUserCache(data: BanOptions) {
+        if (this.ttl.authorTTL !== false) {
+            const subName = this.subreddit.display_name;
+            const name = getActivityAuthorName(data.name);
+            const hash = `sub-${subName}-banned-${name}`;
+            const banData: SnoowrapBannedUser = {date: dayjs().unix(), name: data.name, days_left: data.duration ?? null, note: data.banNote ?? ''};
+            await this.cache.set(hash, banData, {ttl: this.ttl.authorTTL})
+        }
+    }
+
     async hasSubreddit(name: string) {
         if (this.ttl.subredditTTL !== false) {
             const hash = `sub-${name}`;
@@ -1080,6 +1129,9 @@ export class SubredditResources {
 
     async getActivities(user: RedditUser, options: ActivityWindowCriteria, listingData: NamedListing, prefetchedActivities: SnoowrapActivity[] = []): Promise<FetchedActivitiesResult> {
 
+        let cacheKey: string | undefined;
+        let fromCache = false;
+
         try {
 
             let pre: SnoowrapActivity[] = [];
@@ -1087,7 +1139,6 @@ export class SubredditResources {
             let apiCount = 1;
             let preMaxTrigger: undefined | string;
             let rawCount: number = 0;
-            let fromCache = false;
 
             const hashObj = cloneDeep(options);
 
@@ -1100,13 +1151,23 @@ export class SubredditResources {
             const userName = getActivityAuthorName(user);
 
             const hash = objectHash.sha1(hashObj);
-            const cacheKey = `${userName}-${listingData.name}-${hash}`;
+            cacheKey = `${userName}-${listingData.name}-${hash}`;
 
             if (this.ttl.authorTTL !== false) {
                 if (this.useSubredditAuthorCache) {
                     hashObj.subreddit = this.subreddit;
                 }
 
+                // check for cached request error!
+                //
+                // we cache reddit API request errors for 403/404 (suspended/shadowban) in memory so that
+                // we don't waste API calls making the same call repetitively since we know what the result will always be
+                const cachedRequestError = await this.memoryCache.get(cacheKey) as undefined | null | Error;
+                if(cachedRequestError !== undefined && cachedRequestError !== null) {
+                    fromCache = true;
+                    this.logger.debug(`In-memory cache found reddit request error for key ${cacheKey}. Must have been <5 sec ago. Throwing to save API calls!`);
+                    throw cachedRequestError;
+                }
                 const cacheVal = await this.cache.get(cacheKey);
 
                 if(cacheVal === undefined || cacheVal === null) {
@@ -1226,7 +1287,7 @@ export class SubredditResources {
                     }
                     preFilteredPrefetchedActivities = await this.filterListingWithHistoryOptions(preFilteredPrefetchedActivities, user, options.filterOn?.pre);
                 }
-                let unFilteredItems: SnoowrapActivity[] | undefined = [...preFilteredPrefetchedActivities];
+                let unFilteredItems: SnoowrapActivity[] | undefined = undefined;
                 pre = pre.concat(preFilteredPrefetchedActivities);
 
                 const { func: listingFunc } = listingData;
@@ -1285,7 +1346,7 @@ export class SubredditResources {
 
                     if(satisfiedPreEndtime !== undefined || satisfiedPreCount !== undefined) {
                         if(unFilteredItems === undefined) {
-                            unFilteredItems = [];
+                            unFilteredItems = [...preFilteredPrefetchedActivities];
                         }
                         // window has pre filtering, need to check if fallback max would be hit
                         if(satisfiedPreEndtime !== undefined) {
@@ -1343,9 +1404,14 @@ export class SubredditResources {
         } catch (err: any) {
             if(isStatusError(err)) {
                 switch(err.statusCode) {
-                    case 404:
-                        throw new SimpleError('Reddit returned a 404 for user history. Likely this user is shadowbanned.', {isSerious: false});
                     case 403:
+                    case 404:
+                        if(!fromCache && cacheKey !== undefined) {
+                            await this.memoryCache.set(cacheKey, err, {ttl: 5});
+                        }
+                        if(err.statusCode === 404) {
+                            throw new SimpleError('Reddit returned a 404 for user history. Likely this user is shadowbanned.', {isSerious: false});
+                        }
                         throw new MaybeSeriousErrorWithCause('Reddit returned a 403 for user history, likely this user is suspended.', {cause: err, isSerious: false});
                     default:
                         throw err;
@@ -1891,8 +1957,14 @@ export class SubredditResources {
                 if (crit[k] !== undefined) {
                     switch (k) {
                         case 'name':
-                            const nameReg = crit[k] as RegExp;
-                            if(!nameReg.test(subreddit.display_name)) {
+                            const nameReg = crit[k] as RegExp | SubredditPlaceholderType;
+                            // placeholder {{subreddit}} tests as true if the given subreddit matches the subreddit this bot is processing the activity from
+                            if (asSubredditPlaceholder(nameReg)) {
+                                if (this.subreddit.display_name !== subreddit.display_name) {
+                                    log.debug(`Failed: Expected => ${k}:${crit[k]} (${this.subreddit.display_name}) | Found => ${k}:${subreddit.display_name}`)
+                                    return false
+                                }
+                            } else if (!nameReg.test(subreddit.display_name)) {
                                 return false;
                             }
                             break;

src/Utils/SnoowrapUtils.ts

@@ -46,83 +46,6 @@ import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
 
 export const BOT_LINK = 'https://www.reddit.com/r/ContextModBot/comments/otz396/introduction_to_contextmodbot';
 
-export interface AuthorTypedActivitiesOptions extends ActivityWindowCriteria {
-    type?: 'comment' | 'submission',
-}
-
-export const isSubreddit = async (subreddit: Subreddit, stateCriteria: SubredditCriteria | StrongSubredditCriteria, logger?: Logger) => {
-    delete stateCriteria.stateDescription;
-
-    if (Object.keys(stateCriteria).length === 0) {
-        return true;
-    }
-
-    const crit = isStrongSubredditState(stateCriteria) ? stateCriteria : toStrongSubredditState(stateCriteria, {defaultFlags: 'i'});
-
-    const log: Logger | undefined = logger !== undefined ? logger.child({leaf: 'Subreddit Check'}, mergeArr) : undefined;
-
-    return await (async () => {
-        for (const k of Object.keys(crit)) {
-            // @ts-ignore
-            if (crit[k] !== undefined) {
-                switch (k) {
-                    case 'name':
-                        const nameReg = crit[k] as RegExp;
-                        if(!nameReg.test(subreddit.display_name)) {
-                            return false;
-                        }
-                        break;
-                    case 'isUserProfile':
-                        const entity = parseRedditEntity(subreddit.display_name);
-                        const entityIsUserProfile = entity.type === 'user';
-                        if(crit[k] !== entityIsUserProfile) {
-
-                            if(log !== undefined) {
-                                log.debug(`Failed: Expected => ${k}:${crit[k]} | Found => ${k}:${entityIsUserProfile}`)
-                            }
-                            return false
-                        }
-                        break;
-                    case 'over18':
-                    case 'over_18':
-                        // handling an edge case where user may have confused Comment/Submission state "over_18" with SubredditState "over18"
-
-                        // @ts-ignore
-                        if (crit[k] !== subreddit.over18) {
-                            if(log !== undefined) {
-                                // @ts-ignore
-                                log.debug(`Failed: Expected => ${k}:${crit[k]} | Found => ${k}:${subreddit.over18}`)
-                            }
-                            return false
-                        }
-                        break;
-                    default:
-                        // @ts-ignore
-                        if (subreddit[k] !== undefined) {
-                            // @ts-ignore
-                            if (crit[k] !== subreddit[k]) {
-                                if(log !== undefined) {
-                                    // @ts-ignore
-                                    log.debug(`Failed: Expected => ${k}:${crit[k]} | Found => ${k}:${subreddit[k]}`)
-                                }
-                                return false
-                            }
-                        } else {
-                            if(log !== undefined) {
-                                log.warn(`Tried to test for Subreddit property '${k}' but it did not exist`);
-                            }
-                        }
-                        break;
-                }
-            }
-        }
-        if(log !== undefined) {
-            log.debug(`Passed: ${JSON.stringify(stateCriteria)}`);
-        }
-        return true;
-    })() as boolean;
-}
-
 const renderContentCommentTruncate = truncateStringToLength(50);
 const shortTitleTruncate = truncateStringToLength(15);
 
@@ -177,6 +100,7 @@ export const renderContent = async (template: string, data: TemplateContext = {}
             conditional.spoiler = activity.spoiler;
             conditional.op = true;
             conditional.upvoteRatio = `${activity.upvote_ratio * 100}%`;
+            conditional.link_flair_text = activity.link_flair_text;
         } else {
             conditional.op = activity.is_submitter;
         }
@@ -199,6 +123,7 @@ export const renderContent = async (template: string, data: TemplateContext = {}
             author.commentKarma = auth.comment_karma;
             author.totalKarma = auth.comment_karma + auth.link_karma;
             author.verified = auth.has_verified_email;
+            author.flairText = activity.author_flair_text;
         }
 
         const templateData: any = {

src/index.ts

@@ -1,6 +1,9 @@
 import winston from 'winston';
 import 'winston-daily-rotate-file';
 import dayjs from 'dayjs';
+import http from 'http';
+import https from 'https';
+import CacheableLookup from 'cacheable-lookup';
 import utc from 'dayjs/plugin/utc.js';
 import advancedFormat from 'dayjs/plugin/advancedFormat';
 import tz from 'dayjs/plugin/timezone';
@@ -9,7 +12,6 @@ import relTime from 'dayjs/plugin/relativeTime.js';
 import sameafter from 'dayjs/plugin/isSameOrAfter.js';
 import samebefore from 'dayjs/plugin/isSameOrBefore.js';
 import weekOfYear from 'dayjs/plugin/weekOfYear.js';
-import {Manager} from "./Subreddit/Manager";
 import {Command, Argument} from 'commander';
 
 import {
@@ -40,6 +42,17 @@ dayjs.extend(tz);
 dayjs.extend(advancedFormat);
 dayjs.extend(weekOfYear);
 
+const cacheable = new CacheableLookup({
+    // cache dns entries for 60 seconds
+    maxTtl: 60,
+    // fallback to node lookup for 10 minutes in the event of a failure for 10 minutes
+    fallbackDuration: 600
+});
+
+// replace node native request agents, globally, so they used cached dns lookup
+cacheable.install(http.globalAgent);
+cacheable.install(https.globalAgent);
+
 const commentReg = parseLinkIdentifier([COMMENT_URL_ID]);
 const submissionReg = parseLinkIdentifier([SUBMISSION_URL_ID]);
 

src/util.ts

@@ -46,7 +46,14 @@ import {ErrorWithCause, stackWithCauses} from "pony-cause";
 import stringSimilarity from 'string-similarity';
 import calculateCosineSimilarity from "./Utils/StringMatching/CosineSimilarity";
 import levenSimilarity from "./Utils/StringMatching/levenSimilarity";
-import {isRateLimitError, isRequestError, isScopeError, isStatusError, SimpleError} from "./Utils/Errors";
+import {
+    isRateLimitError,
+    isRequestError,
+    isScopeError,
+    isSeriousError,
+    isStatusError,
+    SimpleError
+} from "./Utils/Errors";
 import merge from "deepmerge";
 import {RulePremise} from "./Common/Entities/RulePremise";
 import {RuleResultEntity as RuleResultEntity} from "./Common/Entities/RuleResultEntity";
@@ -70,7 +77,7 @@ import {
 import {
     ActivitySourceData,
     ActivitySourceTypes,
-    ActivitySourceValue,
+    ActivitySourceValue, asSubredditPlaceholder,
     ConfigFormat,
     DurationVal,
     ExternalUrlContext,
@@ -83,7 +90,7 @@ import {
     RelativeDateTimeMatch,
     statFrequencies,
     StatisticFrequency,
-    StatisticFrequencyOption,
+    StatisticFrequencyOption, subredditPlaceholder, SubredditPlaceholderType,
     UrlContext,
     WikiContext
 } from "./Common/Infrastructure/Atomic";
@@ -1096,16 +1103,22 @@ export const createRetryHandler = (opts: RetryOptions, logger: Logger) => {
             // if it's a request error but not a known "oh probably just a reddit blip" status code treat it as other, which should usually have a lower retry max
         }
 
-        // linear backoff
-        otherRetryCount++;
+        let prefix = '';
+        if(isSeriousError(err)) {
+            // linear backoff
+            otherRetryCount++;
+        } else {
+            prefix = 'NON-SERIOUS ';
+        }
+
         let msg = redditApiError ? `Error occurred while making a request to Reddit (${otherRetryCount}/${maxOtherRetry} in ${clearRetryCountAfter} minutes) but it was NOT a well-known "reddit blip" error.` : `Non-request error occurred (${otherRetryCount}/${maxOtherRetry} in ${clearRetryCountAfter} minutes).`;
         if (maxOtherRetry < otherRetryCount) {
-            logger.warn(`${msg} Exceeded max allowed.`);
+            logger.warn(`${prefix}${msg} Exceeded max allowed.`);
             return false;
         }
         if(waitOnRetry) {
             const ms = (4 * 1000) * otherRetryCount;
-            logger.warn(`${msg} Will wait ${formatNumber(ms / 1000)} seconds before retrying`);
+            logger.warn(`${prefix}${msg} Will wait ${formatNumber(ms / 1000)} seconds before retrying`);
             await sleep(ms);
         }
         return true;
@@ -1557,7 +1570,7 @@ export const testMaybeStringRegex = (test: string, subject: string, defaultFlags
 }
 
 export const isStrongSubredditState = (value: SubredditCriteria | StrongSubredditCriteria) => {
-    return value.name === undefined || value.name instanceof RegExp;
+    return value.name === undefined || value.name instanceof RegExp || asSubredditPlaceholder(value.name);
 }
 
 export const asStrongSubredditState = (value: any): value is StrongSubredditCriteria => {
@@ -1575,21 +1588,26 @@ export const toStrongSubredditState = (s: SubredditCriteria, opts?: StrongSubred
 
     let nameValOriginallyRegex = false;
 
-    let nameReg: RegExp | undefined;
+    let nameReg: RegExp | undefined | SubredditPlaceholderType;
     if (nameValRaw !== undefined) {
         if (!(nameValRaw instanceof RegExp)) {
             let nameVal = nameValRaw.trim();
-            nameReg = parseStringToRegex(nameVal, defaultFlags);
-            if (nameReg === undefined) {
-                // if sub state has `isUserProfile=true` and config did not provide a regex then
-                // assume the user wants to use the value in "name" to look for a user profile so we prefix created regex with u_
-                const parsedEntity = parseRedditEntity(nameVal, isUserProfile !== undefined && isUserProfile ? 'user' : 'subreddit');
-                // technically they could provide "u_Username" as the value for "name" and we will then match on it regardless of isUserProfile
-                // but like...why would they do that? There shouldn't be any subreddits that start with u_ that aren't user profiles anyway(?)
-                const regPrefix = parsedEntity.type === 'user' ? 'u_' : '';
-                nameReg = parseStringToRegex(`/^${regPrefix}${nameVal}$/`, defaultFlags);
+            if(asSubredditPlaceholder(nameVal)) {
+                nameReg = subredditPlaceholder;
+                nameValOriginallyRegex = false;
             } else {
-                nameValOriginallyRegex = true;
+                nameReg = parseStringToRegex(nameVal, defaultFlags);
+                if (nameReg === undefined) {
+                    // if sub state has `isUserProfile=true` and config did not provide a regex then
+                    // assume the user wants to use the value in "name" to look for a user profile so we prefix created regex with u_
+                    const parsedEntity = parseRedditEntity(nameVal, isUserProfile !== undefined && isUserProfile ? 'user' : 'subreddit');
+                    // technically they could provide "u_Username" as the value for "name" and we will then match on it regardless of isUserProfile
+                    // but like...why would they do that? There shouldn't be any subreddits that start with u_ that aren't user profiles anyway(?)
+                    const regPrefix = parsedEntity.type === 'user' ? 'u_' : '';
+                    nameReg = parseStringToRegex(`/^${regPrefix}${nameVal}$/`, defaultFlags);
+                } else {
+                    nameValOriginallyRegex = true;
+                }
             }
         } else {
             nameValOriginallyRegex = true;