feat: retain the ability to override the hostname

check-run-reporter · Apr 19, 2022 · 38dcf7f · 38dcf7f
1 parent cfae3c5
commit 38dcf7f
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 14 deletions.
diff --git a/integrations/action/action.yml b/integrations/action/action.yml
@@ -6,7 +6,6 @@ branding:
   color: 'orange'
 inputs:
   hostname:
-    default: api.check-run-reporter.com
     description: Internal. Do not use unless directed. Supercedes --url
     required: false
   label:

diff --git a/integrations/action/src/index.ts b/integrations/action/src/index.ts
@@ -151,9 +151,10 @@ async function main() {
     core.getInput('label') ||
     `${github.context.workflow} / ${github.context.job}`;
 
+  const hostname = core.getInput('hostname');
   const token = core.getInput('token');
 
-  const client = makeClient();
+  const client = makeClient({hostname});
 
   const tests = core.getInput('tests');
   if (tests) {

diff --git a/integrations/check-run-reporter-buildkite-plugin/hooks/post-command b/integrations/check-run-reporter-buildkite-plugin/hooks/post-command
@@ -43,7 +43,7 @@ log () {
   echo "$@" 1>&2
 }
 
-HOSTNAME=${BUILDKITE_PLUGIN_CHECK_RUN_REPORTER_HOSTNAME:-api.check-run-reporter.com}
+HOSTNAME=${BUILDKITE_PLUGIN_CHECK_RUN_REPORTER_HOSTNAME:-''}
 LABEL=${BUILDKITE_PLUGIN_CHECK_RUN_REPORTER_LABEL:-$BUILDKITE_LABEL}
 ROOT=${BUILDKITE_PLUGIN_CHECK_RUN_REPORTER_ROOT:-$(find_root)}
 SHA=$BUILDKITE_COMMIT

diff --git a/integrations/check-run-reporter-buildkite-plugin/hooks/pre-command b/integrations/check-run-reporter-buildkite-plugin/hooks/pre-command
@@ -10,7 +10,7 @@ log () {
   echo "$@" 1>&2
 }
 
-HOSTNAME=${BUILDKITE_PLUGIN_CHECK_RUN_REPORTER_HOSTNAME:-api.check-run-reporter.com}
+HOSTNAME=${BUILDKITE_PLUGIN_CHECK_RUN_REPORTER_HOSTNAME:-''}
 LABEL=${BUILDKITE_PLUGIN_CHECK_RUN_REPORTER_LABEL:-$BUILDKITE_LABEL}
 TOKEN=$BUILDKITE_PLUGIN_CHECK_RUN_REPORTER_TOKEN
 TESTS=${BUILDKITE_PLUGIN_CHECK_RUN_REPORTER_TESTS:-''}

diff --git a/src/cli.ts b/src/cli.ts
@@ -20,8 +20,8 @@ export function cli(argv: string[]) {
       (y) =>
         y.options({
           hostname: {
-            default: 'api.check-run-reporter.com',
             description: 'Internal. Do not use unless directed.',
+            type: 'string',
           },
           json: {
             default: false,
@@ -54,14 +54,14 @@ export function cli(argv: string[]) {
             type: 'string',
           },
         }),
-      async ({tests, ...args}) => {
+      async ({hostname, tests, ...args}) => {
         const directlyUseOutput = !process.stdout.isTTY;
 
         try {
           const result = await split(
             {...args, tests: tests.map(String)},
             {
-              client: makeClient(),
+              client: makeClient({hostname}),
               logger: directlyUseOutput ? silentLogger : logger,
             }
           );
@@ -94,8 +94,8 @@ export function cli(argv: string[]) {
       (y) =>
         y.options({
           hostname: {
-            default: 'api.check-run-reporter.com',
             description: 'Internal. Do not use unless directed.',
+            type: 'string',
           },
           label: {
             description: 'Label that should appear in the GitHub check run.',
@@ -125,13 +125,13 @@ export function cli(argv: string[]) {
             type: 'string',
           },
         }),
-      async ({report, ...args}) => {
+      async ({hostname, report, ...args}) => {
         return submit(
           {
             ...args,
             report: report.map(String),
           },
-          {client: makeClient(), logger}
+          {client: makeClient({hostname}), logger}
         );
       }
     )

diff --git a/src/lib/axios.ts b/src/lib/axios.ts
@@ -1,7 +1,7 @@
 import 'axios-debug-log';
 
 import axiosRetry from 'axios-retry';
-import axios, {AxiosResponse} from 'axios';
+import axios, {AxiosInstance, AxiosResponse} from 'axios';
 import ci from 'ci-info';
 
 import pkg from '../../package.json';
@@ -12,9 +12,11 @@ const {version} = pkg;
 /**
  * Creates a new http client with configuration
  */
-export function makeClient() {
+export function makeClient({hostname}: {hostname?: string}): AxiosInstance {
+  // Do not use ?? here in case hostname is an empty string
+  hostname = hostname || HOSTNAME;
   const client = axios.create({
-    baseURL: new URL(BASEPATH, `https://${HOSTNAME}`).toString(),
+    baseURL: new URL(BASEPATH, `https://${hostname}`).toString(),
     headers: {
       'user-agent': [
         `crr/${version}`,

diff --git a/src/test/context.ts b/src/test/context.ts
@@ -5,5 +5,5 @@ import {Context} from '../lib/types';
  * Creates a (semi) mocked context for use in tests.
  */
 export function makeTestContext(): Context {
-  return {client: makeClient(), logger: console};
+  return {client: makeClient({}), logger: console};
 }