chore: changed target of hoppscotch-old-backend service back to prod

packages/hoppscotch-backend/prisma/migrations/20231106120154_embeds_addition/migration.sql

@@ -1,15 +0,0 @@
-/*
-  Warnings:
-
-  - A unique constraint covering the columns `[id]` on the table `Shortcode` will be added. If there are existing duplicate values, this will fail.
-
-*/
--- AlterTable
-ALTER TABLE "Shortcode" ADD COLUMN     "embedProperties" JSONB,
-ADD COLUMN     "updatedOn" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP;
-
--- CreateIndex
-CREATE UNIQUE INDEX "Shortcode_id_key" ON "Shortcode"("id");
-
--- AddForeignKey
-ALTER TABLE "Shortcode" ADD CONSTRAINT "Shortcode_creatorUid_fkey" FOREIGN KEY ("creatorUid") REFERENCES "User"("uid") ON DELETE SET NULL ON UPDATE CASCADE;

packages/hoppscotch-backend/prisma/schema.prisma

@@ -68,13 +68,11 @@ model TeamRequest {
 }
 
 model Shortcode {
-  id              String   @id @unique
-  request         Json
-  embedProperties Json?
-  creatorUid      String?
-  User            User?    @relation(fields: [creatorUid], references: [uid])
-  createdOn       DateTime @default(now())
-  updatedOn       DateTime @updatedAt @default(now())
+  id         String   @id
+  request    Json
+  creatorUid String?
+  createdOn  DateTime @default(now())
+
   @@unique(fields: [id, creatorUid], name: "creator_uid_shortcode_unique")
 }
 
