@backstage/backend-openapi-utils 0.1.19-next.0 → 0.2.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @backstage/backend-openapi-utils
 
+## 0.2.0-next.1
+
+### Minor Changes
+
+- 66af016: Improved support for OpenAPI validation during Jest tests. Now, OpenAPI validation can happen as you are writing your Jest tests - you no longer have to run `repo schema openapi test`.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.0.1-next.1
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+
 ## 0.1.19-next.0
 
 ### Patch Changes

package/dist/constants.cjs.js

@@ -0,0 +1,6 @@
+'use strict';
+
+const OPENAPI_SPEC_ROUTE = "/openapi.json";
+
+exports.OPENAPI_SPEC_ROUTE = OPENAPI_SPEC_ROUTE;
+//# sourceMappingURL=constants.cjs.js.map

package/dist/constants.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.cjs.js","sources":["../src/constants.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * The route that all OpenAPI specs should be served from.\n * @public\n */\nexport const OPENAPI_SPEC_ROUTE = '/openapi.json';\n"],"names":[],"mappings":";;AAoBO,MAAM,kBAAqB,GAAA;;;;"}

package/dist/index.cjs.js

@@ -1,106 +1,14 @@
 'use strict';
 
-var PromiseRouter = require('express-promise-router');
-var express = require('express');
-var errors = require('@backstage/errors');
-var expressOpenapiValidator = require('express-openapi-validator');
-var openapiMerge = require('openapi-merge');
+var index = require('./types/index.cjs.js');
+var stub = require('./stub.cjs.js');
+var testUtils = require('./testUtils.cjs.js');
 
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
-var PromiseRouter__default = /*#__PURE__*/_interopDefaultCompat(PromiseRouter);
 
-var index = /*#__PURE__*/Object.freeze({
-  __proto__: null
-});
-
-const OPENAPI_SPEC_ROUTE = "/openapi.json";
-
-const baseUrlSymbol = Symbol();
-const originalUrlSymbol = Symbol();
-function validatorErrorTransformer() {
-  return (error, _, _2, next) => {
-    next(new errors.InputError(error.message));
-  };
-}
-function getDefaultRouterMiddleware() {
-  return [express.json()];
-}
-function getOpenApiSpecRoute(baseUrl) {
-  return `${baseUrl}${OPENAPI_SPEC_ROUTE}`;
-}
-function createValidatedOpenApiRouter(spec, options) {
-  const router = PromiseRouter__default.default();
-  router.use(options?.middleware || getDefaultRouterMiddleware());
-  router.use((req, _, next) => {
-    const customRequest = req;
-    customRequest[baseUrlSymbol] = customRequest.baseUrl;
-    customRequest.baseUrl = "";
-    customRequest[originalUrlSymbol] = customRequest.originalUrl;
-    customRequest.originalUrl = customRequest.url;
-    next();
-  });
-  router.use(
-    expressOpenapiValidator.middleware({
-      validateRequests: {
-        coerceTypes: false,
-        allowUnknownQueryParameters: false
-      },
-      ignoreUndocumented: true,
-      validateResponses: false,
-      ...options?.validatorOptions,
-      apiSpec: spec
-    })
-  );
-  router.use((req, _, next) => {
-    const customRequest = req;
-    customRequest.baseUrl = customRequest[baseUrlSymbol];
-    customRequest.originalUrl = customRequest[originalUrlSymbol];
-    delete customRequest[baseUrlSymbol];
-    delete customRequest[originalUrlSymbol];
-    next();
-  });
-  router.use(validatorErrorTransformer());
-  router.get(OPENAPI_SPEC_ROUTE, async (req, res) => {
-    const mergeOutput = openapiMerge.merge([
-      {
-        oas: spec,
-        pathModification: {
-          /**
-           * Get the route that this OpenAPI spec is hosted on. The other
-           *  approach of using the discovery API increases the router constructor
-           *  significantly and since we're just looking for path and not full URL,
-           *  this works.
-           *
-           * If we wanted to add a list of servers, there may be a case for adding
-           *  discovery API to get an exhaustive list of upstream servers, but that's
-           *  also not currently supported.
-           */
-          prepend: req.originalUrl.replace(OPENAPI_SPEC_ROUTE, "")
-        }
-      }
-    ]);
-    if (openapiMerge.isErrorResult(mergeOutput)) {
-      throw new errors.InputError("Invalid spec defined");
-    }
-    res.json(mergeOutput.output);
-  });
-  return router;
-}
-
-const wrapInOpenApiTestServer = (app) => {
-  if (process.env.OPTIC_PROXY) {
-    const server = app.listen(+process.env.PORT);
-    return {
-      ...server,
-      address: () => new URL(process.env.OPTIC_PROXY)
-    };
-  }
-  return app;
-};
-
-exports.createValidatedOpenApiRouter = createValidatedOpenApiRouter;
-exports.getOpenApiSpecRoute = getOpenApiSpecRoute;
 exports.internal = index;
