Skip to content

Commit b9ac9da

Browse files
yaroslav8765yaroslav8765
committed
dev-demo: add key-value adapters tests and update docs for the kv resource adapter
AdminForth/1735/kv-adapters-and-storage-s3-com
1 parent 2109f4b commit b9ac9da

4 files changed

Lines changed: 87 additions & 39 deletions

File tree

‎adminforth/documentation/docs/tutorial/06-Adapters/07-key-value-adapters.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,9 @@ model key_values {
7878
key String @id
7979
value String
8080
collection String?
81+
82+
@@index([key])
83+
@@index([collection])
8184
}
8285
```
8386

‎dev-demo/api.ts‎

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ import * as z from "zod";
44
import TwoFactorsAuthPlugin from "../plugins/adminforth-two-factors-auth/index.js";
55
import { levelDbAdapter, resourceAdapter } from './utils.js';
66

7+
const CURRENT_KV_ADAPTER = resourceAdapter;
8+
79
const DASHBOARD_CAR_SOURCES = [
810
{ resourceId: 'cars_sl', label: 'SQLite' },
911
{ resourceId: 'cars_mysql', label: 'MySQL' },
@@ -189,27 +191,42 @@ export function initApi(app: Express, admin: IAdminForth) {
189191
}
190192
)
191193
);
192-
app.post(`${admin.config.baseUrl}/api/getLevelDbKeys/`,
194+
app.post(`${admin.config.baseUrl}/api/keyValue/list/`,
193195
admin.express.authorize(
194196
async (_req: IAdminUserExpressRequest, res: Response) => {
195-
console.log('Received getLevelDbKeys');
197+
console.log('Received keyValue/list');
196198
const { prefix } = _req.body;
197-
const keys = await resourceAdapter.listByPrefix(prefix, 100);
199+
const keys = await CURRENT_KV_ADAPTER.listByPrefix(prefix, 100, 'dev-demo');
198200
res.json({ keys });
199201
}
200202
)
201203
);
202-
app.post(`${admin.config.baseUrl}/api/addLevelDbKey/`,
204+
app.post(`${admin.config.baseUrl}/api/keyValue/set/`,
203205
admin.express.authorize(
204206
async (_req: IAdminUserExpressRequest, res: Response) => {
205-
console.log('Received addLevelDbKey');
207+
console.log('Received keyValue/set');
206208
const {key, value} = _req.body;
207-
await resourceAdapter.set(key, value);
208-
// for (let i = 0; i < 100; i++) {
209-
// await levelDbAdapter.set(`clean=true||${new Date().toISOString()}||record_${i}`, `true`);
210-
// console.log(`Added record ${i}`);
211-
// await new Promise((resolve) => setTimeout(resolve, 100));
212-
// }
209+
await CURRENT_KV_ADAPTER.set(key, value, undefined, 'dev-demo');
210+
res.json({ ok: true });
211+
}
212+
)
213+
);
214+
app.post(`${admin.config.baseUrl}/api/keyValue/get/`,
215+
admin.express.authorize(
216+
async (_req: IAdminUserExpressRequest, res: Response) => {
217+
console.log('Received keyValue/get');
218+
const { key } = _req.body;
219+
const value = await CURRENT_KV_ADAPTER.get(key, 'dev-demo');
220+
res.json({ key, value });
221+
}
222+
)
223+
);
224+
app.post(`${admin.config.baseUrl}/api/keyValue/delete/`,
225+
admin.express.authorize(
226+
async (_req: IAdminUserExpressRequest, res: Response) => {
227+
console.log('Received keyValue/delete');
228+
const { key } = _req.body;
229+
await CURRENT_KV_ADAPTER.delete(key, 'dev-demo');
213230
res.json({ ok: true });
214231
}
215232
)

‎dev-demo/custom/SystemTest.vue‎

Lines changed: 53 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,25 @@
33
<div class="grid gap-4 md:grid-cols-2">
44
<section class="rounded-xl border border-slate-200 bg-slate-50 p-4">
55
<div class="mb-3 text-xs font-semibold uppercase tracking-wider text-slate-500">
6-
LevelDB
6+
Key/Value
77
</div>
88
<div class="flex flex-col gap-3">
99
<div class="flex w-full gap-3">
10-
<Input class="w-full" v-model="levelDbKey" placeholder="LevelDB key" />
11-
<Input class="w-full" v-model="levelDbValue" placeholder="LevelDB value" />
10+
<Input class="w-full" v-model="kvKey" placeholder="Key" />
11+
<Input class="w-full" v-model="kvValue" placeholder="Value" />
1212
</div>
13-
<Button class="w-full" @click="addLevelDbKeyValue">
14-
Add level DB key/value
13+
<Button class="w-full" @click="setKeyValue">
14+
Set key/value
1515
</Button>
16-
<Input class="w-full" v-model="levelDbPrefix" placeholder="LevelDB prefix" />
17-
<Button class="w-full" @click="getLevelDbKeys">
18-
Get level db keys
16+
<Button class="w-full" @click="getKey">
17+
Get key
18+
</Button>
19+
<Button class="w-full" @click="deleteKey">
20+
Delete key
21+
</Button>
22+
<Input class="w-full" v-model="kvPrefix" placeholder="Prefix" />
23+
<Button class="w-full" @click="listKeys">
24+
List keys by prefix
1925
</Button>
2026
</div>
2127
</section>
@@ -95,9 +101,9 @@ import { useTwoFactorsAuth } from '@/custom/plugins/TwoFactorsAuthPlugin/use2faA
95101
96102
const { get2FaConfirmationResult } = useTwoFactorsAuth();
97103
const valueStart = ref()
98-
const levelDbKey = ref('');
99-
const levelDbValue = ref('');
100-
const levelDbPrefix = ref('');
104+
const kvKey = ref('');
105+
const kvValue = ref('');
106+
const kvPrefix = ref('');
101107
const lastApiOutput = ref('No output yet. Click a button to run an action.');
102108
103109
function setLastApiOutput(actionName: string, data: unknown, isError = false) {
@@ -113,32 +119,54 @@ watch(valueStart, (newVal) => {
113119
console.log('New start value:', newVal);
114120
});
115121
116-
async function addLevelDbKeyValue() {
122+
async function setKeyValue() {
117123
try {
118124
const response = await callApi({
119-
path: '/api/addLevelDbKey/',
125+
path: '/api/keyValue/set/',
120126
method: 'POST',
121127
body: {
122-
key: levelDbKey.value,
123-
value: levelDbValue.value,
128+
key: kvKey.value,
129+
value: kvValue.value,
124130
},
125131
});
126-
console.log('LevelDB key/value added:', response);
127-
setLastApiOutput('Add level DB key/value', response);
132+
console.log('Key/value set:', response);
133+
setLastApiOutput('Set key/value', response);
134+
} catch (error) {
135+
console.error('Error setting key/value:', error);
136+
setLastApiOutput('Set key/value', String(error), true);
137+
}
138+
}
139+
140+
async function getKey() {
141+
try {
142+
const response = await callApi({ path: '/api/keyValue/get/', method: 'POST', body: { key: kvKey.value } });
143+
console.log('Key value:', response);
144+
setLastApiOutput('Get key', response);
145+
} catch (error) {
146+
console.error('Error getting key:', error);
147+
setLastApiOutput('Get key', String(error), true);
148+
}
149+
}
150+
151+
async function deleteKey() {
152+
try {
153+
const response = await callApi({ path: '/api/keyValue/delete/', method: 'POST', body: { key: kvKey.value } });
154+
console.log('Key deleted:', response);
155+
setLastApiOutput('Delete key', response);
128156
} catch (error) {
129-
console.error('Error adding LevelDB key/value:', error);
130-
setLastApiOutput('Add level DB key/value', String(error), true);
157+
console.error('Error deleting key:', error);
158+
setLastApiOutput('Delete key', String(error), true);
131159
}
132160
}
133161
134-
async function getLevelDbKeys() {
162+
async function listKeys() {
135163
try {
136-
const response = await callApi({ path: '/api/getLevelDbKeys/', method: 'POST', body: { prefix: levelDbPrefix.value } });
137-
console.log('LevelDB keys:', response);
138-
setLastApiOutput('Get level db keys', response);
164+
const response = await callApi({ path: '/api/keyValue/list/', method: 'POST', body: { prefix: kvPrefix.value } });
165+
console.log('Keys:', response);
166+
setLastApiOutput('List keys by prefix', response);
139167
} catch (error) {
140-
console.error('Error getting LevelDB keys:', error);
141-
setLastApiOutput('Get level db keys', String(error), true);
168+
console.error('Error listing keys:', error);
169+
setLastApiOutput('List keys by prefix', String(error), true);
142170
}
143171
}
144172

‎dev-demo/resources/key_value_resource.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ export default {
2929
allowedActions: {
3030
list: allowedForSuperAdmins,
3131
show: allowedForSuperAdmins,
32-
create: false,
33-
edit: false,
34-
delete: false,
32+
create: allowedForSuperAdmins,
33+
edit: allowedForSuperAdmins,
34+
delete: allowedForSuperAdmins,
3535
},
3636
},
3737
} as AdminForthResourceInput;

0 commit comments

Comments
 (0)