@@ -104,7 +102,6 @@ model User {
   currentGQLSession  Json?
   createdOn          DateTime            @default(now()) @db.Timestamp(3)
   invitedUsers       InvitedUsers[]
-  shortcodes         Shortcode[]
 }
 
 model Account {

packages/hoppscotch-backend/src/errors.ts

@@ -318,6 +318,18 @@ export const TEAM_INVITATION_NOT_FOUND =
  */
 export const SHORTCODE_NOT_FOUND = 'shortcode/not_found' as const;
 
+/**
+ * Invalid ShortCode format
+ * (ShortcodeService)
+ */
+export const SHORTCODE_INVALID_JSON = 'shortcode/invalid_json' as const;
+
+/**
+ * ShortCode already exists in DB
+ * (ShortcodeService)
+ */
+export const SHORTCODE_ALREADY_EXISTS = 'shortcode/already_exists' as const;
+
 /**
  * Invalid or non-existent TEAM ENVIRONMENT ID
  * (TeamEnvironmentsService)
@@ -609,24 +621,3 @@ export const MAILER_SMTP_URL_UNDEFINED = 'mailer/smtp_url_undefined' as const;
  */
 export const MAILER_FROM_ADDRESS_UNDEFINED =
   'mailer/from_address_undefined' as const;
-
-/**
- * SharedRequest invalid request JSON format
- * (ShortcodeService)
- */
-export const SHORTCODE_INVALID_REQUEST_JSON =
-  'shortcode/request_invalid_format' as const;
-
-/**
- * SharedRequest invalid properties JSON format
- * (ShortcodeService)
- */
-export const SHORTCODE_INVALID_PROPERTIES_JSON =
-  'shortcode/properties_invalid_format' as const;
-
-/**
- * SharedRequest invalid properties not found
- * (ShortcodeService)
- */
-export const SHORTCODE_PROPERTIES_NOT_FOUND =
-  'shortcode/properties_not_found' as const;

packages/hoppscotch-backend/src/pubsub/topicsDefs.ts

@@ -69,7 +69,5 @@ export type TopicDef = {
   [topic: `team_req/${string}/req_deleted`]: string;
   [topic: `team/${string}/invite_added`]: TeamInvitation;
   [topic: `team/${string}/invite_removed`]: string;
-  [
-    topic: `shortcode/${string}/${'created' | 'revoked' | 'updated'}`
-  ]: Shortcode;
+  [topic: `shortcode/${string}/${'created' | 'revoked'}`]: Shortcode;
 };

packages/hoppscotch-backend/src/shortcode/shortcode.model.ts

@@ -3,7 +3,7 @@ import { Field, ID, ObjectType } from '@nestjs/graphql';
 @ObjectType()
 export class Shortcode {
   @Field(() => ID, {
-    description: 'The 12 digit alphanumeric code',
+    description: 'The shortcode. 12 digit alphanumeric.',
   })
   id: string;
 
@@ -12,12 +12,6 @@ export class Shortcode {
   })
   request: string;
 
-  @Field({
-    description: 'JSON string representing the properties for an embed',
-    nullable: true,
-  })
-  properties: string;
-
   @Field({
     description: 'Timestamp of when the Shortcode was created',
   })

packages/hoppscotch-backend/src/shortcode/shortcode.module.ts

@@ -1,4 +1,5 @@
 import { Module } from '@nestjs/common';
+import { JwtModule } from '@nestjs/jwt';
 import { PrismaModule } from 'src/prisma/prisma.module';
 import { PubSubModule } from 'src/pubsub/pubsub.module';
 import { UserModule } from 'src/user/user.module';
@@ -6,7 +7,14 @@ import { ShortcodeResolver } from './shortcode.resolver';
 import { ShortcodeService } from './shortcode.service';
 
 @Module({
-  imports: [PrismaModule, UserModule, PubSubModule],
+  imports: [
+    PrismaModule,
+    UserModule,
+    PubSubModule,
+    JwtModule.register({
+      secret: process.env.JWT_SECRET,
+    }),
+  ],
   providers: [ShortcodeService, ShortcodeResolver],
   exports: [ShortcodeService],
 })

packages/hoppscotch-backend/src/shortcode/shortcode.resolver.ts

@@ -1,5 +1,6 @@
 import {
   Args,
+  Context,
   ID,
   Mutation,
   Query,
@@ -10,12 +11,14 @@ import * as E from 'fp-ts/Either';
 import { UseGuards } from '@nestjs/common';
 import { Shortcode } from './shortcode.model';
 import { ShortcodeService } from './shortcode.service';
+import { UserService } from 'src/user/user.service';
 import { throwErr } from 'src/utils';
 import { GqlUser } from 'src/decorators/gql-user.decorator';
 import { GqlAuthGuard } from 'src/guards/gql-auth.guard';
 import { User } from 'src/user/user.model';
 import { PubSubService } from 'src/pubsub/pubsub.service';
 import { AuthUser } from '../types/AuthUser';
+import { JwtService } from '@nestjs/jwt';
 import { PaginationArgs } from 'src/types/input-types.args';
 import { GqlThrottlerGuard } from 'src/guards/gql-throttler.guard';
 import { SkipThrottle } from '@nestjs/throttler';
@@ -25,7 +28,9 @@ import { SkipThrottle } from '@nestjs/throttler';
 export class ShortcodeResolver {
   constructor(
     private readonly shortcodeService: ShortcodeService,
+    private readonly userService: UserService,
     private readonly pubsub: PubSubService,
+    private jwtService: JwtService,
   ) {}
 
   /* Queries */
@@ -59,53 +64,20 @@ export class ShortcodeResolver {
   @Mutation(() => Shortcode, {
     description: 'Create a shortcode for the given request.',
   })
-  @UseGuards(GqlAuthGuard)
   async createShortcode(
-    @GqlUser() user: AuthUser,
     @Args({
       name: 'request',
       description: 'JSON string of the request object',
     })
     request: string,
-    @Args({
-      name: 'properties',
-      description: 'JSON string of the properties of the embed',
-      nullable: true,
-    })
-    properties: string,
+    @Context() ctx: any,
   ) {
+    const decodedAccessToken = this.jwtService.verify(
+      ctx.req.cookies['access_token'],
+    );
     const result = await this.shortcodeService.createShortcode(
       request,
-      properties,
-      user,
-    );
-
-    if (E.isLeft(result)) throwErr(result.left);
-    return result.right;
-  }
-
-  @Mutation(() => Shortcode, {
-    description: 'Update a user generated Shortcode',
-  })
-  @UseGuards(GqlAuthGuard)
-  async updateEmbedProperties(
-    @GqlUser() user: AuthUser,
-    @Args({
-      name: 'code',
-      type: () => ID,
-      description: 'The Shortcode to update',
-    })
-    code: string,
-    @Args({
-      name: 'properties',
-      description: 'JSON string of the properties of the embed',
-    })
-    properties: string,
-  ) {
-    const result = await this.shortcodeService.updateEmbedProperties(
-      code,
-      user.uid,
-      properties,
+      decodedAccessToken?.sub,
     );
 
     if (E.isLeft(result)) throwErr(result.left);
@@ -142,16 +114,6 @@ export class ShortcodeResolver {
     return this.pubsub.asyncIterator(`shortcode/${user.uid}/created`);
   }
 
-  @Subscription(() => Shortcode, {
-    description: 'Listen for Shortcode updates',
-    resolve: (value) => value,
-  })
-  @SkipThrottle()
-  @UseGuards(GqlAuthGuard)
-  myShortcodesUpdated(@GqlUser() user: AuthUser) {
-    return this.pubsub.asyncIterator(`shortcode/${user.uid}/updated`);
-  }
-
   @Subscription(() => Shortcode, {
     description: 'Listen for shortcode deletion',
     resolve: (value) => value,

packages/hoppscotch-backend/src/shortcode/shortcode.service.spec.ts

@@ -1,15 +1,13 @@
 import { mockDeep, mockReset } from 'jest-mock-extended';
 import { PrismaService } from '../prisma/prisma.service';
 import {
-  SHORTCODE_INVALID_PROPERTIES_JSON,
-  SHORTCODE_INVALID_REQUEST_JSON,
+  SHORTCODE_ALREADY_EXISTS,
+  SHORTCODE_INVALID_JSON,
   SHORTCODE_NOT_FOUND,
-  SHORTCODE_PROPERTIES_NOT_FOUND,
 } from 'src/errors';
 import { Shortcode } from './shortcode.model';
 import { ShortcodeService } from './shortcode.service';
 import { UserService } from 'src/user/user.service';
-import { AuthUser } from 'src/types/AuthUser';
 
 const mockPrisma = mockDeep<PrismaService>();
 
@@ -24,7 +22,7 @@ const mockFB = {
     doc: mockDocFunc,
   },
 };
-const mockUserService = new UserService(mockPrisma as any, mockPubSub as any);
+const mockUserService = new UserService(mockFB as any, mockPubSub as any);
 
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
@@ -40,34 +38,18 @@ beforeEach(() => {
 });
 const createdOn = new Date();
 
-const user: AuthUser = {
-  uid: '123344',
-  email: 'dwight@dundermifflin.com',
-  displayName: 'Dwight Schrute',
-  photoURL: 'https://en.wikipedia.org/wiki/Dwight_Schrute',
-  isAdmin: false,
-  refreshToken: 'hbfvdkhjbvkdvdfjvbnkhjb',
-  createdOn: createdOn,
-  currentGQLSession: {},
-  currentRESTSession: {},
-};
-
-const mockEmbed = {
+const shortCodeWithOutUser = {
   id: '123',
   request: '{}',
-  embedProperties: '{}',
   createdOn: createdOn,
-  creatorUid: user.uid,
-  updatedOn: createdOn,
+  creatorUid: null,
 };
 
-const mockShortcode = {
+const shortCodeWithUser = {
   id: '123',
   request: '{}',
-  embedProperties: null,
   createdOn: createdOn,
-  creatorUid: user.uid,
-  updatedOn: createdOn,
+  creatorUid: 'user_uid_1',
 };
 
 const shortcodes = [
@@ -76,38 +58,33 @@ const shortcodes = [
     request: {
       hello: 'there',
     },
-    embedProperties: {
-      foo: 'bar',
-    },
-    creatorUid: user.uid,
+    creatorUid: 'testuser',
     createdOn: new Date(),
-    updatedOn: createdOn,
   },
   {
     id: 'blablabla1',
     request: {
       hello: 'there',
     },
-    embedProperties: {
-      foo: 'bar',
-    },
-    creatorUid: user.uid,
+    creatorUid: 'testuser',
     createdOn: new Date(),
-    updatedOn: createdOn,
   },
 ];
 
 describe('ShortcodeService', () => {
   describe('getShortCode', () => {
-    test('should return a valid Shortcode with valid Shortcode ID', async () => {
-      mockPrisma.shortcode.findFirstOrThrow.mockResolvedValueOnce(mockEmbed);
+    test('should return a valid shortcode with valid shortcode ID', async () => {
+      mockPrisma.shortcode.findFirstOrThrow.mockResolvedValueOnce(
+        shortCodeWithOutUser,
+      );
 
-      const result = await shortcodeService.getShortCode(mockEmbed.id);
+      const result = await shortcodeService.getShortCode(
+        shortCodeWithOutUser.id,
+      );
       expect(result).toEqualRight(<Shortcode>{
-        id: mockEmbed.id,
-        createdOn: mockEmbed.createdOn,
-        request: JSON.stringify(mockEmbed.request),
-        properties: JSON.stringify(mockEmbed.embedProperties),
+        id: shortCodeWithOutUser.id,
+        createdOn: shortCodeWithOutUser.createdOn,
+        request: JSON.stringify(shortCodeWithOutUser.request),
       });
     });
 
@@ -122,10 +99,10 @@ describe('ShortcodeService', () => {
   });
 
   describe('fetchUserShortCodes', () => {
-    test('should return list of Shortcode with valid inputs and no cursor', async () => {
+    test('should return list of shortcodes with valid inputs and no cursor', async () => {
       mockPrisma.shortcode.findMany.mockResolvedValueOnce(shortcodes);
 
-      const result = await shortcodeService.fetchUserShortCodes(user.uid, {
+      const result = await shortcodeService.fetchUserShortCodes('testuser', {
         cursor: null,
         take: 10,
       });
@@ -133,22 +110,20 @@ describe('ShortcodeService', () => {
         {
           id: shortcodes[0].id,
           request: JSON.stringify(shortcodes[0].request),
-          properties: JSON.stringify(shortcodes[0].embedProperties),
           createdOn: shortcodes[0].createdOn,
         },
         {
           id: shortcodes[1].id,
           request: JSON.stringify(shortcodes[1].request),
-          properties: JSON.stringify(shortcodes[1].embedProperties),
           createdOn: shortcodes[1].createdOn,
         },
       ]);
     });
 
-    test('should return list of Shortcode with valid inputs and cursor', async () => {
+    test('should return list of shortcodes with valid inputs and cursor', async () => {
       mockPrisma.shortcode.findMany.mockResolvedValue([shortcodes[1]]);
 
-      const result = await shortcodeService.fetchUserShortCodes(user.uid, {
+      const result = await shortcodeService.fetchUserShortCodes('testuser', {
         cursor: 'blablabla',
         take: 10,
       });
@@ -156,7 +131,6 @@ describe('ShortcodeService', () => {
         {
           id: shortcodes[1].id,
           request: JSON.stringify(shortcodes[1].request),
-          properties: JSON.stringify(shortcodes[1].embedProperties),
           createdOn: shortcodes[1].createdOn,
         },
       ]);
@@ -165,7 +139,7 @@ describe('ShortcodeService', () => {
     test('should return an empty array for an invalid cursor', async () => {
       mockPrisma.shortcode.findMany.mockResolvedValue([]);
 
-      const result = await shortcodeService.fetchUserShortCodes(user.uid, {
+      const result = await shortcodeService.fetchUserShortCodes('testuser', {
         cursor: 'invalidcursor',
         take: 10,
       });
@@ -197,111 +171,77 @@ describe('ShortcodeService', () => {
   });
 
   describe('createShortcode', () => {
-    test('should throw SHORTCODE_INVALID_REQUEST_JSON error if incoming request data is invalid', async () => {
+    test('should throw SHORTCODE_INVALID_JSON error if incoming request data is invalid', async () => {
       const result = await shortcodeService.createShortcode(
         'invalidRequest',
-        null,
-        user,
+        'user_uid_1',
       );
-      expect(result).toEqualLeft(SHORTCODE_INVALID_REQUEST_JSON);
+      expect(result).toEqualLeft(SHORTCODE_INVALID_JSON);
     });
 
-    test('should throw SHORTCODE_INVALID_PROPERTIES_JSON error if incoming properties data is invalid', async () => {
-      const result = await shortcodeService.createShortcode(
-        '{}',
-        'invalid_data',
-        user,
-      );
-      expect(result).toEqualLeft(SHORTCODE_INVALID_PROPERTIES_JSON);
-    });
-
-    test('should successfully create a new Embed with valid user uid', async () => {
-      // generateUniqueShortCodeID --> getShortcode
+    test('should successfully create a new shortcode with valid user uid', async () => {
+      // generateUniqueShortCodeID --> getShortCode
       mockPrisma.shortcode.findFirstOrThrow.mockRejectedValueOnce(
         'NotFoundError',
       );
-      mockPrisma.shortcode.create.mockResolvedValueOnce(mockEmbed);
+      mockPrisma.shortcode.create.mockResolvedValueOnce(shortCodeWithUser);
 
-      const result = await shortcodeService.createShortcode('{}', '{}', user);
-      expect(result).toEqualRight(<Shortcode>{
-        id: mockEmbed.id,
-        createdOn: mockEmbed.createdOn,
-        request: JSON.stringify(mockEmbed.request),
-        properties: JSON.stringify(mockEmbed.embedProperties),
+      const result = await shortcodeService.createShortcode('{}', 'user_uid_1');
+      expect(result).toEqualRight({
+        id: shortCodeWithUser.id,
+        createdOn: shortCodeWithUser.createdOn,
+        request: JSON.stringify(shortCodeWithUser.request),
       });
     });
 
-    test('should successfully create a new ShortCode with valid user uid', async () => {
-      // generateUniqueShortCodeID --> getShortcode
+    test('should successfully create a new shortcode with null user uid', async () => {
+      // generateUniqueShortCodeID --> getShortCode
       mockPrisma.shortcode.findFirstOrThrow.mockRejectedValueOnce(
         'NotFoundError',
       );
-      mockPrisma.shortcode.create.mockResolvedValueOnce(mockShortcode);
+      mockPrisma.shortcode.create.mockResolvedValueOnce(shortCodeWithUser);
 
-      const result = await shortcodeService.createShortcode('{}', null, user);
-      expect(result).toEqualRight(<Shortcode>{
-        id: mockShortcode.id,
-        createdOn: mockShortcode.createdOn,
-        request: JSON.stringify(mockShortcode.request),
-        properties: mockShortcode.embedProperties,
+      const result = await shortcodeService.createShortcode('{}', null);
+      expect(result).toEqualRight({
+        id: shortCodeWithUser.id,
+        createdOn: shortCodeWithUser.createdOn,
+        request: JSON.stringify(shortCodeWithOutUser.request),
       });
     });
 
-    test('should send pubsub message to `shortcode/{uid}/created` on successful creation of a Shortcode', async () => {
-      // generateUniqueShortCodeID --> getShortcode
+    test('should send pubsub message to `shortcode/{uid}/created` on successful creation of shortcode', async () => {
+      // generateUniqueShortCodeID --> getShortCode
       mockPrisma.shortcode.findFirstOrThrow.mockRejectedValueOnce(
         'NotFoundError',
       );
-      mockPrisma.shortcode.create.mockResolvedValueOnce(mockShortcode);
-
-      const result = await shortcodeService.createShortcode('{}', null, user);
+      mockPrisma.shortcode.create.mockResolvedValueOnce(shortCodeWithUser);
 
+      const result = await shortcodeService.createShortcode('{}', 'user_uid_1');
       expect(mockPubSub.publish).toHaveBeenCalledWith(
-        `shortcode/${mockShortcode.creatorUid}/created`,
-        <Shortcode>{
-          id: mockShortcode.id,
-          createdOn: mockShortcode.createdOn,
-          request: JSON.stringify(mockShortcode.request),
-          properties: mockShortcode.embedProperties,
-        },
-      );
-    });
-
-    test('should send pubsub message to `shortcode/{uid}/created` on successful creation of an Embed', async () => {
-      // generateUniqueShortCodeID --> getShortcode
-      mockPrisma.shortcode.findFirstOrThrow.mockRejectedValueOnce(
-        'NotFoundError',
-      );
-      mockPrisma.shortcode.create.mockResolvedValueOnce(mockEmbed);
-
-      const result = await shortcodeService.createShortcode('{}', '{}', user);
-
-      expect(mockPubSub.publish).toHaveBeenCalledWith(
-        `shortcode/${mockEmbed.creatorUid}/created`,
-        <Shortcode>{
-          id: mockEmbed.id,
-          createdOn: mockEmbed.createdOn,
-          request: JSON.stringify(mockEmbed.request),
-          properties: JSON.stringify(mockEmbed.embedProperties),
+        `shortcode/${shortCodeWithUser.creatorUid}/created`,
+        {
+          id: shortCodeWithUser.id,
+          createdOn: shortCodeWithUser.createdOn,
+          request: JSON.stringify(shortCodeWithUser.request),
         },
       );
     });
   });
 
   describe('revokeShortCode', () => {
-    test('should return true on successful deletion of Shortcode with valid inputs', async () => {
-      mockPrisma.shortcode.delete.mockResolvedValueOnce(mockEmbed);
+    test('should return true on successful deletion of shortcode with valid inputs', async () => {
+      mockPrisma.shortcode.delete.mockResolvedValueOnce(shortCodeWithUser);
 
       const result = await shortcodeService.revokeShortCode(
-        mockEmbed.id,
-        mockEmbed.creatorUid,
+        shortCodeWithUser.id,
+        shortCodeWithUser.creatorUid,
       );
 
       expect(mockPrisma.shortcode.delete).toHaveBeenCalledWith({
         where: {
           creator_uid_shortcode_unique: {
-            creatorUid: mockEmbed.creatorUid,
-            id: mockEmbed.id,
+            creatorUid: shortCodeWithUser.creatorUid,
+            id: shortCodeWithUser.id,
           },
         },
       });
@@ -309,53 +249,52 @@ describe('ShortcodeService', () => {
       expect(result).toEqualRight(true);
     });
 
-    test('should return SHORTCODE_NOT_FOUND error when Shortcode is invalid and user uid is valid', async () => {
+    test('should return SHORTCODE_NOT_FOUND error when shortcode is invalid and user uid is valid', async () => {
       mockPrisma.shortcode.delete.mockRejectedValue('RecordNotFound');
       expect(
         shortcodeService.revokeShortCode('invalid', 'testuser'),
       ).resolves.toEqualLeft(SHORTCODE_NOT_FOUND);
     });
 
-    test('should return SHORTCODE_NOT_FOUND error when Shortcode is valid and user uid is invalid', async () => {
+    test('should return SHORTCODE_NOT_FOUND error when shortcode is valid and user uid is invalid', async () => {
       mockPrisma.shortcode.delete.mockRejectedValue('RecordNotFound');
       expect(
         shortcodeService.revokeShortCode('blablablabla', 'invalidUser'),
       ).resolves.toEqualLeft(SHORTCODE_NOT_FOUND);
     });
 
-    test('should return SHORTCODE_NOT_FOUND error when both Shortcode and user uid are invalid', async () => {
+    test('should return SHORTCODE_NOT_FOUND error when both shortcode and user uid are invalid', async () => {
       mockPrisma.shortcode.delete.mockRejectedValue('RecordNotFound');
       expect(
         shortcodeService.revokeShortCode('invalid', 'invalid'),
       ).resolves.toEqualLeft(SHORTCODE_NOT_FOUND);
     });
 
-    test('should send pubsub message to `shortcode/{uid}/revoked` on successful deletion of Shortcode', async () => {
-      mockPrisma.shortcode.delete.mockResolvedValueOnce(mockEmbed);
+    test('should send pubsub message to `shortcode/{uid}/revoked` on successful deletion of shortcode', async () => {
+      mockPrisma.shortcode.delete.mockResolvedValueOnce(shortCodeWithUser);
 
       const result = await shortcodeService.revokeShortCode(
-        mockEmbed.id,
-        mockEmbed.creatorUid,
+        shortCodeWithUser.id,
+        shortCodeWithUser.creatorUid,
       );
 
       expect(mockPubSub.publish).toHaveBeenCalledWith(
-        `shortcode/${mockEmbed.creatorUid}/revoked`,
+        `shortcode/${shortCodeWithUser.creatorUid}/revoked`,
         {
-          id: mockEmbed.id,
-          createdOn: mockEmbed.createdOn,
-          request: JSON.stringify(mockEmbed.request),
-          properties: JSON.stringify(mockEmbed.embedProperties),
+          id: shortCodeWithUser.id,
+          createdOn: shortCodeWithUser.createdOn,
+          request: JSON.stringify(shortCodeWithUser.request),
         },
       );
     });
   });
 
   describe('deleteUserShortCodes', () => {
-    test('should successfully delete all users Shortcodes with valid user uid', async () => {
+    test('should successfully delete all users shortcodes with valid user uid', async () => {
       mockPrisma.shortcode.deleteMany.mockResolvedValueOnce({ count: 1 });
 
       const result = await shortcodeService.deleteUserShortCodes(
-        mockEmbed.creatorUid,
+        shortCodeWithUser.creatorUid,
       );
       expect(result).toEqual(1);
     });
@@ -364,81 +303,9 @@ describe('ShortcodeService', () => {
       mockPrisma.shortcode.deleteMany.mockResolvedValueOnce({ count: 0 });
 
       const result = await shortcodeService.deleteUserShortCodes(
-        mockEmbed.creatorUid,
+        shortCodeWithUser.creatorUid,
       );
       expect(result).toEqual(0);
     });
   });
-
-  describe('updateShortcode', () => {
-    test('should return SHORTCODE_PROPERTIES_NOT_FOUND error when updatedProps in invalid', async () => {
-      const result = await shortcodeService.updateEmbedProperties(
-        mockEmbed.id,
-        user.uid,
-        '',
-      );
-      expect(result).toEqualLeft(SHORTCODE_PROPERTIES_NOT_FOUND);
-    });
-
-    test('should return SHORTCODE_PROPERTIES_NOT_FOUND error when updatedProps in invalid JSON format', async () => {
-      const result = await shortcodeService.updateEmbedProperties(
-        mockEmbed.id,
-        user.uid,
-        '{kk',
-      );
-      expect(result).toEqualLeft(SHORTCODE_INVALID_PROPERTIES_JSON);
-    });
-
-    test('should return SHORTCODE_NOT_FOUND error when Shortcode ID is invalid', async () => {
-      mockPrisma.shortcode.update.mockRejectedValue('RecordNotFound');
-      const result = await shortcodeService.updateEmbedProperties(
-        'invalidID',
-        user.uid,
-        '{}',
-      );
-      expect(result).toEqualLeft(SHORTCODE_NOT_FOUND);
-    });
-
-    test('should successfully update a Shortcodes with valid inputs', async () => {
-      mockPrisma.shortcode.update.mockResolvedValueOnce({
-        ...mockEmbed,
-        embedProperties: '{"foo":"bar"}',
-      });
-
-      const result = await shortcodeService.updateEmbedProperties(
-        mockEmbed.id,
-        user.uid,
-        '{"foo":"bar"}',
-      );
-      expect(result).toEqualRight({
-        id: mockEmbed.id,
-        createdOn: mockEmbed.createdOn,
-        request: JSON.stringify(mockEmbed.request),
-        properties: JSON.stringify('{"foo":"bar"}'),
-      });
-    });
-
-    test('should send pubsub message to `shortcode/{uid}/updated` on successful Update of Shortcode', async () => {
-      mockPrisma.shortcode.update.mockResolvedValueOnce({
-        ...mockEmbed,
-        embedProperties: '{"foo":"bar"}',
-      });
-
-      const result = await shortcodeService.updateEmbedProperties(
-        mockEmbed.id,
-        user.uid,
-        '{"foo":"bar"}',
-      );
-
-      expect(mockPubSub.publish).toHaveBeenCalledWith(
-        `shortcode/${mockEmbed.creatorUid}/updated`,
-        {
-          id: mockEmbed.id,
-          createdOn: mockEmbed.createdOn,
-          request: JSON.stringify(mockEmbed.request),
-          properties: JSON.stringify('{"foo":"bar"}'),
-        },
-      );
-    });
-  });
 });

packages/hoppscotch-backend/src/shortcode/shortcode.service.ts

@@ -1,14 +1,10 @@
 import { Injectable, OnModuleInit } from '@nestjs/common';
 import * as T from 'fp-ts/Task';
+import * as O from 'fp-ts/Option';
 import * as TO from 'fp-ts/TaskOption';
 import * as E from 'fp-ts/Either';
 import { PrismaService } from 'src/prisma/prisma.service';
-import {
-  SHORTCODE_INVALID_PROPERTIES_JSON,
-  SHORTCODE_INVALID_REQUEST_JSON,
-  SHORTCODE_NOT_FOUND,
-  SHORTCODE_PROPERTIES_NOT_FOUND,
-} from 'src/errors';
+import { SHORTCODE_INVALID_JSON, SHORTCODE_NOT_FOUND } from 'src/errors';
 import { UserDataHandler } from 'src/user/user.data.handler';
 import { Shortcode } from './shortcode.model';
 import { Shortcode as DBShortCode } from '@prisma/client';
@@ -50,14 +46,10 @@ export class ShortcodeService implements UserDataHandler, OnModuleInit {
    * @param shortcodeInfo Prisma Shortcode type
    * @returns GQL Shortcode
    */
-  private cast(shortcodeInfo: DBShortCode): Shortcode {
+  private returnShortCode(shortcodeInfo: DBShortCode): Shortcode {
     return <Shortcode>{
       id: shortcodeInfo.id,
       request: JSON.stringify(shortcodeInfo.request),
-      properties:
-        shortcodeInfo.embedProperties != null
-          ? JSON.stringify(shortcodeInfo.embedProperties)
-          : null,
       createdOn: shortcodeInfo.createdOn,
     };
   }
@@ -102,7 +94,7 @@ export class ShortcodeService implements UserDataHandler, OnModuleInit {
       const shortcodeInfo = await this.prisma.shortcode.findFirstOrThrow({
         where: { id: shortcode },
       });
-      return E.right(this.cast(shortcodeInfo));
+      return E.right(this.returnShortCode(shortcodeInfo));
     } catch (error) {
       return E.left(SHORTCODE_NOT_FOUND);
     }
@@ -112,22 +104,14 @@ export class ShortcodeService implements UserDataHandler, OnModuleInit {
    * Create a new ShortCode
    *
    * @param request JSON string of request details
-   * @param userInfo user UI
-   * @param properties JSON string of embed properties, if present
+   * @param userUID user UID, if present
    * @returns Either of ShortCode or error
    */
-  async createShortcode(
-    request: string,
-    properties: string | null = null,
-    userInfo: AuthUser,
-  ) {
-    const requestData = stringToJson(request);
-    if (E.isLeft(requestData) || !requestData.right)
-      return E.left(SHORTCODE_INVALID_REQUEST_JSON);
+  async createShortcode(request: string, userUID: string | null) {
+    const shortcodeData = stringToJson(request);
+    if (E.isLeft(shortcodeData)) return E.left(SHORTCODE_INVALID_JSON);
 
-    const parsedProperties = stringToJson(properties);
-    if (E.isLeft(parsedProperties))
-      return E.left(SHORTCODE_INVALID_PROPERTIES_JSON);
+    const user = await this.userService.findUserById(userUID);
 
     const generatedShortCode = await this.generateUniqueShortCodeID();
     if (E.isLeft(generatedShortCode)) return E.left(generatedShortCode.left);
@@ -135,9 +119,8 @@ export class ShortcodeService implements UserDataHandler, OnModuleInit {
     const createdShortCode = await this.prisma.shortcode.create({
       data: {
         id: generatedShortCode.right,
-        request: requestData.right,
-        embedProperties: parsedProperties.right ?? undefined,
-        creatorUid: userInfo.uid,
+        request: shortcodeData.right,
+        creatorUid: O.isNone(user) ? null : user.value.uid,
       },
     });
 
@@ -145,11 +128,11 @@ export class ShortcodeService implements UserDataHandler, OnModuleInit {
     if (createdShortCode.creatorUid) {
       this.pubsub.publish(
         `shortcode/${createdShortCode.creatorUid}/created`,
-        this.cast(createdShortCode),
+        this.returnShortCode(createdShortCode),
       );
     }
 
-    return E.right(this.cast(createdShortCode));
+    return E.right(this.returnShortCode(createdShortCode));
   }
 
   /**
@@ -173,7 +156,7 @@ export class ShortcodeService implements UserDataHandler, OnModuleInit {
     });
 
     const fetchedShortCodes: Shortcode[] = shortCodes.map((code) =>
-      this.cast(code),
+      this.returnShortCode(code),
     );
 
     return fetchedShortCodes;
@@ -199,7 +182,7 @@ export class ShortcodeService implements UserDataHandler, OnModuleInit {
 
       this.pubsub.publish(
         `shortcode/${deletedShortCodes.creatorUid}/revoked`,
-        this.cast(deletedShortCodes),
+        this.returnShortCode(deletedShortCodes),
       );
 
       return E.right(true);
@@ -222,45 +205,4 @@ export class ShortcodeService implements UserDataHandler, OnModuleInit {
 
     return deletedShortCodes.count;
   }
-
-  /**
-   * Update a created Shortcode
-   * @param shortcodeID Shortcode ID
-   * @param uid User Uid
-   * @returns Updated Shortcode
-   */
-  async updateEmbedProperties(
-    shortcodeID: string,
-    uid: string,
-    updatedProps: string,
-  ) {
-    if (!updatedProps) return E.left(SHORTCODE_PROPERTIES_NOT_FOUND);
-
-    const parsedProperties = stringToJson(updatedProps);
-    if (E.isLeft(parsedProperties) || !parsedProperties.right)
-      return E.left(SHORTCODE_INVALID_PROPERTIES_JSON);
-
-    try {
-      const updatedShortcode = await this.prisma.shortcode.update({
-        where: {
-          creator_uid_shortcode_unique: {
-            creatorUid: uid,
-            id: shortcodeID,
-          },
-        },
-        data: {
-          embedProperties: parsedProperties.right,
-        },
-      });
-
-      this.pubsub.publish(
-        `shortcode/${updatedShortcode.creatorUid}/updated`,
-        this.cast(updatedShortcode),
-      );
-
-      return E.right(this.cast(updatedShortcode));
-    } catch (error) {
-      return E.left(SHORTCODE_NOT_FOUND);
-    }
-  }
 }

packages/hoppscotch-cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hoppscotch/cli",
-  "version": "0.4.0",
+  "version": "0.3.3",
   "description": "A CLI to run Hoppscotch test scripts in CI environments.",
   "homepage": "https://hoppscotch.io",
   "main": "dist/index.js",
@@ -10,9 +10,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "engines": {
-    "node": ">=18"
-  },
   "scripts": {
     "build": "pnpm exec tsup",
     "dev": "pnpm exec tsup --watch",
@@ -41,24 +38,24 @@
   "devDependencies": {
     "@hoppscotch/data": "workspace:^",
     "@hoppscotch/js-sandbox": "workspace:^",
-    "@relmify/jest-fp-ts": "^2.1.1",
-    "@swc/core": "^1.3.92",
-    "@types/jest": "^29.5.5",
-    "@types/lodash": "^4.14.199",
-    "@types/qs": "^6.9.8",
+    "@relmify/jest-fp-ts": "^2.0.2",
+    "@swc/core": "^1.2.181",
+    "@types/jest": "^27.4.1",
+    "@types/lodash": "^4.14.181",
+    "@types/qs": "^6.9.7",
     "axios": "^0.21.4",
-    "chalk": "^4.1.2",
-    "commander": "^11.0.0",
+    "chalk": "^4.1.1",
+    "commander": "^8.0.0",
     "esm": "^3.2.25",
-    "fp-ts": "^2.16.1",
-    "io-ts": "^2.2.20",
-    "jest": "^29.7.0",
+    "fp-ts": "^2.12.1",
+    "io-ts": "^2.2.16",
+    "jest": "^27.5.1",
     "lodash": "^4.17.21",
-    "prettier": "^3.0.3",
-    "qs": "^6.11.2",
-    "ts-jest": "^29.1.1",
-    "tsup": "^7.2.0",
-    "typescript": "^5.2.2",
-    "zod": "^3.22.4"
+    "prettier": "^2.8.4",
+    "qs": "^6.10.3",
+    "ts-jest": "^27.1.4",
+    "tsup": "^5.12.7",
+    "typescript": "^4.6.4",
+    "zod": "^3.22.2"
   }
 }

packages/hoppscotch-sh-admin/locales/en.json

@@ -39,7 +39,6 @@
     "delete_user_success": "User deleted successfully!!",
     "email": "Email",
     "email_failure": "Failed to send invitation",
-    "email_signin_failure": "Failed to login with Email",
     "email_success": "Email invitation sent successfully",
     "enter_team_email": "Please enter email of team owner!!",
     "error": "Something went wrong",
@@ -51,7 +50,6 @@
     "logout": "Logout",
     "magic_link_sign_in": "Click on the link to sign in.",
     "magic_link_success": "We sent a magic link to",
-    "microsoft_signin_failure": "Failed to login with Microsoft",
     "non_admin_logged_in": "Logged in as non admin user.",
     "non_admin_login": "You are logged in. But you're not an admin",
     "privacy_policy": "Privacy Policy",

packages/hoppscotch-sh-admin/src/components.d.ts

@@ -1,40 +1,39 @@
 // generated by unplugin-vue-components
 // We suggest you to commit this file into source control
 // Read more: https://github.com/vuejs/core/pull/3399
-import '@vue/runtime-core'
+import '@vue/runtime-core';
 
-export {}
+export {};
 
 declare module '@vue/runtime-core' {
   export interface GlobalComponents {
-    AppHeader: typeof import('./components/app/Header.vue')['default']
-    AppLogin: typeof import('./components/app/Login.vue')['default']
-    AppLogout: typeof import('./components/app/Logout.vue')['default']
-    AppModal: typeof import('./components/app/Modal.vue')['default']
-    AppSidebar: typeof import('./components/app/Sidebar.vue')['default']
-    AppToast: typeof import('./components/app/Toast.vue')['default']
-    DashboardMetricsCard: typeof import('./components/dashboard/MetricsCard.vue')['default']
-    HoppButtonPrimary: typeof import('@hoppscotch/ui')['HoppButtonPrimary']
-    HoppButtonSecondary: typeof import('@hoppscotch/ui')['HoppButtonSecondary']
-    HoppSmartAnchor: typeof import('@hoppscotch/ui')['HoppSmartAnchor']
-    HoppSmartAutoComplete: typeof import('@hoppscotch/ui')['HoppSmartAutoComplete']
-    HoppSmartConfirmModal: typeof import('@hoppscotch/ui')['HoppSmartConfirmModal']
-    HoppSmartInput: typeof import('@hoppscotch/ui')['HoppSmartInput']
-    HoppSmartItem: typeof import('@hoppscotch/ui')['HoppSmartItem']
-    HoppSmartModal: typeof import('@hoppscotch/ui')['HoppSmartModal']
-    HoppSmartPicture: typeof import('@hoppscotch/ui')['HoppSmartPicture']
-    HoppSmartSpinner: typeof import('@hoppscotch/ui')['HoppSmartSpinner']
-    IconLucideChevronDown: typeof import('~icons/lucide/chevron-down')['default']
-    IconLucideInbox: typeof import('~icons/lucide/inbox')['default']
-    TeamsAdd: typeof import('./components/teams/Add.vue')['default']
-    TeamsDetails: typeof import('./components/teams/Details.vue')['default']
-    TeamsInvite: typeof import('./components/teams/Invite.vue')['default']
-    TeamsMembers: typeof import('./components/teams/Members.vue')['default']
-    TeamsPendingInvites: typeof import('./components/teams/PendingInvites.vue')['default']
-    TeamsTable: typeof import('./components/teams/Table.vue')['default']
-    Tippy: typeof import('vue-tippy')['Tippy']
-    UsersInviteModal: typeof import('./components/users/InviteModal.vue')['default']
-    UsersTable: typeof import('./components/users/Table.vue')['default']
+    AppHeader: typeof import('./components/app/Header.vue')['default'];
+    AppLogin: typeof import('./components/app/Login.vue')['default'];
+    AppLogout: typeof import('./components/app/Logout.vue')['default'];
+    AppModal: typeof import('./components/app/Modal.vue')['default'];
+    AppSidebar: typeof import('./components/app/Sidebar.vue')['default'];
+    AppToast: typeof import('./components/app/Toast.vue')['default'];
+    DashboardMetricsCard: typeof import('./components/dashboard/MetricsCard.vue')['default'];
+    HoppButtonPrimary: typeof import('@hoppscotch/ui')['HoppButtonPrimary'];
+    HoppButtonSecondary: typeof import('@hoppscotch/ui')['HoppButtonSecondary'];
+    HoppSmartAnchor: typeof import('@hoppscotch/ui')['HoppSmartAnchor'];
+    HoppSmartAutoComplete: typeof import('@hoppscotch/ui')['HoppSmartAutoComplete'];
+    HoppSmartConfirmModal: typeof import('@hoppscotch/ui')['HoppSmartConfirmModal'];
+    HoppSmartInput: typeof import('@hoppscotch/ui')['HoppSmartInput'];
+    HoppSmartItem: typeof import('@hoppscotch/ui')['HoppSmartItem'];
+    HoppSmartModal: typeof import('@hoppscotch/ui')['HoppSmartModal'];
+    HoppSmartPicture: typeof import('@hoppscotch/ui')['HoppSmartPicture'];
+    HoppSmartSpinner: typeof import('@hoppscotch/ui')['HoppSmartSpinner'];
+    IconLucideChevronDown: typeof import('~icons/lucide/chevron-down')['default'];
+    IconLucideInbox: typeof import('~icons/lucide/inbox')['default'];
+    TeamsAdd: typeof import('./components/teams/Add.vue')['default'];
+    TeamsDetails: typeof import('./components/teams/Details.vue')['default'];
+    TeamsInvite: typeof import('./components/teams/Invite.vue')['default'];
+    TeamsMembers: typeof import('./components/teams/Members.vue')['default'];
+    TeamsPendingInvites: typeof import('./components/teams/PendingInvites.vue')['default'];
+    TeamsTable: typeof import('./components/teams/Table.vue')['default'];
+    Tippy: typeof import('vue-tippy')['Tippy'];
+    UsersInviteModal: typeof import('./components/users/InviteModal.vue')['default'];
+    UsersTable: typeof import('./components/users/Table.vue')['default'];
   }
-
 }

packages/hoppscotch-sh-admin/src/components/app/Header.vue

@@ -89,8 +89,8 @@ const t = useI18n();
 const { isOpen, isExpanded } = useSidebar();
 
 const currentUser = useReadonlyStream(
-  auth.getCurrentUserStream(),
-  auth.getCurrentUser()
+  auth.getProbableUserStream(),
+  auth.getProbableUser()
 );
 
 const expandSidebar = () => {

packages/hoppscotch-sh-admin/src/components/app/Login.vue

@@ -184,71 +184,91 @@ onMounted(() => {
   subscribeToStream(currentUser$, (user) => {
     if (user && !user.isAdmin) {
       nonAdminUser.value = true;
-      toast.error(t('state.non_admin_login'));
+      toast.error(`${t('state.non_admin_login')}`);
     }
   });
 });
 
-const signInWithGoogle = () => {
+async function signInWithGoogle() {
   signingInWithGoogle.value = true;
 
   try {
-    auth.signInUserWithGoogle();
+    await auth.signInUserWithGoogle();
   } catch (e) {
     console.error(e);
-    toast.error(t('state.google_signin_failure'));
+    /*
+    A auth/account-exists-with-different-credential Firebase error wont happen between Google and any other providers
+    Seems Google account overwrites accounts of other providers https://github.com/firebase/firebase-android-sdk/issues/25
+    */
+    toast.error(`${t('state.google_signin_failure')}`);
   }
 
   signingInWithGoogle.value = false;
-};
-
-const signInWithGithub = () => {
+}
+async function signInWithGithub() {
   signingInWithGitHub.value = true;
 
   try {
-    auth.signInUserWithGithub();
+    await auth.signInUserWithGithub();
   } catch (e) {
     console.error(e);
-    toast.error(t('state.github_signin_failure'));
+    /*
+    A auth/account-exists-with-different-credential Firebase error wont happen between Google and any other providers
+    Seems Google account overwrites accounts of other providers https://github.com/firebase/firebase-android-sdk/issues/25
+    */
+    toast.error(`${t('state.github_signin_failure')}`);
   }
 
   signingInWithGitHub.value = false;
-};
+}
 
-const signInWithMicrosoft = () => {
+async function signInWithMicrosoft() {
   signingInWithMicrosoft.value = true;
 
   try {
-    auth.signInUserWithMicrosoft();
+    await auth.signInUserWithMicrosoft();
   } catch (e) {
     console.error(e);
-    toast.error(t('state.microsoft_signin_failure'));
+    /*
+    A auth/account-exists-with-different-credential Firebase error wont happen between MS with Google or Github
+    If a Github account exists and user then logs in with MS email we get a "Something went wrong toast" and console errors and MS replaces GH as only provider.
+    The error messages are as follows:
+        FirebaseError: Firebase: Error (auth/popup-closed-by-user).
+        @firebase/auth: Auth (9.6.11): INTERNAL ASSERTION FAILED: Pending promise was never set
+    They may be related to https://github.com/firebase/firebaseui-web/issues/947
+    */
+    toast.error(`${t('state.error')}`);
   }
 
   signingInWithMicrosoft.value = false;
-};
-
-const signInWithEmail = async () => {
+}
+async function signInWithEmail() {
   signingInWithEmail.value = true;
-  try {
-    await auth.signInWithEmail(form.value.email);
-    mode.value = 'email-sent';
-    setLocalConfig('emailForSignIn', form.value.email);
-  } catch (e) {
-    console.error(e);
-    toast.error(t('state.email_signin_failure'));
-  }
-  signingInWithEmail.value = false;
-};
+
+  await auth
+    .signInWithEmail(form.value.email)
+    .then(() => {
+      mode.value = 'email-sent';
+      setLocalConfig('emailForSignIn', form.value.email);
+    })
+    .catch((e: any) => {
+      console.error(e);
+      toast.error(e.message);
+      signingInWithEmail.value = false;
+    })
+    .finally(() => {
+      signingInWithEmail.value = false;
+    });
+}
 
 const logout = async () => {
   try {
     await auth.signOutUser();
     window.location.reload();
-    toast.success(t('state.logged_out'));
+    toast.success(`${t('state.logged_out')}`);
   } catch (e) {
     console.error(e);
-    toast.error(t('state.error'));
+    toast.error(`${t('state.error')}`);
   }
 };
 </script>

packages/hoppscotch-sh-admin/src/components/teams/Invite.vue

@@ -200,7 +200,7 @@ import {
 } from '../../helpers/backend/graphql';
 import { useToast } from '~/composables/toast';
 import { useMutation, useQuery } from '@urql/vue';
-import { Email, EmailCodec } from '~/helpers/Email';
+import { Email, EmailCodec } from '~/helpers/backend/Email';
 import IconTrash from '~icons/lucide/trash';
 import IconPlus from '~icons/lucide/plus';
 import IconCircleDot from '~icons/lucide/circle-dot';

packages/hoppscotch-sh-admin/src/composables/auth.ts

@@ -0,0 +1,62 @@
+import { platform } from '~/platform';
+import { AuthEvent, HoppUser } from '~/platform/auth';
+import { Subscription } from 'rxjs';
+import { onBeforeUnmount, onMounted, watch, WatchStopHandle } from 'vue';
+import { useReadonlyStream } from './stream';
+
+/**
+ * A Vue composable function that is called when the auth status
+ * is being updated to being logged in (fired multiple times),
+ * this is also called on component mount if the login
+ * was already resolved before mount.
+ */
+export function onLoggedIn(exec: (user: HoppUser) => void) {
+  const currentUser = useReadonlyStream(
+    platform.auth.getCurrentUserStream(),
+    platform.auth.getCurrentUser()
+  );
+
+  let watchStop: WatchStopHandle | null = null;
+
+  onMounted(() => {
+    if (currentUser.value) exec(currentUser.value);
+
+    watchStop = watch(currentUser, (newVal, prev) => {
+      if (prev === null && newVal !== null) {
+        exec(newVal);
+      }
+    });
+  });
+
+  onBeforeUnmount(() => {
+    watchStop?.();
+  });
+}
+
+/**
+ * A Vue composable function that calls its param function
+ * when a new event (login, logout etc.) happens in
+ * the auth system.
+ *
+ * NOTE: Unlike `onLoggedIn` for which the callback will be called once on mount with the current state,
+ * here the callback will only be called on authentication event occurances.
+ * You might want to check the auth state from an `onMounted` hook or something
+ * if you want to access the initial state
+ *
+ * @param func A function which accepts an event
+ */
+export function onAuthEvent(func: (ev: AuthEvent) => void) {
+  const authEvents$ = platform.auth.getAuthEventsStream();
+
+  let sub: Subscription | null = null;
+
+  onMounted(() => {
+    sub = authEvents$.subscribe((ev) => {
+      func(ev);
+    });
+  });
+
+  onBeforeUnmount(() => {
+    sub?.unsubscribe();
+  });
+}

packages/hoppscotch-sh-admin/src/helpers/auth.ts

@@ -1,14 +1,12 @@
+import axios from 'axios';
 import { BehaviorSubject, Subject } from 'rxjs';
 import {
   getLocalConfig,
   removeLocalConfig,
   setLocalConfig,
 } from './localpersistence';
-import { Ref, ref } from 'vue';
+import { Ref, ref, watch } from 'vue';
 import * as O from 'fp-ts/Option';
-import authQuery from './backend/rest/authQuery';
-import { COOKIES_NOT_FOUND, UNAUTHORIZED } from './errors';
-
 /**
  * A common (and required) set of fields that describe a user.
  */
@@ -25,16 +23,22 @@ export type HoppUser = {
   /** URL to the profile picture of the user */
   photoURL: string | null;
 
+  // Regarding `provider` and `accessToken`:
+  // The current implementation and use case for these 2 fields are super weird due to legacy.
+  // Currrently these fields are only basically populated for Github Auth as we need the access token issued
+  // by it to implement Gist submission. I would really love refactor to make this thing more sane.
+
   /** Name of the provider authenticating (NOTE: See notes on `platform/auth.ts`) */
   provider?: string;
   /** Access Token for the auth of the user against the given `provider`. */
   accessToken?: string;
   emailVerified: boolean;
-  /** Flag to check for admin status */
+
   isAdmin: boolean;
 };
 
 export type AuthEvent =
+  | { event: 'probable_login'; user: HoppUser } // We have previous login state, but the app is waiting for authentication
   | { event: 'login'; user: HoppUser } // We are authenticated
   | { event: 'logout' } // No authentication and we have no previous state
   | { event: 'token_refresh' }; // We have previous login state, but the app is waiting for authentication
@@ -47,11 +51,17 @@ export type GithubSignInResult =
 export const authEvents$ = new Subject<
   AuthEvent | { event: 'token_refresh' }
 >();
-
 const currentUser$ = new BehaviorSubject<HoppUser | null>(null);
+export const probableUser$ = new BehaviorSubject<HoppUser | null>(null);
+
+async function logout() {
+  await axios.get(`${import.meta.env.VITE_BACKEND_API_URL}/auth/logout`, {
+    withCredentials: true,
+  });
+}
 
 const signOut = async (reloadWindow = false) => {
-  await authQuery.logout();
+  await logout();
 
   // Reload the window if both `access_token` and `refresh_token`is invalid
   // there by the user is taken to the login page
@@ -59,6 +69,7 @@ const signOut = async (reloadWindow = false) => {
     window.location.reload();
   }
 
+  probableUser$.next(null);
   currentUser$.next(null);
   removeLocalConfig('login_state');
 
@@ -67,66 +78,142 @@ const signOut = async (reloadWindow = false) => {
   });
 };
 
-const getInitialUserDetails = async () => {
-  const res = await authQuery.getUserDetails();
+async function signInUserWithGithubFB() {
+  window.location.href = `${
+    import.meta.env.VITE_BACKEND_API_URL
+  }/auth/github?redirect_uri=${import.meta.env.VITE_ADMIN_URL}`;
+}
+
+async function signInUserWithGoogleFB() {
+  window.location.href = `${
+    import.meta.env.VITE_BACKEND_API_URL
+  }/auth/google?redirect_uri=${import.meta.env.VITE_ADMIN_URL}`;
+}
+
+async function signInUserWithMicrosoftFB() {
+  window.location.href = `${
+    import.meta.env.VITE_BACKEND_API_URL
+  }/auth/microsoft?redirect_uri=${import.meta.env.VITE_ADMIN_URL}`;
+}
+
+async function getInitialUserDetails() {
+  const res = await axios.post<{
+    data?: {
+      me?: {
+        uid: string;
+        displayName: string;
+        email: string;
+        photoURL: string;
+        isAdmin: boolean;
+        createdOn: string;
+        // emailVerified: boolean
+      };
+    };
+    errors?: Array<{
+      message: string;
+    }>;
+  }>(
+    `${import.meta.env.VITE_BACKEND_GQL_URL}`,
+    {
+      query: `query Me {
+      me {
+        uid
+        displayName
+        email
+        photoURL
+        isAdmin
+        createdOn
+      }
+    }`,
+    },
+    {
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      withCredentials: true,
+    }
+  );
+
   return res.data;
-};
+}
+
 const isGettingInitialUser: Ref<null | boolean> = ref(null);
 
-const setUser = (user: HoppUser | null) => {
+function setUser(user: HoppUser | null) {
   currentUser$.next(user);
-  setLocalConfig('login_state', JSON.stringify(user));
-};
+  probableUser$.next(user);
 
-const setInitialUser = async () => {
+  setLocalConfig('login_state', JSON.stringify(user));
+}
+
+async function setInitialUser() {
   isGettingInitialUser.value = true;
   const res = await getInitialUserDetails();
 
-  if (res.errors?.[0]) {
-    const [error] = res.errors;
+  const error = res.errors && res.errors[0];
 
-    if (error.message === COOKIES_NOT_FOUND) {
+  // no cookies sent. so the user is not logged in
+  if (error && error.message === 'auth/cookies_not_found') {
+    setUser(null);
+    isGettingInitialUser.value = false;
+    return;
+  }
+
+  // cookies sent, but it is expired, we need to refresh the token
+  if (error && error.message === 'Unauthorized') {
+    const isRefreshSuccess = await refreshToken();
+
+    if (isRefreshSuccess) {
+      setInitialUser();
+    } else {
       setUser(null);
-    } else if (error.message === UNAUTHORIZED) {
-      const isRefreshSuccess = await refreshToken();
-
-      if (isRefreshSuccess) {
-        setInitialUser();
-      } else {
-        setUser(null);
-        signOut(true);
-      }
+      await signOut(true);
+      isGettingInitialUser.value = false;
     }
-  } else if (res.data?.me) {
-    const { uid, displayName, email, photoURL, isAdmin } = res.data.me;
+
+    return;
+  }
+
+  // no errors, we have a valid user
+  if (res.data && res.data.me) {
+    const hoppBackendUser = res.data.me;
 
     const hoppUser: HoppUser = {
-      uid,
-      displayName,
-      email,
-      photoURL,
+      uid: hoppBackendUser.uid,
+      displayName: hoppBackendUser.displayName,
+      email: hoppBackendUser.email,
+      photoURL: hoppBackendUser.photoURL,
+      // all our signin methods currently guarantees the email is verified
       emailVerified: true,
-      isAdmin,
+      isAdmin: hoppBackendUser.isAdmin,
     };
 
     if (!hoppUser.isAdmin) {
-      hoppUser.isAdmin = await elevateUser();
+      const isAdmin = await elevateUser();
+      hoppUser.isAdmin = isAdmin;
     }
 
     setUser(hoppUser);
 
+    isGettingInitialUser.value = false;
+
     authEvents$.next({
       event: 'login',
       user: hoppUser,
     });
-  }
 
-  isGettingInitialUser.value = false;
-};
+    return;
+  }
+}
 
 const refreshToken = async () => {
   try {
-    const res = await authQuery.refreshToken();
+    const res = await axios.get(
+      `${import.meta.env.VITE_BACKEND_API_URL}/auth/refresh`,
+      {
+        withCredentials: true,
+      }
+    );
     authEvents$.next({
       event: 'token_refresh',
     });
@@ -136,67 +223,157 @@ const refreshToken = async () => {
   }
 };
 
-const elevateUser = async () => {
-  const res = await authQuery.elevateUser();
-  return Boolean(res.data?.isAdmin);
-};
+async function elevateUser() {
+  const res = await axios.get(
+    `${import.meta.env.VITE_BACKEND_API_URL}/auth/verify/admin`,
+    {
+      withCredentials: true,
+    }
+  );
 
-const sendMagicLink = async (email: string) => {
-  const res = await authQuery.sendMagicLink(email);
-  if (!res.data?.deviceIdentifier) {
+  return !!res.data?.isAdmin;
+}
+
+async function sendMagicLink(email: string) {
+  const res = await axios.post(
+    `${import.meta.env.VITE_BACKEND_API_URL}/auth/signin?origin=admin`,
+    {
+      email,
+    },
+    {
+      withCredentials: true,
+    }
+  );
+
+  if (res.data && res.data.deviceIdentifier) {
+    setLocalConfig('deviceIdentifier', res.data.deviceIdentifier);
+  } else {
     throw new Error('test: does not get device identifier');
   }
-  setLocalConfig('deviceIdentifier', res.data.deviceIdentifier);
+
   return res.data;
-};
+}
 
 export const auth = {
   getCurrentUserStream: () => currentUser$,
   getAuthEventsStream: () => authEvents$,
+  getProbableUserStream: () => probableUser$,
+
   getCurrentUser: () => currentUser$.value,
+  getProbableUser: () => probableUser$.value,
 
-  performAuthInit: () => {
-    const currentUser = JSON.parse(getLocalConfig('login_state') ?? 'null');
-    currentUser$.next(currentUser);
-    return setInitialUser();
+  getBackendHeaders() {
+    return {};
+  },
+  getGQLClientOptions() {
+    return {
+      fetchOptions: {
+        credentials: 'include',
+      },
+    };
   },
 
-  signInWithEmail: (email: string) => sendMagicLink(email),
+  /**
+   * it is not possible for us to know if the current cookie is expired because we cannot access http-only cookies from js
+   * hence just returning if the currentUser$ has a value associated with it
+   */
+  willBackendHaveAuthError() {
+    return !currentUser$.value;
+  },
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  onBackendGQLClientShouldReconnect(func: () => void) {
+    authEvents$.subscribe((event) => {
+      if (
+        event.event == 'login' ||
+        event.event == 'logout' ||
+        event.event == 'token_refresh'
+      ) {
+        func();
+      }
+    });
+  },
 
-  isSignInWithEmailLink: (url: string) => {
+  /**
+   * we cannot access our auth cookies from javascript, so leaving this as null
+   */
+  getDevOptsBackendIDToken() {
+    return null;
+  },
+  async performAuthInit() {
+    const probableUser = JSON.parse(getLocalConfig('login_state') ?? 'null');
+    probableUser$.next(probableUser);
+    await setInitialUser();
+  },
+
+  waitProbableLoginToConfirm() {
+    return new Promise<void>((resolve, reject) => {
+      if (this.getCurrentUser()) {
+        resolve();
+      }
+
+      if (!probableUser$.value) reject(new Error('no_probable_user'));
+
+      const unwatch = watch(isGettingInitialUser, (val) => {
+        if (val === true || val === false) {
+          resolve();
+          unwatch();
+        }
+      });
+    });
+  },
+
+  async signInWithEmail(email: string) {
+    await sendMagicLink(email);
+  },
+
+  isSignInWithEmailLink(url: string) {
     const urlObject = new URL(url);
     const searchParams = new URLSearchParams(urlObject.search);
-    return Boolean(searchParams.get('token'));
+
+    return !!searchParams.get('token');
   },
 
-  signInUserWithGoogle: () => {
-    window.location.href = `${
-      import.meta.env.VITE_BACKEND_API_URL
-    }/auth/google?redirect_uri=${import.meta.env.VITE_ADMIN_URL}`;
+  async verifyEmailAddress() {
+    return;
   },
-
-  signInUserWithGithub: () => {
-    window.location.href = `${
-      import.meta.env.VITE_BACKEND_API_URL
-    }/auth/github?redirect_uri=${import.meta.env.VITE_ADMIN_URL}`;
+  async signInUserWithGoogle() {
+    await signInUserWithGoogleFB();
   },
-
-  signInUserWithMicrosoft: () => {
-    window.location.href = `${
-      import.meta.env.VITE_BACKEND_API_URL
-    }/auth/microsoft?redirect_uri=${import.meta.env.VITE_ADMIN_URL}`;
+  async signInUserWithGithub() {
+    await signInUserWithGithubFB();
+    return undefined;
   },
-
-  signInWithEmailLink: (url: string) => {
+  async signInUserWithMicrosoft() {
+    await signInUserWithMicrosoftFB();
+  },
+  async signInWithEmailLink(email: string, url: string) {
     const urlObject = new URL(url);
     const searchParams = new URLSearchParams(urlObject.search);
+
     const token = searchParams.get('token');
     const deviceIdentifier = getLocalConfig('deviceIdentifier');
 
-    return authQuery.signInWithEmailLink(token, deviceIdentifier);
+    await axios.post(
+      `${import.meta.env.VITE_BACKEND_API_URL}/auth/verify`,
+      {
+        token: token,
+        deviceIdentifier,
+      },
+      {
+        withCredentials: true,
+      }
+    );
+  },
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  async setEmailAddress(_email: string) {
+    return;
+  },
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  async setDisplayName(name: string) {
+    return;
   },
 
-  performAuthRefresh: async () => {
+  async performAuthRefresh() {
     const isRefreshSuccess = await refreshToken();
 
     if (isRefreshSuccess) {
@@ -209,10 +386,12 @@ export const auth = {
     }
   },
 
-  signOutUser: (reloadWindow = false) => signOut(reloadWindow),
+  async signOutUser(reloadWindow = false) {
+    await signOut(reloadWindow);
+  },
 
-  processMagicLink: async () => {
-    if (auth.isSignInWithEmailLink(window.location.href)) {
+  async processMagicLink() {
+    if (this.isSignInWithEmailLink(window.location.href)) {
       const deviceIdentifier = getLocalConfig('deviceIdentifier');
 
       if (!deviceIdentifier) {
@@ -221,7 +400,7 @@ export const auth = {
         );
       }
 
-      await auth.signInWithEmailLink(window.location.href);
+      await this.signInWithEmailLink(deviceIdentifier, window.location.href);
 
       removeLocalConfig('deviceIdentifier');
       window.location.href = import.meta.env.VITE_ADMIN_URL;

packages/hoppscotch-sh-admin/src/helpers/axiosConfig.ts

@@ -1,20 +0,0 @@
-import axios from 'axios';
-
-const baseConfig = {
-  headers: {
-    'Content-type': 'application/json',
-  },
-  withCredentials: true,
-};
-
-const gqlApi = axios.create({
-  ...baseConfig,
-  baseURL: import.meta.env.VITE_BACKEND_GQL_URL,
-});
-
-const restApi = axios.create({
-  ...baseConfig,
-  baseURL: import.meta.env.VITE_BACKEND_API_URL,
-});
-
-export { gqlApi, restApi };

packages/hoppscotch-sh-admin/src/helpers/backend/rest/authQuery.ts

@@ -1,32 +0,0 @@
-import { gqlApi, restApi } from '~/helpers/axiosConfig';
-
-export default {
-  getUserDetails: () =>
-    gqlApi.post('', {
-      query: `query Me {
-      me {
-        uid
-        displayName
-        email
-        photoURL
-        isAdmin
-        createdOn
-      }
-    }`,
-    }),
-  refreshToken: () => restApi.get('/auth/refresh'),
-  elevateUser: () => restApi.get('/auth/verify/admin'),
-  sendMagicLink: (email: string) =>
-    restApi.post('/auth/signin?origin=admin', {
-      email,
-    }),
-  signInWithEmailLink: (
-    token: string | null,
-    deviceIdentifier: string | null
-  ) =>
-    restApi.post('/auth/verify', {
-      token,
-      deviceIdentifier,
-    }),
-  logout: () => restApi.get('/auth/logout'),
-};

packages/hoppscotch-sh-admin/src/helpers/error.ts

@@ -0,0 +1,3 @@
+export const throwError = (message: string): never => {
+  throw new Error(message)
+}

packages/hoppscotch-sh-admin/src/helpers/errors.ts

@@ -1,9 +0,0 @@
-/* No cookies were found in the auth request
- * (AuthService)
- */
-export const COOKIES_NOT_FOUND = 'auth/cookies_not_found' as const;
-
-export const UNAUTHORIZED = 'Unauthorized' as const;
-
-// Sometimes the backend returns Unauthorized error message as follows:
-export const GRAPHQL_UNAUTHORIZED = '[GraphQL] Unauthorized' as const;

packages/hoppscotch-sh-admin/src/main.ts

@@ -16,7 +16,6 @@ import { HOPP_MODULES } from './modules';
 import { auth } from './helpers/auth';
 import { pipe } from 'fp-ts/function';
 import * as O from 'fp-ts/Option';
-import { GRAPHQL_UNAUTHORIZED } from './helpers/errors';
 
 // Top-level await is not available in our targets
 (async () => {
@@ -41,12 +40,12 @@ import { GRAPHQL_UNAUTHORIZED } from './helpers/errors';
             async refreshAuth() {
               pipe(
                 await auth.performAuthRefresh(),
-                O.getOrElseW(() => auth.signOutUser(true))
+                O.getOrElseW(async () => await auth.signOutUser(true))
               );
             },
 
             didAuthError(error, _operation) {
-              return error.message === GRAPHQL_UNAUTHORIZED;
+              return error.message === '[GraphQL] Unauthorized';
             },
           };
         }),

packages/hoppscotch-sh-admin/src/pages/enter.vue

@@ -13,8 +13,8 @@ import { auth } from '~/helpers/auth';
 const signingInWithEmail = ref(false);
 const error = ref(null);
 
-onBeforeMount(async () => {
-  await auth.performAuthInit();
+onBeforeMount(() => {
+  auth.performAuthInit();
 });
 
 onMounted(async () => {