feat: add self-hosted server details to DeviceInfo (#273)

This adds a new object, `selfHostedServerDetails`, to `DeviceInfo`. It currently has one property, `baseUrl`, but could have more later. See [#268]. [#268]: #268
digidem · Oct 22, 2024 · f7ae02a · f7ae02a
1 parent faf89b5
commit f7ae02a
Show file tree

Hide file tree

Showing 5 changed files with 81 additions and 0 deletions.
diff --git a/proto/deviceInfo/v1.proto b/proto/deviceInfo/v1.proto
@@ -21,6 +21,11 @@ message DeviceInfo_1 {
     selfHostedServer = 4;
   }
 
+  message SelfHostedServerDetails {
+    string baseUrl = 1 [(required) = true];
+  }
+
   string name = 5;
   DeviceType deviceType = 6;
+  optional SelfHostedServerDetails selfHostedServerDetails = 7;
 }
diff --git a/schema/deviceInfo/v1.json b/schema/deviceInfo/v1.json
@@ -23,6 +23,17 @@
         "UNRECOGNIZED"
       ],
       "description": "Type of device"
+    },
+    "selfHostedServerDetails": {
+      "type": "object",
+      "properties": {
+        "baseUrl": {
+          "description": "base URL for the server",
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "required": ["baseUrl"]
     }
   },
   "required": ["schemaName", "name", "deviceType"],

diff --git a/src/lib/encode-conversions.ts b/src/lib/encode-conversions.ts
@@ -122,6 +122,17 @@ export const convertRole: ConvertFunction<'role'> = (mapeoDoc) => {
 }
 
 export const convertDeviceInfo: ConvertFunction<'deviceInfo'> = (mapeoDoc) => {
+  const { selfHostedServerDetails } = mapeoDoc
+  if (selfHostedServerDetails) {
+    try {
+      new URL(selfHostedServerDetails.baseUrl || '')
+    } catch (_err) {
+      throw new Error(
+        'deviceInfo.selfHostedServerDetails.baseUrl is not a valid URL'
+      )
+    }
+  }
+
   return {
     common: convertCommon(mapeoDoc),
     ...mapeoDoc,

diff --git a/test/fixtures/bad-docs.js b/test/fixtures/bad-docs.js
@@ -97,6 +97,42 @@ export const badDocs = [
       deleted: false,
     },
   },
+  {
+    text: 'server without base URL',
+    /** @type {import('../../dist/index.js').DeviceInfo} */
+    doc: {
+      docId: cachedValues.docId,
+      versionId: cachedValues.versionId,
+      originalVersionId: cachedValues.originalVersionId,
+      schemaName: 'deviceInfo',
+      createdAt: cachedValues.createdAt,
+      updatedAt: cachedValues.updatedAt,
+      links: [],
+      name: 'my server',
+      deviceType: 'selfHostedServer',
+      deleted: false,
+      selfHostedServerDetails: {},
+    },
+  },
+  {
+    text: 'server with bogus base URL',
+    /** @type {import('../../dist/index.js').DeviceInfo} */
+    doc: {
+      docId: cachedValues.docId,
+      versionId: cachedValues.versionId,
+      originalVersionId: cachedValues.originalVersionId,
+      schemaName: 'deviceInfo',
+      createdAt: cachedValues.createdAt,
+      updatedAt: cachedValues.updatedAt,
+      links: [],
+      name: 'my server',
+      deviceType: 'selfHostedServer',
+      deleted: false,
+      selfHostedServerDetails: {
+        baseUrl: 'foo',
+      },
+    },
+  },
   {
     text: 'icon without name',
     doc: {

diff --git a/test/fixtures/good-docs-completed.js b/test/fixtures/good-docs-completed.js
@@ -212,6 +212,24 @@ export const goodDocsCompleted = [
       deviceType: 'UNRECOGNIZED',
     },
   },
+  {
+    doc: {
+      docId: cachedValues.docId,
+      versionId: cachedValues.versionId,
+      originalVersionId: cachedValues.originalVersionId,
+      schemaName: 'deviceInfo',
+      createdAt: cachedValues.createdAt,
+      updatedAt: cachedValues.updatedAt,
+      links: [],
+      name: 'my server',
+      deviceType: 'selfHostedServer',
+      deleted: false,
+      selfHostedServerDetails: {
+        baseUrl: 'https://mapeo.example/foo',
+      },
+    },
+    expected: {},
+  },
   {
     doc: {
       docId: cachedValues.docId,