rename endpoints to paths, use self_url to consgruct endpoints

Author: trioletas

docker-compose.yml

@@ -12,4 +12,4 @@ services:
  - 3001:3001
  environment:
  - SHELL=/bin/sh
- - SELF_URL=http://localhost:3001
+ 

src/app.ts

@@ -38,13 +38,15 @@ const graphqlMiddleware = graphqlKoa({
  },
 });
 
-router.post(`/${process.env.GRAPHQL_ENDPOINT}*`, koaBodyparser(), graphqlMiddleware);
-router.get(`/${process.env.GRAPHQL_ENDPOINT}*`, graphqlMiddleware);
+router.post(`/${process.env.GRAPHQL_PATH}*`, koaBodyparser(), graphqlMiddleware);
+router.get(`/${process.env.GRAPHQL_PATH}*`, graphqlMiddleware);
+
+const GRAPHQL_ENDPOINT = `${process.env.SELF_URL}/${process.env.GRAPHQL_PATH}`;
 
 // GraphQL Voyager?
 if (process.env.VOYAGER) {
- router.all(`/${process.env.VOYAGER_ENDPOINT}`, koaMiddleware({
- endpointUrl: `/${process.env.GRAPHQL_ENDPOINT}`,
+ router.all(`/${process.env.VOYAGER_PATH}`, koaMiddleware({
+ endpointUrl: GRAPHQL_ENDPOINT,
  displayOptions: {
  sortByAlphabet: true,
  },
@@ -53,21 +55,22 @@ if (process.env.VOYAGER) {
 
 // GraphiQL?
 if (process.env.GRAPHIQL) {
- router.get(`/${process.env.GRAPHIQL_ENDPOINT}`, graphiqlKoa({ endpointURL: `/${process.env.GRAPHQL_ENDPOINT}` }));
+ router.get(
+ `/${process.env.GRAPHIQL_PATH}`,
+ graphiqlKoa({ endpointURL: GRAPHQL_ENDPOINT }),
+ );
 }
 
 // GraphQL Playground?
 if (process.env.PLAYGROUND) {
  router.all(
- `/${process.env.PLAYGROUND_ENDPOINT}`,
- koaPlayground({
- endpoint: `/${process.env.GRAPHQL_ENDPOINT}`,
- }),
+ `/${process.env.PLAYGROUND_PATH}`,
+ koaPlayground({ endpoint: GRAPHQL_ENDPOINT }),
  );
 }
 
 // Koa Heartbeat
-app.use(koaHeartbeat({ path: `/${process.env.LIVENESS_ENDPOINT}`, body: 'ok' }));
+app.use(koaHeartbeat({ path: `/${process.env.LIVENESS_PATH}`, body: 'ok' }));
 
 app.use(router.routes());
 app.use(router.allowedMethods());

src/entrypoint.ts

@@ -3,11 +3,11 @@ import fs from 'fs';
 import { pickBy, identity, isEmpty } from 'lodash';
 
 const endpointsConfig = {
- graphql: `${process.env.SELF_URL}/${process.env.GRAPHQL_ENDPOINT}`,
- liveness: `${process.env.SELF_URL}/${process.env.LIVENESS_ENDPOINT}`,
- graphiql: process.env.GRAPHIQL && `${process.env.SELF_URL}/${process.env.GRAPHIQL_ENDPOINT}`,
- playground: process.env.PLAYGROUND && `${process.env.SELF_URL}/${process.env.PLAYGROUND_ENDPOINT}`,
- voyager: process.env.VOYAGER && `${process.env.SELF_URL}/${process.env.VOYAGER_ENDPOINT}`,
+ graphql: `${process.env.SELF_URL}/${process.env.GRAPHQL_PATH}`,
+ liveness: `${process.env.SELF_URL}/${process.env.LIVENESS_PATH}`,
+ graphiql: process.env.GRAPHIQL && `${process.env.SELF_URL}/${process.env.GRAPHIQL_PATH}`,
+ playground: process.env.PLAYGROUND && `${process.env.SELF_URL}/${process.env.PLAYGROUND_PATH}`,
+ voyager: process.env.VOYAGER && `${process.env.SELF_URL}/${process.env.VOYAGER_PATH}`,
 };
 
 const packageJsonPath = path.resolve('package.json');

src/env.ts

@@ -4,20 +4,20 @@ const { url, bool, str, port } = envalid;
 
 const env = envalid.cleanEnv(process.env, {
  PORT: port({ default: 3001 }),
- SELF_URL: str({ default: '' }),
+ SELF_URL: str({ devDefault: 'http://localhost:3001' }),
  NODE_ENV: str({ devDefault: 'development' }),
  JOKE_SERVICE_URL: url({ default: 'https://api.icndb.com' }),
- GRAPHQL_ENDPOINT: str({ default: 'graphql' }),
+ GRAPHQL_PATH: str({ default: 'graphql' }),
  GRAPHQL_TRACING: bool({ default: true }),
  GRAPHIQL: bool({ default: true }),
- GRAPHIQL_ENDPOINT: str({ default: 'graphiql' }),
+ GRAPHIQL_PATH: str({ default: 'graphiql' }),
  VOYAGER: bool({ default: true }),
- VOYAGER_ENDPOINT: str({ default: 'voyager' }),
+ VOYAGER_PATH: str({ default: 'voyager' }),
  PLAYGROUND: bool({ default: true }),
- PLAYGROUND_ENDPOINT: str({ default: 'playground' }),
+ PLAYGROUND_PATH: str({ default: 'playground' }),
  CORS: bool({ devDefault: true, default: false }),
  LOG_LEVEL: str({ default: 'info' }),
- LIVENESS_ENDPOINT: str({ default: 'healthz' }),
+ LIVENESS_PATH: str({ default: 'healthz' }),
 });
 
 export default env;

src/server.ts

@@ -12,7 +12,7 @@ app.listen(port, () => {
  if (process.env.GRAPHIQL) {
  console.log(`The GraphiQL App is running at:`);
  console.log();
- console.log(` ${chalk.cyan(`http://localhost:${port}/${process.env.GRAPHIQL_ENDPOINT}`)}`);
+ console.log(` ${chalk.cyan(`http://localhost:${port}/${process.env.GRAPHIQL_PATH }`)}`);
  } else {
  console.log(`The Koa App is running at:`);
  console.log();
@@ -24,15 +24,15 @@ app.listen(port, () => {
  }
  console.log(`The GraphQL Voyager App is running at:`);
  console.log();
- console.log(` ${chalk.cyan(`http://localhost:${port}/${process.env.VOYAGER_ENDPOINT}`)}`);
+ console.log(` ${chalk.cyan(`http://localhost:${port}/${process.env.VOYAGER_PATH}`)}`);
  }
  if (process.env.PLAYGROUND) {
  if (process.env.GRAPHIQL || process.env.VOYAGER) {
  console.log();
  }
  console.log(`The GraphQL Plaground App is running at:`);
  console.log();
- console.log(` ${chalk.cyan(`http://localhost:${port}/${process.env.PLAYGROUND_ENDPOINT}`)}`);
+ console.log(` ${chalk.cyan(`http://localhost:${port}/${process.env.PLAYGROUND_PATH}`)}`);
  }
  } else {
  console.log(`The Koa App is running`);