Skip to content

Commit 16fa22c

Browse files
author
Deep Patidar
committed
feat: Implement template storage and management - Added TemplateStore with CRUD operations, updated API handlers to use TemplateStore, added error handling for template operations, and created comprehensive tests for TemplateStore
1 parent aa3144f commit 16fa22c

8 files changed

+357
-26
lines changed

‎server/.env

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Server Configuration
2+
HOST=localhost
3+
PORT=9000
4+
5+
# Other configuration variables can be added here as needed

‎server/index.ts

+74-12
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import Express from 'express';
44
import morgan from 'morgan';
55
import path from 'path';
66
import dotenv from 'dotenv';
7+
import { TemplateStore, TemplateNotFoundError, DuplicateTemplateError } from './src/services/TemplateStore';
78

89
// Load environment variables from .env file
910
dotenv.config({ path: path.join(__dirname, '..', '.env') });
@@ -16,23 +17,84 @@ app.use(Express.json());
1617
const openApiPath = path.join(__dirname, '..', '..', 'openapi.json');
1718
console.log(openApiPath);
1819

20+
// Initialize template store
21+
const templateStore = new TemplateStore();
22+
1923
// define api
2024
const api = new OpenAPIBackend({
2125
quick: true, // disabled validation of OpenAPI on load
2226
definition: openApiPath,
2327
handlers: {
24-
listTemplates: async (c: Context, req: Express.Request, res: Express.Response) =>
25-
res.status(200).json([]),
26-
createTemplate: async (c: Context, req: Express.Request, res: Express.Response) =>
27-
res.status(200).json({}),
28-
getTemplate: async (c: Context, req: Express.Request, res: Express.Response) =>
29-
res.status(200).json({}),
30-
replaceTemplate: async (c: Context, req: Express.Request, res: Express.Response) =>
31-
res.status(200).json({}),
32-
deleteTemplate: async (c: Context, req: Express.Request, res: Express.Response) =>
33-
res.status(200).json({}),
34-
validationFail: async (c: Context, req: ExpressReq, res: ExpressRes) => res.status(400).json({ err: c.validation.errors }),
35-
notFound: async (c: Context, req: ExpressReq, res: ExpressRes) => res.status(404).json({ err: 'not found' }),
28+
listTemplates: async (c: Context, req: Express.Request, res: Express.Response) => {
29+
try {
30+
const templates = await templateStore.listTemplates();
31+
res.status(200).json(templates);
32+
} catch (error) {
33+
console.error('Error listing templates:', error);
34+
res.status(500).json({ error: 'Internal server error' });
35+
}
36+
},
37+
createTemplate: async (c: Context, req: Express.Request, res: Express.Response) => {
38+
try {
39+
const template = await templateStore.createTemplate(req.body);
40+
res.status(201).json(template);
41+
} catch (error) {
42+
if (error instanceof DuplicateTemplateError) {
43+
res.status(409).json({ error: error.message });
44+
} else {
45+
console.error('Error creating template:', error);
46+
res.status(500).json({ error: 'Internal server error' });
47+
}
48+
}
49+
},
50+
getTemplate: async (c: Context, req: Express.Request, res: Express.Response) => {
51+
try {
52+
const id = Array.isArray(c.request.params.id) ? c.request.params.id[0] : c.request.params.id;
53+
const template = await templateStore.getTemplate(id);
54+
res.status(200).json(template);
55+
} catch (error) {
56+
if (error instanceof TemplateNotFoundError) {
57+
res.status(404).json({ error: error.message });
58+
} else {
59+
console.error('Error getting template:', error);
60+
res.status(500).json({ error: 'Internal server error' });
61+
}
62+
}
63+
},
64+
replaceTemplate: async (c: Context, req: Express.Request, res: Express.Response) => {
65+
try {
66+
const id = Array.isArray(c.request.params.id) ? c.request.params.id[0] : c.request.params.id;
67+
const template = await templateStore.updateTemplate(id, req.body);
68+
res.status(200).json(template);
69+
} catch (error) {
70+
if (error instanceof TemplateNotFoundError) {
71+
res.status(404).json({ error: error.message });
72+
} else if (error instanceof DuplicateTemplateError) {
73+
res.status(409).json({ error: error.message });
74+
} else {
75+
console.error('Error updating template:', error);
76+
res.status(500).json({ error: 'Internal server error' });
77+
}
78+
}
79+
},
80+
deleteTemplate: async (c: Context, req: Express.Request, res: Express.Response) => {
81+
try {
82+
const id = Array.isArray(c.request.params.id) ? c.request.params.id[0] : c.request.params.id;
83+
await templateStore.deleteTemplate(id);
84+
res.status(204).send();
85+
} catch (error) {
86+
if (error instanceof TemplateNotFoundError) {
87+
res.status(404).json({ error: error.message });
88+
} else {
89+
console.error('Error deleting template:', error);
90+
res.status(500).json({ error: 'Internal server error' });
91+
}
92+
}
93+
},
94+
validationFail: async (c: Context, req: ExpressReq, res: ExpressRes) =>
95+
res.status(400).json({ error: c.validation.errors }),
96+
notFound: async (c: Context, req: ExpressReq, res: ExpressRes) =>
97+
res.status(404).json({ error: 'not found' }),
3698
notImplemented: async (c: Context, req: ExpressReq, res: ExpressRes) => {
3799
const { status, mock } = c.api.mockResponseForOperation(c.operation.operationId);
38100
return res.status(status).json(mock);

‎server/jest.config.js

+8-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
module.exports = {
2-
preset: 'ts-jest',
3-
testEnvironment: 'node',
4-
testMatch: [ '**/?(*.)+(spec|test).ts?(x)' ]
5-
};
2+
preset: 'ts-jest',
3+
testEnvironment: 'node',
4+
roots: ['<rootDir>/src'],
5+
testMatch: ['**/*.test.ts'],
6+
transform: {
7+
'^.+\\.tsx?$': 'ts-jest'
8+
}
9+
};

‎server/package-lock.json

+26-7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎server/package.json

+5-3
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,20 @@
99
"postinstall": "npm run build",
1010
"build": "tsc",
1111
"watch-build": "tsc -w",
12-
"start": "node dist/index.js",
12+
"start": "ts-node index.ts",
1313
"watch-start": "nodemon --delay 2 -w dist/ -x 'npm run start'",
1414
"dev": "concurrently -k -p '[{name}]' -n 'typescript,api' -c 'yellow.bold,cyan.bold' npm:watch-build npm:watch-start",
1515
"lint": "tslint --format prose --project .",
1616
"test": "jest"
1717
},
1818
"dependencies": {
19+
"@types/uuid": "^10.0.0",
1920
"dotenv": "^16.4.5",
2021
"express": "^4.17.1",
2122
"morgan": "^1.10.0",
2223
"openapi-backend": "^5.2.0",
23-
"source-map-support": "^0.5.19"
24+
"source-map-support": "^0.5.19",
25+
"uuid": "^11.1.0"
2426
},
2527
"devDependencies": {
2628
"@types/express": "^4.17.21",
@@ -36,4 +38,4 @@
3638
"typescript": "^5.3.3",
3739
"wait-on": "^3.2.0"
3840
}
39-
}
41+
}

