appwrite-utils-cli 1.5.1 → 1.6.0

package/tests/testUtils.ts

@@ -0,0 +1,340 @@
+import fs from 'fs';
+import path from 'path';
+import { tmpdir } from 'os';
+import { randomBytes } from 'crypto';
+import { type AppwriteConfig, type CollectionCreate } from 'appwrite-utils';
+
+/**
+ * Test utilities for creating temporary directories and test fixtures
+ */
+export class TestUtils {
+  private static tempDirs: string[] = [];
+
+  /**
+   * Creates a temporary directory for testing
+   */
+  static createTempDir(prefix = 'appwrite-test'): string {
+    const tempDir = path.join(tmpdir(), `${prefix}-${randomBytes(8).toString('hex')}`);
+    fs.mkdirSync(tempDir, { recursive: true });
+    this.tempDirs.push(tempDir);
+    return tempDir;
+  }
+
+  /**
+   * Cleans up all created temporary directories
+   */
+  static cleanup(): void {
+    this.tempDirs.forEach(dir => {
+      try {
+        fs.rmSync(dir, { recursive: true, force: true });
+      } catch (error) {
+        // Ignore cleanup errors
+      }
+    });
+    this.tempDirs = [];
+  }
+
+  /**
+   * Creates a test appwrite config
+   */
+  static createTestAppwriteConfig(overrides: Partial<AppwriteConfig> = {}): AppwriteConfig {
+    return {
+      appwriteEndpoint: 'http://localhost:8080/v1',
+      appwriteProject: 'test-project',
+      appwriteKey: 'test-key',
+      databases: [
+        {
+          name: 'test-database',
+          $id: 'test-db-id',
+          enabled: true,
+        }
+      ],
+      buckets: [],
+      teams: [],
+      functions: [],
+      messaging: [],
+      collections: [],
+      ...overrides,
+    };
+  }
+
+  /**
+   * Creates a test collection configuration
+   */
+  static createTestCollection(overrides: Partial<CollectionCreate> = {}): CollectionCreate {
+    return {
+      name: 'TestCollection',
+      $id: 'test-collection',
+      documentSecurity: false,
+      enabled: true,
+      $permissions: [],
+      attributes: [
+        {
+          key: 'name',
+          type: 'string',
+          size: 255,
+          required: true,
+          array: false,
+        },
+        {
+          key: 'email',
+          type: 'email',
+          required: true,
+          array: false,
+        }
+      ],
+      indexes: [
+        {
+          key: 'email_index',
+          type: 'unique',
+          attributes: ['email'],
+        }
+      ],
+      ...overrides,
+    };
+  }
+
+  /**
+   * Creates a test table configuration (tables API)
+   */
+  static createTestTable(overrides: any = {}): any {
+    return {
+      name: 'TestTable',
+      tableId: 'test-table',
+      databaseId: 'test-db-id',
+      documentSecurity: false,
+      enabled: true,
+      $permissions: [],
+      attributes: [
+        {
+          key: 'title',
+          type: 'string',
+          size: 255,
+          required: true,
+          array: false,
+        },
+        {
+          key: 'count',
+          type: 'integer',
+          required: false,
+          min: 0,
+          max: 1000,
+        }
+      ],
+      indexes: [
+        {
+          key: 'title_index',
+          type: 'key',
+          attributes: ['title'],
+        }
+      ],
+      _isFromTablesDir: true,
+      ...overrides,
+    };
+  }
+
+  /**
+   * Creates a test project structure with collections and/or tables
+   */
+  static createTestProject(options: {
+    hasCollections?: boolean;
+    hasTables?: boolean;
+    hasConflicts?: boolean;
+    useYaml?: boolean;
+    configDir?: string;
+  } = {}): string {
+    const {
+      hasCollections = true,
+      hasTables = false,
+      hasConflicts = false,
+      useYaml = false,
+      configDir,
+    } = options;
+
+    const testDir = configDir || this.createTempDir('test-project');
+
+    // Create .appwrite directory
+    const appwriteDir = path.join(testDir, '.appwrite');
+    fs.mkdirSync(appwriteDir, { recursive: true });
+
+    // Create config file
+    const config = this.createTestAppwriteConfig();
+    if (useYaml) {
+      const yamlContent = `
+appwriteEndpoint: ${config.appwriteEndpoint}
+appwriteProject: ${config.appwriteProject}
+appwriteKey: ${config.appwriteKey}
+databases:
+  - name: ${config.databases[0].name}
+    $id: ${config.databases[0].$id}
+    enabled: ${config.databases[0].enabled}
+buckets: []
+teams: []
+functions: []
+messaging: []
+`;
+      fs.writeFileSync(path.join(appwriteDir, 'config.yaml'), yamlContent);
+    } else {
+      const tsContent = `
+import { type AppwriteConfig } from 'appwrite-utils';
+
+const appwriteConfig: AppwriteConfig = ${JSON.stringify(config, null, 2)};
+
+export default appwriteConfig;
+`;
+      fs.writeFileSync(path.join(testDir, 'appwriteConfig.ts'), tsContent);
+    }
+
+    // Create collections directory if requested
+    if (hasCollections) {
+      const collectionsDir = path.join(testDir, 'collections');
+      fs.mkdirSync(collectionsDir);
+
+      const collection = this.createTestCollection();
+      if (useYaml) {
+        const yamlContent = `
+name: ${collection.name}
+id: ${collection.$id}
+documentSecurity: ${collection.documentSecurity}
+enabled: ${collection.enabled}
+permissions: []
+attributes:
+  - key: name
+    type: string
+    size: 255
+    required: true
+  - key: email
+    type: email
+    required: true
+indexes:
+  - key: email_index
+    type: unique
+    attributes: [email]
+`;
+        fs.writeFileSync(path.join(collectionsDir, 'TestCollection.yaml'), yamlContent);
+      } else {
+        const tsContent = `
+import { type CollectionCreate } from 'appwrite-utils';
+
+const TestCollection: CollectionCreate = ${JSON.stringify(collection, null, 2)};
+
+export default TestCollection;
+`;
+        fs.writeFileSync(path.join(collectionsDir, 'TestCollection.ts'), tsContent);
+      }
+    }
+
+    // Create tables directory if requested
+    if (hasTables) {
+      const tablesDir = path.join(testDir, 'tables');
+      fs.mkdirSync(tablesDir);
+
+      const table = this.createTestTable();
+      if (useYaml) {
+        const yamlContent = `
+name: ${table.name}
+tableId: ${table.tableId}
+databaseId: ${table.databaseId}
+documentSecurity: ${table.documentSecurity}
+enabled: ${table.enabled}
+permissions: []
+attributes:
+  - key: title
+    type: string
+    size: 255
+    required: true
+  - key: count
+    type: integer
+    required: false
+    min: 0
+    max: 1000
+indexes:
+  - key: title_index
+    type: key
+    attributes: [title]
+`;
+        fs.writeFileSync(path.join(tablesDir, 'TestTable.yaml'), yamlContent);
+      } else {
+        const tsContent = `
+import { type TableCreate } from 'appwrite-utils';
+
+const TestTable: any = ${JSON.stringify(table, null, 2)};
+
+export default TestTable;
+`;
+        fs.writeFileSync(path.join(tablesDir, 'TestTable.ts'), tsContent);
+      }
+
+      // Create conflicting collection if requested
+      if (hasConflicts && hasCollections) {
+        const conflictTable = this.createTestTable({
+          name: 'TestCollection', // Same name as collection
+          tableId: 'test-collection-conflict'
+        });
+        const tsContent = `
+const ConflictTable: any = ${JSON.stringify(conflictTable, null, 2)};
+export default ConflictTable;
+`;
+        fs.writeFileSync(path.join(tablesDir, 'ConflictTable.ts'), tsContent);
+      }
+    }
+
+    return testDir;
+  }
+
+  /**
+   * Creates mock Appwrite client responses
+   */
+  static createMockAppwriteResponses() {
+    return {
+      databases: {
+        list: jest.fn().mockResolvedValue({
+          databases: [
+            {
+              $id: 'test-db-id',
+              name: 'test-database',
+              enabled: true,
+              $createdAt: new Date().toISOString(),
+              $updatedAt: new Date().toISOString(),
+            }
+          ],
+          total: 1,
+        }),
+        get: jest.fn().mockResolvedValue({
+          $id: 'test-db-id',
+          name: 'test-database',
+          enabled: true,
+          $createdAt: new Date().toISOString(),
+          $updatedAt: new Date().toISOString(),
+        }),
+        listCollections: jest.fn().mockResolvedValue({
+          collections: [
+            {
+              $id: 'test-collection',
+              name: 'TestCollection',
+              enabled: true,
+              documentSecurity: false,
+              $permissions: [],
+              attributes: [],
+              indexes: [],
+              $createdAt: new Date().toISOString(),
+              $updatedAt: new Date().toISOString(),
+            }
+          ],
+          total: 1,
+        }),
+      },
+      health: {
+        get: jest.fn().mockResolvedValue({
+          status: 'OK',
+          version: '1.6.0',
+        }),
+      },
+    };
+  }
+}
+
+// Clean up after all tests
+afterAll(() => {
+  TestUtils.cleanup();
+});

