Skip to content

feat: generate credentials using crypto.random for less collisions #665

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jona159 merged 1 commit into from
Dec 10, 2025
Merged

feat: generate credentials using crypto.random for less collisions #665

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions tests/data/generate_test_user.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { randomBytes, randomUUID } from 'crypto'

/**
* Generates valid credentials for a user to run a unit test with.
* @returns A valid user object containing the credentials required to create it
*/
export const generateTestUserCredentials = (): {
name: string
email: string
password: string
} => {
return {
name: randomUUID().toString(),
email: `${randomBytes(6).toString('hex')}@${randomBytes(6).toString('hex')}.${randomBytes(2).toString('hex')}`,
password: randomBytes(20).toString('hex'),
}
}
263 changes: 132 additions & 131 deletions tests/routes/api.boxes.$deviceId.data.$sensorId.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,154 +1,155 @@
import { type Params, type LoaderFunctionArgs } from "react-router";
import { BASE_URL } from "vitest.setup";
import { registerUser } from "~/lib/user-service.server";
import { createDevice, deleteDevice } from "~/models/device.server";
import { deleteMeasurementsForSensor, deleteMeasurementsForTime, insertMeasurements } from "~/models/measurement.server";
import { getSensors } from "~/models/sensor.server";
import { deleteUserByEmail } from "~/models/user.server";
import { loader } from "~/routes/api.boxes.$deviceId.data.$sensorId";
import { type Sensor, type Device, type User } from "~/schema";
import { type Params, type LoaderFunctionArgs } from 'react-router'
import { generateTestUserCredentials } from 'tests/data/generate_test_user'
import { BASE_URL } from 'vitest.setup'
import { registerUser } from '~/lib/user-service.server'
import { createDevice, deleteDevice } from '~/models/device.server'
import {
deleteMeasurementsForSensor,
deleteMeasurementsForTime,
insertMeasurements,
} from '~/models/measurement.server'
import { getSensors } from '~/models/sensor.server'
import { deleteUserByEmail } from '~/models/user.server'
import { loader } from '~/routes/api.boxes.$deviceId.data.$sensorId'
import { type Sensor, type Device, type User } from '~/schema'

const DEVICE_SENSORS_ID_USER = {
name: "meTestSensorsIds",
email: "[email protected]",
password: "highlySecurePasswordForTesting",
};
const DEVICE_SENSORS_ID_USER = generateTestUserCredentials()

const DEVICE_SENSOR_ID_BOX = {
name: `${DEVICE_SENSORS_ID_USER}s Box`,
exposure: "outdoor",
expiresAt: null,
tags: [],
latitude: 0,
longitude: 0,
model: "luftdaten.info",
mqttEnabled: false,
ttnEnabled: false,
sensors: [
{
title: "Temp",
unit: "°C",
sensorType: "dummy",
},
{
title: "CO2",
unit: "mol/L",
sensorType: "dummy",
},
{
title: "Air Pressure",
unit: "kPa",
sensorType: "dummy",
},
],
};
name: `${DEVICE_SENSORS_ID_USER}s Box`,
exposure: 'outdoor',
expiresAt: null,
tags: [],
latitude: 0,
longitude: 0,
model: 'luftdaten.info',
mqttEnabled: false,
ttnEnabled: false,
sensors: [
{
title: 'Temp',
unit: '°C',
sensorType: 'dummy',
},
{
title: 'CO2',
unit: 'mol/L',
sensorType: 'dummy',
},
{
title: 'Air Pressure',
unit: 'kPa',
sensorType: 'dummy',
},
],
}

const MEASUREMENTS = [
{
value: 1589625,
createdAt: new Date('1954-06-07 12:00:00+00'),
sensor_id: ""
sensor_id: '',
},
{
value: 3.14159,
createdAt: new Date('1988-03-14 1:59:26+00'),
sensor_id: '',
},
{
value: 3.14159,
createdAt: new Date('1988-03-14 1:59:26+00'),
sensor_id: ""
}
]