‎server/src/services/TemplateStore.test.ts

+145
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
import { TemplateStore, TemplateNotFoundError, DuplicateTemplateError } from './TemplateStore';
2+
3+
describe('TemplateStore', () => {
4+
let store: TemplateStore;
5+
6+
beforeEach(() => {
7+
store = new TemplateStore();
8+
});
9+
10+
describe('createTemplate', () => {
11+
it('should create a new template', async () => {
12+
const template = await store.createTemplate({
13+
name: 'Test Template',
14+
content: 'Test Content',
15+
metadata: { version: '1.0' }
16+
});
17+
18+
expect(template.id).toBeDefined();
19+
expect(template.name).toBe('Test Template');
20+
expect(template.content).toBe('Test Content');
21+
expect(template.metadata).toEqual({ version: '1.0' });
22+
expect(template.createdAt).toBeInstanceOf(Date);
23+
expect(template.updatedAt).toBeInstanceOf(Date);
24+
});
25+
26+
it('should throw DuplicateTemplateError for duplicate names', async () => {
27+
await store.createTemplate({
28+
name: 'Test Template',
29+
content: 'Test Content'
30+
});
31+
32+
await expect(store.createTemplate({
33+
name: 'Test Template',
34+
content: 'Different Content'
35+
})).rejects.toThrow(DuplicateTemplateError);
36+
});
37+
});
38+
39+
describe('getTemplate', () => {
40+
it('should retrieve an existing template', async () => {
41+
const created = await store.createTemplate({
42+
name: 'Test Template',
43+
content: 'Test Content'
44+
});
45+
46+
const retrieved = await store.getTemplate(created.id);
47+
expect(retrieved).toEqual(created);
48+
});
49+
50+
it('should throw TemplateNotFoundError for non-existent template', async () => {
51+
await expect(store.getTemplate('non-existent-id'))
52+
.rejects.toThrow(TemplateNotFoundError);
53+
});
54+
});
55+
56+
describe('updateTemplate', () => {
57+
it('should update an existing template', async () => {
58+
const created = await store.createTemplate({
59+
name: 'Test Template',
60+
content: 'Test Content'
61+
});
62+
63+
// Add a small delay to ensure updatedAt will be different
64+
await new Promise(resolve => setTimeout(resolve, 1));
65+
66+
const updated = await store.updateTemplate(created.id, {
67+
name: 'Updated Template',
68+
content: 'Updated Content'
69+
});
70+
71+
expect(updated.id).toBe(created.id);
72+
expect(updated.name).toBe('Updated Template');
73+
expect(updated.content).toBe('Updated Content');
74+
expect(updated.createdAt).toEqual(created.createdAt);
75+
expect(updated.updatedAt).toBeInstanceOf(Date);
76+
expect(updated.updatedAt.getTime()).toBeGreaterThan(created.updatedAt.getTime());
77+
});
78+
79+
it('should throw TemplateNotFoundError for non-existent template', async () => {
80+
await expect(store.updateTemplate('non-existent-id', {
81+
name: 'Test',
82+
content: 'Test'
83+
})).rejects.toThrow(TemplateNotFoundError);
84+
});
85+
86+
it('should throw DuplicateTemplateError when updating to existing name', async () => {
87+
await store.createTemplate({
88+
name: 'Template 1',
89+
content: 'Content 1'
90+
});
91+
92+
const template2 = await store.createTemplate({
93+
name: 'Template 2',
94+
content: 'Content 2'
95+
});
96+
97+
await expect(store.updateTemplate(template2.id, {
98+
name: 'Template 1',
99+
content: 'Updated Content'
100+
})).rejects.toThrow(DuplicateTemplateError);
101+
});
102+
});
103+
104+
describe('deleteTemplate', () => {
105+
it('should delete an existing template', async () => {
106+
const created = await store.createTemplate({
107+
name: 'Test Template',
108+
content: 'Test Content'
109+
});
110+
111+
await store.deleteTemplate(created.id);
112+
await expect(store.getTemplate(created.id))
113+
.rejects.toThrow(TemplateNotFoundError);
114+
});
115+
116+
it('should throw TemplateNotFoundError for non-existent template', async () => {
117+
await expect(store.deleteTemplate('non-existent-id'))
118+
.rejects.toThrow(TemplateNotFoundError);
119+
});
120+
});
121+
122+
describe('listTemplates', () => {
123+
it('should return empty array when no templates exist', async () => {
124+
const templates = await store.listTemplates();
125+
expect(templates).toEqual([]);
126+
});
127+
128+
it('should return all created templates', async () => {
129+
const template1 = await store.createTemplate({
130+
name: 'Template 1',
131+
content: 'Content 1'
132+
});
133+
134+
const template2 = await store.createTemplate({
135+
name: 'Template 2',
136+
content: 'Content 2'
137+
});
138+
139+
const templates = await store.listTemplates();
140+
expect(templates).toHaveLength(2);
141+
expect(templates).toContainEqual(template1);
142+
expect(templates).toContainEqual(template2);
143+
});
144+
});
145+
});

0 commit comments

Comments
 (0)