package/tests/utils/loadConfigs.test.ts

@@ -0,0 +1,350 @@
+import fs from 'fs';
+import path from 'path';
+import { jest } from '@jest/globals';
+import { TestUtils } from '../testUtils';
+import { loadConfig, loadConfigWithPath, findAppwriteConfig } from '../../src/utils/loadConfigs';
+import { MessageFormatter } from '../../src/shared/messageFormatter';
+
+// Mock MessageFormatter to capture log messages
+jest.mock('../../src/shared/messageFormatter', () => ({
+  MessageFormatter: {
+    success: jest.fn(),
+    warning: jest.fn(),
+    info: jest.fn(),
+    error: jest.fn(),
+  },
+}));
+
+// Mock version detection
+jest.mock('../../src/utils/versionDetection', () => ({
+  detectAppwriteVersionCached: jest.fn().mockResolvedValue({
+    serverVersion: '1.6.0',
+    apiMode: 'database',
+  }),
+  fetchServerVersion: jest.fn().mockResolvedValue('1.6.0'),
+  isVersionAtLeast: jest.fn((version, target) => {
+    if (!version) return false;
+    return version >= target;
+  }),
+}));
+
+describe('loadConfigs - Dual Schema Support', () => {
+  let testDir: string;
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  afterEach(() => {
+    TestUtils.cleanup();
+  });
+
+  describe('findAppwriteConfig', () => {
+    it('should find YAML config in .appwrite directory', () => {
+      testDir = TestUtils.createTestProject({ useYaml: true });
+      const configPath = findAppwriteConfig(testDir);
+      expect(configPath).toBe(testDir);
+    });
+
+    it('should find TypeScript config as fallback', () => {
+      testDir = TestUtils.createTestProject({ useYaml: false });
+      const configPath = findAppwriteConfig(testDir);
+      expect(configPath).toBe(testDir);
+    });
+
+    it('should return null when no config found', () => {
+      testDir = TestUtils.createTempDir();
+      const configPath = findAppwriteConfig(testDir);
+      expect(configPath).toBeNull();
+    });
+  });
+
+  describe('Dual Folder Loading', () => {
+    it('should load collections from collections/ directory only', async () => {
+      testDir = TestUtils.createTestProject({
+        hasCollections: true,
+        hasTables: false,
+      });
+
+      const config = await loadConfig(testDir);
+
+      expect(config.collections).toHaveLength(1);
+      expect(config.collections[0].name).toBe('TestCollection');
+      expect(config.collections[0]._isFromTablesDir).toBeUndefined();
+      expect(MessageFormatter.success).toHaveBeenCalledWith(
+        'Loading from collections/ directory: 1 files found',
+        { prefix: 'Config' }
+      );
+    });
+
+    it('should load tables from tables/ directory only', async () => {
+      testDir = TestUtils.createTestProject({
+        hasCollections: false,
+        hasTables: true,
+      });
+
+      const config = await loadConfig(testDir);
+
+      expect(config.collections).toHaveLength(1);
+      expect(config.collections[0].name).toBe('TestTable');
+      expect(config.collections[0]._isFromTablesDir).toBe(true);
+      expect(MessageFormatter.success).toHaveBeenCalledWith(
+        'Loading from tables/ directory: 1 files found',
+        { prefix: 'Config' }
+      );
+    });
+
+    it('should load from both collections/ and tables/ directories', async () => {
+      testDir = TestUtils.createTestProject({
+        hasCollections: true,
+        hasTables: true,
+      });
+
+      const config = await loadConfig(testDir);
+
+      expect(config.collections).toHaveLength(2);
+
+      const collection = config.collections.find((c: any) => !c._isFromTablesDir);
+      const table = config.collections.find((c: any) => c._isFromTablesDir);
+
+      expect(collection).toBeDefined();
+      expect(collection.name).toBe('TestCollection');
+
+      expect(table).toBeDefined();
+      expect(table.name).toBe('TestTable');
+      expect(table._isFromTablesDir).toBe(true);
+
+      expect(MessageFormatter.success).toHaveBeenCalledWith(
+        'Loading from collections/ directory: 1 files found',
+        { prefix: 'Config' }
+      );
+      expect(MessageFormatter.success).toHaveBeenCalledWith(
+        'Loading from tables/ directory: 1 files found',
+        { prefix: 'Config' }
+      );
+    });
+
+    it('should handle naming conflicts with collections/ taking priority', async () => {
+      testDir = TestUtils.createTestProject({
+        hasCollections: true,
+        hasTables: true,
+        hasConflicts: true,
+      });
+
+      const config = await loadConfig(testDir);
+
+      // Should have 2 items: original collection + one table (conflict skipped)
+      expect(config.collections).toHaveLength(2);
+
+      // Check that the collection takes priority
+      const collectionItems = config.collections.filter((c: any) => !c._isFromTablesDir);
+      expect(collectionItems).toHaveLength(1);
+      expect(collectionItems[0].name).toBe('TestCollection');
+
+      // Check warning was logged
+      expect(MessageFormatter.warning).toHaveBeenCalledWith(
+        expect.stringContaining('Found 1 naming conflicts'),
+        { prefix: 'Config' }
+      );
+    });
+  });
+
+  describe('YAML Support', () => {
+    it('should load YAML collections', async () => {
+      testDir = TestUtils.createTestProject({
+        hasCollections: true,
+        useYaml: true,
+      });
+
+      const config = await loadConfig(testDir);
+
+      expect(config.collections).toHaveLength(1);
+      expect(config.collections[0].name).toBe('TestCollection');
+      expect(config.collections[0].$id).toBe('test-collection');
+      expect(config.collections[0].attributes).toHaveLength(2);
+    });
+
+    it('should load YAML tables', async () => {
+      testDir = TestUtils.createTestProject({
+        hasTables: true,
+        useYaml: true,
+      });
+
+      const config = await loadConfig(testDir);
+
+      expect(config.collections).toHaveLength(1);
+      expect(config.collections[0].name).toBe('TestTable');
+      expect(config.collections[0]._isFromTablesDir).toBe(true);
+    });
+
+    it('should load mixed YAML and TypeScript files', async () => {
+      testDir = TestUtils.createTestProject({
+        hasCollections: true,
+        useYaml: false,
+      });
+
+      // Add a YAML table alongside TypeScript collection
+      const tablesDir = path.join(testDir, 'tables');
+      fs.mkdirSync(tablesDir);
+
+      const yamlContent = `
+name: YamlTable
+tableId: yaml-table
+databaseId: test-db-id
+documentSecurity: false
+enabled: true
+permissions: []
+attributes:
+  - key: content
+    type: string
+    size: 1000
+    required: true
+indexes: []
+`;
+      fs.writeFileSync(path.join(tablesDir, 'YamlTable.yaml'), yamlContent);
+
+      const config = await loadConfig(testDir);
+
+      expect(config.collections).toHaveLength(2);
+      expect(config.collections.some((c: any) => c.name === 'TestCollection')).toBe(true);
+      expect(config.collections.some((c: any) => c.name === 'YamlTable')).toBe(true);
+    });
+  });
+
+  describe('Legacy Single Directory Support', () => {
+    it('should fall back to legacy collections/ directory when no dual directories', async () => {
+      testDir = TestUtils.createTempDir();
+
+      // Create config without .appwrite structure
+      const config = TestUtils.createTestAppwriteConfig();
+      const tsContent = `
+import { type AppwriteConfig } from 'appwrite-utils';
+const appwriteConfig: AppwriteConfig = ${JSON.stringify(config, null, 2)};
+export default appwriteConfig;
+`;
+      fs.writeFileSync(path.join(testDir, 'appwriteConfig.ts'), tsContent);
+
+      // Create only collections directory (legacy)
+      const collectionsDir = path.join(testDir, 'collections');
+      fs.mkdirSync(collectionsDir);
+
+      const collection = TestUtils.createTestCollection();
+      const collectionContent = `
+const TestCollection = ${JSON.stringify(collection, null, 2)};
+export default TestCollection;
+`;
+      fs.writeFileSync(path.join(collectionsDir, 'TestCollection.ts'), collectionContent);
+
+      const loadedConfig = await loadConfig(testDir);
+
+      expect(loadedConfig.collections).toHaveLength(1);
+      expect(loadedConfig.collections[0].name).toBe('TestCollection');
+      expect(MessageFormatter.info).toHaveBeenCalledWith(
+        'Using legacy single directory: collections/',
+        { prefix: 'Config' }
+      );
+    });
+  });
+
+  describe('loadConfigWithPath', () => {
+    it('should return both config and actual config path', async () => {
+      testDir = TestUtils.createTestProject({ useYaml: true });
+
+      const result = await loadConfigWithPath(testDir);
+
+      expect(result.config).toBeDefined();
+      expect(result.actualConfigPath).toContain('config.yaml');
+      expect(result.config.appwriteProject).toBe('test-project');
+    });
+
+    it('should handle .appwrite directory path directly', async () => {
+      testDir = TestUtils.createTestProject({ useYaml: true });
+      const appwriteDir = path.join(testDir, '.appwrite');
+
+      const result = await loadConfigWithPath(appwriteDir);
+
+      expect(result.config).toBeDefined();
+      expect(result.actualConfigPath).toContain('config.yaml');
+    });
+  });
+
+  describe('Error Handling', () => {
+    it('should throw error when no config found', async () => {
+      testDir = TestUtils.createTempDir();
+
+      await expect(loadConfig(testDir)).rejects.toThrow('No valid configuration found');
+    });
+
+    it('should handle malformed YAML gracefully', async () => {
+      testDir = TestUtils.createTestProject({ useYaml: true });
+
+      // Create malformed YAML collection
+      const collectionsDir = path.join(testDir, 'collections');
+      fs.writeFileSync(path.join(collectionsDir, 'BadCollection.yaml'), 'invalid: yaml: content:');
+
+      const config = await loadConfig(testDir);
+
+      // Should still load other valid collections
+      expect(config).toBeDefined();
+      // The malformed collection should be skipped
+    });
+
+    it('should handle missing TypeScript exports gracefully', async () => {
+      testDir = TestUtils.createTestProject({ useYaml: false });
+
+      // Create TypeScript file with no export
+      const collectionsDir = path.join(testDir, 'collections');
+      fs.writeFileSync(path.join(collectionsDir, 'NoExport.ts'), 'const collection = {};');
+
+      const config = await loadConfig(testDir);
+
+      expect(config).toBeDefined();
+      // Should still have the original test collection
+      expect(config.collections.length).toBeGreaterThanOrEqual(1);
+    });
+  });
+
+  describe('Performance and Scalability', () => {
+    it('should handle large numbers of collections and tables', async () => {
+      testDir = TestUtils.createTempDir();
+
+      // Create config
+      const config = TestUtils.createTestAppwriteConfig();
+      const tsContent = `export default ${JSON.stringify(config, null, 2)};`;
+      fs.writeFileSync(path.join(testDir, 'appwriteConfig.ts'), tsContent);
+
+      // Create many collections
+      const collectionsDir = path.join(testDir, 'collections');
+      fs.mkdirSync(collectionsDir);
+
+      for (let i = 0; i < 50; i++) {
+        const collection = TestUtils.createTestCollection({
+          name: `Collection${i}`,
+          $id: `collection-${i}`,
+        });
+        const content = `export default ${JSON.stringify(collection, null, 2)};`;
+        fs.writeFileSync(path.join(collectionsDir, `Collection${i}.ts`), content);
+      }
+
+      // Create many tables
+      const tablesDir = path.join(testDir, 'tables');
+      fs.mkdirSync(tablesDir);
+
+      for (let i = 0; i < 30; i++) {
+        const table = TestUtils.createTestTable({
+          name: `Table${i}`,
+          tableId: `table-${i}`,
+        });
+        const content = `export default ${JSON.stringify(table, null, 2)};`;
+        fs.writeFileSync(path.join(tablesDir, `Table${i}.ts`), content);
+      }
+
+      const startTime = Date.now();
+      const loadedConfig = await loadConfig(testDir);
+      const loadTime = Date.now() - startTime;
+
+      expect(loadedConfig.collections).toHaveLength(80); // 50 collections + 30 tables
+      expect(loadTime).toBeLessThan(5000); // Should load within 5 seconds
+    });
+  });
+});