mirror of
https://github.com/michivonah/themepark-assistant.git
synced 2025-12-22 22:16:29 +01:00
add KV namespaces & implement sending of notifications if waittime changes
This commit is contained in:
parent
c1336fbc88
commit
fd042118ad
7 changed files with 193 additions and 5 deletions
|
|
@ -1,5 +1,5 @@
|
|||
# themepark-assistant
|
||||
A tool for improving your trips to themepark - once developed
|
||||
A tool for improving your trips to themeparks - once developed
|
||||
|
||||
## Testing
|
||||
Send request
|
||||
|
|
@ -16,6 +16,12 @@ apply changes
|
|||
npx drizzle-kit push --config=drizzle-dev.config.ts
|
||||
```
|
||||
|
||||
## SQLite / D1
|
||||
Delete view
|
||||
```sql
|
||||
DROP VIEW IF EXISTS attraction_subscriptions;
|
||||
```
|
||||
|
||||
## Cloudflare workers tricks
|
||||
If types are missing, run:
|
||||
```bash
|
||||
|
|
|
|||
|
|
@ -29,7 +29,13 @@ export const notificationMethod = sqliteTable('notification_method', {
|
|||
id: integer().primaryKey({ autoIncrement: true }),
|
||||
webhookUrl: text().notNull(),
|
||||
shownName: text().notNull(),
|
||||
userId: integer().notNull().references(() => user.id)
|
||||
userId: integer().notNull().references(() => user.id),
|
||||
notificationProviderId: integer().notNull().references(() => notificationProvider.id),
|
||||
})
|
||||
|
||||
export const notificationProvider = sqliteTable('notification_provider', {
|
||||
id: integer().primaryKey({ autoIncrement: true }),
|
||||
name: text().notNull().unique()
|
||||
})
|
||||
|
||||
export const themepark = sqliteTable('themepark', {
|
||||
|
|
@ -59,9 +65,11 @@ export const attractionSubscriptions = sqliteView('attraction_subscriptions').as
|
|||
qb.selectDistinct({
|
||||
attractionApiCode: sql<string>`attraction.api_code`.as('attraction_api_code'),
|
||||
themeparkApiName: sql<string>`themepark.api_name`.as('themepark_api_name'),
|
||||
webhookUrl: sql<string>`notification_method.webhook_url`.as('webhook_url')
|
||||
webhookUrl: sql<string>`notification_method.webhook_url`.as('webhook_url'),
|
||||
notificationProviderName: sql<string>`notification_provider.name`.as('notification_provider_name'),
|
||||
}).from(attractionNotification)
|
||||
.innerJoin(attraction, eq(attractionNotification.attractionId, attraction.id))
|
||||
.innerJoin(themepark, eq(attraction.themeparkId, themepark.id))
|
||||
.innerJoin(notificationMethod, eq(attractionNotification.notificationMethodId, notificationMethod.id))
|
||||
.innerJoin(notificationProvider, eq(notificationMethod.notificationProviderId, notificationProvider.id))
|
||||
);
|
||||
|
|
@ -1,6 +1,7 @@
|
|||
// Cron Router
|
||||
import { updateThemeparkData } from "./update-themepark-data";
|
||||
import { batchAttractionImport } from "./update-attraction-list";
|
||||
import updateWaittimes from "./send-notifications";
|
||||
|
||||
export default async function cronRouter(
|
||||
event: ScheduledEvent,
|
||||
|
|
@ -9,7 +10,7 @@ export default async function cronRouter(
|
|||
){
|
||||
switch (event.cron){
|
||||
case '*/5 * * * *':
|
||||
console.log('every 5 minutes');
|
||||
await updateWaittimes(env);
|
||||
break;
|
||||
case '0 1-6 7,14,21,28 * *':
|
||||
await batchAttractionImport(env, event.scheduledTime, event.cron);
|
||||
|
|
|
|||
159
api/src/jobs/send-notifications.ts
Normal file
159
api/src/jobs/send-notifications.ts
Normal file
|
|
@ -0,0 +1,159 @@
|
|||
import { AttractionImport, AttractionChanges } from "../types/attraction";
|
||||
import { getDbEnv } from '../db/client'
|
||||
import { subscribedThemeparks, attractionSubscriptions } from "../db/schema";
|
||||
import { SubscribedThemeparks } from "../types/subscribed-themeparks";
|
||||
import { AttractionSubscription } from "../types/attraction-subscriptions";
|
||||
import httpRequest from "../lib/http-request";
|
||||
import fetchAttractions from "../lib/fetch-attractions";
|
||||
|
||||
/**
|
||||
* Default function which connects all components to update the
|
||||
* waittime in cache & send notification about changes in waittime.
|
||||
* @param env Connection to Cloudflare
|
||||
*/
|
||||
export default async function updateWaittimes(env: Env): Promise<void>{
|
||||
const db = getDbEnv(env);
|
||||
const subscribedParks = await db.select().from(subscribedThemeparks);
|
||||
const subscriptions = await db.select().from(attractionSubscriptions);
|
||||
|
||||
for(let park of subscribedParks){
|
||||
const currentWaittimes = await fetchAttractions(park.apiName);
|
||||
const cachedWaittimes = await getJsonFromKV<AttractionImport[]>(env, park.apiName, []);
|
||||
|
||||
const changes = compareWaittimes(cachedWaittimes, currentWaittimes);
|
||||
|
||||
if(changes.length > 0){
|
||||
await notifyAboutChanges(subscriptions, changes, park);
|
||||
await cacheWaittimes(env, park.apiName, currentWaittimes);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves the waittime of a specified themepark into KV namespace
|
||||
* @param env KV connection
|
||||
* @param themepark Themepark name to use as key in KV
|
||||
* @param waittimes Object with the waittimes to save in cache
|
||||
*/
|
||||
async function cacheWaittimes(env: Env, themepark: string, waittimes: AttractionImport[]){
|
||||
await env.waittime_cache.put(themepark, JSON.stringify(waittimes));
|
||||
}
|
||||
|
||||
/**
|
||||
* Load value for specified key from KV and tries to parse as JSON
|
||||
* @param env KV connection
|
||||
* @param key Key to get value from
|
||||
* @param defaultValue Default value to return if key is empty/not defined
|
||||
* @returns Value of key from KV as defined type
|
||||
*/
|
||||
async function getJsonFromKV<T>(env: Env, key: string, defaultValue: T): Promise<T>{
|
||||
const cache = await env.waittime_cache.get(key);
|
||||
if(!cache) return defaultValue;
|
||||
|
||||
try{
|
||||
return JSON.parse(cache) as T;
|
||||
}
|
||||
catch(e){
|
||||
throw new Error(`Failed to parse JSON from KV, affected key: ${key}, error: ${e}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Compares the waittimes of two objects from the type AttractionImport
|
||||
* @param cached The cached/old object of the waittimes
|
||||
* @param current The current object with the newer waittimes
|
||||
* @returns An object of type AttractionChanges (booleans for changes -> increase)
|
||||
*/
|
||||
function compareWaittimes(cached: AttractionImport[], current: AttractionImport[]): AttractionChanges[]{
|
||||
const cachedMap = new Map(cached.map(obj => [obj.code, obj]));
|
||||
let changes: AttractionChanges[] = [];
|
||||
|
||||
current.forEach(attraction => {
|
||||
const cachedTime = cachedMap.get(attraction.code)?.waitingtime;
|
||||
const currentTime = attraction.waitingtime;
|
||||
|
||||
if(attraction.status !== "opened") return;
|
||||
|
||||
if((currentTime ?? 0) > (cachedTime ?? 0)){
|
||||
changes.push({
|
||||
apiCode: attraction.code,
|
||||
name: attraction.name,
|
||||
waittime: currentTime,
|
||||
hasChanged: true,
|
||||
increased: true
|
||||
});
|
||||
}
|
||||
else if((currentTime ?? 0) < (cachedTime ?? 0)){
|
||||
changes.push({
|
||||
apiCode: attraction.code,
|
||||
name: attraction.name,
|
||||
waittime: currentTime,
|
||||
hasChanged: true,
|
||||
increased: false
|
||||
})
|
||||
}
|
||||
});
|
||||
|
||||
return changes;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a message to a specified webhook endpoint
|
||||
* @param webhookUrl The webhook's POST URL to send the request to
|
||||
* @param message The message to send to the webhook
|
||||
* @param type The type of notification (discord, slack, ntfy)
|
||||
*/
|
||||
// TODO: implement support for custom webhook providers (https://github.com/michivonah/themepark-assistant/issues/1) -> read templates from DB instead of switch case
|
||||
async function sendNotification(webhookUrl: string, message: string, type: string): Promise<void>{
|
||||
try{
|
||||
let body: Record<string, string> | string;
|
||||
|
||||
switch(type){
|
||||
case 'discord':
|
||||
body = {
|
||||
'content':message
|
||||
}
|
||||
break;
|
||||
case 'slack':
|
||||
body = {
|
||||
'text':message
|
||||
}
|
||||
break;
|
||||
case 'ntfy':
|
||||
default:
|
||||
body = message;
|
||||
break;
|
||||
}
|
||||
|
||||
await httpRequest(webhookUrl, {
|
||||
method:'POST',
|
||||
body:body
|
||||
});
|
||||
}
|
||||
catch(e){
|
||||
throw new Error(`Failed to send notification: ${e}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends notification about changes in waittime to a defined list of subscribers
|
||||
* @param subscriptions Object of subscribed attractions with associated webhook URL
|
||||
* @param changes Object of the changes at waittime
|
||||
* @param themepark The API name of the themepark which should be checked for subscriptions
|
||||
*/
|
||||
async function notifyAboutChanges(subscriptions: AttractionSubscription[], changes: AttractionChanges[], themepark: SubscribedThemeparks){
|
||||
const changeMap = new Map(changes.map(c => [c.apiCode, c]));
|
||||
|
||||
const subscribedChanges = subscriptions.filter(sub =>
|
||||
sub.themeparkApiName === themepark.apiName && changeMap.has(sub.attractionApiCode)
|
||||
);
|
||||
|
||||
subscribedChanges.forEach(sub => {
|
||||
const change = changeMap.get(sub.attractionApiCode);
|
||||
|
||||
if(change && change.hasChanged){
|
||||
const message = `Waittime for ${change.name} ${change.increased ? 'increased' : 'sank'} to ${change.waittime} minutes!`;
|
||||
sendNotification(sub.webhookUrl, message, sub.notificationProviderName);
|
||||
}
|
||||
});
|
||||
}
|
||||
5
api/src/types/notification-provider.ts
Normal file
5
api/src/types/notification-provider.ts
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
import { type InferSelectModel, type InferInsertModel } from 'drizzle-orm';
|
||||
import { notificationProvider } from '../db/schema';
|
||||
|
||||
export type NotificationProvider = InferInsertModel<typeof notificationProvider>
|
||||
export type NotificationProviderSelect = InferSelectModel<typeof notificationProvider>
|
||||
4
api/worker-configuration.d.ts
vendored
4
api/worker-configuration.d.ts
vendored
|
|
@ -1,10 +1,12 @@
|
|||
/* eslint-disable */
|
||||
// Generated by Wrangler by running `wrangler types` (hash: c639935623921ec3a10a77e49ca2a486)
|
||||
// Generated by Wrangler by running `wrangler types` (hash: aceadb651dd4392a981fdd98096a2639)
|
||||
// Runtime types generated with workerd@1.20250902.0 2025-09-07
|
||||
declare namespace Cloudflare {
|
||||
interface Env {
|
||||
waittime_cache: KVNamespace;
|
||||
CLOUDFLARE_ACCOUNT_ID: string;
|
||||
CLOUDFLARE_DATABASE_ID: string;
|
||||
CLOUDFLARE_DATABASE_ID_DEV: string;
|
||||
CLOUDFLARE_D1_TOKEN: string;
|
||||
d1_db: D1Database;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -30,6 +30,13 @@
|
|||
"migrations_dir": "drizzle/migrations"
|
||||
}
|
||||
],
|
||||
"kv_namespaces": [
|
||||
{
|
||||
"binding": "waittime_cache",
|
||||
"id": "496e1b5c3a1d4211b5f63315dd1423e3",
|
||||
"preview_id": "1a44ab1983f04d9e90d035b6f11ccb09"
|
||||
}
|
||||
],
|
||||
"triggers": {
|
||||
"crons": [
|
||||
"0 1-6 7,14,21,28 * *", // Each hour from 01:00 to 06:00 on day-of-month 7, 14, 21, and 28. -> update attraction list
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue