Improved naming in plugin resolver + misc things

Author: kevinwang5658

.eslintrc.json

@@ -9,9 +9,15 @@
       "warn",
       "always"
     ],
-    "perfectionist/sort-classes": [
-      "off"
-    ],
+    "perfectionist/sort-classes": "off",
+    "perfectionist/sort-interfaces": "off",
+    "perfectionist/sort-enums": "off",
+    "perfectionist/sort-objects": "off",
+    "perfectionist/sort-object-types": "off",
+    "unicorn/no-array-reduce": "off",
+    "unicorn/no-array-for-each": "off",
+    "unicorn/prefer-object-from-entries": "off",
+    "unicorn/prefer-type-error": "off",
     "quotes": [
       "error",
       "single"

package.json

@@ -110,8 +110,8 @@
     },
     "update": {
       "s3": {
-        "host": "https://releases-dev.codifycli.com",
-        "bucket": "cli-releases-dev"
+        "host": "https://releases.codifycli.com",
+        "bucket": "cli-releases"
       }
     },
     "warn-if-update-available": {

src/plugins/plugin-manager.ts

@@ -1,15 +1,14 @@
 import { ResourceOperation, ValidateResponseData } from 'codify-schemas';
 
+import { InternalError } from '../common/errors.js';
 import { Plan, ResourcePlan } from '../entities/plan.js';
+import { PlanRequest } from '../entities/plan-request.js';
 import { Project } from '../entities/project.js';
-import { ResourceConfig } from '../entities/resource-config.js';
 import { SubProcessName, ctx } from '../events/context.js';
 import { prettyFormatResourcePlan } from '../ui/plan-pretty-printer.js';
 import { groupBy } from '../utils/index.js';
 import { Plugin } from './plugin.js';
 import { PluginResolver } from './resolver.js';
-import { InternalError } from '../common/errors.js';
-import { PlanRequest } from '../entities/plan-request.js';
 
 type PluginName = string;
 type ResourceTypeId = string;
@@ -96,10 +95,10 @@ export class PluginManager {
     };
 
     const configPlugins = await Promise.all(Object.entries(pluginDefinitions).map(([name, version]) =>
-      PluginResolver.resolve(name, version)
+      PluginResolver.getOrDownload(name, version)
     ));
 
-    const existingPlugins = await PluginResolver.resolveExisting(Object.keys(pluginDefinitions));
+    const existingPlugins = await PluginResolver.getAllExisting(Object.keys(pluginDefinitions));
 
     return [...existingPlugins, ...configPlugins];
   }

src/plugins/resolver.ts

@@ -12,28 +12,31 @@ const PLUGIN_CACHE_DIR = '/Library/Caches/codify/plugins'
 
 export class PluginResolver {
 
-  static async resolve(name: string, version: string): Promise<Plugin> {
-    await PluginResolver.checkAndCreateCacheDirIfNotExists()
+  static async getOrDownload(name: string, versionOrPath?: string): Promise<Plugin> {
+    await PluginResolver.createPluginDirIfNotExists()
+
+    // Default versions to latest
+    versionOrPath = versionOrPath ?? 'latest';
 
     let directoryStat;
     try {
-      directoryStat = await fs.stat(version);
+      directoryStat = await fs.stat(versionOrPath);
     } catch {
     }
 
     // For easier development. A direct js file can be specified for the plugin.
     if (directoryStat && directoryStat.isFile()) {
-      return PluginResolver.resolvePluginFs(name, version)
+      return PluginResolver.getFromFileSystem(name, versionOrPath)
     }
 
     if (name === 'default') {
-      return PluginResolver.resolvePluginDefault(name, version)
+      return PluginResolver.downloadDefaultPlugin(name, versionOrPath)
     }
 
     throw new Error('Non-default plugins are not currently supported');
   }
 
-  static async resolveExisting(exclude: string[]): Promise<Plugin[]> {
+  static async getAllExisting(exclude: string[]): Promise<Plugin[]> {
     let files;
     try {
       files = await fs.readdir(PLUGIN_CACHE_DIR);
@@ -57,7 +60,7 @@ export class PluginResolver {
     }
   }
 
-  private static async resolvePluginFs(name: string, filePath: string): Promise<Plugin> {
+  private static async getFromFileSystem(name: string, filePath: string): Promise<Plugin> {
     const fileExtension = filePath.slice(filePath.lastIndexOf('.'))
     if (fileExtension !== '.js' && fileExtension !== '.ts') {
       throw new Error(`Only .js and .ts plugins are support currently. Can't resolve ${filePath}`);
@@ -70,7 +73,7 @@ export class PluginResolver {
     )
   }
 
-  private static async resolvePluginDefault(name: string, version: string): Promise<Plugin> {
+  private static async downloadDefaultPlugin(name: string, version: string): Promise<Plugin> {
     const { body } = await fetch(DEFAULT_PLUGIN_URL)
     if (!body) {
       throw new Error('Un-able to fetch the default plugin (body not found). Exiting');
@@ -89,7 +92,7 @@ export class PluginResolver {
     )
   }
 
-  private static async checkAndCreateCacheDirIfNotExists() {
+  private static async createPluginDirIfNotExists() {
     let pluginDirStat = null;
     try {
       pluginDirStat = await fs.stat(PluginResolver.getCacheDir())

test/integration/resolver.test.ts

@@ -13,7 +13,7 @@ describe('Plugin resolver integration test', () => {
   })
 
   it('resolves the default plugin', async () => {
-    const plugin = await PluginResolver.resolve('default')
+    const plugin = await PluginResolver.getOrDownload('default')
 
     expect(fs.existsSync('/Library/Caches/codify/plugins/default.js')).to.be.true;
   })