Feat/device schema by jona159 · Pull Request #985 · openSenseMap/frontend

jona159 · 2026-06-17T07:16:18Z

Type of Change

Dependency upgrade
Bug fix (non-breaking change)
Breaking change
- e.g. a fixed bug or new feature that may break something else
New feature
Code quality improvements
- e.g. refactoring, documentation, tests, tooling, ...

Implementation

Checklist

I gave this pull request a meaningful title
My pull request is targeting the dev branch
I have added documentation to my code
I have deleted code that I have commented out

Additional Information

This PR closes #

… from device

github-actions · 2026-07-08T08:17:14Z

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	65.81%	2224 / 3379
🔵	Statements	64.36%	2294 / 3564
🔵	Functions	63.19%	431 / 682
🔵	Branches	50.49%	1065 / 2109

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
app/db/models/device-schema.server.ts	0%	0%	0%	0%	29-475
app/db/models/device.server.ts	61.38%	65.5%	60.41%	61.96%	96-101, 109, 215, 227-228, 298-360, 400, 434, 463, 492, 522, 526, 534-536, 542-544, 562-564, 568-570, 612-614, 629-783, 834-838, 866-872, 877-893, 975-977, 988, 995-996, 1008-1015, 1019-1030, 1039, 1072, 1180-1200, 1219
app/db/models/sensor.server.ts	59.18%	58.06%	47.05%	60.41%	70-72, 124-129, 154-229, 283
app/db/schema/device-schema.ts	66.66%	100%	44.44%	66.66%	31-40, 65-81
app/db/schema/device.ts	66.66%	100%	50%	63.63%	58-63, 83-89
app/db/schema/index.ts	100%	100%	100%	100%
app/lib/device-schemas/device-schema-v1.ts	100%	100%	100%	100%
app/lib/device-schemas/util.ts	10%	0%	0%	11.11%	4-30
app/services/device-service.server.ts	28.33%	20.68%	16.66%	29.09%	56, 67-72, 78-186, 204, 221, 243-246

Generated in workflow #2807 for commit 3960a4f by the Vitest Coverage Report Action

zven · 2026-07-21T12:29:57Z

Why a different tile design for the public device schemas?

zven · 2026-07-21T12:41:48Z

The schema download link for a public schema on my profile page is without function:

zven · 2026-07-21T12:53:11Z

What are the tags contained in the schema for? They are not shown for a device created based on that schema:

zven · 2026-07-21T13:34:01Z

