fix: validation errors are shown as "Server communication error" (#515)

* fix: documentLoader() was not loading with method GET When parent function fetchJsonLd() was called with method POST the method is inherited which resulted in a status 415 response from the API which refused the unsafe method with unrecognized Content Type jsonld. * fix: was not displaying a useful error message when creating an entity
api-platform · Nov 27, 2023 · eebbc51 · eebbc51
1 parent 47e05b0
commit eebbc51
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 27 deletions.
diff --git a/jest.setup.ts b/jest.setup.ts
@@ -1,8 +1,9 @@
 // eslint-disable-next-line import/no-extraneous-dependencies
 import '@testing-library/jest-dom';
-import { TextEncoder } from 'util';
+import { TextEncoder, TextDecoder } from 'util';
 // eslint-disable-next-line import/no-extraneous-dependencies
 import { Request } from 'node-fetch';
 
 global.TextEncoder = TextEncoder;
+global.TextDecoder = TextDecoder as any;
 global.Request = Request as any;
diff --git a/src/hydra/dataProvider.test.ts b/src/hydra/dataProvider.test.ts
@@ -138,7 +138,7 @@ describe('Transform a React Admin request to an Hydra request', () => {
         perPage: 30,
       },
       sort: {
-        order: '',
+        order: 'ASC',
         field: '',
       },
       filter: {

diff --git a/src/hydra/dataProvider.ts b/src/hydra/dataProvider.ts
@@ -722,7 +722,7 @@ function dataProvider(
               page: 1,
             },
             filter: { id: params.ids },
-            sort: { field: '', order: '' },
+            sort: { field: '', order: 'ASC' },
           }).then(({ data }) => ({ data }));
         }
 

diff --git a/src/hydra/fetchHydra.ts b/src/hydra/fetchHydra.ts
@@ -4,7 +4,7 @@ import {
   getDocumentationUrlFromHeaders,
 } from '@api-platform/api-doc-parser';
 import jsonld from 'jsonld';
-import type { NodeObject } from 'jsonld';
+import type { ContextDefinition, NodeObject } from 'jsonld';
 import type { JsonLdObj } from 'jsonld/jsonld-spec';
 import type { HttpClientOptions, HydraHttpClientResponse } from '../types.js';
 
@@ -40,21 +40,28 @@ function fetchHydra(
 
       delete (body as NodeObject).trace;
 
-      const documentLoader = (input: string) =>
-        fetchJsonLd(input, authOptions).then((response) => {
+      const documentLoader = (input: string) => {
+        const loaderOptions = authOptions;
+        loaderOptions.method = 'GET';
+        delete loaderOptions.body;
+
+        return fetchJsonLd(input, loaderOptions).then((response) => {
           if (!('body' in response)) {
             throw new Error(
               'An empty response was received when expanding JSON-LD error document.',
             );
           }
           return response;
         });
+      };
+
+      return documentLoader(getDocumentationUrlFromHeaders(headers))
+        .then((response) =>
+          jsonld.expand(body, {
+            expandContext: response.document as ContextDefinition,
+          }),
+        )
 
-      return jsonld
-        .expand(body, {
-          base: getDocumentationUrlFromHeaders(headers),
-          documentLoader,
-        })
         .then((json) =>
           Promise.reject(
             new HttpError(

diff --git a/src/types.ts b/src/types.ts
@@ -226,22 +226,22 @@ export type ApiPlatformAdminDataProviderTypeParams<T extends DataProviderType> =
   T extends typeof GET_LIST
     ? ApiPlatformAdminGetListParams
     : T extends typeof GET_ONE
-    ? ApiPlatformAdminGetOneParams
-    : T extends typeof GET_MANY
-    ? ApiPlatformAdminGetManyParams
-    : T extends typeof GET_MANY_REFERENCE
-    ? ApiPlatformAdminGetManyReferenceParams
-    : T extends typeof UPDATE
-    ? ApiPlatformAdminUpdateParams
-    : T extends typeof UPDATE_MANY
-    ? ApiPlatformAdminUpdateManyParams
-    : T extends typeof CREATE
-    ? ApiPlatformAdminCreateParams
-    : T extends typeof DELETE
-    ? ApiPlatformAdminDeleteParams
-    : T extends typeof DELETE_MANY
-    ? ApiPlatformAdminDeleteManyParams
-    : never;
+      ? ApiPlatformAdminGetOneParams
+      : T extends typeof GET_MANY
+        ? ApiPlatformAdminGetManyParams
+        : T extends typeof GET_MANY_REFERENCE
+          ? ApiPlatformAdminGetManyReferenceParams
+          : T extends typeof UPDATE
+            ? ApiPlatformAdminUpdateParams
+            : T extends typeof UPDATE_MANY
+              ? ApiPlatformAdminUpdateManyParams
+              : T extends typeof CREATE
+                ? ApiPlatformAdminCreateParams
+                : T extends typeof DELETE
+                  ? ApiPlatformAdminDeleteParams
+                  : T extends typeof DELETE_MANY
+                    ? ApiPlatformAdminDeleteManyParams
+                    : never;
 
 export interface ApiPlatformAdminDataProviderFactoryParams {
   entrypoint: string;