@dxos/protocols 0.5.3-main.e76d664 → 0.5.3-main.eb56347

package/dist/esm/src/proto/gen/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/proto/gen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AA+DhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AA0iB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,y/zGAAy/zG,CAAC,CAAC,CAAC;AAClj0G,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/proto/gen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AA+DhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AA2iB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,4o0GAA4o0G,CAAC,CAAC,CAAC;AACrs0G,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/protocols",
-  "version": "0.5.3-main.e76d664",
+  "version": "0.5.3-main.eb56347",
   "description": "Protobuf definitions for DXOS protocols.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -33,10 +33,10 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/codec-protobuf": "0.5.3-main.e76d664",
-    "@dxos/invariant": "0.5.3-main.e76d664",
-    "@dxos/keys": "0.5.3-main.e76d664",
-    "@dxos/timeframe": "0.5.3-main.e76d664"
+    "@dxos/codec-protobuf": "0.5.3-main.eb56347",
+    "@dxos/invariant": "0.5.3-main.eb56347",
+    "@dxos/keys": "0.5.3-main.eb56347",
+    "@dxos/timeframe": "0.5.3-main.eb56347"
   },
   "devDependencies": {
     "glob": "~7.1.6"

package/src/indexing.test.ts

@@ -0,0 +1,36 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+import { expect } from 'chai';
+
+import { describe, test } from '@dxos/test';
+
+import { ObjectPointerVersion, objectPointerCodec } from './indexing';
+
+describe('Indexing object pointer codec', () => {
+  test('getVersion', async () => {
+    expect(objectPointerCodec.getVersion('aaaa|bbbb')).to.eq(ObjectPointerVersion.V0);
+    expect(objectPointerCodec.getVersion('#01|ssss|aaaa|bbbb')).to.eq(ObjectPointerVersion.V1);
+  });
+
+  test('v0', async () => {
+    expect(objectPointerCodec.encode({ spaceKey: undefined, documentId: 'aaaa', objectId: 'bbbb' })).to.eq('aaaa|bbbb');
+    expect(objectPointerCodec.decode('aaaa|bbbb')).to.eql({
+      spaceKey: undefined,
+      documentId: 'aaaa',
+      objectId: 'bbbb',
+    });
+  });
+
+  test('v1', async () => {
+    expect(objectPointerCodec.encode({ spaceKey: 'ssss', documentId: 'aaaa', objectId: 'bbbb' })).to.eq(
+      '#01|ssss|aaaa|bbbb',
+    );
+    expect(objectPointerCodec.decode('#01|ssss|aaaa|bbbb')).to.eql({
+      spaceKey: 'ssss',
+      documentId: 'aaaa',
+      objectId: 'bbbb',
+    });
+  });
+});

package/src/indexing.ts

@@ -3,19 +3,58 @@
 //
 
 export type ObjectPointerDecoded = {
+  spaceKey: string | undefined;
   documentId: string;
   objectId: string;
 };
 
 /**
- * Encoded object pointer: `${documentId}|${objectId}`.
+ * Encoded object pointer: `#01|${spaceKey}|${documentId}|${objectId}`.
+ * Old format without spaceKey: `${documentId}|${objectId}`.
+ * The spaceKey is optional and was added in the later version.
+ * Space key is encoded in the front to allow prefix iteration.
  */
 export type ObjectPointerEncoded = string;
 
-export const idCodec = {
-  encode: ({ documentId, objectId }: ObjectPointerDecoded): ObjectPointerEncoded => `${documentId}|${objectId}`,
+const V1_PREFIX = '#01';
+
+export enum ObjectPointerVersion {
+  /**
+   * `${documentId}|${objectId}`
+   */
+  V0 = 0,
+  /**
+   * `#01|${spaceKey}|${documentId}|${objectId}`
+   */
+  V1 = 1,
+}
+
+export const objectPointerCodec = {
+  encode: ({ spaceKey, documentId, objectId }: ObjectPointerDecoded): ObjectPointerEncoded => {
+    if (spaceKey === undefined) {
+      return `${documentId}|${objectId}`;
+    } else {
+      return `${V1_PREFIX}|${spaceKey}|${documentId}|${objectId}`;
+    }
+  },
   decode: (id: ObjectPointerEncoded): ObjectPointerDecoded => {
-    const [documentId, objectId] = id.split('|');
-    return { documentId, objectId };
+    if (id.startsWith(V1_PREFIX)) {
+      const [_, spaceKey, documentId, objectId] = id.split('|');
+      return { spaceKey, documentId, objectId };
+    } else {
+      const [documentId, objectId] = id.split('|');
+      return { spaceKey: undefined, documentId, objectId };
+    }
+  },
+  getVersion: (id: ObjectPointerEncoded): ObjectPointerVersion => {
+    if (id.startsWith(V1_PREFIX)) {
+      return ObjectPointerVersion.V1;
+    } else {
+      return ObjectPointerVersion.V0;
+    }
+  },
+  convertV1ToV0: (id: ObjectPointerEncoded): ObjectPointerEncoded => {
+    const { documentId, objectId } = objectPointerCodec.decode(id);
+    return objectPointerCodec.encode({ documentId, objectId, spaceKey: undefined });
   },
 };

package/src/proto/dxos/agent/functions.proto

@@ -14,14 +14,13 @@ message FunctionsConfig {
   optional string manifest = 2;
 }
 
-// TODO(burdon): Reconcile with typedefs.
 message Function {
-  string name = 1;
+  string id = 1;
+  string route = 2;
 }
 
 message RegisterRequest {
   string endpoint = 1;
-  repeated Function functions = 2;
 }
 
 message RegisterResponse {
@@ -29,11 +28,17 @@ message RegisterResponse {
   string endpoint = 2;
 }
 
+message UpdateRegistrationRequest {
+  string registration_id = 1;
+  repeated Function functions = 2;
+}
+
 message UnregisterRequest {
   string registration_id = 1;
 }
 
 service FunctionRegistryService {
   rpc Register(RegisterRequest) returns (RegisterResponse) {}
+  rpc UpdateRegistration(UpdateRegistrationRequest) returns (google.protobuf.Empty) {}
   rpc Unregister(UnregisterRequest) returns (google.protobuf.Empty) {}
 }

package/src/proto/dxos/halo/credentials.proto

@@ -170,13 +170,13 @@ message DeviceProfileDocument {
 
   optional string platform = 2;
   optional string platform_version = 3;
-  optional string architecture = 4; 
+  optional string architecture = 4;
   optional string os = 5;
   optional string os_version = 6;
   optional DeviceType type = 7;
 }
 
-/// [ASSERTION]: Sets device profile information. 
+/// [ASSERTION]: Sets device profile information.
 message DeviceProfile {
   DeviceProfileDocument profile = 1;
 }

package/src/proto/gen/dxos/agent/functions.ts

@@ -82,7 +82,8 @@ export interface FunctionsConfig {
  *   {@link file://./../../../dxos/agent/functions.proto}
  */
 export interface Function {
-    name: string;
+    id: string;
+    route: string;
 }
 /**
  * Defined in:
@@ -90,7 +91,6 @@ export interface Function {
  */
 export interface RegisterRequest {
     endpoint: string;
-    functions?: Function[];
 }
 /**
  * Defined in:
@@ -100,6 +100,14 @@ export interface RegisterResponse {
     registrationId: string;
     endpoint: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/agent/functions.proto}
+ */
+export interface UpdateRegistrationRequest {
+    registrationId: string;
+    functions?: Function[];
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/agent/functions.proto}
@@ -113,5 +121,6 @@ export interface UnregisterRequest {
  */
 export interface FunctionRegistryService {
     register: (request: RegisterRequest, options?: RequestOptions) => Promise<RegisterResponse>;
+    updateRegistration: (request: UpdateRegistrationRequest, options?: RequestOptions) => Promise<void>;
     unregister: (request: UnregisterRequest, options?: RequestOptions) => Promise<void>;
 }