Skip to content

Commit 7f2b6c1

Browse files
NiennienzzNiennienzz
authored
Merge pull request #7 from dragonflydb/joezhou/ad-server-cache-bun
feat(example): Ad server cache using Bun, ElysiaJS, and Dragonfly
2 parents eb8f9e1 + 05cc282 commit 7f2b6c1

File tree

8 files changed

+347
-0
lines changed

8 files changed

+347
-0
lines changed

‎ad-server-cache-bun/.gitignore

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
8+
# testing
9+
/coverage
10+
11+
# next.js
12+
/.next/
13+
/out/
14+
15+
# production
16+
/build
17+
18+
# misc
19+
.DS_Store
20+
*.pem
21+
22+
# debug
23+
npm-debug.log*
24+
yarn-debug.log*
25+
yarn-error.log*
26+
27+
# local env files
28+
.env.local
29+
.env.development.local
30+
.env.test.local
31+
.env.production.local
32+
33+
# vercel
34+
.vercel
35+
36+
**/*.trace
37+
**/*.zip
38+
**/*.tar.gz
39+
**/*.tgz
40+
**/*.log
41+
package-lock.json
42+
**/*.bun

‎ad-server-cache-bun/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Example: Ad Server using Bun, ElysiaJS, and Dragonfly
2+
3+
## Packages Used
4+
5+
- [ElysiaJS](https://elysiajs.com/) is a TypeScript framework supercharged by the [Bun](https://bun.sh/) runtime with end-to-end type safety.
6+
- [ioredis](https://github.com/redis/ioredis) is a Redis client for Node.js that can be used to interact with Dragonfly.
7+
- [typebox](https://github.com/sinclairzx81/typebox) is a JSON schema type builder and validator with static type resolution for TypeScript.
8+
9+
## Local Setup
10+
11+
- Make sure that you have [Bun v1.0.6+](https://bun.sh/) installed locally.
12+
- Make sure that you have [Docker](https://docs.docker.com/engine/install/) installed locally.
13+
14+
## Run Dragonfly & Service Application
15+
16+
- Run a Dragonfly instance using Docker:
17+
18+
```bash
19+
docker run -p 6379:6379 --ulimit memlock=-1 docker.dragonflydb.io/dragonflydb/dragonfly
20+
```
21+
22+
- Install dependencies and run the service application:
23+
24+
```bash
25+
# within the root directory of this example (dragonfly-examples/ad-server-cache-bun)
26+
bun install
27+
bun run dev # (or `bun dev`)
28+
```
29+
30+
- The ad server API would be running on `http://localhost:3000/`

‎ad-server-cache-bun/bun.lockb

8.42 KB
Binary file not shown.

‎ad-server-cache-bun/package.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"name": "ad-server-cache-bun",
3+
"version": "1.0.50",
4+
"scripts": {
5+
"test": "echo \"Error: no test specified\" && exit 1",
6+
"dev": "bun run --watch src/index.ts"
7+
},
8+
"dependencies": {
9+
"@sinclair/typebox": "^0.31.18",
10+
"elysia": "latest",
11+
"ioredis": "^5.3.2"
12+
},
13+
"devDependencies": {
14+
"bun-types": "latest"
15+
},
16+
"module": "src/index.js"
17+
}

‎ad-server-cache-bun/src/ads.ts

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
import {Redis as Dragonfly} from 'ioredis';
2+
import {Value} from '@sinclair/typebox/value'
3+
4+
import {AdMetadata, UserAdPreferences} from './types';
5+
6+
export class AdMetadataStore {
7+
private client: Dragonfly;
8+
static readonly AD_PREFIX = 'ad';
9+
static readonly AD_METADATA_PREFIX = `${AdMetadataStore.AD_PREFIX}:metadata`;
10+
static readonly AD_CATEGORY_PREFIX = `${AdMetadataStore.AD_PREFIX}:category`;
11+
static readonly AD_USER_PREFERENCE_PREFIX = `${AdMetadataStore.AD_PREFIX}:user_preference`;
12+
static readonly SET_MEMBER_COUNT = 10;
13+
14+
constructor(client: Dragonfly) {
15+
this.client = client;
16+
}
17+
18+
metadataKey(metadataId: string): string {
19+
return `${AdMetadataStore.AD_METADATA_PREFIX}:${metadataId}`;
20+
}
21+
22+
categoryKey(metadataCategory: string): string {
23+
return `${AdMetadataStore.AD_CATEGORY_PREFIX}:${metadataCategory}`;
24+
}
25+
26+
userPreferenceKey(userId: string): string {
27+
return `${AdMetadataStore.AD_USER_PREFERENCE_PREFIX}:${userId}`;
28+
}
29+
30+
async createAdMetadata(metadata: AdMetadata): Promise<void> {
31+
await this.client.hmset(this.metadataKey(metadata.id), metadata);
32+
await this.client.sadd(this.categoryKey(metadata.category), metadata.id);
33+
}
34+
35+
async createUserPreference(userAdPreferences: UserAdPreferences): Promise<void> {
36+
await this.client.sadd(this.userPreferenceKey(userAdPreferences.userId), userAdPreferences.categories);
37+
}
38+
39+
async getAdMetadataListByUserPreference(userId: string): Promise<Array<AdMetadata>> {
40+
const [_, categoryKeys] = await this.client.sscan(
41+
this.userPreferenceKey(userId),
42+
0,
43+
'COUNT',
44+
AdMetadataStore.SET_MEMBER_COUNT,
45+
);
46+
const pipeline = this.client.pipeline();
47+
categoryKeys.forEach((category: string) => {
48+
pipeline.sscan(
49+
this.categoryKey(category),
50+
0,
51+
'COUNT',
52+
AdMetadataStore.SET_MEMBER_COUNT,
53+
);
54+
});
55+
const results = await pipeline.exec();
56+
if (!results) {
57+
return [];
58+
}
59+
const adIds = results.map(([error, scanResult]) => {
60+
if (error) {
61+
throw error;
62+
}
63+
if (!scanResult) {
64+
return [];
65+
}
66+
// scanResult is a tuple of [string, Array<string>]
67+
// The 1st element is the cursor.
68+
// The 2nd element is the array of ids.
69+
const [_, ids] = scanResult as [string, Array<string>];
70+
return ids;
71+
}).flat();
72+
return await this.getAdMetadataList(adIds);
73+
}
74+
75+
async getAdMetadataList(ids: Array<string>): Promise<Array<AdMetadata>> {
76+
const pipeline = this.client.pipeline();
77+
ids.forEach((id: string) => {
78+
pipeline.hgetall(this.metadataKey(id))
79+
});
80+
const results = await pipeline.exec();
81+
if (!results) {
82+
return [];
83+
}
84+
return results.reduce((acc: Array<AdMetadata>, [error, hash]) => {
85+
if (error) {
86+
throw error;
87+
}
88+
if (!hash) {
89+
return acc;
90+
}
91+
if (!Value.Check(AdMetadata, hash)) {
92+
return acc;
93+
}
94+
acc.push(hash);
95+
return acc;
96+
}, []);
97+
}
98+
}

‎ad-server-cache-bun/src/index.ts

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
import {Elysia} from "elysia";
2+
import {Redis as Dragonfly} from 'ioredis';
3+
4+
import {AdMetadataStore} from "./ads";
5+
import {AdMetadata, UserAdPreferences} from "./types";
6+
7+
const client = new Dragonfly();
8+
9+
const app = new Elysia()
10+
.decorate("adMetadataCache", new AdMetadataStore(client))
11+
.get(
12+
"/ads/:userId",
13+
async (context) => {
14+
return await context.adMetadataCache.getAdMetadataListByUserPreference(context.params.userId);
15+
},
16+
)
17+
.post(
18+
"/ads",
19+
async (context) => {
20+
await context.adMetadataCache.createAdMetadata(context.body);
21+
context.set.status = 201;
22+
return;
23+
},
24+
{body: AdMetadata}
25+
)
26+
.post(
27+
"/ads/preferences",
28+
async (context) => {
29+
await context.adMetadataCache.createUserPreference(context.body);
30+
context.set.status = 201;
31+
return;
32+
},
33+
{body: UserAdPreferences}
34+
)
35+
.listen(3000);
36+
37+
console.log(
38+
`Ad server API is running at ${app.server?.hostname}:${app.server?.port}`
39+
);

‎ad-server-cache-bun/src/types.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
import {Type, Static} from '@sinclair/typebox'
2+
3+
export const AdMetadata = Type.Object({
4+
id: Type.String(),
5+
title: Type.String(),
6+
category: Type.String(),
7+
clickURL: Type.String(),
8+
imageURL: Type.String(),
9+
});
10+
11+
export type AdMetadata = Static<typeof AdMetadata>;
12+
13+
export const UserAdPreferences = Type.Object({
14+
userId: Type.String(),
15+
categories: Type.Array(Type.String()),
16+
});
17+
18+
export type UserAdPreferences = Static<typeof UserAdPreferences>;

‎ad-server-cache-bun/tsconfig.json

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
{
2+
"compilerOptions": {
3+
/* Visit https://aka.ms/tsconfig to read more about this file */
4+
5+
/* Projects */
6+
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
7+
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
8+
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
9+
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
10+
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
11+
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
12+
13+
/* Language and Environment */
14+
"target": "ES2021", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
15+
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
16+
// "jsx": "preserve", /* Specify what JSX code is generated. */
17+
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
18+
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
19+
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
20+
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
21+
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
22+
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
23+
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
24+
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
25+
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
26+
27+
/* Modules */
28+
"module": "ES2022", /* Specify what module code is generated. */
29+
// "rootDir": "./", /* Specify the root folder within your source files. */
30+
"moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
31+
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
32+
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
33+
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
34+
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
35+
"types": ["bun-types"], /* Specify type package names to be included without being referenced in a source file. */
36+
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
37+
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
38+
// "resolveJsonModule": true, /* Enable importing .json files. */
39+
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
40+
41+
/* JavaScript Support */
42+
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
43+
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
44+
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
45+
46+
/* Emit */
47+
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
48+
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
49+
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
50+
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
51+
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
52+
// "outDir": "./", /* Specify an output folder for all emitted files. */
53+
// "removeComments": true, /* Disable emitting comments. */
54+
// "noEmit": true, /* Disable emitting files from a compilation. */
55+
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
56+
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
57+
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
58+
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
59+
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
60+
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
61+
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
62+
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
63+
// "newLine": "crlf", /* Set the newline character for emitting files. */
64+
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
65+
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
66+
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
67+
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
68+
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
69+
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
70+
71+
/* Interop Constraints */
72+
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
73+
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
74+
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
75+
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
76+
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
77+
78+
/* Type Checking */
79+
"strict": true, /* Enable all strict type-checking options. */
80+
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
81+
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
82+
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
83+
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
84+
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
85+
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
86+
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
87+
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
88+
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
89+
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
90+
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
91+
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
92+
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
93+
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
94+
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
95+
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
96+
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
97+
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
98+
99+
/* Completeness */
100+
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
101+
"skipLibCheck": true /* Skip type checking all .d.ts files. */
102+
}
103+
}

0 commit comments

Comments
 (0)