WIP

Author: kevinwang5658

src/common/errors.test.ts

@@ -45,7 +45,7 @@ describe('AjvValidationError tests', () => {
     const sourceMaps = new SourceMapCache()
     const result = new JsonParser().parse({
       fileType: FileType.JSON,
-      filePath: '/test/path/to/test.json',
+      path: '/test/path/to/test.json',
       contents
     }, sourceMaps);
 

src/common/initialize-plugins.ts

@@ -21,6 +21,7 @@ export interface InitializeArgs {
   forceEmptyProject?: boolean;
   codifyConfigs?: Config[];
   noProgress?: boolean;
+  allowTemplates?: boolean;
 }
 
 export interface InitializationResult {
@@ -59,7 +60,7 @@ export class PluginInitOrchestrator {
       return CodifyParser.parseJson(args.codifyConfigs);
     }
 
-    const codifyPath = await PluginInitOrchestrator.resolveCodifyRootPath(args, reporter);
+    const codifyPath = await PluginInitOrchestrator.resolveCodify(args, reporter);
     ctx.subprocessStarted(SubProcessName.PARSE);
 
     const project = codifyPath
@@ -85,10 +86,18 @@ export class PluginInitOrchestrator {
    * 6. If none exists, return default file from codify cloud.
    * 7. If user is not logged in, return an error.
    *
+   * Order:
+   * 1. If the name ends in .json|.jsonc|.json5|.yaml then search the local folder
+   * 2. If it is a path (relative or absolute) then search for that directory or file
+   * 3. If the path is a uuid (try to match it with a UUID) on the user's account (if they are logged in)
+   * 4. Attempt to search for the name on the user's account (if they are logged in)
+   * 5. Attempt to resolve to a public template (if allowTemplate is enabled)
+   * Error out and tell the user that the following file could not be found
+   *
    * @param args
    * @private
    */
-  private static async resolveCodifyRootPath(args: InitializeArgs, reporter: Reporter): Promise<string | undefined> {
+  private static async resolveCodify(args: InitializeArgs, reporter: Reporter): Promise<string | undefined> {
     const inputPath = args.path ?? process.cwd();
 
     // Cloud files will be fetched and processed later in the parser.

src/entities/project.ts

@@ -1,5 +1,5 @@
 import { OS, PlanRequestData, ResourceOperation, ValidateResponseData } from 'codify-schemas';
-import * as os from 'os'
+import * as os from 'node:os'
 import { validate } from 'uuid'
 
 import {
@@ -14,30 +14,29 @@ import { SourceMapCache } from '../parser/source-maps.js';
 import { ResourceDefinitionMap } from '../plugins/plugin-manager.js';
 import { DependencyGraphResolver } from '../utils/dependency-graph-resolver.js';
 import { groupBy } from '../utils/index.js';
+import { ShellUtils } from '../utils/shell.js';
 import { ConfigBlock, ConfigType } from './config.js';
 import { type Plan } from './plan.js';
 import { ProjectConfig } from './project-config.js';
 import { ResourceConfig } from './resource-config.js';
-import { ShellUtils } from '../utils/shell.js';
 
 export class Project {
   projectConfig: ProjectConfig | null;
   resourceConfigs: ResourceConfig[];
   stateConfigs: ResourceConfig[] | null = null;
   evaluationOrder: null | string[] = null;
 
-  codifyFiles: string[];
-
+  path?: string;
   sourceMaps?: SourceMapCache;
   planRequestsCache?: Map<string, PlanRequestData>
 
   isDestroyProject = false;
 
   static empty(): Project {
-    return Project.create([], []);
+    return Project.create([]);
   }
 
-  static create(configs: ConfigBlock[], codifyFiles: string[], sourceMaps?: SourceMapCache): Project {
+  static create(configs: ConfigBlock[], path?: string, sourceMaps?: SourceMapCache): Project {
     const projectConfigs = configs.filter((u) => u.configClass === ConfigType.PROJECT);
     if (projectConfigs.length > 1) {
       throw new Error(`Only one project config can be specified. Found ${projectConfigs.length}. \n\n
@@ -47,16 +46,16 @@ ${JSON.stringify(projectConfigs, null, 2)}`);
     return new Project(
       (projectConfigs[0] as ProjectConfig) ?? null,
       configs.filter((u) => u.configClass !== ConfigType.PROJECT) as ResourceConfig[],
-      codifyFiles,
+      path,
       sourceMaps,
     );
   }
 
-  constructor(projectConfig: ProjectConfig | null, resourceConfigs: ResourceConfig[], codifyFiles: string[], sourceMaps?: SourceMapCache) {
+  constructor(projectConfig: ProjectConfig | null, resourceConfigs: ResourceConfig[], path?: string, sourceMaps?: SourceMapCache) {
     this.projectConfig = projectConfig;
     this.resourceConfigs = resourceConfigs;
     this.sourceMaps = sourceMaps;
-    this.codifyFiles = codifyFiles;
+    this.path = path;
 
     this.addUniqueNamesForDuplicateResources()
   }
@@ -66,7 +65,7 @@ ${JSON.stringify(projectConfigs, null, 2)}`);
   }
 
   exists(): boolean {
-    return this.codifyFiles.length > 0;
+    return Boolean(this.path);
   }
 
   isStateful(): boolean {
@@ -75,7 +74,7 @@ ${JSON.stringify(projectConfigs, null, 2)}`);
 
   // TODO: Update to a more robust method in the future
   isCloud(): boolean {
-    return validate(this.codifyFiles[0])
+    return Boolean(this.path && validate(this.path));
   }
 
   filterInPlace(ids: string[]): Project {
@@ -130,7 +129,7 @@ ${JSON.stringify(projectConfigs, null, 2)}`);
     const uninstallProject = new Project(
       this.projectConfig,
       this.resourceConfigs,
-      this.codifyFiles,
+      this.path,
       this.sourceMaps,
     )
 

src/generators/file-modification-calculator.ts

@@ -18,7 +18,7 @@ export class FileModificationCalculator {
   private readonly indentString: string;
 
   constructor(existing: Project) {
-    const { file, sourceMap } = existing.sourceMaps!.getSourceMap(existing.codifyFiles[0])!;
+    const { file, sourceMap } = existing.sourceMaps!.getSourceMap(existing.path!)!;
     this.existingFile = file;
     this.sourceMap = sourceMap;
     this.existingConfigs = [...existing.resourceConfigs];
@@ -97,8 +97,8 @@ export class FileModificationCalculator {
       return;
     }
 
-    if (this.existingFile?.fileType !== FileType.JSON && this.existingFile?.fileType !== FileType.JSON5 && this.existingFile?.fileType !== FileType.JSONC && this.existingFile?.fileType !== FileType.CLOUD) {
-      throw new Error(`Only updating .json, .json5, and .jsonc files are currently supported. Found ${this.existingFile?.filePath}`);
+    if (this.existingFile?.fileType !== FileType.JSON && this.existingFile?.fileType !== FileType.JSON5 && this.existingFile?.fileType !== FileType.JSONC && this.existingFile?.fileType !== FileType.REMOTE) {
+      throw new Error(`Only updating .json, .json5, and .jsonc files are currently supported. Found ${this.existingFile?.path}`);
     }
 
     if (this.existingConfigs.some((r) => !r.resourceInfo)) {
@@ -239,7 +239,7 @@ export class FileModificationCalculator {
       return 'cjson'
     }
 
-    if (fileType === FileType.CLOUD) {
+    if (fileType === FileType.REMOTE) {
       return 'cjson'
     }
 

src/orchestrators/destroy.ts

@@ -80,7 +80,7 @@ Open a new terminal or source '.zshrc' for the new changes to be reflected`);
     const destroyProject = new Project(
       null,
       resourcesToDestroy,
-      project.codifyFiles
+      project.path
     ).toDestroyProject();
 
     destroyProject.resolveDependenciesAndCalculateEvalOrder(resourceDefinitions);

src/orchestrators/import.ts

@@ -174,14 +174,14 @@ export class ImportOrchestrator {
     // Special handling for remote-file resources. Offer to save them remotely if any changes are detected on import.
     await ImportOrchestrator.handleCodifyRemoteFiles(reporter, importResult);
 
-    const multipleCodifyFiles = project.codifyFiles.length > 1;
+    const multipleCodifyFiles = project.path.length > 1;
     const saveType = await ImportOrchestrator.getSaveType(reporter, project, args);
 
     // Update an existing file
     if (saveType === SaveType.EXISTING) {
       const file = multipleCodifyFiles
-        ? project.codifyFiles[await reporter.promptOptions('\nIf new resources are added, where to write them?', project.codifyFiles)]
-        : project.codifyFiles[0];
+        ? project.path[await reporter.promptOptions('\nIf new resources are added, where to write them?', project.path)]
+        : project.path;
       await ImportOrchestrator.updateExistingFiles(reporter, project, importResult, resourceInfoList, file, pluginManager);
       return;
     }
@@ -411,7 +411,7 @@ ${JSON.stringify(unsupportedTypeIds)}`);
     args: ImportArgs,
   ): Promise<SaveType> {
     const projectExists = project.exists();
-    const multipleCodifyFiles = project.codifyFiles.length > 1;
+    const multipleCodifyFiles = project.path.length > 1;
 
     if (args.updateExisting && projectExists) {
       return SaveType.EXISTING;
@@ -421,7 +421,7 @@ ${JSON.stringify(unsupportedTypeIds)}`);
         '\nDo you want to save the results?',
         [
           projectExists ?
-            multipleCodifyFiles ? 'Update existing files' : `Update existing file (${project.codifyFiles})`
+            multipleCodifyFiles ? 'Update existing files' : `Update existing file (${project.path})`
             : undefined,
           'In a new file',
           'No'

src/orchestrators/refresh.ts

@@ -50,7 +50,7 @@ export class RefreshOrchestrator {
       project,
       importResult,
       resourceInfoList,
-      project.codifyFiles[0],
+      project.path!,
       pluginManager,
     );
   }

src/orchestrators/test.ts

@@ -58,7 +58,7 @@ export const TestOrchestrator = {
     // Install codify on the VM
     // await spawn(`tart exec ${vmName} /bin/bash -c "$(curl -fsSL https://releases.codifycli.com/install.sh)"`, { interactive: true });
     const { data: ip } = await spawnSafe(`tart ip ${vmName}`, { interactive: true });
-    await spawn(`sshpass -p "admin" scp -o PubkeyAuthentication=no -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null ${initializationResult.project.codifyFiles[0]} admin@${ip}:~/codify.jsonc`, { interactive: true });
+    await spawn(`sshpass -p "admin" scp -o PubkeyAuthentication=no -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null ${initializationResult.project.path} admin@${ip}:~/codify.jsonc`, { interactive: true });
 
     if (args.vmOs === OS.Darwin) {
       await spawn(`tart exec ${vmName} osascript -e "tell application \\"Terminal\\" to do script \\"cd ~/ && codify apply\\""`, { interactive: true });

src/parser/cloud/cloud-parser.ts

@@ -16,7 +16,7 @@ export class CloudParser implements LanguageSpecificParser {
       const { type, ...config } = content;
       return {
         contents: { type, ...config },
-        sourceMapKey: SourceMapCache.constructKey(file.filePath, `/${idx}`),
+        sourceMapKey: SourceMapCache.constructKey(file.path, `/${idx}`),
       }
     })
   }

src/parser/entities.ts

@@ -3,7 +3,7 @@ import { SourceMapCache } from './source-maps.js';
 
 export interface InMemoryFile {
   contents: string;
-  filePath: string;
+  path: string;
   fileType: FileType;
 }
 
@@ -21,5 +21,5 @@ export enum FileType {
   YAML = 'yaml',
   JSON5 = 'json5',
   JSONC = 'jsonc',
-  CLOUD = 'cloud',
+  REMOTE = 'remote',
 }