update error text when relationship is invalid (#69)

Author: miparnisari

src/spicedb-common/parsing.test.ts

@@ -50,79 +50,79 @@ describe("parsing relationships", () => {
     const relationship = "";
     expect(parseRelationshipWithError(relationship)).toEqual({
       errorMessage:
-        "Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid`",
+        'Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid[caveatname:[{"key":"value"}]]`',
     });
   });
 
   it("returns an error for a relationship missing an object", () => {
     const relationship = "somenamespace#somerel@someuser:foo";
     expect(parseRelationshipWithError(relationship)).toEqual({
       errorMessage:
-        "Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid`",
+        'Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid[caveatname:[{"key":"value"}]]`',
     });
   });
 
   it("returns an error for a relationship missing a subject", () => {
     const relationship = "somenamespace:something#somerel";
     expect(parseRelationshipWithError(relationship)).toEqual({
       errorMessage:
-        "Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid`",
+        'Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid[caveatname:[{"key":"value"}]]`',
     });
   });
 
   it("returns an error for a relationship with an invalid namespace", () => {
     const relationship = "a:something#somerel@user:foo";
     expect(parseRelationshipWithError(relationship)).toEqual({
       errorMessage:
-        "Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid`",
+        'Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid[caveatname:[{"key":"value"}]]`',
     });
   });
 
   it("returns an error for a relationship with an invalid object id", () => {
     const relationship = "document:some.thing#somerel@user:foo";
     expect(parseRelationshipWithError(relationship)).toEqual({
       errorMessage:
-        "Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid`",
+        'Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid[caveatname:[{"key":"value"}]]`',
     });
   });
 
   it("returns an error for a relationship with a wildcard resource id", () => {
     const relationship = "document:*#somerel@user:foo";
     expect(parseRelationshipWithError(relationship)).toEqual({
       errorMessage:
-        "Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid`",
+        'Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid[caveatname:[{"key":"value"}]]`',
     });
   });
 
   it("returns an error for a relationship with an invalid relation", () => {
     const relationship = "document:something#a@user:foo";
     expect(parseRelationshipWithError(relationship)).toEqual({
       errorMessage:
-        "Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid`",
+        'Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid[caveatname:[{"key":"value"}]]`',
     });
   });
 
   it("returns an error for a relationship with an invalid subject namespace", () => {
     const relationship = "document:something#somerel@a:foo";
     expect(parseRelationshipWithError(relationship)).toEqual({
       errorMessage:
-        "Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid`",
+        'Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid[caveatname:[{"key":"value"}]]`',
     });
   });
 
   it("returns an error for a relationship with an invalid subject object id", () => {
     const relationship = "document:something#somerel@user:some.thing";
     expect(parseRelationshipWithError(relationship)).toEqual({
       errorMessage:
-        "Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid`",
+        'Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid[caveatname:[{"key":"value"}]]`',
     });
   });
 
   it("returns an error for a relationship with an invalid subject relation", () => {
     const relationship = "document:something#somerel@user:someuser#a";
     expect(parseRelationshipWithError(relationship)).toEqual({
       errorMessage:
-        "Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid`",
+        'Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid[caveatname:[{"key":"value"}]]`',
     });
   });
 

src/spicedb-common/parsing.ts

@@ -94,7 +94,7 @@ export const parseRelationshipWithError = (
   if (!parsed || !parsed.groups) {
     return {
       errorMessage:
-        "Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid`",
+        'Relationship must be of the form `resourcetype:resourceid#relation@subjecttype:subjectid[caveatname:[{"key":"value"}]]`',
     };
   }