Refactor LinkedInToken to LinkedInProfile

Author: jankeromnes

components/gitpod-db/src/linked-in-token-db.ts renamed to components/gitpod-db/src/linked-in-profile-db.ts

@@ -4,5 +4,5 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
-export const LinkedInTokenDB = Symbol("LinkedInTokenDB");
-export interface LinkedInTokenDB {}
+export const LinkedInProfileDB = Symbol("LinkedInProfileDB");
+export interface LinkedInProfileDB {}

components/gitpod-db/src/tables.ts

@@ -341,7 +341,7 @@ export class GitpodTableDescriptionProvider implements TableDescriptionProvider
             deletionColumn: "deleted",
         },
         {
-            name: "d_b_linked_in_token",
+            name: "d_b_linked_in_profile",
             primaryKeys: ["id"],
             timeColumn: "_lastModified",
         },

components/gitpod-db/src/typeorm/entity/db-linked-in-token.ts renamed to components/gitpod-db/src/typeorm/entity/db-linked-in-profile.ts

@@ -5,13 +5,12 @@
  */
 
 import { Column, Entity, PrimaryColumn } from "typeorm";
-import { Transformer } from "../transformer";
 import { TypeORM } from "../typeorm";
-import { encryptionService } from "../user-db-impl";
+import { LinkedInProfile } from "@gitpod/gitpod-protocol";
 
 @Entity()
 // on DB but not Typeorm: @Index("ind_lastModified", ["_lastModified"])   // DBSync
-export class DBLinkedInToken {
+export class DBLinkedInProfile {
     @PrimaryColumn(TypeORM.UUID_COLUMN_TYPE)
     id: string;
 
@@ -20,11 +19,7 @@ export class DBLinkedInToken {
 
     @Column({
         type: "simple-json",
-        transformer: Transformer.compose(
-            Transformer.SIMPLE_JSON([]),
-            // Relies on the initialization of the var in UserDbImpl
-            Transformer.encrypted(() => encryptionService),
-        ),
+        nullable: false,
     })
-    token: { token: string };
+    profile: LinkedInProfile;
 }

components/gitpod-db/src/typeorm/linked-in-token-db-impl.ts

@@ -4,29 +4,33 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
+import { LinkedInProfile } from "@gitpod/gitpod-protocol";
 import { inject, injectable } from "inversify";
 import { Repository } from "typeorm";
-import { LinkedInTokenDB } from "../linked-in-token-db";
-import { DBLinkedInToken } from "./entity/db-linked-in-token";
+import { v4 as uuidv4 } from "uuid";
+import { LinkedInProfileDB } from "../linked-in-profile-db";
+import { DBLinkedInProfile } from "./entity/db-linked-in-profile";
 import { TypeORM } from "./typeorm";
 
 @injectable()
-export class LinkedInTokenDBImpl implements LinkedInTokenDB {
+export class LinkedInProfileDBImpl implements LinkedInProfileDB {
     @inject(TypeORM) typeORM: TypeORM;
 
     protected async getEntityManager() {
         return (await this.typeORM.getConnection()).manager;
     }
 
-    protected async getRepo(): Promise<Repository<DBLinkedInToken>> {
-        return (await this.getEntityManager()).getRepository<DBLinkedInToken>(DBLinkedInToken);
+    protected async getRepo(): Promise<Repository<DBLinkedInProfile>> {
+        return (await this.getEntityManager()).getRepository<DBLinkedInProfile>(DBLinkedInProfile);
     }
 
-    public async storeToken(userId: string, token: string): Promise<void> {
+    public async storeProfile(userId: string, profile: LinkedInProfile): Promise<void> {
         const repo = await this.getRepo();
-        const dbToken = new DBLinkedInToken();
-        dbToken.userId = userId;
-        dbToken.token = { token };
-        await repo.save(dbToken);
+        // TODO(janx): check if profile with same LinkedIn ID already exists
+        await repo.save({
+            id: uuidv4(),
+            userId,
+            profile,
+        });
     }
 }

components/gitpod-db/src/typeorm/migration/1680096507296-LinkedInToken.ts renamed to components/gitpod-db/src/typeorm/migration/1680096507296-LinkedInProfile.ts

@@ -7,12 +7,12 @@
 import { MigrationInterface, QueryRunner } from "typeorm";
 import { tableExists } from "./helper/helper";
 
-const TABLE_NAME = "d_b_linked_in_token";
+const TABLE_NAME = "d_b_linked_in_profile";
 
-export class LinkedInToken1680096507296 implements MigrationInterface {
+export class LinkedInProfile1680096507296 implements MigrationInterface {
     public async up(queryRunner: QueryRunner): Promise<void> {
         await queryRunner.query(
-            `CREATE TABLE IF NOT EXISTS ${TABLE_NAME} (id char(36) NOT NULL, userId char(36) NOT NULL, token text NOT NULL, _lastModified timestamp(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6), PRIMARY KEY (id)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;`,
+            `CREATE TABLE IF NOT EXISTS ${TABLE_NAME} (id char(36) NOT NULL, userId char(36) NOT NULL, profile text NOT NULL, _lastModified timestamp(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6), PRIMARY KEY (id)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;`,
         );
     }
 

components/gitpod-protocol/src/protocol.ts

@@ -1591,3 +1591,11 @@ export interface StripeConfig {
     individualUsagePriceIds: { [currency: string]: string };
     teamUsagePriceIds: { [currency: string]: string };
 }
+
+export interface LinkedInProfile {
+    id: string;
+    firstName: string;
+    lastName: string;
+    profilePicture: string;
+    emailAddress: string;
+}

components/server/ee/src/user/linkedin-service.ts

@@ -5,6 +5,7 @@
  */
 
 import { ErrorCodes } from "@gitpod/gitpod-protocol/lib/messaging/error";
+import { LinkedInProfile } from "@gitpod/gitpod-protocol/src/protocol";
 import { inject, injectable } from "inversify";
 import fetch from "node-fetch";
 import { ResponseError } from "vscode-jsonrpc";
@@ -36,4 +37,9 @@ export class LinkedInService {
         }
         return data;
     }
+
+    // TODO(janx): retrieve LinkedIn profile, profile pic, and email address: https://learn.microsoft.com/en-us/linkedin/consumer/integrations/self-serve/sign-in-with-linkedin
+    async getLinkedInProfile(): Promise<LinkedInProfile> {
+        throw new Error("Not implemented");
+    }
 }