Switch from ajv to io-ts for config validation; validate configs on save in the API/dashboard; start work on creating io-ts schemas for all plugins

src/plugins/AutoReactionsPlugin.ts

@@ -5,20 +5,23 @@ import { GuildAutoReactions } from "../data/GuildAutoReactions";
 import { Message } from "eris";
 import { customEmojiRegex, errorMessage, isEmoji, successMessage } from "../utils";
 import { ZeppelinPlugin } from "./ZeppelinPlugin";
+import * as t from "io-ts";
 
-interface IAutoReactionsPluginConfig {
-  can_manage: boolean;
-}
+const configSchema = t.type({
+  can_manage: t.boolean,
+});
+type TConfigSchema = t.TypeOf<typeof configSchema>;
 
-export class AutoReactionsPlugin extends ZeppelinPlugin<IAutoReactionsPluginConfig> {
+export class AutoReactionsPlugin extends ZeppelinPlugin<TConfigSchema> {
   public static pluginName = "auto_reactions";
+  protected static configSchema = configSchema;
 
   protected savedMessages: GuildSavedMessages;
   protected autoReactions: GuildAutoReactions;
 
   private onMessageCreateFn;
 
-  getDefaultOptions(): IPluginOptions<IAutoReactionsPluginConfig> {
+  getDefaultOptions(): IPluginOptions<TConfigSchema> {
     return {
       config: {
         can_manage: false,

src/plugins/GlobalZeppelinPlugin.ts

@@ -0,0 +1,39 @@
+import { GlobalPlugin, IBasePluginConfig, IPluginOptions, logger } from "knub";
+import { PluginRuntimeError } from "../PluginRuntimeError";
+import * as t from "io-ts";
+import { pipe } from "fp-ts/lib/pipeable";
+import { fold } from "fp-ts/lib/Either";
+import { PathReporter } from "io-ts/lib/PathReporter";
+import { isSnowflake, isUnicodeEmoji, resolveMember, resolveUser, UnknownUser } from "../utils";
+import { Member, User } from "eris";
+import { performance } from "perf_hooks";
+import { validateStrict } from "../validatorUtils";
+
+const SLOW_RESOLVE_THRESHOLD = 1500;
+
+export class GlobalZeppelinPlugin<TConfig extends {} = IBasePluginConfig> extends GlobalPlugin<TConfig> {
+  protected static configSchema: t.TypeC<any>;
+  public static dependencies = [];
+
+  public static validateOptions(options: IPluginOptions): string[] | null {
+    // Validate config values
+    if (this.configSchema) {
+      if (options.config) {
+        const errors = validateStrict(this.configSchema, options.config);
+        if (errors) return errors;
+      }
+
+      if (options.overrides) {
+        for (const override of options.overrides) {
+          if (override.config) {
+            const errors = validateStrict(this.configSchema, override.config);
+            if (errors) return errors;
+          }
+        }
+      }
+    }
+
+    // No errors, return null
+    return null;
+  }
+}

src/plugins/MessageSaver.ts

@@ -2,12 +2,13 @@ import { Plugin, decorators as d, IPluginOptions } from "knub";
 import { GuildChannel, Message, TextChannel } from "eris";
 import { GuildSavedMessages } from "../data/GuildSavedMessages";
 import { successMessage } from "../utils";
+import { ZeppelinPlugin } from "./ZeppelinPlugin";
 
 interface IMessageSaverPluginConfig {
   can_manage: boolean;
 }
 
-export class MessageSaverPlugin extends Plugin<IMessageSaverPluginConfig> {
+export class MessageSaverPlugin extends ZeppelinPlugin<IMessageSaverPluginConfig> {
   public static pluginName = "message_saver";
 
   protected savedMessages: GuildSavedMessages;

src/plugins/ZeppelinPlugin.ts

@@ -1,15 +1,18 @@
 import { IBasePluginConfig, IPluginOptions, logger, Plugin } from "knub";
 import { PluginRuntimeError } from "../PluginRuntimeError";
-import Ajv, { ErrorObject } from "ajv";
+import * as t from "io-ts";
+import { pipe } from "fp-ts/lib/pipeable";
+import { fold } from "fp-ts/lib/Either";
+import { PathReporter } from "io-ts/lib/PathReporter";
 import { isSnowflake, isUnicodeEmoji, resolveMember, resolveUser, UnknownUser } from "../utils";
 import { Member, User } from "eris";
-
 import { performance } from "perf_hooks";
+import { validateStrict } from "../validatorUtils";
 
 const SLOW_RESOLVE_THRESHOLD = 1500;
 
 export class ZeppelinPlugin<TConfig extends {} = IBasePluginConfig> extends Plugin<TConfig> {
-  protected static configSchema: any;
+  protected static configSchema: t.TypeC<any>;
   public static dependencies = [];
 
   protected throwPluginRuntimeError(message: string) {
@@ -26,22 +29,19 @@ export class ZeppelinPlugin<TConfig extends {} = IBasePluginConfig> extends Plug
     return ourLevel > memberLevel;
   }
 
-  public static validateOptions(options: IPluginOptions): ErrorObject[] | null {
+  public static validateOptions(options: any): string[] | null {
     // Validate config values
     if (this.configSchema) {
-      const ajv = new Ajv();
-      const validate = ajv.compile(this.configSchema);
-
       if (options.config) {
-        const isValid = validate(options.config);
-        if (!isValid) return validate.errors;
+        const errors = validateStrict(this.configSchema, options.config);
+        if (errors) return errors;
       }
 
       if (options.overrides) {
         for (const override of options.overrides) {
           if (override.config) {
-            const isValid = validate(override.config);
-            if (!isValid) return validate.errors;
+            const errors = validateStrict(this.configSchema, override.config);
+            if (errors) return errors;
           }
         }
       }