-exports.wrapInOpenApiTestServer = wrapInOpenApiTestServer;
+exports.createValidatedOpenApiRouter = stub.createValidatedOpenApiRouter;
+exports.getOpenApiSpecRoute = stub.getOpenApiSpecRoute;
+exports.wrapInOpenApiTestServer = testUtils.wrapInOpenApiTestServer;
+exports.wrapServer = testUtils.wrapServer;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/constants.ts","../src/stub.ts","../src/testUtils.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * The route that all OpenAPI specs should be served from.\n * @public\n */\nexport const OPENAPI_SPEC_ROUTE = '/openapi.json';\n","/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport PromiseRouter from 'express-promise-router';\nimport { ApiRouter } from './router';\nimport { RequiredDoc } from './types';\nimport {\n  ErrorRequestHandler,\n  RequestHandler,\n  NextFunction,\n  Request,\n  Response,\n  json,\n} from 'express';\nimport { InputError } from '@backstage/errors';\nimport { middleware as OpenApiValidator } from 'express-openapi-validator';\nimport { OPENAPI_SPEC_ROUTE } from './constants';\nimport { isErrorResult, merge } from 'openapi-merge';\n\ntype PropertyOverrideRequest = Request & {\n  [key: symbol]: string;\n};\n\nconst baseUrlSymbol = Symbol();\nconst originalUrlSymbol = Symbol();\n\nfunction validatorErrorTransformer(): ErrorRequestHandler {\n  return (error: Error, _: Request, _2: Response, next: NextFunction) => {\n    next(new InputError(error.message));\n  };\n}\n\nexport function getDefaultRouterMiddleware() {\n  return [json()];\n}\n\n/**\n * Given a base url for a plugin, find the given OpenAPI spec for that plugin.\n * @param baseUrl - Plugin base url.\n * @returns OpenAPI spec route for the base url.\n * @public\n */\nexport function getOpenApiSpecRoute(baseUrl: string) {\n  return `${baseUrl}${OPENAPI_SPEC_ROUTE}`;\n}\n\n/**\n * Create a new OpenAPI router with some default middleware.\n * @param spec - Your OpenAPI spec imported as a JSON object.\n * @param validatorOptions - `openapi-express-validator` options to override the defaults.\n * @returns A new express router with validation middleware.\n * @public\n */\nexport function createValidatedOpenApiRouter<T extends RequiredDoc>(\n  spec: T,\n  options?: {\n    validatorOptions?: Partial<Parameters<typeof OpenApiValidator>['0']>;\n    middleware?: RequestHandler[];\n  },\n) {\n  const router = PromiseRouter();\n  router.use(options?.middleware || getDefaultRouterMiddleware());\n\n  /**\n   * Middleware to setup the routing for OpenApiValidator. OpenApiValidator expects `req.originalUrl`\n   *    and `req.baseUrl` to be the full path. We adjust them here to basically be nothing and then\n   *    revive the old values in the last function in this method. We could instead update `req.path`\n   *    but that might affect the routing and I'd rather not.\n   *\n   * TODO: I opened https://github.com/cdimascio/express-openapi-validator/issues/843\n   *    to track this on the middleware side, but there was a similar ticket, https://github.com/cdimascio/express-openapi-validator/issues/113\n   *    that has had minimal activity. If that changes, update this to use a new option on their side.\n   */\n  router.use((req: Request, _, next) => {\n    /**\n     * Express typings are weird. They don't recognize PropertyOverrideRequest as a valid\n     *  Request child and try to overload as PathParams. Just cast it here, since we know\n     *  what we're doing.\n     */\n    const customRequest = req as PropertyOverrideRequest;\n    customRequest[baseUrlSymbol] = customRequest.baseUrl;\n    customRequest.baseUrl = '';\n    customRequest[originalUrlSymbol] = customRequest.originalUrl;\n    customRequest.originalUrl = customRequest.url;\n    next();\n  });\n\n  // TODO: Handle errors by converting from OpenApiValidator errors to known @backstage/errors errors.\n  router.use(\n    OpenApiValidator({\n      validateRequests: {\n        coerceTypes: false,\n        allowUnknownQueryParameters: false,\n      },\n      ignoreUndocumented: true,\n      validateResponses: false,\n      ...options?.validatorOptions,\n      apiSpec: spec as any,\n    }),\n  );\n\n  /**\n   * Revert `req.baseUrl` and `req.originalUrl` changes. This ensures that any further usage\n   *    of these variables will be unchanged.\n   */\n  router.use((req: Request, _, next) => {\n    const customRequest = req as PropertyOverrideRequest;\n    customRequest.baseUrl = customRequest[baseUrlSymbol];\n    customRequest.originalUrl = customRequest[originalUrlSymbol];\n    delete customRequest[baseUrlSymbol];\n    delete customRequest[originalUrlSymbol];\n    next();\n  });\n\n  // Any errors from the middleware get through here.\n  router.use(validatorErrorTransformer());\n\n  router.get(OPENAPI_SPEC_ROUTE, async (req, res) => {\n    const mergeOutput = merge([\n      {\n        oas: spec as any,\n        pathModification: {\n          /**\n           * Get the route that this OpenAPI spec is hosted on. The other\n           *  approach of using the discovery API increases the router constructor\n           *  significantly and since we're just looking for path and not full URL,\n           *  this works.\n           *\n           * If we wanted to add a list of servers, there may be a case for adding\n           *  discovery API to get an exhaustive list of upstream servers, but that's\n           *  also not currently supported.\n           */\n          prepend: req.originalUrl.replace(OPENAPI_SPEC_ROUTE, ''),\n        },\n      },\n    ]);\n    if (isErrorResult(mergeOutput)) {\n      throw new InputError('Invalid spec defined');\n    }\n    res.json(mergeOutput.output);\n  });\n\n  return router as ApiRouter<typeof spec>;\n}\n","/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { Express } from 'express';\nimport { Server } from 'http';\n\n/**\n * !!! THIS CURRENTLY ONLY SUPPORTS SUPERTEST !!!\n * Running against supertest, we need some way to hit the optic proxy. This ensures that\n *  that happens at runtime when in the context of a `yarn optic capture` command.\n * @param app - Express router that would be passed to supertest's `request`.\n * @returns A wrapper around the express router (or the router untouched) that still works with supertest.\n * @public\n */\nexport const wrapInOpenApiTestServer = (app: Express): Server | Express => {\n  if (process.env.OPTIC_PROXY) {\n    const server = app.listen(+process.env.PORT!);\n    return {\n      ...server,\n      address: () => new URL(process.env.OPTIC_PROXY!),\n    } as any;\n  }\n  return app;\n};\n"],"names":["InputError","json","PromiseRouter","OpenApiValidator","merge","isErrorResult"],"mappings":";;;;;;;;;;;;;;;;AAoBO,MAAM,kBAAqB,GAAA,eAAA;;ACgBlC,MAAM,gBAAgB,MAAO,EAAA,CAAA;AAC7B,MAAM,oBAAoB,MAAO,EAAA,CAAA;AAEjC,SAAS,yBAAiD,GAAA;AACxD,EAAA,OAAO,CAAC,KAAA,EAAc,CAAY,EAAA,EAAA,EAAc,IAAuB,KAAA;AACrE,IAAA,IAAA,CAAK,IAAIA,iBAAA,CAAW,KAAM,CAAA,OAAO,CAAC,CAAA,CAAA;AAAA,GACpC,CAAA;AACF,CAAA;AAEO,SAAS,0BAA6B,GAAA;AAC3C,EAAO,OAAA,CAACC,cAAM,CAAA,CAAA;AAChB,CAAA;AAQO,SAAS,oBAAoB,OAAiB,EAAA;AACnD,EAAO,OAAA,CAAA,EAAG,OAAO,CAAA,EAAG,kBAAkB,CAAA,CAAA,CAAA;AACxC,CAAA;AASgB,SAAA,4BAAA,CACd,MACA,OAIA,EAAA;AACA,EAAA,MAAM,SAASC,8BAAc,EAAA,CAAA;AAC7B,EAAA,MAAA,CAAO,GAAI,CAAA,OAAA,EAAS,UAAc,IAAA,0BAAA,EAA4B,CAAA,CAAA;AAY9D,EAAA,MAAA,CAAO,GAAI,CAAA,CAAC,GAAc,EAAA,CAAA,EAAG,IAAS,KAAA;AAMpC,IAAA,MAAM,aAAgB,GAAA,GAAA,CAAA;AACtB,IAAc,aAAA,CAAA,aAAa,IAAI,aAAc,CAAA,OAAA,CAAA;AAC7C,IAAA,aAAA,CAAc,OAAU,GAAA,EAAA,CAAA;AACxB,IAAc,aAAA,CAAA,iBAAiB,IAAI,aAAc,CAAA,WAAA,CAAA;AACjD,IAAA,aAAA,CAAc,cAAc,aAAc,CAAA,GAAA,CAAA;AAC1C,IAAK,IAAA,EAAA,CAAA;AAAA,GACN,CAAA,CAAA;AAGD,EAAO,MAAA,CAAA,GAAA;AAAA,IACLC,kCAAiB,CAAA;AAAA,MACf,gBAAkB,EAAA;AAAA,QAChB,WAAa,EAAA,KAAA;AAAA,QACb,2BAA6B,EAAA,KAAA;AAAA,OAC/B;AAAA,MACA,kBAAoB,EAAA,IAAA;AAAA,MACpB,iBAAmB,EAAA,KAAA;AAAA,MACnB,GAAG,OAAS,EAAA,gBAAA;AAAA,MACZ,OAAS,EAAA,IAAA;AAAA,KACV,CAAA;AAAA,GACH,CAAA;AAMA,EAAA,MAAA,CAAO,GAAI,CAAA,CAAC,GAAc,EAAA,CAAA,EAAG,IAAS,KAAA;AACpC,IAAA,MAAM,aAAgB,GAAA,GAAA,CAAA;AACtB,IAAc,aAAA,CAAA,OAAA,GAAU,cAAc,aAAa,CAAA,CAAA;AACnD,IAAc,aAAA,CAAA,WAAA,GAAc,cAAc,iBAAiB,CAAA,CAAA;AAC3D,IAAA,OAAO,cAAc,aAAa,CAAA,CAAA;AAClC,IAAA,OAAO,cAAc,iBAAiB,CAAA,CAAA;AACtC,IAAK,IAAA,EAAA,CAAA;AAAA,GACN,CAAA,CAAA;AAGD,EAAO,MAAA,CAAA,GAAA,CAAI,2BAA2B,CAAA,CAAA;AAEtC,EAAA,MAAA,CAAO,GAAI,CAAA,kBAAA,EAAoB,OAAO,GAAA,EAAK,GAAQ,KAAA;AACjD,IAAA,MAAM,cAAcC,kBAAM,CAAA;AAAA,MACxB;AAAA,QACE,GAAK,EAAA,IAAA;AAAA,QACL,gBAAkB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,UAWhB,OAAS,EAAA,GAAA,CAAI,WAAY,CAAA,OAAA,CAAQ,oBAAoB,EAAE,CAAA;AAAA,SACzD;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AACD,IAAI,IAAAC,0BAAA,CAAc,WAAW,CAAG,EAAA;AAC9B,MAAM,MAAA,IAAIL,kBAAW,sBAAsB,CAAA,CAAA;AAAA,KAC7C;AACA,IAAI,GAAA,CAAA,IAAA,CAAK,YAAY,MAAM,CAAA,CAAA;AAAA,GAC5B,CAAA,CAAA;AAED,EAAO,OAAA,MAAA,CAAA;AACT;;AClIa,MAAA,uBAAA,GAA0B,CAAC,GAAmC,KAAA;AACzE,EAAI,IAAA,OAAA,CAAQ,IAAI,WAAa,EAAA;AAC3B,IAAA,MAAM,SAAS,GAAI,CAAA,MAAA,CAAO,CAAC,OAAA,CAAQ,IAAI,IAAK,CAAA,CAAA;AAC5C,IAAO,OAAA;AAAA,MACL,GAAG,MAAA;AAAA,MACH,SAAS,MAAM,IAAI,GAAI,CAAA,OAAA,CAAQ,IAAI,WAAY,CAAA;AAAA,KACjD,CAAA;AAAA,GACF;AACA,EAAO,OAAA,GAAA,CAAA;AACT;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { JSONSchema, FromSchema } from 'json-schema-to-ts';
 import { ReferenceObject, OpenAPIObject, ContentObject, RequestBodyObject, ResponseObject, ParameterObject, SchemaObject } from 'openapi3-ts';
 import core from 'express-serve-static-core';
@@ -530,6 +531,15 @@ declare function createValidatedOpenApiRouter<T extends RequiredDoc>(spec: T, op
     middleware?: RequestHandler[];
 }): ApiRouter<T>;
 
