Merge pull request #16230 from backstage/blam/bs/new

Switch out `'plain'` in `HttpServerCertificateOptions`

.changeset/hot-wasps-cover.md

@@ -0,0 +1,5 @@
+---
+'@backstage/backend-common': patch
+---
+
+Updated to work with the new `type: 'pem'` with `createHttpServer` from `@backstage/backend-app-api`

.changeset/soft-actors-worry.md

@@ -0,0 +1,5 @@
+---
+'@backstage/backend-app-api': minor
+---
+
+**BREAKING** `HttpServerCertificateOptions` when specified with a `key` and `cert` should also have the `type: 'pem'` instead of `type: 'plain'`

packages/backend-app-api/api-report.md

@@ -133,7 +133,7 @@ export const httpRouterServiceFactory: (
 // @public
 export type HttpServerCertificateOptions =
   | {
-      type: 'plain';
+      type: 'pem';
       key: string;
       cert: string;
     }

packages/backend-app-api/src/http/config.test.ts

@@ -53,7 +53,7 @@ describe('readHttpServerOptions', () => {
       {
         listen: { host: '', port: 7007 },
         https: {
-          certificate: { type: 'plain', cert: 'my-cert', key: 'my-key' },
+          certificate: { type: 'pem', cert: 'my-cert', key: 'my-key' },
         },
       },
     ],

packages/backend-app-api/src/http/config.ts

@@ -93,7 +93,7 @@ function readHttpsOptions(config?: Config): HttpServerOptions['https'] {
 
   return {
     certificate: {
-      type: 'plain',
+      type: 'pem',
       cert: cc.getString('certificate.cert'),
       key: cc.getString('certificate.key'),
     },

packages/backend-app-api/src/http/types.ts

@@ -51,7 +51,7 @@ export type HttpServerOptions = {
  */
 export type HttpServerCertificateOptions =
   | {
-      type: 'plain';
+      type: 'pem';
       key: string;
       cert: string;
     }

packages/backend-common/src/service/lib/ServiceBuilderImpl.ts

@@ -102,7 +102,7 @@ export class ServiceBuilderImpl implements ServiceBuilder {
       this.serverOptions.https = {
         certificate: {
           ...settings.certificate,
-          type: 'plain',
+          type: 'pem',
         },
       };
     }