fix: fixing context resolution issues with xanoscript repo generation logic

Author: MihalyToth20

.changeset/thin-trees-open.md

@@ -5,4 +5,6 @@
 "@calycode/cli": patch
 ---
 
-fix: fixing package.json for package publishing, not building packages in the github action resulted with non-existent dist directory...
+feat: added getStartDir() method to the ConfigStorage interface. Goal is to allow platform agnosticity in the context resolution.
+fix: fixing an issue where xanoscript generation would fail due to missing context
+fix: fixing package.json for package publishing, not building packages in the github action resulted with non-existent dist directory...

packages/cli/src/commands/generate-xanoscript-repo.ts

@@ -31,26 +31,27 @@ async function generateXanoscriptRepo({ instance, workspace, branch, core, print
       workspace,
       branch,
    });
-   const { instanceConfig, workspaceConfig, branchConfig } = await resolveConfigs({
+   const { instanceConfig, workspaceConfig, branchConfig, context } = await resolveConfigs({
+      requiredFields: ['instance', 'workspace', 'branch'],
       cliContext: { instance, workspace, branch },
       core,
    });
 
    // Resolve output dir
    const outputDir = replacePlaceholders(instanceConfig.xanoscript.output, {
-      '@': await core.findProjectRoot(),
+      '@': await findProjectRoot(),
       instance: instanceConfig.name,
       workspace: workspaceConfig.name,
       branch: branchConfig.label,
    });
 
    clearDirectory(outputDir);
-   await mkdirSync(outputDir, { recursive: true });
+   mkdirSync(outputDir, { recursive: true });
 
    const plannedWrites: { path: string; content: string }[] = await core.buildXanoscriptRepo({
-      instance,
-      workspace,
-      branch,
+      instance: context.instance,
+      workspace: context.workspace,
+      branch: context.branch,
    });
    await Promise.all(
       plannedWrites.map(async ({ path, content }) => {

packages/cli/src/node-config-storage.ts

@@ -13,7 +13,7 @@ import os from 'os';
 import { x } from 'tar';
 import { tmpdir } from 'os';
 import { join } from 'path';
-import { ConfigStorage, CoreContext, InstanceConfig } from '@calycode/types';
+import { ConfigStorage, InstanceConfig } from '@calycode/types';
 
 const BASE_DIR = path.join(os.homedir(), '.xano-tools');
 const GLOBAL_CONFIG_PATH = path.join(BASE_DIR, 'config.json');
@@ -219,6 +219,15 @@ export const nodeConfigStorage: ConfigStorage = {
       fs.writeFileSync(p, token, { mode: 0o600 });
    },
 
+   /**
+    * Get the current working directory as 'startDir' for reuse in the core methods.
+    *
+    * @return string
+    */
+   getStartDir() {
+      return process.cwd();
+   },
+// 
    // ----- FILESYSTEM OPS -----
    async mkdir(dirPath, options) {
       await fs.promises.mkdir(dirPath, options);

packages/cli/src/utils/commands/context-resolution.ts

@@ -26,10 +26,7 @@ async function promptForContext(
          const selectedWorkspaceId = responses['workspace'] ?? knownContext.workspace;
          // Workspace could be identified by id or label or name; adjust as needed:
          let workspace = instanceConfig.workspaces.find(
-            (w) =>
-               w.id === selectedWorkspaceId ||
-               w.name === selectedWorkspaceId ||
-               w.label === selectedWorkspaceId
+            (w) => w.id === selectedWorkspaceId || w.name === selectedWorkspaceId
          );
          choices = workspace?.branches || [];
       }

packages/core/src/features/testing/index.ts

@@ -51,6 +51,7 @@ async function testRunner({
    groups,
    testConfig,
    core,
+   storage,
 }: {
    context: CoreContext;
    groups: ApiGroupConfig[];
@@ -64,6 +65,7 @@ async function testRunner({
       customAsserts: AssertDefinition;
    }[];
    core: Caly;
+   storage: Caly['storage'];
 }): Promise<
    {
       group: ApiGroupConfig;
@@ -80,7 +82,7 @@ async function testRunner({
    const { instance, workspace, branch } = context;
 
    core.emit('start', { name: 'start-testing', payload: context });
-   const startDir = process.cwd();
+   const startDir = storage.getStartDir();
    const { instanceConfig, workspaceConfig, branchConfig } = await core.loadAndValidateContext({
       instance,
       workspace,

packages/core/src/implementations/backups.ts

@@ -15,7 +15,7 @@ async function exportBackupImplementation({ instance, workspace, branch, core })
          message: 'Loading context...',
          percent: 5,
       });
-      const startDir = process.cwd();
+      const startDir = core.storage.getStartDir();
       const { instanceConfig, workspaceConfig, branchConfig } = await core.loadAndValidateContext({
          instance,
          workspace,
@@ -103,7 +103,7 @@ async function restoreBackupImplementation({ instance, workspace, formData, core
       message: 'Loading context...',
       percent: 5,
    });
-   const startDir = process.cwd();
+   const startDir = core.storage.getStartDir();
    const { instanceConfig, workspaceConfig } = await core.loadAndValidateContext({
       instance,
       workspace,

packages/core/src/implementations/build-xanoscript-repo.ts

@@ -48,28 +48,33 @@ async function fetchAndProcessEntities({
           "description" = "Xanoscript fetching failed with message: ${xanoscript.message}"
       }
       `;
-      tempResults.push({ path: `${path}/script.xs`, content: xanoScriptContent });
+      tempResults.push({ path: `${path}/script.freezed.xs`, content: xanoScriptContent });
    }
 
    return tempResults;
 }
 
-async function buildXanoscriptRepoImplementation(
-   storage: Caly['storage'],
-   core: Caly,
-   options: CoreContext
-): Promise<{ path: string; content: string }[]> {
+async function buildXanoscriptRepoImplementation({
+   storage,
+   core,
+   options,
+}: {
+   storage: Caly['storage'];
+   core: Caly;
+   options: CoreContext;
+}): Promise<{ path: string; content: string }[]> {
    const { instance, workspace, branch } = options;
 
    core.emit('start', { name: 'xs-repo-generation', payload: options });
 
+   // [ ] THIS IS WHERE THE ROOT OF ALL EVIL IS
    const results: { path: string; content: string }[] = [];
-   const startDir = process.cwd();
+   const startDir = storage.getStartDir();
    const { instanceConfig, workspaceConfig, branchConfig } = await core.loadAndValidateContext({
       instance,
       workspace,
       branch,
-      startDir
+      startDir,
    });
 
    const baseUrl = instanceConfig.url;

packages/core/src/implementations/load-and-validate-context.ts

@@ -8,16 +8,6 @@ import {
 } from '@calycode/types';
 import { getCurrentContextConfigImplementation } from './get-current-context';
 
-function assignDefined<T>(base: T, overrides: Partial<T>): T {
-   const result = { ...base };
-   for (const key in overrides) {
-      if (overrides[key] !== undefined) {
-         result[key] = overrides[key]!;
-      }
-   }
-   return result;
-}
-
 export async function loadAndValidateContextImplementation({
    storage,
    overrides,

packages/core/src/implementations/run-tests.ts

@@ -7,6 +7,7 @@ async function runTestsImplementation({
    groups,
    testConfig,
    core,
+   storage,
 }: {
    context: CoreContext;
    groups: ApiGroupConfig[];
@@ -20,6 +21,7 @@ async function runTestsImplementation({
       customAsserts: AssertDefinition;
    }[];
    core: Caly;
+   storage: Caly['storage'];
 }): Promise<
    {
       group: ApiGroupConfig;
@@ -33,7 +35,7 @@ async function runTestsImplementation({
       }[];
    }[]
 > {
-   return await testRunner({ context, groups, testConfig, core });
+   return await testRunner({ context, groups, testConfig, core, storage });
 }
 
 export { runTestsImplementation };

packages/core/src/index.ts

@@ -236,10 +236,14 @@ export class Caly extends TypedEmitter<EventMap> {
       workspace,
       branch,
    }): Promise<{ path: string; content: string }[]> {
-      const response = await buildXanoscriptRepoImplementation(this.storage, this, {
-         instance,
-         workspace,
-         branch,
+      const response = await buildXanoscriptRepoImplementation({
+         storage: this.storage,
+         core: this,
+         options: {
+            instance,
+            workspace,
+            branch,
+         },
       });
       return response;
    }
@@ -301,7 +305,13 @@ export class Caly extends TypedEmitter<EventMap> {
          }[];
       }[]
    > {
-      return await runTestsImplementation({ context, groups, testConfig, core: this });
+      return await runTestsImplementation({
+         context,
+         groups,
+         testConfig,
+         core: this,
+         storage: this.storage,
+      });
    }
 
    // ----- SEMI-UTIL METHODS ----- //