+/**
+ * !!! THIS CURRENTLY ONLY SUPPORTS SUPERTEST !!!
+ * Setup a server with a custom OpenAPI proxy. This proxy will capture all requests and responses and make sure they
+ *  conform to the spec.
+ * @param app - express server, needed to ensure we have the correct ports for the proxy.
+ * @returns - a configured HTTP server that should be used with supertest.
+ * @public
+ */
+declare function wrapServer(app: Express): Promise<Server>;
 /**
  * !!! THIS CURRENTLY ONLY SUPPORTS SUPERTEST !!!
  * Running against supertest, we need some way to hit the optic proxy. This ensures that
@@ -540,4 +550,4 @@ declare function createValidatedOpenApiRouter<T extends RequiredDoc>(spec: T, op
  */
 declare const wrapInOpenApiTestServer: (app: Express) => Server | Express;
 
-export { type ApiRouter, type CookieParameters, type HeaderParameters, type PathParameters, type QueryParameters, type Request, type Response, createValidatedOpenApiRouter, getOpenApiSpecRoute, index_d as internal, wrapInOpenApiTestServer };
+export { type ApiRouter, type CookieParameters, type HeaderParameters, type PathParameters, type QueryParameters, type Request, type Response, createValidatedOpenApiRouter, getOpenApiSpecRoute, index_d as internal, wrapInOpenApiTestServer, wrapServer };

package/dist/proxy/setup.cjs.js

@@ -0,0 +1,74 @@
+'use strict';
+
+var mockttp = require('mockttp');
+var validation = require('../schema/validation.cjs.js');
+var getPort = require('get-port');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+function _interopNamespaceCompat(e) {
+  if (e && typeof e === 'object' && 'default' in e) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var mockttp__namespace = /*#__PURE__*/_interopNamespaceCompat(mockttp);
+var getPort__default = /*#__PURE__*/_interopDefaultCompat(getPort);
+
+class Proxy {
+  server;
+  #openRequests = {};
+  requestResponsePairs = /* @__PURE__ */ new Map();
+  validator;
+  forwardTo = { port: 0 };
+  express = { server: void 0 };
+  constructor() {
+    this.server = mockttp__namespace.getLocal();
+    this.validator = new validation.OpenApiProxyValidator();
+  }
+  async setup() {
+    await this.server.start();
+    this.forwardTo.port = await getPort__default.default();
+    this.server.forAnyRequest().thenForwardTo(`http://localhost:${this.forwardTo.port}`);
+    await this.server.on("request", (request) => {
+      this.#openRequests[request.id] = request;
+    });
+    await this.server.on("response", (response) => {
+      const request = this.#openRequests[response.id];
+      if (request) {
+        this.requestResponsePairs.set(request, response);
+      }
+      delete this.#openRequests[response.id];
+      this.validator.validate(request, response);
+    });
+  }
+  async initialize(url, server) {
+    await this.validator.initialize(`${url}/openapi.json`);
+    this.express.server = server;
+  }
+  stop() {
+    if (Object.keys(this.#openRequests).length > 0) {
+      throw new Error("There are still open requests");
+    }
+    this.server.stop();
+    this.express.server?.close();
+  }
+  get url() {
+    return this.server.proxyEnv.HTTP_PROXY;
+  }
+}
+
+exports.Proxy = Proxy;
+//# sourceMappingURL=setup.cjs.js.map

package/dist/proxy/setup.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.cjs.js","sources":["../../src/proxy/setup.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport * as mockttp from 'mockttp';\nimport { OpenApiProxyValidator } from '../schema/validation';\nimport getPort from 'get-port';\nimport { Server } from 'http';\n\nexport class Proxy {\n  server: mockttp.Mockttp;\n  #openRequests: Record<string, mockttp.CompletedRequest> = {};\n  requestResponsePairs = new Map<\n    mockttp.CompletedRequest,\n    mockttp.CompletedResponse\n  >();\n  validator: OpenApiProxyValidator;\n  public forwardTo: { port: number } = { port: 0 };\n  express: { server: Server | undefined } = { server: undefined };\n  constructor() {\n    this.server = mockttp.getLocal();\n    this.validator = new OpenApiProxyValidator();\n  }\n\n  async setup() {\n    await this.server.start();\n    this.forwardTo.port = await getPort();\n    this.server\n      .forAnyRequest()\n      .thenForwardTo(`http://localhost:${this.forwardTo.port}`);\n    await this.server.on('request', request => {\n      this.#openRequests[request.id] = request;\n    });\n    await this.server.on('response', response => {\n      const request = this.#openRequests[response.id];\n      if (request) {\n        this.requestResponsePairs.set(request, response);\n      }\n      delete this.#openRequests[response.id];\n      this.validator.validate(request, response);\n    });\n  }\n\n  async initialize(url: string, server: Server) {\n    await this.validator.initialize(`${url}/openapi.json`);\n    this.express.server = server;\n  }\n\n  stop() {\n    if (Object.keys(this.#openRequests).length > 0) {\n      throw new Error('There are still open requests');\n    }\n    this.server.stop();\n\n    // If this isn't expressly closed, it will cause a jest memory leak warning.\n    this.express.server?.close();\n  }\n\n  get url() {\n    return this.server.proxyEnv.HTTP_PROXY;\n  }\n}\n"],"names":["mockttp","OpenApiProxyValidator","getPort"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqBO,MAAM,KAAM,CAAA;AAAA,EACjB,MAAA,CAAA;AAAA,EACA,gBAA0D,EAAC,CAAA;AAAA,EAC3D,oBAAA,uBAA2B,GAGzB,EAAA,CAAA;AAAA,EACF,SAAA,CAAA;AAAA,EACO,SAAA,GAA8B,EAAE,IAAA,EAAM,CAAE,EAAA,CAAA;AAAA,EAC/C,OAAA,GAA0C,EAAE,MAAA,EAAQ,KAAU,CAAA,EAAA,CAAA;AAAA,EAC9D,WAAc,GAAA;AACZ,IAAK,IAAA,CAAA,MAAA,GAASA,mBAAQ,QAAS,EAAA,CAAA;AAC/B,IAAK,IAAA,CAAA,SAAA,GAAY,IAAIC,gCAAsB,EAAA,CAAA;AAAA,GAC7C;AAAA,EAEA,MAAM,KAAQ,GAAA;AACZ,IAAM,MAAA,IAAA,CAAK,OAAO,KAAM,EAAA,CAAA;AACxB,IAAK,IAAA,CAAA,SAAA,CAAU,IAAO,GAAA,MAAMC,wBAAQ,EAAA,CAAA;AACpC,IAAK,IAAA,CAAA,MAAA,CACF,eACA,CAAA,aAAA,CAAc,oBAAoB,IAAK,CAAA,SAAA,CAAU,IAAI,CAAE,CAAA,CAAA,CAAA;AAC1D,IAAA,MAAM,IAAK,CAAA,MAAA,CAAO,EAAG,CAAA,SAAA,EAAW,CAAW,OAAA,KAAA;AACzC,MAAK,IAAA,CAAA,aAAA,CAAc,OAAQ,CAAA,EAAE,CAAI,GAAA,OAAA,CAAA;AAAA,KAClC,CAAA,CAAA;AACD,IAAA,MAAM,IAAK,CAAA,MAAA,CAAO,EAAG,CAAA,UAAA,EAAY,CAAY,QAAA,KAAA;AAC3C,MAAA,MAAM,OAAU,GAAA,IAAA,CAAK,aAAc,CAAA,QAAA,CAAS,EAAE,CAAA,CAAA;AAC9C,MAAA,IAAI,OAAS,EAAA;AACX,QAAK,IAAA,CAAA,oBAAA,CAAqB,GAAI,CAAA,OAAA,EAAS,QAAQ,CAAA,CAAA;AAAA,OACjD;AACA,MAAO,OAAA,IAAA,CAAK,aAAc,CAAA,QAAA,CAAS,EAAE,CAAA,CAAA;AACrC,MAAK,IAAA,CAAA,SAAA,CAAU,QAAS,CAAA,OAAA,EAAS,QAAQ,CAAA,CAAA;AAAA,KAC1C,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,MAAM,UAAW,CAAA,GAAA,EAAa,MAAgB,EAAA;AAC5C,IAAA,MAAM,IAAK,CAAA,SAAA,CAAU,UAAW,CAAA,CAAA,EAAG,GAAG,CAAe,aAAA,CAAA,CAAA,CAAA;AACrD,IAAA,IAAA,CAAK,QAAQ,MAAS,GAAA,MAAA,CAAA;AAAA,GACxB;AAAA,EAEA,IAAO,GAAA;AACL,IAAA,IAAI,OAAO,IAAK,CAAA,IAAA,CAAK,aAAa,CAAA,CAAE,SAAS,CAAG,EAAA;AAC9C,MAAM,MAAA,IAAI,MAAM,+BAA+B,CAAA,CAAA;AAAA,KACjD;AACA,IAAA,IAAA,CAAK,OAAO,IAAK,EAAA,CAAA;AAGjB,IAAK,IAAA,CAAA,OAAA,CAAQ,QAAQ,KAAM,EAAA,CAAA;AAAA,GAC7B;AAAA,EAEA,IAAI,GAAM,GAAA;AACR,IAAO,OAAA,IAAA,CAAK,OAAO,QAAS,CAAA,UAAA,CAAA;AAAA,GAC9B;AACF;;;;"}

package/dist/schema/errors.cjs.js

@@ -0,0 +1,43 @@
+'use strict';
+
+var utils = require('./utils.cjs.js');
+
+class OperationError extends Error {
+  constructor(operation, message) {
+    super(
+      `["${operation.method.toLocaleUpperCase("en-US")} ${operation.path}"] ${message}`
+    );
+  }
+}
+class OperationResponseError extends Error {
+  constructor(operation, response, message) {
+    super(
+      `["${operation.method.toLocaleUpperCase("en-US")} ${operation.path}" (${response.status})]: ${message}`
+    );
+  }
+}
+class OperationParsingError extends OperationError {
+  constructor(operation, type, errors) {
+    super(
+      operation,
+      `${type} validation failed.
+ - ${errors.map(utils.humanifyAjvError).join("\n - ")}`
+    );
+  }
+}
+class OperationParsingResponseError extends OperationResponseError {
+  constructor(operation, response, type, errors) {
+    super(
+      operation,
+      response,
+      `${type} validation failed.
+ - ${errors.map(utils.humanifyAjvError).join("\n - ")}`
+    );
+  }
+}
+
+exports.OperationError = OperationError;
+exports.OperationParsingError = OperationParsingError;
+exports.OperationParsingResponseError = OperationParsingResponseError;
+exports.OperationResponseError = OperationResponseError;
+//# sourceMappingURL=errors.cjs.js.map

package/dist/schema/errors.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.cjs.js","sources":["../../src/schema/errors.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Operation } from './types';\nimport { ErrorObject } from 'ajv';\nimport { humanifyAjvError } from './utils';\n\nexport class OperationError extends Error {\n  constructor(operation: Operation, message: string) {\n    super(\n      `[\"${operation.method.toLocaleUpperCase('en-US')} ${\n        operation.path\n      }\"] ${message}`,\n    );\n  }\n}\n\nexport class OperationResponseError extends Error {\n  constructor(operation: Operation, response: Response, message: string) {\n    super(\n      `[\"${operation.method.toLocaleUpperCase('en-US')} ${operation.path}\" (${\n        response.status\n      })]: ${message}`,\n    );\n  }\n}\n\nexport class OperationParsingError extends OperationError {\n  constructor(operation: Operation, type: string, errors: ErrorObject[]) {\n    super(\n      operation,\n      `${type} validation failed.\\n - ${errors\n        .map(humanifyAjvError)\n        .join('\\n - ')}`,\n    );\n  }\n}\n\nexport class OperationParsingResponseError extends OperationResponseError {\n  constructor(\n    operation: Operation,\n    response: Response,\n    type: string,\n    errors: ErrorObject[],\n  ) {\n    super(\n      operation,\n      response,\n      `${type} validation failed.\\n - ${errors\n        .map(humanifyAjvError)\n        .join('\\n - ')}`,\n    );\n  }\n}\n"],"names":["humanifyAjvError"],"mappings":";;;;AAoBO,MAAM,uBAAuB,KAAM,CAAA;AAAA,EACxC,WAAA,CAAY,WAAsB,OAAiB,EAAA;AACjD,IAAA,KAAA;AAAA,MACE,CAAA,EAAA,EAAK,SAAU,CAAA,MAAA,CAAO,iBAAkB,CAAA,OAAO,CAAC,CAC9C,CAAA,EAAA,SAAA,CAAU,IACZ,CAAA,GAAA,EAAM,OAAO,CAAA,CAAA;AAAA,KACf,CAAA;AAAA,GACF;AACF,CAAA;AAEO,MAAM,+BAA+B,KAAM,CAAA;AAAA,EAChD,WAAA,CAAY,SAAsB,EAAA,QAAA,EAAoB,OAAiB,EAAA;AACrE,IAAA,KAAA;AAAA,MACE,CAAK,EAAA,EAAA,SAAA,CAAU,MAAO,CAAA,iBAAA,CAAkB,OAAO,CAAC,CAAI,CAAA,EAAA,SAAA,CAAU,IAAI,CAAA,GAAA,EAChE,QAAS,CAAA,MACX,OAAO,OAAO,CAAA,CAAA;AAAA,KAChB,CAAA;AAAA,GACF;AACF,CAAA;AAEO,MAAM,8BAA8B,cAAe,CAAA;AAAA,EACxD,WAAA,CAAY,SAAsB,EAAA,IAAA,EAAc,MAAuB,EAAA;AACrE,IAAA,KAAA;AAAA,MACE,SAAA;AAAA,MACA,GAAG,IAAI,CAAA;AAAA,GAAA,EAA2B,OAC/B,GAAI,CAAAA,sBAAgB,CACpB,CAAA,IAAA,CAAK,OAAO,CAAC,CAAA,CAAA;AAAA,KAClB,CAAA;AAAA,GACF;AACF,CAAA;AAEO,MAAM,sCAAsC,sBAAuB,CAAA;AAAA,EACxE,WACE,CAAA,SAAA,EACA,QACA,EAAA,IAAA,EACA,MACA,EAAA;AACA,IAAA,KAAA;AAAA,MACE,SAAA;AAAA,MACA,QAAA;AAAA,MACA,GAAG,IAAI,CAAA;AAAA,GAAA,EAA2B,OAC/B,GAAI,CAAAA,sBAAgB,CACpB,CAAA,IAAA,CAAK,OAAO,CAAC,CAAA,CAAA;AAAA,KAClB,CAAA;AAAA,GACF;AACF;;;;;;;"}