chore: improve readme & added get-linkedin-token script (NOJIRA) (#13)

rebecamendez · web-flow · commit ab76b6ac965b · 2024-12-18T03:10:03.000+01:00
diff --git a/README.md b/README.md
@@ -8,34 +8,66 @@ _Note: This API is available only to LinkedIn users registered in the European U
 
 # Environment variables
 
-TBD
+Environment variables must be defined in the .env file. The full list of environment variables can be found in [environment.ts](./src/util/environment.ts). Below, we highlight the most important variables for running local tests:
+
+- `LOCAL_LINKEDIN_API_TOKEN=YOUR_LINKEDIN_API_TOKEN`: Your LinkedIn user token for easily testing this Lambda locally.
+- `LOGGER_CONSOLE=true`: Enables the logger in a human-friendly format instead of JSON format.
+
+## How to retrieve a valid Linkedin token
+
+- `LOCAL_LINKEDIN_CLIENT_ID` and `LOCAL_LINKEDIN_CLIENT_SECRET` must be configured properly (see next section). Then type:
+
+```bash
+  yarn dev:token
+```
+
+And copy token value inside `LOCAL_LINKEDIN_CLIENT_SECRET` environment variable.
 
 # How to develop
 
 Follow these steps to set up the development environment and run essential tasks for the project:
 
+- Install all dependencies using `nvm` and `yarn`:
+
+  ```bash
+    nvm use
+    yarn install
+  ```
+
 - If you're part of Manfred's staff, download the necessary environment variables using [Doppler](https://www.doppler.com/):
 
   ```bash
-    npm run dev:secrets
+    yarn dev:secrets
   ```
 
-- Run the application locally with a fake sqs event. This uses the `LOCAL_PROFILE_API_TOKEN` environment variable to retrieve the LinkedIn profile:
+- Run the application locally with a fake sqs event. This uses the `LOCAL_PROFILE_API_TOKEN` environment variable to retrieve the LinkedIn profile (by default dev Manfred user):
 
   ```bash
-    npm run dev
+    yarn dev
+  ```
+
+- If you need to get new API token:
+
+  ```bash
+    yarn dev:token
   ```
 
 - Automatically lint the code and apply fixes to linting and formatting errors:
 
   ```bash
-    npm run lint
+    yarn lint
   ```
 
 - Execute the unit test suite to ensure that everything is working as expected:
 
   ```bash
-    npm run test
+    yarn test
+  ```
+
+- If you have `localstack` configured, you can send a real message to the queue, simulate its reception, and handle it with:
+
+  ```bash
+    yarn dev:consumer
   ```
 
 Make sure you have all necessary environment variables and dependencies set up before running the tasks.
diff --git a/jest.config.js b/jest.config.js
@@ -7,5 +7,12 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   coverageReporters: ['lcov', 'text-summary', 'clover'],
-  collectCoverageFrom: ['src/**/*.ts', '!src/test/**/*', '!src/**/*spec.ts', '!src/launch.ts', '!src/launch-sqs-consumer.ts']
+  collectCoverageFrom: [
+    'src/**/*.ts',
+    '!src/test/**/*',
+    '!src/**/*spec.ts',
+    '!src/launch.ts',
+    '!src/launch-sqs-consumer.ts',
+    '!src/get-linkedin-token.ts'
+  ]
 };
diff --git a/package.json b/package.json
@@ -13,6 +13,7 @@
     "test": "jest --silent --logHeapUsage --coverage",
     "dev": "node --env-file=.env -r esbuild-register ./src/launch.ts -e .ts",
     "dev:secrets": "doppler setup --no-interactive && doppler secrets download --no-file --format env > .env && touch .env.overrides && cat .env.overrides >> .env",
+    "dev:token": "node --env-file=.env -r esbuild-register ./src/get-linkedin-token.ts",
     "dev:consumer": "node --env-file=.env -r esbuild-register ./src/launch-sqs-consumer.ts",
     "audit:critical": "npm audit --audit-level=critical",
     "clean": "rm -rf dist node_modules"
@@ -44,6 +45,7 @@
     "eslint-plugin-prettier": "5.2.1",
     "jest": "29.7.0",
     "jest-mock-extended": "3.0.7",
+    "open": "10.1.0",
     "prettier": "3.4.2",
     "prettier-plugin-sort-imports": "1.8.6",
     "sqs-consumer": "11.2.0",
diff --git a/src/get-linkedin-token.ts b/src/get-linkedin-token.ts
@@ -0,0 +1,64 @@
+/* eslint-disable no-process-env */
+/* eslint-disable no-console */
+import axios from 'axios';
+import { createServer } from 'http';
+import open from 'open';
+
+/**
+ *  👉 Script: Retrieves Linkedin API token for local testing (LOCAL_LINKEDIN_API_TOKEN environment variable value)
+ */
+
+const CLIENT_ID = process.env.LOCAL_LINKEDIN_CLIENT_ID!;
+const CLIENT_SECRET = process.env.LOCAL_LINKEDIN_CLIENT_SECRET!;
+const SCOPE = 'r_dma_portability_3rd_party';
+const REDIRECT_URI = 'http://localhost:3000/callback';
+
+const startOAuthFlow = async (): Promise<void> => {
+  const authUrl = `https://www.linkedin.com/oauth/v2/authorization?response_type=code&client_id=${CLIENT_ID}&redirect_uri=${REDIRECT_URI}&scope=${SCOPE}`;
+  console.log('👉 Opening LinkedIn OAuth URL...');
+  await open(authUrl);
+};
+
+// Create a simple server to handle the LinkedIn redirect
+createServer(async (req, res) => {
+  if (req.url?.startsWith('/callback')) {
+    const urlParams = new URLSearchParams(req.url.split('?')[1]);
+    const code = urlParams.get('code');
+
+    console.log('🔑 Authorization Code:', code);
+
+    if (!code) {
+      res.writeHead(400, { 'Content-Type': 'text/plain' });
+      res.end('Authorization code is missing.');
+      return;
+    }
+
+    try {
+      const tokenUrl = 'https://www.linkedin.com/oauth/v2/accessToken';
+      const tokenUrlParams = new URLSearchParams({
+        grant_type: 'authorization_code',
+        code,
+        redirect_uri: REDIRECT_URI,
+        client_id: CLIENT_ID!,
+        client_secret: CLIENT_SECRET!
+      }).toString();
+
+      const response = await axios.post(tokenUrl, tokenUrlParams, { headers: { 'Content-Type': 'application/x-www-form-urlencoded' } });
+      const accessToken = response.data.access_token;
+
+      console.log('✅ Access Token:', accessToken);
+
+      res.writeHead(200, { 'Content-Type': 'text/plain' });
+      res.end(`Access Token: ${accessToken}\n\nYou can now close this window.`);
+    } catch (error: unknown) {
+      console.error('❌ Error exchanging code for token:', error);
+      res.writeHead(500, { 'Content-Type': 'text/plain' });
+      res.end('Failed to get access token.');
+    }
+  }
+}).listen(3000, () => {
+  console.log('🚀 Server running at http://localhost:3000');
+  startOAuthFlow().catch((error) => {
+    console.error('❌ Error starting OAuth flow:', error);
+  });
+});
diff --git a/src/launch-sqs-consumer.ts b/src/launch-sqs-consumer.ts
@@ -6,7 +6,7 @@ import { handler } from './index';
 import { logger } from './util/logger';
 
 /**
- * Test the SQS consumer locally using LocalStack queues
+ *  👉  Script: Test the SQS consumer locally using LocalStack queues
  */
 const sqsClient = new SQSClient({ region: 'eu-west-1', endpoint: 'http://localhost:4566' });
 
diff --git a/src/launch.ts b/src/launch.ts
@@ -5,7 +5,9 @@ import { createMockedLinkedinProfileRequest } from './test/mocks/linkedin-profil
 import { createMockedSqsSEvent } from './test/mocks/sqs.mocks';
 import { logger } from './util/logger';
 
-// 👉 Fake manual execution without AWS: For local debug
+/**
+ *  👉  Script: Fake manual execution without AWS: For local debug
+ */
 void (async (): Promise<void> => {
   const linkedinApiToken = process.env['LOCAL_LINKEDIN_API_TOKEN'];
   const request = createMockedLinkedinProfileRequest({ linkedinApiToken });
diff --git a/yarn.lock b/yarn.lock
@@ -2095,6 +2095,13 @@ buffer@4.9.2:
     ieee754 "^1.1.4"
     isarray "^1.0.0"
 
+bundle-name@^4.1.0:
+  version "4.1.0"
+  resolved "https://registry.yarnpkg.com/bundle-name/-/bundle-name-4.1.0.tgz#f3b96b34160d6431a19d7688135af7cfb8797889"
+  integrity sha512-tjwM5exMg6BGRI+kNmTntNsvdZS1X8BFYS6tnJ2hdH0kVxM6/eVZ2xy+FqStSWvYmtfFMDLIxurorHwDKfDz5Q==
+  dependencies:
+    run-applescript "^7.0.0"
+
 call-bind-apply-helpers@^1.0.0:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.1.tgz#32e5892e6361b29b0b545ba6f7763378daca2840"
@@ -2308,6 +2315,19 @@ deepmerge@^4.2.2:
   resolved "https://registry.yarnpkg.com/deepmerge/-/deepmerge-4.3.1.tgz#44b5f2147cd3b00d4b56137685966f26fd25dd4a"
   integrity sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==
 
+default-browser-id@^5.0.0:
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/default-browser-id/-/default-browser-id-5.0.0.tgz#a1d98bf960c15082d8a3fa69e83150ccccc3af26"
+  integrity sha512-A6p/pu/6fyBcA1TRz/GqWYPViplrftcW2gZC9q79ngNCKAeR/X3gcEdXQHl4KNXV+3wgIJ1CPkJQ3IHM6lcsyA==
+
+default-browser@^5.2.1:
+  version "5.2.1"
+  resolved "https://registry.yarnpkg.com/default-browser/-/default-browser-5.2.1.tgz#7b7ba61204ff3e425b556869ae6d3e9d9f1712cf"
+  integrity sha512-WY/3TUME0x3KPYdRRxEJJvXRHV4PyPoUsxtZa78lwItwRQRHhd2U9xOscaT/YTf8uCXIAjeJOFBVEh/7FtD8Xg==
+  dependencies:
+    bundle-name "^4.1.0"
+    default-browser-id "^5.0.0"
+
 define-data-property@^1.1.4:
   version "1.1.4"
   resolved "https://registry.yarnpkg.com/define-data-property/-/define-data-property-1.1.4.tgz#894dc141bb7d3060ae4366f6a0107e68fbe48c5e"
@@ -2317,6 +2337,11 @@ define-data-property@^1.1.4:
     es-errors "^1.3.0"
     gopd "^1.0.1"
 
+define-lazy-prop@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/define-lazy-prop/-/define-lazy-prop-3.0.0.tgz#dbb19adfb746d7fc6d734a06b72f4a00d021255f"
+  integrity sha512-N+MeXYoqr3pOgn8xfyRPREN7gHakLYjhsHhWGT3fWAiL4IkAt0iDw14QiiEm2bE30c5XX5q0FtAA3CK5f9/BUg==
+
 delayed-stream@~1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/delayed-stream/-/delayed-stream-1.0.0.tgz#df3ae199acadfb7d440aaae0b29e2272b24ec619"
@@ -2947,6 +2972,11 @@ is-core-module@^2.13.0:
   dependencies:
     hasown "^2.0.2"
 
+is-docker@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/is-docker/-/is-docker-3.0.0.tgz#90093aa3106277d8a77a5910dbae71747e15a200"
+  integrity sha512-eljcgEDlEns/7AXFosB5K/2nCM4P7FQPkGc/DWLy5rmFEWvZayGrik1d9/QIY5nJ4f9YsVvBkA6kJpHn9rISdQ==
+
 is-extglob@^2.1.1:
   version "2.1.1"
   resolved "https://registry.yarnpkg.com/is-extglob/-/is-extglob-2.1.1.tgz#a88c02535791f02ed37c76a1b9ea9773c833f8c2"
@@ -2976,6 +3006,13 @@ is-glob@^4.0.0, is-glob@^4.0.1, is-glob@^4.0.3:
   dependencies:
     is-extglob "^2.1.1"
 
+is-inside-container@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/is-inside-container/-/is-inside-container-1.0.0.tgz#e81fba699662eb31dbdaf26766a61d4814717ea4"
+  integrity sha512-KIYLCCJghfHZxqjYBE7rEy0OBuTd5xCHS7tHVgvCLkx7StIoaxwNW3hCALgEUjFfeRk+MG/Qxmp/vtETEF3tRA==
+  dependencies:
+    is-docker "^3.0.0"
+
 is-number@^7.0.0:
   version "7.0.0"
   resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b"
@@ -2993,6 +3030,13 @@ is-typed-array@^1.1.3:
   dependencies:
     which-typed-array "^1.1.14"
 
+is-wsl@^3.1.0:
+  version "3.1.0"
+  resolved "https://registry.yarnpkg.com/is-wsl/-/is-wsl-3.1.0.tgz#e1c657e39c10090afcbedec61720f6b924c3cbd2"
+  integrity sha512-UcVfVfaK4Sc4m7X3dUSoHoozQGBEFeDC+zVo06t98xe8CzHSZZBekNXH+tu0NalHolcJ/QAGqS46Hef7QXBIMw==
+  dependencies:
+    is-inside-container "^1.0.0"
+
 isarray@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/isarray/-/isarray-1.0.0.tgz#bb935d48582cba168c06834957a54a3e07124f11"
@@ -3697,6 +3741,16 @@ onetime@^5.1.2:
   dependencies:
     mimic-fn "^2.1.0"
 
+open@10.1.0:
+  version "10.1.0"
+  resolved "https://registry.yarnpkg.com/open/-/open-10.1.0.tgz#a7795e6e5d519abe4286d9937bb24b51122598e1"
+  integrity sha512-mnkeQ1qP5Ue2wd+aivTD3NHd/lZ96Lu0jgf0pwktLPtx6cTZiH7tyeGRRHs0zX0rbrahXPnXlUnbeXyaBBuIaw==
+  dependencies:
+    default-browser "^5.2.1"
+    define-lazy-prop "^3.0.0"
+    is-inside-container "^1.0.0"
+    is-wsl "^3.1.0"
+
 optionator@^0.9.3:
   version "0.9.4"
   resolved "https://registry.yarnpkg.com/optionator/-/optionator-0.9.4.tgz#7ea1c1a5d91d764fb282139c88fe11e182a3a734"
@@ -3937,6 +3991,11 @@ reusify@^1.0.4:
   resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.0.4.tgz#90da382b1e126efc02146e90845a88db12925d76"
   integrity sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==
 
+run-applescript@^7.0.0:
+  version "7.0.0"
+  resolved "https://registry.yarnpkg.com/run-applescript/-/run-applescript-7.0.0.tgz#e5a553c2bffd620e169d276c1cd8f1b64778fbeb"
+  integrity sha512-9by4Ij99JUr/MCFBUkDKLWK3G9HVXmabKz9U5MlIAIuvuzkiOicRYs8XJLxX+xahD+mLiiCYDqF9dKAgtzKP1A==
+
 run-parallel@^1.1.9:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee"
