{viewers.length}
@@ -22,153 +25,157 @@ function TestPluginConsumer() {
);
}
-// Mock plugin
-const mockPlugin: StudioPlugin = {
- manifest: defineStudioPlugin({
- id: 'test.plugin',
- name: 'Test Plugin',
- version: '1.0.0',
- description: 'Test plugin',
- contributes: {
- metadataViewers: [
- {
- id: 'test-viewer',
- metadataTypes: ['object'],
- label: 'Test Viewer',
- priority: 100,
- },
- ],
- sidebarGroups: [
- {
- key: 'test',
- label: 'Test',
- icon: 'database',
- metadataTypes: ['object'],
- order: 10,
- },
- ],
- },
- }),
- activate: vi.fn(),
-};
-
-describe('Plugin System', () => {
+// Minimal React component used as a registered viewer
+function DummyViewer() {
+ return
dummy
;
+}
+
+/** Build a plugin that contributes a single metadata viewer + sidebar group. */
+function makePlugin(opts: {
+ id: string;
+ viewerId: string;
+ priority?: number;
+ label?: string;
+ metadataTypes?: string[];
+ groupKey?: string;
+}): StudioPlugin {
+ const {
+ id,
+ viewerId,
+ priority = 100,
+ label = viewerId,
+ metadataTypes = ['object'],
+ groupKey = 'test-group',
+ } = opts;
+ return {
+ manifest: defineStudioPlugin({
+ id,
+ name: id,
+ version: '1.0.0',
+ description: `${id} test plugin`,
+ contributes: {
+ metadataViewers: [
+ {
+ id: viewerId,
+ metadataTypes,
+ label,
+ priority,
+ modes: ['preview'],
+ },
+ ],
+ sidebarGroups: [
+ {
+ key: groupKey,
+ label: 'Test Group',
+ icon: 'database',
+ metadataTypes,
+ order: 10,
+ },
+ ],
+ },
+ }),
+ activate: vi.fn((api) => {
+ api.registerViewer(viewerId, DummyViewer);
+ }),
+ };
+}
+
+describe('Studio Plugin System', () => {
beforeEach(() => {
vi.clearAllMocks();
});
describe('PluginRegistry', () => {
- it('should register plugins', () => {
- const registry = new PluginRegistry([mockPlugin]);
+ it('registers plugins via register()', () => {
+ const registry = new PluginRegistry();
+ const plugin = makePlugin({ id: 'p1', viewerId: 'v1' });
+
+ registry.register(plugin);
- expect(registry.getAllPlugins()).toHaveLength(1);
- expect(registry.getPlugin('test.plugin')).toBe(mockPlugin);
+ expect(registry.getPlugins()).toHaveLength(1);
+ expect(registry.getPlugins()[0].manifest.id).toBe('p1');
});
- it('should activate plugins', () => {
- const registry = new PluginRegistry([mockPlugin]);
- const api = {} as any; // Mock API
+ it('activates plugins and invokes their activate() callback', async () => {
+ const registry = new PluginRegistry();
+ const plugin = makePlugin({ id: 'p1', viewerId: 'v1' });
- registry.activateAll(api);
+ await registry.registerAndActivate(plugin);
- expect(mockPlugin.activate).toHaveBeenCalledWith(api);
+ expect(plugin.activate).toHaveBeenCalledTimes(1);
+ expect(registry.isActivated('p1')).toBe(true);
});
- it('should return viewers for metadata type', () => {
- const registry = new PluginRegistry([mockPlugin]);
-
- const viewers = registry.getViewersForType('object');
+ it('returns viewers matching a given metadata type', async () => {
+ const registry = new PluginRegistry();
+ await registry.registerAndActivate(
+ makePlugin({ id: 'p1', viewerId: 'v1', metadataTypes: ['object'] }),
+ );
+ const viewers = registry.getViewers('object');
expect(viewers).toHaveLength(1);
- expect(viewers[0].id).toBe('test-viewer');
- expect(viewers[0].label).toBe('Test Viewer');
+ expect(viewers[0].id).toBe('v1');
});
- it('should return empty array for unknown metadata type', () => {
- const registry = new PluginRegistry([mockPlugin]);
-
- const viewers = registry.getViewersForType('unknown');
+ it('returns an empty array for unknown metadata types', async () => {
+ const registry = new PluginRegistry();
+ await registry.registerAndActivate(
+ makePlugin({ id: 'p1', viewerId: 'v1', metadataTypes: ['object'] }),
+ );
- expect(viewers).toHaveLength(0);
+ expect(registry.getViewers('unknown-type')).toHaveLength(0);
});
- it('should return sidebar groups', () => {
- const registry = new PluginRegistry([mockPlugin]);
+ it('returns sidebar groups contributed by registered plugins', () => {
+ const registry = new PluginRegistry();
+ registry.register(makePlugin({ id: 'p1', viewerId: 'v1' }));
const groups = registry.getSidebarGroups();
-
expect(groups).toHaveLength(1);
- expect(groups[0].key).toBe('test');
- expect(groups[0].label).toBe('Test');
+ expect(groups[0].key).toBe('test-group');
+ expect(groups[0].label).toBe('Test Group');
});
- it('should sort viewers by priority (higher first)', () => {
- const plugin1: StudioPlugin = {
- manifest: defineStudioPlugin({
- id: 'plugin1',
- name: 'Plugin 1',
- version: '1.0.0',
- contributes: {
- metadataViewers: [
- {
- id: 'viewer1',
- metadataTypes: ['object'],
- label: 'Viewer 1',
- priority: 50,
- },
- ],
- },
- }),
- activate: vi.fn(),
- };
-
- const plugin2: StudioPlugin = {
- manifest: defineStudioPlugin({
- id: 'plugin2',
- name: 'Plugin 2',
- version: '1.0.0',
- contributes: {
- metadataViewers: [
- {
- id: 'viewer2',
- metadataTypes: ['object'],
- label: 'Viewer 2',
- priority: 100,
- },
- ],
- },
- }),
- activate: vi.fn(),
- };
-
- const registry = new PluginRegistry([plugin1, plugin2]);
- const viewers = registry.getViewersForType('object');
+ it('sorts viewers by priority (higher first)', async () => {
+ const registry = new PluginRegistry();
+ await registry.registerAndActivate(
+ makePlugin({ id: 'p1', viewerId: 'v-low', priority: 50 }),
+ );
+ await registry.registerAndActivate(
+ makePlugin({ id: 'p2', viewerId: 'v-high', priority: 100 }),
+ );
- expect(viewers[0].id).toBe('viewer2'); // Higher priority first
- expect(viewers[1].id).toBe('viewer1');
+ const viewers = registry.getViewers('object');
+ expect(viewers.map(v => v.id)).toEqual(['v-high', 'v-low']);
});
});
describe('PluginRegistryProvider', () => {
- it('should provide plugin registry to children', () => {
+ it('provides an activated plugin registry to children', async () => {
+ const plugin = makePlugin({ id: 'p1', viewerId: 'v1' });
+
render(
-
-
-
+
+
+ ,
);
- expect(screen.getByTestId('viewer-count')).toHaveTextContent('1');
- expect(screen.getByTestId('viewer-test-viewer')).toHaveTextContent('Test Viewer');
+ await waitFor(() => {
+ expect(screen.getByTestId('viewer-count')).toHaveTextContent('1');
+ });
+ expect(screen.getByTestId('viewer-v1')).toHaveTextContent('v1');
});
- it('should handle empty plugin list', () => {
+ it('handles an empty plugin list', async () => {
render(
-
-
-
+
+
+ ,
);
- expect(screen.getByTestId('viewer-count')).toHaveTextContent('0');
+ await waitFor(() => {
+ expect(screen.getByTestId('viewer-count')).toHaveTextContent('0');
+ });
});
});
});
diff --git a/apps/studio/vitest.config.ts b/apps/studio/vitest.config.ts
index 262b4934a..9dde6d5c8 100644
--- a/apps/studio/vitest.config.ts
+++ b/apps/studio/vitest.config.ts
@@ -7,6 +7,12 @@ import react from '@vitejs/plugin-react';
import { TanStackRouterVite } from '@tanstack/router-plugin/vite';
import path from 'path';
+// NOTE: Keep the resolve.alias block in sync with vite.config.ts.
+// Studio depends on package subpaths (e.g. `@objectstack/plugin-auth/objects`)
+// that are not declared in those packages' exports maps; we alias them to
+// source files here so both `vite dev/build` and `vitest` can resolve them.
+const polyfillPath = path.resolve(__dirname, './mocks/node-polyfills.ts');
+
export default defineConfig({
plugins: [
TanStackRouterVite(),
@@ -15,7 +21,7 @@ export default defineConfig({
test: {
globals: true,
environment: 'happy-dom',
- setupFiles: ['./test/setup.ts'],
+ setupFiles: [path.resolve(__dirname, './test/setup.ts')],
coverage: {
reporter: ['text', 'json', 'html'],
exclude: [
@@ -31,8 +37,38 @@ export default defineConfig({
},
},
resolve: {
+ dedupe: ['react', 'react-dom'],
alias: {
+ 'react': path.resolve(__dirname, './node_modules/react'),
+ 'react-dom': path.resolve(__dirname, './node_modules/react-dom'),
'@': path.resolve(__dirname, './src'),
+ // System object definitions — resolve to plugin source (no runtime deps)
+ '@objectstack/plugin-auth/objects': path.resolve(__dirname, '../../packages/plugins/plugin-auth/src/objects/index.ts'),
+ '@objectstack/plugin-security/objects': path.resolve(__dirname, '../../packages/plugins/plugin-security/src/objects/index.ts'),
+ '@objectstack/plugin-audit/objects': path.resolve(__dirname, '../../packages/plugins/plugin-audit/src/objects/index.ts'),
+ // Node built-ins stubbed for browser-like test env
+ 'node:fs/promises': polyfillPath,
+ 'node:fs': polyfillPath,
+ 'node:events': polyfillPath,
+ 'node:stream': polyfillPath,
+ 'node:string_decoder': polyfillPath,
+ 'node:path': polyfillPath,
+ 'node:url': polyfillPath,
+ 'node:util': polyfillPath,
+ 'node:os': polyfillPath,
+ 'node:crypto': polyfillPath,
+ 'events': polyfillPath,
+ 'stream': polyfillPath,
+ 'string_decoder': polyfillPath,
+ 'path': polyfillPath,
+ 'fs/promises': polyfillPath,
+ 'fs': polyfillPath,
+ 'util': polyfillPath,
+ 'os': polyfillPath,
+ 'crypto': polyfillPath,
+ 'url': polyfillPath,
+ // Chokidar stub (not needed in the browser/test environment)
+ 'chokidar': path.resolve(__dirname, './src/mocks/noop.ts'),
},
},
});