@trayio/cdk-runtime 2.4.0 → 2.5.0

package/dist/connector/operation/HttpOperationExecution.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HttpOperationExecution.d.ts","sourceRoot":"","sources":["../../../src/connector/operation/HttpOperationExecution.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,oBAAoB,EACpB,uBAAuB,EACvB,sBAAsB,EAEtB,MAAM,sDAAsD,CAAC;AAC9D,OAAO,EAEN,oBAAoB,EAKpB,MAAM,0DAA0D,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAQ7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,qBAAa,sBAAsB,CAClC,IAAI,SAAS,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,EACnD,EAAE,EACF,GAAG,CACF,YAAW,kBAAkB,CAAC,IAAI,EAAE,EAAE,EAAE,GAAG,CAAC;IAE7C,OAAO,CAAC,iBAAiB,CAAoB;IAC7C,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,OAAO,CAAsC;gBAGpD,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,oBAAoB,CAAC,IAAI,EAAE,EAAE,EAAE,GAAG,CAAC;IAOvC,OAAO,CACZ,GAAG,EAAE,uBAAuB,CAAC,IAAI,CAAC,EAClC,KAAK,EAAE,EAAE,GACP,OAAO,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;IAyCvC,OAAO,CAAC,6BAA6B;IA4BrC,OAAO,CAAC,eAAe;IAKvB,OAAO,CAAC,eAAe;IAKvB,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,oBAAoB;IAc5B,OAAO,CAAC,aAAa;IAiCrB,OAAO,CAAC,eAAe;IAmBvB,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,eAAe;IAUvB,OAAO,CAAC,gBAAgB;CAexB"}
+{"version":3,"file":"HttpOperationExecution.d.ts","sourceRoot":"","sources":["../../../src/connector/operation/HttpOperationExecution.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,oBAAoB,EACpB,uBAAuB,EACvB,sBAAsB,EAGtB,MAAM,sDAAsD,CAAC;AAC9D,OAAO,EAEN,oBAAoB,EAKpB,MAAM,0DAA0D,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAc7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,qBAAa,sBAAsB,CAClC,IAAI,SAAS,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,EACnD,EAAE,EACF,GAAG,CACF,YAAW,kBAAkB,CAAC,IAAI,EAAE,EAAE,EAAE,GAAG,CAAC;IAE7C,OAAO,CAAC,iBAAiB,CAAoB;IAC7C,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,OAAO,CAAsC;gBAGpD,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,oBAAoB,CAAC,IAAI,EAAE,EAAE,EAAE,GAAG,CAAC;IAOvC,OAAO,CACZ,GAAG,EAAE,uBAAuB,CAAC,IAAI,CAAC,EAClC,KAAK,EAAE,EAAE,GACP,OAAO,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;IAiDvC,OAAO,CAAC,6BAA6B;IA2BrC,OAAO,CAAC,eAAe;IAOvB,OAAO,CAAC,eAAe;IAOvB,OAAO,CAAC,oBAAoB;IAM5B,OAAO,CAAC,eAAe;IA0BvB,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,oBAAoB;IAc5B,OAAO,CAAC,aAAa;IAiCrB,OAAO,CAAC,eAAe;IAmBvB,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,eAAe;IAUvB,OAAO,CAAC,gBAAgB;CAexB"}

package/dist/connector/operation/HttpOperationExecution.js

@@ -38,6 +38,7 @@ const HttpOperationHandler_1 = require("@trayio/cdk-dsl/connector/operation/Http
 const Http_1 = require("@trayio/commons/http/Http");
 const JsonSerialization_1 = require("@trayio/commons/serialization/JsonSerialization");
 const TE = __importStar(require("fp-ts/TaskEither"));
+const E = __importStar(require("fp-ts/Either"));
 const O = __importStar(require("fp-ts/Option"));
 const function_1 = require("fp-ts/function");
 const BufferExtensions_1 = require("@trayio/commons/buffer/BufferExtensions");
@@ -50,8 +51,11 @@ class HttpOperationExecution {
     execute(ctx, input) {
         return __awaiter(this, void 0, void 0, function* () {
             const operationRequest = this.handler.requestHandler(ctx, input, this.handler.request);
-            const httpRequest = this.operationRequestToHttpRequest(operationRequest);
-            const resultTE = this.httpClient.execute(operationRequest.method, operationRequest.path, httpRequest);
+            const httpRequestE = yield this.operationRequestToHttpRequest(operationRequest)();
+            if (E.isLeft(httpRequestE)) {
+                return OperationHandler_1.OperationHandlerResult.failure(OperationHandler_1.OperationHandlerError.connectorError(httpRequestE.left.message));
+            }
+            const resultTE = this.httpClient.execute(operationRequest.method, operationRequest.path, httpRequestE.right);
             const operationResponseTE = (0, function_1.pipe)(resultTE, 
             // get the dsl http response object
             TE.map((response) => this.handler.responseHandler(ctx, input, new HttpOperationHandler_1.HttpOperationResponseBuilder(response, this.defaultErrorHandling(response.statusCode)))), 
@@ -62,14 +66,13 @@ class HttpOperationExecution {
             return TE.toUnion(operationResponseTE)();
         });
     }
-    // TODO: Add file support, the output may need to be changed to TastEither<Error, HttpRequest>
     operationRequestToHttpRequest(operationRequest) {
-        const serializedBody = (0, function_1.pipe)(operationRequest.contentType, O.map((contentType) => {
+        return (0, function_1.pipe)(operationRequest.contentType, O.map((contentType) => {
             switch (contentType) {
                 case Http_1.HttpContentType.Json:
                     return this.serializeAsJson(operationRequest.body);
                 case Http_1.HttpContentType.OctetStream:
-                    return this.serializeAsFile(operationRequest.body);
+                    return this.serializeAsFile(operationRequest);
                 case Http_1.HttpContentType.MultipartRequestBody:
                     return this.serializeAsMultipart(operationRequest.body);
                 case Http_1.HttpContentType.Text:
@@ -77,25 +80,35 @@ class HttpOperationExecution {
                 default:
                     return this.serializeAsJson(operationRequest.body);
             }
-        }), O.getOrElse(() => this.serializeEmptyBody()));
-        return Object.assign(Object.assign({}, operationRequest.request), { body: serializedBody });
+        }), O.getOrElse(() => this.serializeEmptyBody()), TE.map((serializedBody) => (Object.assign(Object.assign({}, operationRequest.request), { body: serializedBody }))));
     }
     serializeAsJson(body) {
         const serializedBody = this.jsonSerialization.serialize(body);
-        return BufferExtensions_1.BufferExtensions.arrayBufferToReadable(serializedBody);
+        return TE.right(BufferExtensions_1.BufferExtensions.arrayBufferToReadable(serializedBody));
     }
     serializeAsText(body) {
         const serializedBody = new TextEncoder().encode(body);
-        return BufferExtensions_1.BufferExtensions.arrayBufferToReadable(serializedBody);
+        return TE.right(BufferExtensions_1.BufferExtensions.arrayBufferToReadable(serializedBody));
     }
     serializeAsMultipart(body) {
         throw new Error('unimplemented');
     }
-    serializeAsFile(body) {
-        throw new Error('unimplemented');
+    serializeAsFile(operationRequest) {
+        const downloadFilefromReference = this.httpClient.execute(Http_1.HttpMethod.Get, operationRequest.body.url, {
+            headers: { [Http_1.HttpHeader.ContentType]: Http_1.HttpContentType.OctetStream },
+            pathParams: {},
+            queryString: {},
+            body: BufferExtensions_1.BufferExtensions.arrayBufferToReadable(new ArrayBuffer(0)),
+        });
+        return (0, function_1.pipe)(downloadFilefromReference, TE.chain((response) => {
+            if (response.statusCode >= 300) {
+                return TE.left(Error('error downloading file from source'));
+            }
+            return TE.right(response.body);
+        }));
     }
     serializeEmptyBody() {
-        return BufferExtensions_1.BufferExtensions.arrayBufferToReadable(new ArrayBuffer(0));
+        return TE.right(BufferExtensions_1.BufferExtensions.arrayBufferToReadable(new ArrayBuffer(0)));
     }
     defaultErrorHandling(statusCode) {
         return () => OperationHandler_1.OperationHandlerResult.failure(OperationHandler_1.OperationHandlerError.apiError(`API returned a status code of ${statusCode}`, {

package/dist/connector/operation/OperationExecutionGateway.unit.test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OperationExecutionGateway.unit.test.d.ts","sourceRoot":"","sources":["../../../src/connector/operation/OperationExecutionGateway.unit.test.ts"],"names":[],"mappings":"AAGA,OAAO,8BAA8B,CAAC"}
+{"version":3,"file":"OperationExecutionGateway.unit.test.d.ts","sourceRoot":"","sources":["../../../src/connector/operation/OperationExecutionGateway.unit.test.ts"],"names":[],"mappings":"AAIA,OAAO,8BAA8B,CAAC"}

package/dist/connector/operation/OperationExecutionGateway.unit.test.js

@@ -1,62 +1,178 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const OperationHandlerSetup_1 = require("@trayio/cdk-dsl/connector/operation/OperationHandlerSetup");
 const OperationHandlerTest_1 = require("@trayio/cdk-dsl/connector/operation/OperationHandlerTest");
 const OperationHandler_1 = require("@trayio/cdk-dsl/connector/operation/OperationHandler");
 require("./OperationHandlerTestRunner");
-const getProductOperation = OperationHandlerSetup_1.OperationHandlerSetup.configureHandler((handler) => handler
-    .addInputValidation((inputValidation) => inputValidation
-    .condition((ctx, input) => input.id > 0)
-    .errorMessage(() => 'id must be bigger than zero'))
-    .usingHttp((http) => http
-    .get('https://jsonplaceholder.typicode.com/posts/:id')
-    .handleRequest((ctx, input, request) => request.addPathParameter('id', input.id.toString()).withoutBody())
-    .handleResponse((ctx, input, response) => response.parseWithBodyAsJson())));
-OperationHandlerTest_1.OperationHandlerTestSetup.configureHandlerTest(getProductOperation, (handlerTest) => handlerTest
-    .usingHandlerContext('test')
-    .nothingBeforeAll()
-    .testCase('should get a product', (testCase) => testCase
-    .usingHandlerContext('test')
-    .givenNothing()
-    .when(() => ({ id: 2 }))
-    .then(({ output }) => {
-    const outputValue = OperationHandler_1.OperationHandlerResult.getSuccessfulValueOrFail(output);
-    expect(outputValue.id).toEqual(2);
-})
-    .finallyDoNothing())
-    .testCase('should validate id', (testCase) => testCase
-    .givenNothing()
-    .when(() => ({ id: -1 }))
-    .then(({ output }) => {
-    expect(output.isFailure).toBe(true);
-})
-    .finallyDoNothing())
-    .nothingAfterAll());
-const getProductOperationAsText = OperationHandlerSetup_1.OperationHandlerSetup.configureHandler((handler) => handler
-    .addInputValidation((inputValidation) => inputValidation
-    .condition((ctx, input) => input.id > 0)
-    .errorMessage(() => 'id must be bigger than zero'))
-    .usingHttp((http) => http
-    .get('https://jsonplaceholder.typicode.com/posts/:id')
-    .handleRequest((ctx, input, request) => request.addPathParameter('id', input.id.toString()).withoutBody())
-    .handleResponse((ctx, input, response) => response.parseWithBodyAsText((text) => OperationHandler_1.OperationHandlerResult.success({ textField: text })))));
-OperationHandlerTest_1.OperationHandlerTestSetup.configureHandlerTest(getProductOperationAsText, (handlerTest) => handlerTest
-    .usingHandlerContext('test')
-    .nothingBeforeAll()
-    .testCase('should get a product', (testCase) => testCase
-    .usingHandlerContext('test')
-    .givenNothing()
-    .when(() => ({ id: 2 }))
-    .then(({ output }) => {
-    const outputValue = OperationHandler_1.OperationHandlerResult.getSuccessfulValueOrFail(output);
-    expect(outputValue.textField).toContain(`"id": 2`);
-})
-    .finallyDoNothing())
-    .testCase('should validate id', (testCase) => testCase
-    .givenNothing()
-    .when(() => ({ id: -1 }))
-    .then(({ output }) => {
-    expect(output.isFailure).toBe(true);
-})
-    .finallyDoNothing())
-    .nothingAfterAll());
+const T = __importStar(require("fp-ts/Task"));
+const TE = __importStar(require("fp-ts/TaskEither"));
+const function_1 = require("fp-ts/function");
+const Http_1 = require("@trayio/commons/http/Http");
+const stream_1 = require("stream");
+const ExpressHttpServer_1 = require("@trayio/express/http/ExpressHttpServer");
+const ExpressHttpController_1 = require("@trayio/express/http/ExpressHttpController");
+const NodeFsFileStorage_1 = require("@trayio/commons/file/NodeFsFileStorage");
+const fileStorage = new NodeFsFileStorage_1.NodeFsFileStorage('/tmp');
+class TestControllerHttp {
+    constructor() {
+        this.getEndpoints = () => [
+            {
+                path: `/posts/:id`,
+                method: Http_1.HttpMethod.Get,
+                execute: (request) => {
+                    const { id } = request.pathParams;
+                    return T.of({
+                        body: stream_1.Readable.from(JSON.stringify({
+                            id: parseInt(id, 10),
+                            title: 'test',
+                        })),
+                        headers: {},
+                        statusCode: 200,
+                    });
+                },
+            },
+            {
+                path: `/image-upload`,
+                method: Http_1.HttpMethod.Post,
+                execute: (request) => {
+                    const { body } = request;
+                    return (0, function_1.pipe)(fileStorage.write({
+                        content: body,
+                        metadata: {
+                            key: 'test.ico',
+                        },
+                    }), TE.fold(() => T.of({
+                        body: stream_1.Readable.from(JSON.stringify({
+                            success: false,
+                        })),
+                        headers: {},
+                        statusCode: 500,
+                    }), () => T.of({
+                        body: stream_1.Readable.from(JSON.stringify({
+                            success: true,
+                        })),
+                        headers: {},
+                        statusCode: 200,
+                    })));
+                },
+            },
+        ];
+    }
+}
+const testHttpController = new ExpressHttpController_1.ExpressHttpController(new TestControllerHttp(), '/tmp');
+describe('OperationExecutionGateway', () => {
+    let server;
+    beforeAll(() => {
+        server = (0, ExpressHttpServer_1.startServer)([testHttpController], { port: 3000 });
+    });
+    afterAll(() => {
+        server.close();
+    });
+    describe('get a product', () => {
+        const getProductOperation = OperationHandlerSetup_1.OperationHandlerSetup.configureHandler((handler) => handler
+            .addInputValidation((inputValidation) => inputValidation
+            .condition((ctx, input) => input.id > 0)
+            .errorMessage(() => 'id must be bigger than zero'))
+            .usingHttp((http) => http
+            .get('http://localhost:3000/posts/:id')
+            .handleRequest((ctx, input, request) => request.addPathParameter('id', input.id.toString()).withoutBody())
+            .handleResponse((ctx, input, response) => response.parseWithBodyAsJson())));
+        OperationHandlerTest_1.OperationHandlerTestSetup.configureHandlerTest(getProductOperation, (handlerTest) => handlerTest
+            .usingHandlerContext('test')
+            .nothingBeforeAll()
+            .testCase('should get a product', (testCase) => testCase
+            .usingHandlerContext('test')
+            .givenNothing()
+            .when(() => ({ id: 2 }))
+            .then(({ output }) => {
+            const outputValue = OperationHandler_1.OperationHandlerResult.getSuccessfulValueOrFail(output);
+            expect(outputValue.id).toEqual(2);
+        })
+            .finallyDoNothing())
+            .testCase('should validate id', (testCase) => testCase
+            .givenNothing()
+            .when(() => ({ id: -1 }))
+            .then(({ output }) => {
+            expect(output.isFailure).toBe(true);
+        })
+            .finallyDoNothing())
+            .nothingAfterAll());
+    });
+    describe('get a product as text', () => {
+        const getProductOperationAsText = OperationHandlerSetup_1.OperationHandlerSetup.configureHandler((handler) => handler
+            .addInputValidation((inputValidation) => inputValidation
+            .condition((ctx, input) => input.id > 0)
+            .errorMessage(() => 'id must be bigger than zero'))
+            .usingHttp((http) => http
+            .get('http://localhost:3000/posts/:id')
+            .handleRequest((ctx, input, request) => request.addPathParameter('id', input.id.toString()).withoutBody())
+            .handleResponse((ctx, input, response) => response.parseWithBodyAsText((text) => OperationHandler_1.OperationHandlerResult.success({ textField: text })))));
+        OperationHandlerTest_1.OperationHandlerTestSetup.configureHandlerTest(getProductOperationAsText, (handlerTest) => handlerTest
+            .usingHandlerContext('test')
+            .nothingBeforeAll()
+            .testCase('should get a product as text', (testCase) => testCase
+            .usingHandlerContext('test')
+            .givenNothing()
+            .when(() => ({ id: 2 }))
+            .then(({ output }) => {
+            const outputValue = OperationHandler_1.OperationHandlerResult.getSuccessfulValueOrFail(output);
+            expect(outputValue.textField).toContain(`"id":2`);
+        })
+            .finallyDoNothing())
+            .testCase('should validate id', (testCase) => testCase
+            .givenNothing()
+            .when(() => ({ id: -1 }))
+            .then(({ output }) => {
+            expect(output.isFailure).toBe(true);
+        })
+            .finallyDoNothing())
+            .nothingAfterAll());
+    });
+    describe('upload an image', () => {
+        const uploadImageOperation = OperationHandlerSetup_1.OperationHandlerSetup.configureHandler((handler) => handler.usingHttp((http) => http
+            .post('http://localhost:3000/image-upload')
+            .handleRequest((ctx, input, request) => request.withBodyAsFile({
+            name: 'test-image',
+            url: 'https://tray.io/favicon.ico',
+            mime_type: 'image/png',
+            expires: 0,
+        }))
+            .handleResponse((ctx, input, response) => response.parseWithBodyAsJson())));
+        OperationHandlerTest_1.OperationHandlerTestSetup.configureHandlerTest(uploadImageOperation, (handlerTest) => handlerTest
+            .usingHandlerContext('test')
+            .nothingBeforeAll()
+            .testCase('should upload an image', (testCase) => testCase
+            .usingHandlerContext('test')
+            .givenNothing()
+            .when(() => ({}))
+            .then(({ output }) => {
+            const outputValue = OperationHandler_1.OperationHandlerResult.getSuccessfulValueOrFail(output);
+            expect(outputValue.success).toEqual(true);
+        })
+            .finallyDoNothing())
+            .nothingAfterAll());
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/cdk-runtime",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "A Runtime that executes connector operations defined using the CDK DSL",
   "exports": {
     "./*": "./dist/*.js"
@@ -14,9 +14,10 @@
     "node": ">=18.x"
   },
   "dependencies": {
-    "@trayio/axios": "2.4.0",
-    "@trayio/cdk-dsl": "2.4.0",
-    "@trayio/winston": "2.4.0"
+    "@trayio/axios": "2.5.0",
+    "@trayio/cdk-dsl": "2.5.0",
+    "@trayio/express": "2.5.0",
+    "@trayio/winston": "2.5.0"
   },
   "typesVersions": {
     "*": {