refactor(backend): add entity ID to the document in the API

seed-hypermedia · Jul 27, 2023 · 3a9f6a7 · 3a9f6a7
1 parent 0c19b83
commit 3a9f6a7
Show file tree

Hide file tree

Showing 7 changed files with 159 additions and 133 deletions.
diff --git a/backend/daemon/api/documents/v1alpha/document_model.go b/backend/daemon/api/documents/v1alpha/document_model.go
@@ -306,7 +306,8 @@ func (dm *docModel) cleanupPatch() {
 func (dm *docModel) hydrate(ctx context.Context, blobs *hyper.Storage) (*documents.Document, error) {
 	e := dm.e
 	docpb := &documents.Document{
-		Id: e.ID().TrimPrefix("hd://d/"),
+		Id:  e.ID().TrimPrefix("hd://d/"),
+		Eid: string(e.ID()),
 	}
 
 	{

diff --git a/backend/daemon/api/documents/v1alpha/documents_test.go b/backend/daemon/api/documents/v1alpha/documents_test.go
@@ -316,6 +316,7 @@ func TestAPIUpdateDraft_Complex(t *testing.T) {
 
 		want := &documents.Document{
 			Id:         draft.Id,
+			Eid:        draft.Eid,
 			Author:     draft.Author,
 			Editors:    []string{draft.Author},
 			Title:      "Hello Drafts V2",
@@ -372,6 +373,7 @@ func TestAPIUpdateDraft_Complex(t *testing.T) {
 
 		want := &documents.Document{
 			Id:         draft.Id,
+			Eid:        draft.Eid,
 			Author:     draft.Author,
 			Editors:    []string{draft.Author},
 			Title:      "Hello Drafts V2",
@@ -422,6 +424,7 @@ func TestAPIUpdateDraft_Complex(t *testing.T) {
 
 		want := &documents.Document{
 			Id:         draft.Id,
+			Eid:        draft.Eid,
 			Author:     draft.Author,
 			Editors:    []string{draft.Author},
 			Title:      "Hello Drafts V2",
@@ -570,6 +573,7 @@ func TestAPIUpdateDraft_WithList(t *testing.T) {
 
 	want := &documents.Document{
 		Id:      draft.Id,
+		Eid:     draft.Eid,
 		Title:   "My new document title",
 		Author:  draft.Author,
 		Editors: []string{draft.Author},

diff --git a/backend/genproto/documents/v1alpha/documents.pb.go b/backend/genproto/documents/v1alpha/documents.pb.go
diff --git a/frontend/packages/shared/src/client/.generated/documents/v1alpha/documents_pb.ts b/frontend/packages/shared/src/client/.generated/documents/v1alpha/documents_pb.ts
@@ -782,6 +782,13 @@ export class Document extends Message<Document> {
    */
   id = "";
 
+  /**
+   * Entity ID of the document.
+   *
+   * @generated from field: string eid = 12;
+   */
+  eid = "";
+
   /**
    * Title of the document.
    *
@@ -848,6 +855,7 @@ export class Document extends Message<Document> {
   static readonly typeName = "com.mintter.documents.v1alpha.Document";
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: "id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 12, name: "eid", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 2, name: "title", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 4, name: "author", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 10, name: "web_url", kind: "scalar", T: 9 /* ScalarType.STRING */ },

diff --git a/proto/documents/v1alpha/documents.proto b/proto/documents/v1alpha/documents.proto
@@ -206,6 +206,9 @@ message Document {
   // Permanent ID of the document.
   string id = 1;
 
+  // Entity ID of the document.
+  string eid = 12;
+
   // Title of the document.
   string title = 2;
 

diff --git a/proto/documents/v1alpha/go.gensum b/proto/documents/v1alpha/go.gensum
@@ -1,2 +1,2 @@
-srcs: 08fa35d79aad416cb79efde2e41830a1
-outs: 424535f2838016dcfba650fddf70b40c
+srcs: de8217901a48274b8593f7759db2cadc
+outs: d250a84410ccddb51bd9836632f1d6a5
diff --git a/proto/documents/v1alpha/js.gensum b/proto/documents/v1alpha/js.gensum
@@ -1,2 +1,2 @@
-srcs: 08fa35d79aad416cb79efde2e41830a1
-outs: a76a67f5ab3be2aced51d5a1f4b430dd
+srcs: de8217901a48274b8593f7759db2cadc
+outs: a278d13a7830b946855dde05f1c44881