@@ -0,0 +1,35 @@
+{
+  "schemaType": "opensensemap.deviceSchema",
+  "schemaVersion": "1.0.0",


What's the difference between the schemaVersion and version? Is schemaVersion the foundation for futurel, different styles of schemas?

Yes, schemaVersion would refer to the schema format, while version would refer to the specific device schema version

jona159 · 2026-07-23T06:49:30Z

Why a different tile design for the public device schemas?

As this is an older branch it does not yet use the newer design tokens that were introduced with the dark-mode feature. I will make the necessary adjustments

jona159 · 2026-07-23T06:52:46Z

The schema download link for a public schema on my profile page is without function:

Should be fixed

jona159 · 2026-07-23T06:57:02Z

What are the tags contained in the schema for? They are not shown for a device created based on that schema:

That's true, they are currently unused. Later on they could be used for filtering / grouping or maybe to recommend schemas to certain devices. But we can discuss if we want to keep them

zven · 2026-07-23T09:52:29Z

I have uploaded a new (second) device schema during the device creation process (v.1.2.2) and have not yet published it in the settings, see pill shaped Privat. Why does it show Veröffentlicht at the same time?

Edit: I think I now understand: A schema version can either be published or deprecated. If there is only one version, it gets the state published. If I add a new version of tthat schema, the previous one is now deprecated.

I think it might be a bit confusing to have published (veröffentlicht) schemas that are still private. 🤔 Suggestion: How about current instead of published?

zven · 2026-07-23T12:00:43Z

-		if (newSensor.title && newSensor.unit && newSensor.sensorType) {
+		if (
+			!deviceSchema &&
+			!deviceSchemaVersionId &&


Only add new sensor when no device schema is present? How about an early exit?

zven · 2026-07-23T12:09:40Z

+			setValue('deviceSchema', parsedSchema)
+			setValue('deviceSchemaVersionId', undefined)
+			setValue('deviceSchemaRegistrySelection', undefined)
+			setValue('selectedSensors', schemaSensors)


Why are you setting deviceSchemaVersionId to undefined in this case? Although we don't have selected a schema from a registry, it should still have a version, right?
Plus: Why set it to undefined in two different ways?

zven · 2026-07-23T12:10:34Z

+		setValue('deviceSchema', undefined)
+		setValue('deviceSchemaVersionId', undefined)
+		setValue('deviceSchemaRegistrySelection', undefined)
+		setValue('selectedSensors', [])


Why are you setting the same things to undefined in two different ways?

zven · 2026-07-23T12:21:43Z

+		setValue('deviceSchema', undefined)
+		setValue('deviceSchemaVersionId', schema.versionId)
+		setValue('deviceSchemaRegistrySelection', schema)
+		setValue('selectedSensors', schemaSensors)


See above.
(Maybe I just don't get the pattern here.)

zven · 2026-07-23T12:36:43Z

+		deviceSchema?.version ?? selectedRegistrySchema?.version
+	const selectedSchemaSensorCount =
+		deviceSchema?.sensors.length ??
+		selectedRegistrySchema?.content.sensors.length


Your are using the selected registry schema as a fallback. Why? Shouldn't the schema information of the selected registry schema already be contained in the schema parameter?

zven · 2026-07-23T12:46:11Z

+		setValue('selectedSensors', [])
+	}
+
+	const useRegistrySchema = (schema: RegistryDeviceSchema) => {


Naming suggestion: applyRegistrySchema?

zven · 2026-07-23T13:12:57Z

+		setValue('selectedSensors', schemaSensors)
+	}
+
+	const hasLockedSchema = !!deviceSchema || !!deviceSchemaVersionId


hasLockedSchema - Isn't that more something like userHasSelectedSchema?

zven · 2026-07-23T13:27:02Z

Should we add some explicit checks if the schema version as written in the json files (1.0.0) corresponds with the schema version we currently support?

zven · 2026-07-23T13:36:13Z

+ALTER TABLE "device" ADD COLUMN "device_schema_id" text;--> statement-breakpoint
+ALTER TABLE "device" ADD COLUMN "device_schema_name" text;--> statement-breakpoint
+ALTER TABLE "device" ADD COLUMN "device_schema_version" text;--> statement-breakpoint
+ALTER TABLE "device" ADD COLUMN "device_schema_hash" text;--> statement-breakpoint


This seems like a lot of redundant information. 🤔 How about having a separate table for the device schemas and then just link to a specific schema from a device?

zven · 2026-08-04T12:26:06Z

+	deviceSchemaId: text('device_schema_id'),
+	deviceSchemaName: text('device_schema_name'),
+	deviceSchemaVersion: text('device_schema_version'),
+	deviceSchemaHash: text('device_schema_hash'),


Why do we need to duplicate those entries? Aren't they already in the deviceSchemaVersion-table?

Is this supposed to be a snapshot of the used deviceSchemaVersion during device creation time or something that should sync with any deviceSchemaVersion-changes?
If I understand the feature correctly, we can't update a deviceSchemaVersion once its created, right? 🤔

zven · 2026-08-04T13:18:30Z

+			return {
+				isUpdated: false,
+				message:
+					'This device no longer matches its schema. Detach it from the schema before editing sensors.',


Can that ever be the case? Atm, I can't edit sensor for device schema devices.

See comment below

zven · 2026-08-04T13:22:42Z

+				return {
+					isUpdated: false,
+					message:
+						'Schema-backed sensors cannot be added or deleted. Detach the device from its schema first.',


See comment above: Can this case ever happen?

Or do we have those checks as a safeguard for the case when users edit a device via the api?

Yes, although unlikely i would prefer to keep those checks just in case an edit occurs via API / the admin interface or something along those lines. Or do you think checks like these add too much noise to the file?

jona159 added 23 commits June 15, 2026 14:31

feat: device schema db model and related fields

13ac36e

feat: upload device schema zod validation

1d96b97

feat: add optional device schema to create device schema

2c7a3b5

feat: example device schema

4fe422e

feat: translation

371fd97

feat: import and save schemas on custom devices

5e22eb3

feat: migrations

007d4db

fix: rm draft state, fix migrations

3c6ef4d

feat: translations

b02720b

feat: add optional schema version and registry fields to sensor schema

a70b61b

feat: add db methods to manage schemas

65deb54

feat: resource route to load schemas for registry

9695d80

feat: resource route to download public schema of specific version

074037a

feat: allow to donwload device schemas from public profile

aa57ce7

feat: add model and schema version to custom device creation payload

b3364f3

feat: adjust add and update sensors

48d9708

feat: adjust device creation for sensor schema, allow to detach schema

88c544d

feat: add optional schema version id to zod schema

8bb2456

feat: translation

4a2b930

feat: adjust hook to track copied string

e732bc2

feat: manage own schemas on settings profile

f4e72be

feat: restrict editing sensors from schema but allow to detach schema…

dd7be25

… from device

feat: tab view for browsing schema registry, upload and manual sensors

7b6cc69

zven linked an issue Jun 18, 2026 that may be closed by this pull request

device-schemas #966

Open

jona159 marked this pull request as ready for review June 19, 2026 07:04

Merge branch 'dev' into feat/device-schema

7a21333

jona159 added 2 commits July 21, 2026 14:09

Merge branch 'dev' into feat/device-schema

794d176

fix: disable state after merge conflict

0512fba

zven reviewed Jul 21, 2026

View reviewed changes

fix: use design tokens, download link

16944a9

jona159 added 5 commits July 23, 2026 09:16

fix: rm asChild for text node

76a70d2

fix: use design tokens

4d9d5b7

fix: use alert dialog instead of default window.confirm

a57c2ba

feat: add example schema download link

3960a4f

feat: add translations

a6e3ee4

zven reviewed Jul 23, 2026

View reviewed changes

zven reviewed Aug 4, 2026

View reviewed changes

Uh oh!

Uh oh!

Conversation

jona159 commented Jun 17, 2026

Type of Change

Implementation

Checklist

Additional Information

Uh oh!

github-actions Bot commented Jul 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

zven commented Jul 21, 2026

Uh oh!

zven commented Jul 21, 2026

Uh oh!

zven commented Jul 21, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jona159 commented Jul 23, 2026

Uh oh!

jona159 commented Jul 23, 2026

Uh oh!

jona159 commented Jul 23, 2026

Uh oh!

zven commented Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zven commented Jul 23, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions Bot commented Jul 8, 2026 •

edited

Loading

zven commented Jul 23, 2026 •

edited

Loading