@backstage/backend-openapi-utils 0.6.10 → 0.7.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @backstage/backend-openapi-utils
 
+## 0.7.0-next.1
+
+### Minor Changes
+
+- 84171b3: **BREAKING**: Removed `wrapInOpenApiTestServer`. This function redirected test traffic through the Optic `capture` proxy via the `OPTIC_PROXY` environment variable. Since the Optic dependency has been removed, this function no longer serves a purpose. Use `wrapServer` instead for OpenAPI spec validation in tests.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.9.3-next.1
+
+## 0.6.11-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.9.3-next.0
+
 ## 0.6.10
 
 ### Patch Changes

package/dist/testUtils.cjs.js

@@ -29,17 +29,6 @@ function registerHooks() {
   });
 }
 registerHooks();
-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.wrapInOpenApiTestServer = wrapInOpenApiTestServer;
 exports.wrapServer = wrapServer;
 //# sourceMappingURL=testUtils.cjs.js.map

package/dist/testUtils.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"testUtils.cjs.js","sources":["../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 */\nimport { Express } from 'express';\nimport { Server } from 'node:http';\nimport { Proxy } from './proxy/setup';\n\nconst proxiesToCleanup: Set<Proxy> = new Set();\n\n/**\n * !!! THIS CURRENTLY ONLY SUPPORTS SUPERTEST !!!\n * Setup a server with a custom OpenAPI proxy. This proxy will capture all requests and responses and make sure they\n *  conform to the spec.\n * @param app - express server, needed to ensure we have the correct ports for the proxy.\n * @returns - a configured HTTP server that should be used with supertest.\n * @public\n */\nexport async function wrapServer(app: Express): Promise<Server> {\n  const proxy = new Proxy();\n  proxiesToCleanup.add(proxy);\n  await proxy.setup();\n\n  const server = app.listen(proxy.forwardTo.port);\n  await proxy.initialize(`http://localhost:${proxy.forwardTo.port}`, server);\n\n  return { ...server, address: () => new URL(proxy.url) } as any;\n}\n\nlet registered = false;\nfunction registerHooks() {\n  if (typeof afterAll !== 'function' || typeof beforeAll !== 'function') {\n    return;\n  }\n  if (registered) {\n    return;\n  }\n  registered = true;\n\n  afterAll(async () => {\n    const stopPromises = Array.from(proxiesToCleanup).map(proxy =>\n      proxy.stop(),\n    );\n    await Promise.allSettled(stopPromises);\n    proxiesToCleanup.clear();\n  });\n}\n\nregisterHooks();\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":["Proxy"],"mappings":";;;;AAmBA,MAAM,gBAAA,uBAAmC,GAAA,EAAI;AAU7C,eAAsB,WAAW,GAAA,EAA+B;AAC9D,EAAA,MAAM,KAAA,GAAQ,IAAIA,WAAA,EAAM;AACxB,EAAA,gBAAA,CAAiB,IAAI,KAAK,CAAA;AAC1B,EAAA,MAAM,MAAM,KAAA,EAAM;AAElB,EAAA,MAAM,MAAA,GAAS,GAAA,CAAI,MAAA,CAAO,KAAA,CAAM,UAAU,IAAI,CAAA;AAC9C,EAAA,MAAM,MAAM,UAAA,CAAW,CAAA,iBAAA,EAAoB,MAAM,SAAA,CAAU,IAAI,IAAI,MAAM,CAAA;AAEzE,EAAA,OAAO,EAAE,GAAG,MAAA,EAAQ,OAAA,EAAS,MAAM,IAAI,GAAA,CAAI,KAAA,CAAM,GAAG,CAAA,EAAE;AACxD;AAEA,IAAI,UAAA,GAAa,KAAA;AACjB,SAAS,aAAA,GAAgB;AACvB,EAAA,IAAI,OAAO,QAAA,KAAa,UAAA,IAAc,OAAO,cAAc,UAAA,EAAY;AACrE,IAAA;AAAA,EACF;AACA,EAAA,IAAI,UAAA,EAAY;AACd,IAAA;AAAA,EACF;AACA,EAAA,UAAA,GAAa,IAAA;AAEb,EAAA,QAAA,CAAS,YAAY;AACnB,IAAA,MAAM,YAAA,GAAe,KAAA,CAAM,IAAA,CAAK,gBAAgB,CAAA,CAAE,GAAA;AAAA,MAAI,CAAA,KAAA,KACpD,MAAM,IAAA;AAAK,KACb;AACA,IAAA,MAAM,OAAA,CAAQ,WAAW,YAAY,CAAA;AACrC,IAAA,gBAAA,CAAiB,KAAA,EAAM;AAAA,EACzB,CAAC,CAAA;AACH;AAEA,aAAA,EAAc;AAUP,MAAM,uBAAA,GAA0B,CAAC,GAAA,KAAmC;AACzE,EAAA,IAAI,OAAA,CAAQ,IAAI,WAAA,EAAa;AAC3B,IAAA,MAAM,SAAS,GAAA,CAAI,MAAA,CAAO,CAAC,OAAA,CAAQ,IAAI,IAAK,CAAA;AAC5C,IAAA,OAAO;AAAA,MACL,GAAG,MAAA;AAAA,MACH,SAAS,MAAM,IAAI,GAAA,CAAI,OAAA,CAAQ,IAAI,WAAY;AAAA,KACjD;AAAA,EACF;AACA,EAAA,OAAO,GAAA;AACT;;;;;"}
+{"version":3,"file":"testUtils.cjs.js","sources":["../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 */\nimport { Express } from 'express';\nimport { Server } from 'node:http';\nimport { Proxy } from './proxy/setup';\n\nconst proxiesToCleanup: Set<Proxy> = new Set();\n\n/**\n * !!! THIS CURRENTLY ONLY SUPPORTS SUPERTEST !!!\n * Setup a server with a custom OpenAPI proxy. This proxy will capture all requests and responses and make sure they\n *  conform to the spec.\n * @param app - express server, needed to ensure we have the correct ports for the proxy.\n * @returns - a configured HTTP server that should be used with supertest.\n * @public\n */\nexport async function wrapServer(app: Express): Promise<Server> {\n  const proxy = new Proxy();\n  proxiesToCleanup.add(proxy);\n  await proxy.setup();\n\n  const server = app.listen(proxy.forwardTo.port);\n  await proxy.initialize(`http://localhost:${proxy.forwardTo.port}`, server);\n\n  return { ...server, address: () => new URL(proxy.url) } as any;\n}\n\nlet registered = false;\nfunction registerHooks() {\n  if (typeof afterAll !== 'function' || typeof beforeAll !== 'function') {\n    return;\n  }\n  if (registered) {\n    return;\n  }\n  registered = true;\n\n  afterAll(async () => {\n    const stopPromises = Array.from(proxiesToCleanup).map(proxy =>\n      proxy.stop(),\n    );\n    await Promise.allSettled(stopPromises);\n    proxiesToCleanup.clear();\n  });\n}\n\nregisterHooks();\n"],"names":["Proxy"],"mappings":";;;;AAmBA,MAAM,gBAAA,uBAAmC,GAAA,EAAI;AAU7C,eAAsB,WAAW,GAAA,EAA+B;AAC9D,EAAA,MAAM,KAAA,GAAQ,IAAIA,WAAA,EAAM;AACxB,EAAA,gBAAA,CAAiB,IAAI,KAAK,CAAA;AAC1B,EAAA,MAAM,MAAM,KAAA,EAAM;AAElB,EAAA,MAAM,MAAA,GAAS,GAAA,CAAI,MAAA,CAAO,KAAA,CAAM,UAAU,IAAI,CAAA;AAC9C,EAAA,MAAM,MAAM,UAAA,CAAW,CAAA,iBAAA,EAAoB,MAAM,SAAA,CAAU,IAAI,IAAI,MAAM,CAAA;AAEzE,EAAA,OAAO,EAAE,GAAG,MAAA,EAAQ,OAAA,EAAS,MAAM,IAAI,GAAA,CAAI,KAAA,CAAM,GAAG,CAAA,EAAE;AACxD;AAEA,IAAI,UAAA,GAAa,KAAA;AACjB,SAAS,aAAA,GAAgB;AACvB,EAAA,IAAI,OAAO,QAAA,KAAa,UAAA,IAAc,OAAO,cAAc,UAAA,EAAY;AACrE,IAAA;AAAA,EACF;AACA,EAAA,IAAI,UAAA,EAAY;AACd,IAAA;AAAA,EACF;AACA,EAAA,UAAA,GAAa,IAAA;AAEb,EAAA,QAAA,CAAS,YAAY;AACnB,IAAA,MAAM,YAAA,GAAe,KAAA,CAAM,IAAA,CAAK,gBAAgB,CAAA,CAAE,GAAA;AAAA,MAAI,CAAA,KAAA,KACpD,MAAM,IAAA;AAAK,KACb;AACA,IAAA,MAAM,OAAA,CAAQ,WAAW,YAAY,CAAA;AACrC,IAAA,gBAAA,CAAiB,KAAA,EAAM;AAAA,EACzB,CAAC,CAAA;AACH;AAEA,aAAA,EAAc;;;;"}

package/dist/testUtils.d.ts

@@ -10,14 +10,5 @@ import { Server } from 'node:http';
  * @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
- *  that happens at runtime when in the context of a `yarn optic capture` command.
- * @param app - Express router that would be passed to supertest's `request`.
- * @returns A wrapper around the express router (or the router untouched) that still works with supertest.
- * @public
- */
-declare const wrapInOpenApiTestServer: (app: Express) => Server | Express;
 
-export { wrapInOpenApiTestServer, wrapServer };
+export { wrapServer };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-openapi-utils",
-  "version": "0.6.10",
+  "version": "0.7.0-next.1",
   "description": "OpenAPI typescript support.",
   "backstage": {
     "role": "node-library"
@@ -54,9 +54,9 @@
   },
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
-    "@backstage/backend-plugin-api": "^1.9.2",
-    "@backstage/errors": "^1.3.1",
-    "@backstage/types": "^1.2.2",
+    "@backstage/backend-plugin-api": "1.9.3-next.1",
+    "@backstage/errors": "1.3.1",
+    "@backstage/types": "1.2.2",
     "@types/express": "^4.17.6",
     "@types/express-serve-static-core": "^4.17.5",
     "ajv": "^8.16.0",
@@ -71,9 +71,9 @@
     "openapi3-ts": "^3.1.2"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.36.3",
-    "@backstage/test-utils": "^1.7.19",
-    "msw": "^1.0.0",
+    "@backstage/cli": "0.36.4-next.2",
+    "@backstage/test-utils": "1.7.20-next.0",
+    "msw": "^2.0.0",
     "supertest": "^7.0.0"
   }
 }