Revert "Revert "FCE-1780 / accept fishjam id to configure the sdk"" (#176)

Reverts #175
Now, that the deploy workflow is disabled, we can safely merge the code.

Author: czerwiukk

.github/workflows/static.yaml

@@ -40,7 +40,7 @@ jobs:
         run: yarn typecheck
 
       - name: Generate OpenAPI reference 📸
-        run: yarn gen:openapi ref.yaml
+        run: FISHJAM_ID="openapi" yarn gen:openapi ref.yaml
 
       - name: Compare OpenAPI reference 🔦
         run: |

examples/room-manager/openapi.yaml

@@ -52,8 +52,6 @@ paths:
                 properties:
                   peerToken:
                     type: string
-                  url:
-                    type: string
                   room:
                     type: object
                     properties:
@@ -70,7 +68,6 @@ paths:
                         type: string
                 required:
                   - peerToken
-                  - url
         "401":
           description: Default Response
           content:

examples/room-manager/src/config.ts

@@ -4,7 +4,8 @@ declare module 'fastify' {
       PORT: number;
       ENABLE_SIMULCAST: boolean;
       MAX_PEERS?: number;
-      FISHJAM_URL: string;
+      FISHJAM_ID?: string;
+      FISHJAM_URL?: string;
       FISHJAM_SERVER_TOKEN?: string;
       // TODO[FCE-1283] make this param required
       FISHJAM_MANAGEMENT_TOKEN?: string;
@@ -16,7 +17,7 @@ declare module 'fastify' {
 export const configSchema = {
   type: 'object',
   // TODO[FCE-1283] uncomment FISHJAM_MANAGEMENT_TOKEN
-  required: ['PORT', 'ENABLE_SIMULCAST', 'FISHJAM_URL' /*'FISHJAM_MANAGEMENT_TOKEN'*/],
+  required: ['PORT', 'ENABLE_SIMULCAST' /*'FISHJAM_MANAGEMENT_TOKEN'*/],
   properties: {
     PORT: {
       type: 'string',
@@ -30,9 +31,13 @@ export const configSchema = {
       type: 'number',
       default: undefined,
     },
+    FISHJAM_ID: {
+      type: 'string',
+      default: undefined,
+    },
     FISHJAM_URL: {
       type: 'string',
-      default: 'http://localhost:5002',
+      default: undefined,
     },
     FISHJAM_SERVER_TOKEN: {
       type: 'string',

examples/room-manager/src/plugins/fishjam.ts

@@ -37,6 +37,7 @@ export const fishjamPlugin = fastifyPlugin(async (fastify: FastifyInstance): Pro
   }
 
   const fishjamClient = new FishjamClient({
+    fishjamId: fastify.config.FISHJAM_ID,
     fishjamUrl: fastify.config.FISHJAM_URL,
     managementToken: fastify.config.FISHJAM_MANAGEMENT_TOKEN ?? fastify.config.FISHJAM_SERVER_TOKEN ?? 'development',
   });

examples/room-manager/src/routes/rooms.ts

@@ -9,7 +9,6 @@ import {
   streamEndpointSchema,
   viewerEndpointSchema,
 } from '../schema';
-import { httpToWebsocket, removeTrailingSlash } from '../utils';
 
 async function getRoomAccessHandler(fastify: FastifyInstance, params: GetPeerAccessQueryParams, res: FastifyReply) {
   try {
@@ -19,13 +18,8 @@ async function getRoomAccessHandler(fastify: FastifyInstance, params: GetPeerAcc
       params.roomType,
       params.public
     );
-    const url = httpToWebsocket(fastify.config.FISHJAM_URL);
 
-    // When creating a URL object from a URL without a path (e.g., `http://localhost:5002`),
-    // the `href` field may contain an additional '/' at the end (`http://localhost:5002/`).
-    const urlWithoutTrailingSlash = removeTrailingSlash(url);
-
-    return { ...accessData, url: urlWithoutTrailingSlash };
+    return accessData;
   } catch (error: unknown) {
     const [parsedError, errorCode] = parseError(error);
 

examples/room-manager/src/schema.ts

@@ -34,7 +34,6 @@ export interface LivestreamData {
 
 const response200 = S.object()
   .prop('peerToken', S.string().required())
-  .prop('url', S.string().required())
   .prop('room', S.object().prop('id', S.string()).prop('name', S.string()))
   .prop('peer', S.object().prop('id', S.string()).prop('name', S.string()));
 

packages/js-server-sdk/src/client.ts

@@ -2,6 +2,7 @@ import axios from 'axios';
 import { RoomApi, PeerOptions, ViewerApi, RoomConfig, StreamerApi } from '@fishjam-cloud/fishjam-openapi';
 import { FishjamConfig, PeerId, Room, RoomId, Peer } from './types';
 import { mapException } from './exceptions/mapper';
+import { getFishjamUrl } from './utils';
 
 /**
  * Client class that allows to manage Rooms and Peers for a Fishjam App.
@@ -31,9 +32,11 @@ export class FishjamClient {
       },
     });
 
-    this.roomApi = new RoomApi(undefined, config.fishjamUrl, client);
-    this.viewerApi = new ViewerApi(undefined, config.fishjamUrl, client);
-    this.streamerApi = new StreamerApi(undefined, config.fishjamUrl, client);
+    const fishjamUrl = getFishjamUrl(config);
+
+    this.roomApi = new RoomApi(undefined, fishjamUrl, client);
+    this.viewerApi = new ViewerApi(undefined, fishjamUrl, client);
+    this.streamerApi = new StreamerApi(undefined, fishjamUrl, client);
   }
 
   /**

packages/js-server-sdk/src/exceptions/index.ts

@@ -1,5 +1,11 @@
 import axios from 'axios';
 
+export class MissingFishjamIdException extends Error {
+  constructor() {
+    super('Fishjam ID is required');
+  }
+}
+
 export class FishjamBaseException extends Error {
   statusCode: number;
   axiosCode?: string;

packages/js-server-sdk/src/types.ts

@@ -26,6 +26,19 @@ export type Room = {
 };
 
 export type FishjamConfig = {
-  fishjamUrl: string;
+  /*
+   * Fishjam ID is a unique identifier for your account and environment.
+   * Visit https://fishjam.io/app/ to get your Fishjam ID.
+   */
+  fishjamId?: string;
+  /*
+   * @deprecated
+   */
+  fishjamUrl?: string;
+  /*
+   * Management token is a secret token authorizing to perform actions on your account.
+   * Never share this token with anyone.
+   * Visit https://fishjam.io/app/ to get your Management Token.
+   */
   managementToken: string;
 };

packages/js-server-sdk/src/utils.ts

@@ -0,0 +1,16 @@
+import { MissingFishjamIdException } from './exceptions';
+import type { FishjamConfig } from './types';
+
+export const httpToWebsocket = (httpUrl: string) => {
+  const url = new URL(httpUrl);
+
+  // note that this will handle http as well as https
+  url.protocol = url.protocol.replace('http', 'ws');
+  return url.href;
+};
+
+export const getFishjamUrl = (config: FishjamConfig) => {
+  if (!config.fishjamId && !config.fishjamUrl) throw new MissingFishjamIdException();
+
+  return config.fishjamUrl ?? `https://fishjam.io/api/v1/connect/${config.fishjamId}`;
+};