describe("openSenseMap API Routes: /api/boxes/:deviceId/data/:sensorId", () => {
let device: Device;
let deviceId: string = "";
let sensors: Sensor[] = [];
describe('openSenseMap API Routes: /api/boxes/:deviceId/data/:sensorId', () => {
let device: Device
let deviceId: string = ''
let sensors: Sensor[] = []

beforeAll(async () => {
const user = await registerUser(
DEVICE_SENSORS_ID_USER.name,
DEVICE_SENSORS_ID_USER.email,
DEVICE_SENSORS_ID_USER.password,
"en_US",
);
beforeAll(async () => {
const user = await registerUser(
DEVICE_SENSORS_ID_USER.name,
DEVICE_SENSORS_ID_USER.email,
DEVICE_SENSORS_ID_USER.password,
'en_US',
)

device = await createDevice(DEVICE_SENSOR_ID_BOX, (user as User).id);
deviceId = device.id;
sensors = await getSensors(deviceId);
device = await createDevice(DEVICE_SENSOR_ID_BOX, (user as User).id)
deviceId = device.id
sensors = await getSensors(deviceId)

MEASUREMENTS.forEach(meas => meas.sensor_id = sensors[0].id)
await insertMeasurements(MEASUREMENTS);
});
MEASUREMENTS.forEach((meas) => (meas.sensor_id = sensors[0].id))
await insertMeasurements(MEASUREMENTS)
})

describe("GET", () => {
it("should return measurements for a single sensor of a box in json format", async () => {
// Arrange
const request = new Request(
`${BASE_URL}/api/boxes/${deviceId}/data/${sensors[0].id}?from-date=${new Date('1954-06-07 11:00:00+00')}&to-date=${new Date('1988-03-14 1:59:27+00')}`,
{ method: "GET" },
);
describe('GET', () => {
it('should return measurements for a single sensor of a box in json format', async () => {
// Arrange
const request = new Request(
`${BASE_URL}/api/boxes/${deviceId}/data/${sensors[0].id}?from-date=${new Date('1954-06-07 11:00:00+00')}&to-date=${new Date('1988-03-14 1:59:27+00')}`,
{ method: 'GET' },
)

// Act
const dataFunctionValue = await loader({
request,
params: {
deviceId: `${deviceId}`,
sensorId: `${sensors[0].id}`
} as Params<string>,
} as LoaderFunctionArgs); // Assuming a separate loader for single sensor
const response = dataFunctionValue as Response;
const body = await response?.json();
// Act
const dataFunctionValue = await loader({
request,
params: {
deviceId: `${deviceId}`,
sensorId: `${sensors[0].id}`,
} as Params<string>,
} as LoaderFunctionArgs) // Assuming a separate loader for single sensor
const response = dataFunctionValue as Response
const body = await response?.json()

// Assert
expect(response.status).toBe(200);
expect(response.headers.get("content-type")).toBe(
"application/json; charset=utf-8",
);
expect(body).toHaveLength(2);
expect(body[0].sensor_id).toBe(sensors[0].id);
expect(body[1].sensor_id).toBe(sensors[0].id);
expect(body[0].time).toBe('1988-03-14 01:59:26+00');
expect(body[1].time).toBe('1954-06-07 12:00:00+00');
expect(body[0].value).toBeCloseTo(3.14159);
expect(body[1].value).toBe(1589625);
});
// Assert
expect(response.status).toBe(200)
expect(response.headers.get('content-type')).toBe(
'application/json; charset=utf-8',
)
expect(body).toHaveLength(2)
expect(body[0].sensor_id).toBe(sensors[0].id)
expect(body[1].sensor_id).toBe(sensors[0].id)
expect(body[0].time).toBe('1988-03-14 01:59:26+00')
expect(body[1].time).toBe('1954-06-07 12:00:00+00')
expect(body[0].value).toBeCloseTo(3.14159)
expect(body[1].value).toBe(1589625)
})

it("should return measurements for a single sensor of a box in csv format", async () => {
// Arrange
const request = new Request(
`${BASE_URL}/api/boxes/${deviceId}/data/${sensors[0].id}?from-date=${new Date('1954-06-07 11:00:00+00')}&to-date=${new Date('1988-03-14 1:59:27+00')}&format=csv`,
{ method: "GET" },
);
it('should return measurements for a single sensor of a box in csv format', async () => {
// Arrange
const request = new Request(
`${BASE_URL}/api/boxes/${deviceId}/data/${sensors[0].id}?from-date=${new Date('1954-06-07 11:00:00+00')}&to-date=${new Date('1988-03-14 1:59:27+00')}&format=csv`,
{ method: 'GET' },
)

// Act
const dataFunctionValue = await loader({
request,
params: {
deviceId: `${deviceId}`,
sensorId: `${sensors[0].id}`
} as Params<string>,
} as LoaderFunctionArgs); // Assuming a separate loader for single sensor
const response = dataFunctionValue as Response;
const body = await response?.text();
// Act
const dataFunctionValue = await loader({
request,
params: {
deviceId: `${deviceId}`,
sensorId: `${sensors[0].id}`,
} as Params<string>,
} as LoaderFunctionArgs) // Assuming a separate loader for single sensor
const response = dataFunctionValue as Response
const body = await response?.text()

// Assert
expect(response.status).toBe(200);
expect(response.headers.get("content-type")).toBe(
"text/csv; charset=utf-8",
);
expect(body).toBe(
// Assert
expect(response.status).toBe(200)
expect(response.headers.get('content-type')).toBe(
'text/csv; charset=utf-8',
)
expect(body).toBe(
'createdAt,value\n1988-03-14 01:59:26+00,3.14159\n1954-06-07 12:00:00+00,1589625',
)
});
});
})
})

afterAll(async () => {
//delete measurements
if (sensors.length > 0) {
await deleteMeasurementsForSensor(sensors[0].id);
await deleteMeasurementsForTime(MEASUREMENTS[0].createdAt);
await deleteMeasurementsForTime(MEASUREMENTS[1].createdAt);
}
// delete the valid test user
await deleteUserByEmail(DEVICE_SENSORS_ID_USER.email);
// delete the box
await deleteDevice({ id: deviceId });
});
});
afterAll(async () => {
//delete measurements
if (sensors.length > 0) {
await deleteMeasurementsForSensor(sensors[0].id)
await deleteMeasurementsForTime(MEASUREMENTS[0].createdAt)
await deleteMeasurementsForTime(MEASUREMENTS[1].createdAt)
}
// delete the valid test user
await deleteUserByEmail(DEVICE_SENSORS_ID_USER.email)
// delete the box
await deleteDevice({ id: deviceId })
})
})
Loading
Loading