Merge pull request #33 from constructive-io/lucas/node-sql-template-v2

feat(node-sql): add SQL-based function template with example

Author: theothersideofgod

functions/sql-example/__tests__/handler.test.ts

@@ -0,0 +1,74 @@
+const mockQuery = jest.fn();
+const mockRelease = jest.fn();
+
+const createMockContext = () => {
+  const mockClient = {
+    query: mockQuery,
+    release: mockRelease,
+  };
+
+  return {
+    job: {
+      jobId: 'test-job-id',
+      workerId: 'test-worker',
+      databaseId: 'test-db',
+    },
+    pool: {
+      connect: jest.fn().mockResolvedValue(mockClient),
+    },
+    withUserContext: jest.fn(async (_actorId: string | undefined, fn: (client: typeof mockClient) => Promise<unknown>) => {
+      return fn(mockClient);
+    }),
+    log: {
+      info: jest.fn(),
+      error: jest.fn(),
+      warn: jest.fn(),
+    },
+    env: {},
+  };
+};
+
+const loadHandler = () => {
+  const mod = require('../handler');
+  return mod.default ?? mod;
+};
+
+describe('sql-example handler', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+    mockQuery.mockReset();
+  });
+
+  it('should execute default query (SELECT version()) when no query provided', async () => {
+    const handler = loadHandler();
+    const context = createMockContext();
+    mockQuery.mockResolvedValueOnce({ rows: [{ version: 'PostgreSQL 15.0' }] });
+
+    const result = await handler({}, context);
+
+    expect(result.success).toBe(true);
+    expect(result.message).toBe('Query executed successfully');
+    expect(context.withUserContext).toHaveBeenCalledWith(undefined, expect.any(Function));
+  });
+
+  it('should execute custom query', async () => {
+    const handler = loadHandler();
+    const context = createMockContext();
+    mockQuery.mockResolvedValueOnce({ rows: [{ count: 5 }] });
+
+    const result = await handler({ query: 'SELECT count(*) FROM users' }, context);
+
+    expect(result.success).toBe(true);
+    expect(result.data).toEqual([{ count: 5 }]);
+  });
+
+  it('should pass actor_id to withUserContext', async () => {
+    const handler = loadHandler();
+    const context = createMockContext();
+    mockQuery.mockResolvedValueOnce({ rows: [] });
+
+    await handler({ actor_id: 'user-123' }, context);
+
+    expect(context.withUserContext).toHaveBeenCalledWith('user-123', expect.any(Function));
+  });
+});

functions/sql-example/handler.json

@@ -0,0 +1,6 @@
+{
+  "name": "sql-example",
+  "version": "1.0.0",
+  "type": "node-sql",
+  "description": "Example function using node-sql template for direct PostgreSQL access"
+}

functions/sql-example/handler.ts

@@ -0,0 +1,34 @@
+import type { FunctionHandler } from './types';
+
+type Params = {
+  query?: string;
+  actor_id?: string;
+};
+
+type Result = {
+  success: boolean;
+  message: string;
+  data?: unknown;
+};
+
+const handler: FunctionHandler<Params, Result> = async (params, context) => {
+  const { log, withUserContext } = context;
+  const { query = 'SELECT version()', actor_id } = params;
+
+  log.info('[sql-example] Executing query', { query, actor_id });
+
+  const result = await withUserContext(actor_id, async (client) => {
+    const res = await client.query(query);
+    return res.rows;
+  });
+
+  log.info('[sql-example] Query complete', { rowCount: result.length });
+
+  return {
+    success: true,
+    message: 'Query executed successfully',
+    data: result,
+  };
+};
+
+export default handler;