Refactor naming of proxy bootstrapping function

Signed-off-by: enyineer <nico.enking@gmail.com>

packages/cli-common/report.api.md

@@ -6,15 +6,15 @@
 // @public
 export const BACKSTAGE_JSON = 'backstage.json';
 
+// @public
+export function bootstrapEnvProxyAgents(): void;
+
 // @public
 export function findPaths(searchDir: string): Paths;
 
 // @public
 export function isChildPath(base: string, path: string): boolean;
 
-// @public
-export function maybeBootstrapProxy(): void;
-
 // @public
 export type Paths = {
   ownDir: string;

packages/cli-common/src/index.ts

@@ -23,4 +23,4 @@
 export { findPaths, BACKSTAGE_JSON } from './paths';
 export { isChildPath } from './isChildPath';
 export type { Paths, ResolveFunc } from './paths';
-export { maybeBootstrapProxy } from './proxyBootstrap';
+export { bootstrapEnvProxyAgents } from './proxyBootstrap';

packages/cli-common/src/proxyBootstrap.test.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { maybeBootstrapProxy } from './proxyBootstrap';
+import { bootstrapEnvProxyAgents } from './proxyBootstrap';
 
 jest.mock('global-agent', () => ({
   bootstrap: jest.fn(),
@@ -24,7 +24,7 @@ jest.mock('undici', () => ({
   EnvHttpProxyAgent: jest.fn(),
 }));
 
-describe('maybeBootstrapProxy', () => {
+describe('bootstrapEnvProxyAgents', () => {
   const originalEnv = process.env;
 
   beforeEach(() => {
@@ -42,7 +42,7 @@ describe('maybeBootstrapProxy', () => {
 
     const { bootstrap } =
       require('global-agent') as typeof import('global-agent');
-    maybeBootstrapProxy();
+    bootstrapEnvProxyAgents();
 
     expect(bootstrap).toHaveBeenCalledTimes(1);
   });
@@ -52,7 +52,7 @@ describe('maybeBootstrapProxy', () => {
 
     const { bootstrap } =
       require('global-agent') as typeof import('global-agent');
-    maybeBootstrapProxy();
+    bootstrapEnvProxyAgents();
 
     expect(bootstrap).toHaveBeenCalledTimes(1);
   });
@@ -62,7 +62,7 @@ describe('maybeBootstrapProxy', () => {
 
     const { setGlobalDispatcher, EnvHttpProxyAgent } =
       require('undici') as typeof import('undici');
-    maybeBootstrapProxy();
+    bootstrapEnvProxyAgents();
 
     expect(EnvHttpProxyAgent).toHaveBeenCalledTimes(1);
     expect(setGlobalDispatcher).toHaveBeenCalledWith(
@@ -75,7 +75,7 @@ describe('maybeBootstrapProxy', () => {
 
     const { setGlobalDispatcher, EnvHttpProxyAgent } =
       require('undici') as typeof import('undici');
-    maybeBootstrapProxy();
+    bootstrapEnvProxyAgents();
 
     expect(EnvHttpProxyAgent).toHaveBeenCalledTimes(1);
     expect(setGlobalDispatcher).toHaveBeenCalledWith(
@@ -89,7 +89,7 @@ describe('maybeBootstrapProxy', () => {
     const { setGlobalDispatcher } =
       require('undici') as typeof import('undici');
 
-    maybeBootstrapProxy();
+    bootstrapEnvProxyAgents();
 
     expect(bootstrap).not.toHaveBeenCalled();
     expect(setGlobalDispatcher).not.toHaveBeenCalled();
@@ -101,7 +101,7 @@ describe('maybeBootstrapProxy', () => {
 
     const { bootstrap } =
       require('global-agent') as typeof import('global-agent');
-    maybeBootstrapProxy();
+    bootstrapEnvProxyAgents();
 
     expect(bootstrap).toHaveBeenCalledTimes(1);
   });

packages/cli-common/src/proxyBootstrap.ts

@@ -28,7 +28,7 @@
  *
  * @public
  */
-export function maybeBootstrapProxy() {
+export function bootstrapEnvProxyAgents() {
   // see https://www.npmjs.com/package/global-agent
   const globalAgentNamespace =
     process.env.GLOBAL_AGENT_ENVIRONMENT_VARIABLE_NAMESPACE ?? 'GLOBAL_AGENT_';

packages/cli/src/modules/migrate/commands/versions/bump.ts

@@ -13,9 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { BACKSTAGE_JSON, maybeBootstrapProxy } from '@backstage/cli-common';
+import { BACKSTAGE_JSON, bootstrapEnvProxyAgents } from '@backstage/cli-common';
 
-maybeBootstrapProxy();
+bootstrapEnvProxyAgents();
 
 import fs from 'fs-extra';
 import chalk from 'chalk';

packages/create-app/src/lib/tasks.ts

@@ -13,9 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { maybeBootstrapProxy } from '@backstage/cli-common';
+import { bootstrapEnvProxyAgents } from '@backstage/cli-common';
 
-maybeBootstrapProxy();
+bootstrapEnvProxyAgents();
 
 import chalk from 'chalk';
 import fs from 'fs-extra';