Migrate deleting a boxes measurements #658
+414
−58
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| import { type ActionFunctionArgs } from 'react-router' | ||
| import z from 'zod' | ||
| import { getUserFromJwt } from '~/lib/jwt' | ||
| import { getUserDevices } from '~/models/device.server' | ||
| import { | ||
| deleteMeasurementsForSensor, | ||
| deleteSensorMeasurementsForTimeRange, | ||
| deleteSensorMeasurementsForTimes, | ||
| } from '~/models/measurement.server' | ||
| import { StandardResponse } from '~/utils/response-utils' | ||
|
|
||
| export async function action({ request, params }: ActionFunctionArgs) { | ||
| try { | ||
| const { deviceId, sensorId } = params | ||
| if (!deviceId || !sensorId) | ||
| return StandardResponse.badRequest( | ||
| 'Invalid device id or sensor id specified', | ||
| ) | ||
|
|
||
| const jwtResponse = await getUserFromJwt(request) | ||
|
|
||
| if (typeof jwtResponse === 'string') | ||
| return StandardResponse.forbidden( | ||
| 'Invalid JWT authorization. Please sign in to obtain new JWT.', | ||
| ) | ||
|
|
||
| if (request.method !== 'DELETE') | ||
| return StandardResponse.methodNotAllowed('Endpoint only supports DELETE') | ||
|
|
||
| const userDevices = await getUserDevices(jwtResponse.id) | ||
| if (!userDevices.some((d) => d.id === deviceId)) | ||
| return StandardResponse.forbidden( | ||
| 'You are not allowed to delete data of the given device', | ||
| ) | ||
|
|
||
| const device = userDevices.find((d) => d.id === deviceId) | ||
| if (!device?.sensors.some((s) => s.id === sensorId)) | ||
|
Contributor
There was a problem hiding this comment. I think the old app would have thrown a 404 here (see Box.js l. 387)
Collaborator
Author
There was a problem hiding this comment. I tried with the existing api and it indeed returns 404. Thanks for pointing out! |
||
| return StandardResponse.forbidden( | ||
| 'You are not allowed to delete data of the given sensor', | ||
| ) | ||
|
|
||
| try { | ||
| const parsedParams = await parseQueryParams(request) | ||
| let count = 0 | ||
|
|
||
| if (parsedParams.deleteAllMeasurements) | ||
| count = (await deleteMeasurementsForSensor(sensorId)).count | ||
| else if (parsedParams.timestamps) | ||
| count = ( | ||
| await deleteSensorMeasurementsForTimes( | ||
| sensorId, | ||
| parsedParams.timestamps, | ||
| ) | ||
| ).count | ||
| else if (parsedParams['from-date'] && parsedParams['to-date']) | ||
| count = ( | ||
| await deleteSensorMeasurementsForTimeRange( | ||
| sensorId, | ||
| parsedParams['from-date'], | ||
| parsedParams['to-date'], | ||
| ) | ||
| ).count | ||
|
|
||
| return StandardResponse.ok({ | ||
| message: `Successfully deleted ${count} of sensor ${sensorId}`, | ||
| }) | ||
| } catch (e) { | ||
| if (e instanceof Response) return e | ||
| else throw e | ||
| } | ||
| } catch (err: any) { | ||
| return StandardResponse.internalServerError( | ||
| err.message || 'An unexpected error occured', | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| const DeleteQueryParams = z | ||
scheidtdav marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| .object({ | ||
| 'from-date': z | ||
| .string() | ||
| .transform((s) => new Date(s)) | ||
| .refine((d) => !isNaN(d.getTime()), { | ||
| message: 'from-date is invalid', | ||
| }) | ||
| .optional(), | ||
| 'to-date': z | ||
| .string() | ||
| .transform((s) => new Date(s)) | ||
| .refine((d) => !isNaN(d.getTime()), { | ||
| message: 'to-date is invalid', | ||
| }) | ||
| .optional(), | ||
| timestamps: z | ||
| .preprocess((val) => { | ||
| if (Array.isArray(val)) return val | ||
| else return [val] | ||
| }, z.array(z.string())) | ||
| .transform((a) => a.map((i) => new Date(i))) | ||
| .refine((a) => a.some((i) => !isNaN(i.getTime())), { | ||
| message: 'timestamps contains invalid input', | ||
| }) | ||
| .optional(), | ||
| deleteAllMeasurements: z.coerce.boolean().optional(), | ||
| }) | ||
| .superRefine((data, ctx) => { | ||
| const fromDateSet = data['from-date'] !== undefined | ||
| const toDateSet = data['to-date'] !== undefined | ||
| const timestampsSet = data.timestamps !== undefined | ||
| const deleteAllSet = data.deleteAllMeasurements !== undefined | ||
|
|
||
| if (deleteAllSet && (timestampsSet || fromDateSet || toDateSet)) { | ||
| const paths: string[] = [] | ||
| if (timestampsSet) paths.push('timestamps') | ||
| if (fromDateSet) paths.push('from-date') | ||
| if (toDateSet) paths.push('to-date') | ||
| ctx.addIssue({ | ||
| code: z.ZodIssueCode.custom, | ||
| message: 'Parameter deleteAllMeasurements can only be used by itself', | ||
| path: paths, | ||
| }) | ||
| } else if (!deleteAllSet && timestampsSet && fromDateSet && toDateSet) | ||
| ctx.addIssue({ | ||
| code: z.ZodIssueCode.custom, | ||
| message: | ||
| 'Please specify only timestamps or a range with from-date and to-date', | ||
| path: ['timestamps', 'from-date', 'to-date'], | ||
| }) | ||
| else if (!deleteAllSet && !timestampsSet && !fromDateSet && !toDateSet) | ||
| ctx.addIssue({ | ||
| code: z.ZodIssueCode.custom, | ||
| message: | ||
| 'Please specify only timestamps or a range with from-date and to-date', | ||
| path: ['timestamps', 'from-date', 'to-date'], | ||
| }) | ||
| }) | ||
|
|
||
| const parseQueryParams = async ( | ||
| request: Request, | ||
| ): Promise<z.infer<typeof DeleteQueryParams>> => { | ||
| const url = new URL(request.url) | ||
| let params: Record<string, any> | ||
| if (request.method !== 'GET') { | ||
|
Contributor
There was a problem hiding this comment. Ì think this endpoint should only support the
Collaborator
Author
There was a problem hiding this comment. I don't remember why its there and you are perfectly correct.. removing it! |
||
| const contentType = request.headers.get('content-type') || '' | ||
| if (contentType.includes('application/json')) { | ||
| try { | ||
| params = await request.json() | ||
| } catch { | ||
| params = Object.fromEntries(url.searchParams) | ||
|
Contributor
There was a problem hiding this comment. I think in principle it is a good idea to fall back to params, but i am a bit unsure if we should do this here with regards to backwards-compatibility. In the old docs the endpoint is described as using the request body, so i guess this would introduce a new behaviour? Also if the content type is invalid (so !=
Collaborator
Author
There was a problem hiding this comment. Trying it with the existing API, even though the docs specify it to work with body parameters, I actually does not seem to work with those at all. (funnily enough, you have to set content-type: application/json for it to work even though you never send json data. Definitely an inconsistency. The question is if we should loosen that or keep it for now?) |
||
| } | ||
| } else { | ||
| params = Object.fromEntries(url.searchParams) | ||
| } | ||
| } else { | ||
| params = Object.fromEntries(url.searchParams) | ||
| } | ||
|
|
||
| const parseResult = DeleteQueryParams.safeParse(params) | ||
|
|
||
| if (!parseResult.success) { | ||
| const firstError = parseResult.error.errors[0] | ||
| const message = firstError.message || 'Invalid query parameters' | ||
| throw StandardResponse.badRequest(message) | ||
| } | ||
|
|
||
| return parseResult.data | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,44 @@ | ||
| import { type LoaderFunction, type LoaderFunctionArgs } from 'react-router' | ||
| import { getLatestMeasurementsForSensor } from '~/lib/measurement-service.server' | ||
| import { StandardResponse } from '~/utils/response-utils' | ||
|
|
||
| export const loader: LoaderFunction = async ({ | ||
| request, | ||
| params, | ||
| }: LoaderFunctionArgs): Promise<Response> => { | ||
| try { | ||
| const deviceId = params.deviceId | ||
| if (deviceId === undefined) | ||
| return StandardResponse.badRequest('Invalid device id specified') | ||
|
|
||
| const sensorId = params.sensorId | ||
| if (sensorId === undefined) | ||
| return StandardResponse.badRequest('Invalid sensor id specified') | ||
|
|
||
| const searchParams = new URL(request.url).searchParams | ||
| const onlyValue = | ||
| (searchParams.get('onlyValue')?.toLowerCase() ?? '') === 'true' | ||
| if (sensorId === undefined && onlyValue) | ||
| return StandardResponse.badRequest( | ||
| 'onlyValue can only be used when a sensor id is specified', | ||
| ) | ||
|
|
||
| const meas = await getLatestMeasurementsForSensor( | ||
| deviceId, | ||
| sensorId, | ||
| undefined, | ||
| ) | ||
|
|
||
| if (meas == null) return StandardResponse.notFound('Device not found.') | ||
|
|
||
| if (onlyValue) | ||
| return StandardResponse.ok(meas['lastMeasurement']?.value ?? null) | ||
|
|
||
| return StandardResponse.ok( | ||
| { ...meas, _id: meas.id } /* for legacy purposes */, | ||
| ) | ||
| } catch (err) { | ||
| console.warn(err) | ||
| return StandardResponse.internalServerError() | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unlikely to break anything, but the message in the old api was
User does not own this senseBox(mentioning this because in the old app there was also a test for this: ```expect(response).to.have.json({ code: 'Forbidden', message: 'User does not own this senseBox' });There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes good point, I'm thinking we should still changes this, because we should get rid of the strict "senseBox" branding and use the more generic "device" term. As you said its unlikely to break anything, so I guess we can keep the message?