Make REST API ID divider configurable

Author: thomassnielsen

packages/server/src/api/rest/index.ts

@@ -22,17 +22,6 @@ import { LoggerConfig, Response } from '../../types';
 import { APIHandlerBase, RequestContext } from '../base';
 import { logWarning, registerCustomSerializers } from '../utils';
 
-const urlPatterns = {
-    // collection operations
-    collection: new UrlPattern('/:type'),
-    // single resource operations
-    single: new UrlPattern('/:type/:id'),
-    // related entity fetching
-    fetchRelationship: new UrlPattern('/:type/:id/:relationship'),
-    // relationship operations
-    relationship: new UrlPattern('/:type/:id/relationships/:relationship'),
-};
-
 /**
  * Request handler options
  */
@@ -215,9 +204,26 @@ class RequestHandler extends APIHandlerBase {
     private typeMap: Record<string, ModelInfo>;
     public idDivider;
 
+    private urlPatterns;
+
     constructor(private readonly options: Options) {
         super();
         this.idDivider = options.idDivider ?? '_';
+        this.urlPatterns = this.buildUrlPatterns(this.idDivider);
+    }
+
+    buildUrlPatterns(idDivider: string) {
+        const options = { segmentNameCharset: `a-zA-Z0-9-_~ %${idDivider}` };
+        return {
+            // collection operations
+            collection: new UrlPattern('/:type', options),
+            // single resource operations
+            single: new UrlPattern('/:type/:id', options),
+            // related entity fetching
+            fetchRelationship: new UrlPattern('/:type/:id/:relationship', options),
+            // relationship operations
+            relationship: new UrlPattern('/:type/:id/relationships/:relationship', options),
+        };
     }
 
     async handleRequest({
@@ -251,19 +257,19 @@ class RequestHandler extends APIHandlerBase {
         try {
             switch (method) {
                 case 'GET': {
-                    let match = urlPatterns.single.match(path);
+                    let match = this.urlPatterns.single.match(path);
                     if (match) {
                         // single resource read
                         return await this.processSingleRead(prisma, match.type, match.id, query);
                     }
 
-                    match = urlPatterns.fetchRelationship.match(path);
+                    match = this.urlPatterns.fetchRelationship.match(path);
                     if (match) {
                         // fetch related resource(s)
                         return await this.processFetchRelated(prisma, match.type, match.id, match.relationship, query);
                     }
 
-                    match = urlPatterns.relationship.match(path);
+                    match = this.urlPatterns.relationship.match(path);
                     if (match) {
                         // read relationship
                         return await this.processReadRelationship(
@@ -275,7 +281,7 @@ class RequestHandler extends APIHandlerBase {
                         );
                     }
 
-                    match = urlPatterns.collection.match(path);
+                    match = this.urlPatterns.collection.match(path);
                     if (match) {
                         // collection read
                         return await this.processCollectionRead(prisma, match.type, query);
@@ -289,13 +295,13 @@ class RequestHandler extends APIHandlerBase {
                         return this.makeError('invalidPayload');
                     }
 
-                    let match = urlPatterns.collection.match(path);
+                    let match = this.urlPatterns.collection.match(path);
                     if (match) {
                         // resource creation
                         return await this.processCreate(prisma, match.type, query, requestBody, modelMeta, zodSchemas);
                     }
 
-                    match = urlPatterns.relationship.match(path);
+                    match = this.urlPatterns.relationship.match(path);
                     if (match) {
                         // relationship creation (collection relationship only)
                         return await this.processRelationshipCRUD(
@@ -319,7 +325,7 @@ class RequestHandler extends APIHandlerBase {
                         return this.makeError('invalidPayload');
                     }
 
-                    let match = urlPatterns.single.match(path);
+                    let match = this.urlPatterns.single.match(path);
                     if (match) {
                         // resource update
                         return await this.processUpdate(
@@ -333,7 +339,7 @@ class RequestHandler extends APIHandlerBase {
                         );
                     }
 
-                    match = urlPatterns.relationship.match(path);
+                    match = this.urlPatterns.relationship.match(path);
                     if (match) {
                         // relationship update
                         return await this.processRelationshipCRUD(
@@ -351,13 +357,13 @@ class RequestHandler extends APIHandlerBase {
                 }
 
                 case 'DELETE': {
-                    let match = urlPatterns.single.match(path);
+                    let match = this.urlPatterns.single.match(path);
                     if (match) {
                         // resource deletion
                         return await this.processDelete(prisma, match.type, match.id);
                     }
 
-                    match = urlPatterns.relationship.match(path);
+                    match = this.urlPatterns.relationship.match(path);
                     if (match) {
                         // relationship deletion (collection relationship only)
                         return await this.processRelationshipCRUD(

packages/server/tests/api/rest.test.ts

@@ -85,7 +85,7 @@ describe('REST server tests', () => {
             zodSchemas = params.zodSchemas;
             modelMeta = params.modelMeta;
 
-            const _handler = makeHandler({ endpoint: 'http://localhost/api', pageSize: 5, idDivider });
+            const _handler = makeHandler({ endpoint: 'http://localhost/api', pageSize: 5 });
             handler = (args) =>
                 _handler({ ...args, zodSchemas, modelMeta, url: new URL(`http://localhost/${args.path}`) });
         });
@@ -2521,4 +2521,97 @@ describe('REST server tests', () => {
             expect(Buffer.isBuffer(included.attributes.bytes)).toBeTruthy();
         });
     });
+
+    describe('REST server tests - compound id with custom separator', () => {
+        const schema = `
+    enum Role {
+        COMMON_USER
+        ADMIN_USER
+    }
+
+    model User {
+        email String
+        role Role
+
+        @@id([email, role])
+    }
+    `;
+        const idDivider = ':';
+
+        beforeAll(async () => {
+            const params = await loadSchema(schema);
+
+            prisma = params.enhanceRaw(params.prisma, params);
+            zodSchemas = params.zodSchemas;
+            modelMeta = params.modelMeta;
+
+            const _handler = makeHandler({ endpoint: 'http://localhost/api', pageSize: 5, idDivider });
+            handler = (args) =>
+                _handler({ ...args, zodSchemas, modelMeta, url: new URL(`http://localhost/${args.path}`) });
+        });
+
+        it('POST', async () => {
+            const r = await handler({
+                method: 'post',
+                path: '/user',
+                query: {},
+                requestBody: {
+                    data: {
+                        type: 'user',
+                        attributes: { email: '[email protected]', role: 'COMMON_USER' },
+                    },
+                },
+                prisma,
+            });
+
+            expect(r.status).toBe(201);
+        });
+
+        it('GET', async () => {
+            await prisma.user.create({
+                data: { email: '[email protected]', role: 'COMMON_USER' },
+            });
+
+            const r = await handler({
+                method: 'get',
+                path: '/user',
+                query: {},
+                prisma,
+            });
+
+            expect(r.status).toBe(200);
+            expect(r.body.data).toHaveLength(1);
+        });
+
+        it('GET single', async () => {
+            await prisma.user.create({
+                data: { email: '[email protected]', role: 'COMMON_USER' },
+            });
+
+            const r = await handler({
+                method: 'get',
+                path: '/user/[email protected]:COMMON_USER',
+                query: {},
+                prisma,
+            });
+
+            expect(r.status).toBe(200);
+            expect(r.body.data.attributes.email).toBe('[email protected]');
+        });
+
+        it('PUT', async () => {
+            await prisma.user.create({
+                data: { email: '[email protected]', role: 'COMMON_USER' },
+            });
+
+            const r = await handler({
+                method: 'put',
+                path: '/user/[email protected]:COMMON_USER',
+                query: {},
+                prisma,
+            });
+
+            expect(r.status).toBe(200);
+        });
+    });
 });