refactoring slack auth variable names

AmericanAirlines · Jan 10, 2024 · d674c6f · d674c6f
1 parent cadcbeb
commit d674c6f
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 22 deletions.
diff --git a/packages/api/src/api/auth/callback/slack/get.ts b/packages/api/src/api/auth/callback/slack/get.ts
@@ -16,7 +16,11 @@ export type SlackTokenData = {
 
 export const get = async (req: Request, res: Response) => {
   const myCode: string = req.query[codeQueryParam] as string;
-  const { slackClientID, slackClientSecret, slackBotToken } = slackAuth;
+  const {
+    clientId: slackClientID,
+    clientSecret: slackClientSecret,
+    botToken: slackBotToken,
+  } = slackAuth;
 
   const returnTo = req.query[Config.global.authReturnUriParamName] as string | undefined;
 

diff --git a/packages/api/src/api/auth/utils/authUrlFormatters/formatSlackAuthUrl.ts b/packages/api/src/api/auth/utils/authUrlFormatters/formatSlackAuthUrl.ts
@@ -12,7 +12,7 @@ export const slackAuthBaseUrl: string =
 export const formatSlackAuthUrl: AuthUrlFormatter = ({ returnTo }) => {
   const queryArgs = new URLSearchParams({
     redirect_uri: formatRedirectUri({ returnTo }),
-    client_id: slackAuth.slackClientID,
+    client_id: slackAuth.clientId,
   }).toString();
 
   return `${slackAuthBaseUrl}${queryArgs}`;

diff --git a/packages/api/src/env/auth/slackAuth.ts b/packages/api/src/env/auth/slackAuth.ts
@@ -2,12 +2,9 @@ import setEnv from '@americanairlines/simple-env';
 
 export const slackAuth = setEnv({
   required: {
-    slackBotToken: 'SLACK_BOT_TOKEN',
-    slackSigningSecret: 'SLACK_SIGNING_SECRET',
-    slackClientID: 'SLACK_CLIENT_ID',
-    slackClientSecret: 'SLACK_CLIENT_SECRET',
-  },
-  optional: {
-    slackLogLevel: 'SLACK_LOG_LEVEL',
+    botToken: 'SLACK_BOT_TOKEN',
+    signingSecret: 'SLACK_SIGNING_SECRET',
+    clientId: 'SLACK_CLIENT_ID',
+    clientSecret: 'SLACK_CLIENT_SECRET',
   },
 });
diff --git a/packages/api/src/env/index.ts b/packages/api/src/env/index.ts
@@ -6,8 +6,3 @@ config(); // Must be called before exports
  * All core environment variables
  */
 export * from './env';
-
-/**
- * All auth environment variables
- */
-export * as Auth from './auth';
diff --git a/packages/api/tests/api/auth/callback/slack/get.test.ts b/packages/api/tests/api/auth/callback/slack/get.test.ts
@@ -16,9 +16,9 @@ jest.mock('../../../../../src/api/auth/utils/formatRedirectUri');
 jest.mock('../../../../../src/env/auth');
 
 (slackAuth as Partial<typeof slackAuth>) = {
-  slackClientID: 'mockClientID',
-  slackBotToken: 'mockBotToken',
-  slackClientSecret: 'mockClientSecret',
+  clientId: 'mockClientID',
+  botToken: 'mockBotToken',
+  clientSecret: 'mockClientSecret',
 };
 
 const mockToken = {
@@ -53,12 +53,12 @@ describe('Slack auth callback', () => {
 
       await get(mockReq as any, {} as any);
 
-      expect(webClientSpy).toBeCalledWith(slackAuth.slackBotToken);
+      expect(webClientSpy).toBeCalledWith(slackAuth.botToken);
       expect(mockTokenMethod).toHaveBeenCalledTimes(1);
       expect(mockTokenMethod).toHaveBeenCalledWith(
         expect.objectContaining({
-          client_id: slackAuth.slackClientID,
-          client_secret: slackAuth.slackClientSecret,
+          client_id: slackAuth.clientId,
+          client_secret: slackAuth.clientSecret,
           code: mockReq.query.code,
           redirect_uri: mockRedirectUri,
         }),

diff --git a/...ages/api/tests/api/auth/callback/slack/utils/authUrlFormatters/formatSlackAuthUrl.test.ts b/...ages/api/tests/api/auth/callback/slack/utils/authUrlFormatters/formatSlackAuthUrl.test.ts
@@ -11,7 +11,7 @@ jest.mock('../../../../../../../src/api/auth/utils/formatRedirectUri');
 const formatRedirectUriMock = getMock(formatRedirectUri);
 
 (slackAuth as Partial<typeof slackAuth>) = {
-  slackClientID: 'mockClientId',
+  clientId: 'mockClientId',
 };
 
 describe('formatSlackAuthUrl', () => {
@@ -26,7 +26,7 @@ describe('formatSlackAuthUrl', () => {
     expect(formatRedirectUriMock).toBeCalledWith({ returnTo });
 
     expect(redirectUri).toEqual(
-      `${slackAuthBaseUrl}redirect_uri=${mockRedirectUri}&client_id=${slackAuth.slackClientID}`,
+      `${slackAuthBaseUrl}redirect_uri=${mockRedirectUri}&client_id=${slackAuth.clientId}`,
     );
   });
 });