Merge pull request #295 from superfaceai/feature/map-interpreter-stream

streaming map interpreter

Author: TheEdda

.gitignore

@@ -105,3 +105,4 @@ dist
 
 .yalc
 .vscode
+workdir/

CHANGELOG.md

@@ -20,10 +20,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - `multipart/form-data` supports array values to define duplicate fields
 
+### Changed
+- Reworked map interpreter into an asynchronous generator. It should be 1:1 replacement of the original interpreter, but opens up the road to expose streaming perform later.
+
 ### Fixed
 - Do not set `Accept` and `Content-Type` header when defined in [HTTP request headers](https://spec.superface.dev/latest/map-spec.html#HTTPHeaders) - [#264](https://github.com/superfaceai/one-sdk-js/issues/264)
 - Replaced `isomorphic-form-data` with `form-data` package to fix `FormData` serialization - [#291](https://github.com/superfaceai/one-sdk-js/issues/291)
 - Create valid `headersInit` shape in `NodeFetch.fetch`
+- Added `UnexpectedError` and `SDKExecutionError` to MapInterpreter and BoundProfileProvider return signatures.
 - An http call to `/` url returning an error about it being an absolute url
 
 ## [2.0.0] - 2022-08-15

src/core/errors/errors.helpers.ts

@@ -100,7 +100,7 @@ export function sourceFileExtensionFoundError(
   return new SDKExecutionError(
     `${extension} extension found.`,
     [],
-    [`${extension} files needs to be compiled with Superface CLI.`]
+    [`${extension} files need to be compiled with Superface CLI.`]
   );
 }
 

src/core/events/events.test.ts

@@ -7,7 +7,7 @@ import type {
 import { ApiKeyPlacement, HttpScheme, SecurityType } from '@superfaceai/ast';
 import { getLocal } from 'mockttp';
 
-import { err } from '../../lib';
+import { err, UnexpectedError } from '../../lib';
 import { MockTimers } from '../../mock';
 import { NodeCrypto, NodeFetch, NodeFileSystem } from '../../node';
 import { Config } from '../config';
@@ -243,6 +243,7 @@ describe('events', () => {
       events
     );
 
+    const error = new UnexpectedError('modified rejection');
     events.on(
       'post-fetch',
       { priority: 1 },
@@ -254,14 +255,14 @@ describe('events', () => {
         } catch (e) {
           return {
             kind: 'modify',
-            newResult: Promise.reject('modified rejection'),
+            newResult: Promise.reject(error),
           };
         }
       }
     );
 
     const result = await profile.perform('Test');
-    expect(result).toStrictEqual(err('modified rejection'));
+    expect(result).toStrictEqual(err(error));
   });
 
   it('passes unhandled http responses to unhandled-http (201)', async () => {

src/core/interpreter/http/utils.test.ts

@@ -1,25 +1,35 @@
-import { createUrl, deleteHeader, getHeader, hasHeader, setHeader } from './utils';
+import {
+  createUrl,
+  deleteHeader,
+  getHeader,
+  hasHeader,
+  setHeader,
+} from './utils';
 
 describe('interpreter · http · utils', () => {
   describe('getHeader', () => {
     it('returns all values', () => {
-      expect(getHeader({ foo: 'bar', Foo: 'baz', FOO: ['qux', 'quz'] }, 'foo')).toEqual('bar, baz, qux, quz');
+      expect(
+        getHeader({ foo: 'bar', Foo: 'baz', FOO: ['qux', 'quz'] }, 'foo')
+      ).toEqual('bar, baz, qux, quz');
     });
 
     it('cleans up undefined values', () => {
-      expect(getHeader({ foo: 'bar', Foo: undefined, FOO: ['qux', 'quz'] }, 'foo')).toEqual('bar, qux, quz');
+      expect(
+        getHeader({ foo: 'bar', Foo: undefined, FOO: ['qux', 'quz'] }, 'foo')
+      ).toEqual('bar, qux, quz');
     });
   });
 
   describe('hasHeader', () => {
     it('should return true if header is present', () => {
-      expect(hasHeader({ 'Foo': 'bar' }, 'foo')).toBe(true);
+      expect(hasHeader({ Foo: 'bar' }, 'foo')).toBe(true);
     });
 
     it('should return false if header is not present', () => {
-      expect(hasHeader({ 'Foo': 'bar' }, 'baz')).toBe(false);
+      expect(hasHeader({ Foo: 'bar' }, 'baz')).toBe(false);
     });
-  })
+  });
 
   describe('setHeader', () => {
     it('mutates passed data', () => {
@@ -41,28 +51,28 @@ describe('interpreter · http · utils', () => {
       deleteHeader(headers, 'Foo');
       expect(headers).toEqual({});
     });
-  })
+  });
 
   describe('createUrl', () => {
     it('correctly creates url for empty string', () => {
       const mapUrl = '';
-      expect(
-        createUrl(mapUrl, { baseUrl: 'http://example.com' })
-      ).toBe('http://example.com')
+      expect(createUrl(mapUrl, { baseUrl: 'http://example.com' })).toBe(
+        'http://example.com'
+      );
     });
 
     it('correctly creates url for single slash', () => {
       const mapUrl = '/';
-      expect(
-        createUrl(mapUrl, { baseUrl: 'http://example.com' })
-      ).toBe('http://example.com/')
+      expect(createUrl(mapUrl, { baseUrl: 'http://example.com' })).toBe(
+        'http://example.com/'
+      );
     });
 
     it('returns an error for absolute url', () => {
       const mapUrl = 'something';
-      expect(
-        () => createUrl(mapUrl, { baseUrl: 'http://example.com' })
-      ).toThrow('Expected relative url')
+      expect(() =>
+        createUrl(mapUrl, { baseUrl: 'http://example.com' })
+      ).toThrow('Expected relative url');
     });
   });
 });

src/core/interpreter/http/utils.ts

@@ -145,13 +145,15 @@ export async function fetchRequest(
  * Get header value. For duplicate headers all delimited by `,` are returned
  */
 export function getHeader(headers: NonPrimitive, headerName: string): string {
-  const values = Object.entries(headers).flatMap(([key, value]) => {
-    if (key.toLowerCase() === headerName.toLowerCase()) {
-      return value;
-    }
-
-    return undefined;
-  }).filter(value => value !== undefined);
+  const values = Object.entries(headers)
+    .flatMap(([key, value]) => {
+      if (key.toLowerCase() === headerName.toLowerCase()) {
+        return value;
+      }
+
+      return undefined;
+    })
+    .filter(value => value !== undefined);
 
   return values.join(', ');
 }

src/core/interpreter/map-interpreter.errors.test.ts

@@ -9,7 +9,7 @@ import { getLocal } from 'mockttp';
 
 import { UnexpectedError } from '../../lib';
 import { MockTimers } from '../../mock';
-import { NodeCrypto, NodeFetch, NodeFileSystem } from '../../node';
+import { NodeCrypto, NodeFetch, NodeFileSystem, NodeLogger } from '../../node';
 import { Config } from '../config';
 import { ServiceSelector } from '../services';
 import { MapInterpreter } from './map-interpreter';
@@ -21,11 +21,14 @@ import {
   MappedHTTPError,
 } from './map-interpreter.errors';
 
-const config = new Config(NodeFileSystem);
 const mockServer = getLocal();
 const timers = new MockTimers();
-const crypto = new NodeCrypto();
-const fetchInstance = new NodeFetch(timers);
+const interpreterDependencies = {
+  fetchInstance: new NodeFetch(timers),
+  config: new Config(NodeFileSystem),
+  crypto: new NodeCrypto(),
+  logger: new NodeLogger(),
+};
 const header: MapHeaderNode = {
   kind: 'MapHeader',
   profile: {
@@ -231,7 +234,7 @@ AST Path: definitions[0].statements[0].assignments[0].value`
           security: [],
           services: ServiceSelector.empty(),
         },
-        { fetchInstance, config, crypto }
+        interpreterDependencies
       );
       const result = await interpreter.perform({
         kind: 'Invalid',
@@ -248,7 +251,7 @@ AST Path: definitions[0].statements[0].assignments[0].value`
           security: [],
           services: ServiceSelector.empty(),
         },
-        { fetchInstance, config, crypto }
+        interpreterDependencies
       );
       const result = await interpreter.perform({
         astMetadata,
@@ -266,7 +269,7 @@ AST Path: definitions[0].statements[0].assignments[0].value`
           security: [],
           services: ServiceSelector.empty(),
         },
-        { fetchInstance, config, crypto }
+        interpreterDependencies
       );
       const result = await interpreter.perform(
         parseMapFromSource(`
@@ -289,7 +292,7 @@ AST Path: definitions[0].statements[0].assignments[0].value`
           security: [],
           services: ServiceSelector.empty(),
         },
-        { fetchInstance, config, crypto }
+        interpreterDependencies
       );
       const ast = parseMapFromSource(`
         map Test {
@@ -319,7 +322,7 @@ AST Path: definitions[0].statements[0].assignments[0].value`
           security: [],
           services: mockServicesSelector,
         },
-        { fetchInstance, config, crypto }
+        interpreterDependencies
       );
 
       const ast = parseMapFromSource(`
@@ -353,7 +356,7 @@ AST Path: definitions[0].statements[0].assignments[0].value`
           security: [],
           services: mockServicesSelector,
         },
-        { fetchInstance, config, crypto }
+        interpreterDependencies
       );
       const ast = parseMapFromSource(`
           map testCase {
@@ -383,7 +386,7 @@ AST Path: definitions[0].statements[0].assignments[0].value`
           security: [],
           services: mockServicesSelector,
         },
-        { fetchInstance, config, crypto }
+        interpreterDependencies
       );
       const ast = parseMapFromSource(`
         map Test {
@@ -422,7 +425,7 @@ AST Path: definitions[0].statements[0].assignments[0].value`
           security: [],
           services: mockServicesSelector,
         },
-        { fetchInstance, config, crypto }
+        interpreterDependencies
       );
       const ast = parseMapFromSource(`
         map Test {
@@ -453,7 +456,7 @@ AST Path: definitions[0].statements[0].assignments[0].value`
           security: [],
           services: ServiceSelector.empty(),
         },
-        { fetchInstance, config, crypto }
+        interpreterDependencies
       );
       const ast = parseMapFromSource(`
         map Test {
@@ -472,7 +475,7 @@ AST Path: definitions[0].statements[0].assignments[0].value`
           security: [],
           services: mockServicesSelector,
         },
-        { fetchInstance, config, crypto }
+        interpreterDependencies
       );
       const ast = parseMapFromSource(`
         map Test {
@@ -496,7 +499,7 @@ AST Path: definitions[0].statements[0].assignments[0].value`
           security: [],
           services: mockServicesSelector,
         },
-        { fetchInstance, config, crypto }
+        interpreterDependencies
       );
       const ast = parseMapFromSource(`
         map Test {
@@ -538,7 +541,7 @@ AST Path: definitions[0].statements[0].assignments[0].value`
             `${mockServicesSelector.getUrl()!}/{path}`
           ),
         },
-        { fetchInstance, config, crypto }
+        interpreterDependencies
       );
       const result = await interpreter.perform(ast);
       expect(result.isErr() && result.error.toString()).toMatch(
@@ -573,7 +576,7 @@ AST Path: definitions[0].statements[0].assignments[0].value`
         security: [],
         services: ServiceSelector.empty(),
       },
-      { fetchInstance, config, crypto }
+      interpreterDependencies
     );
 
     const result = await interpreter.perform(ast);
@@ -609,7 +612,7 @@ AST Path: definitions[0].statements[0].assignments[0].value`
         security: [],
         services: ServiceSelector.empty(),
       },
-      { fetchInstance, config, crypto }
+      interpreterDependencies
     );
 
     const result = await interpreter.perform(ast);
@@ -645,7 +648,7 @@ AST Path: definitions[0].statements[0].assignments[0].value`
         security: [],
         services: ServiceSelector.empty(),
       },
-      { fetchInstance, config, crypto }
+      interpreterDependencies
     );
 
     const result = await interpreter.perform(ast);