FCE-2017 / remove fishjam url (#199)

## Description

Removes fishjam url property.

## Types of changes

- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to
      not work as expected)

Author: czerwiukk

.github/workflows/build-and-test-room-manager-amd64.yaml

@@ -40,7 +40,7 @@ jobs:
           --name gh-runner-room-manager \
           --restart always \
           -e PORT=8080 \
-          -e FISHJAM_URL=${{ vars.ROOM_MANAGER_FISHJAM_URL }} \
+          -e FISHJAM_ID=${{ vars.ROOM_MANAGER_FISHJAM_URL }} \
           -e FISHJAM_MANAGEMENT_TOKEN=${{ vars.ROOM_MANAGER_FISHJAM_SERVER_TOKEN }} \
           room-manager:${{ github.event.pull_request.head.sha }}
       - name: Test Room Manager Healtcheck

examples/room-manager/.env.example

@@ -1,2 +1,2 @@
+FISHJAM_ID=Fishjam ID
 FISHJAM_MANAGEMENT_TOKEN=Admin secret token
-FISHJAM_URL=App url

examples/room-manager/README.md

@@ -25,10 +25,10 @@ We recommend using the provided Room Manger instance on [fishjam.io](https://fis
 docker build -t room-manager -f examples/room-manager/Dockerfile .
 ```
 
-2. Run the following command with `{url}` and `{token}` placeholders replaced to start the Room Manager:
+2. Run the following command with `{fishjam_id}` and `{token}` placeholders replaced to start the Room Manager:
 
 ```sh
-docker run -e FISHJAM_URL={url} -e FISHJAM_MANAGEMENT_TOKEN={token} -d -p 8000:8080 room-manager:latest
+docker run -e FISHJAM_ID={fishjam_id} -e FISHJAM_MANAGEMENT_TOKEN={token} -d -p 8000:8080 room-manager:latest
 ```
 
 ## API

examples/room-manager/src/config.ts

@@ -4,8 +4,7 @@ declare module 'fastify' {
       PORT: number;
       ENABLE_SIMULCAST: boolean;
       MAX_PEERS?: number;
-      FISHJAM_ID?: string;
-      FISHJAM_URL?: string;
+      FISHJAM_ID: string;
       FISHJAM_MANAGEMENT_TOKEN: string;
       ROOM_VIDEO_CODEC: string;
     };
@@ -14,7 +13,7 @@ declare module 'fastify' {
 
 export const configSchema = {
   type: 'object',
-  required: ['PORT', 'ENABLE_SIMULCAST', 'FISHJAM_MANAGEMENT_TOKEN'],
+  required: ['PORT', 'ENABLE_SIMULCAST', 'FISHJAM_ID', 'FISHJAM_MANAGEMENT_TOKEN'],
   properties: {
     PORT: {
       type: 'string',
@@ -30,15 +29,9 @@ export const configSchema = {
     },
     FISHJAM_ID: {
       type: 'string',
-      default: undefined,
-    },
-    FISHJAM_URL: {
-      type: 'string',
-      default: undefined,
     },
     FISHJAM_MANAGEMENT_TOKEN: {
       type: 'string',
-      default: undefined,
     },
     ROOM_VIDEO_CODEC: {
       type: 'string',

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

@@ -36,7 +36,6 @@ 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,
   });
 

examples/transcription/src/environment.d.ts

@@ -1,8 +1,7 @@
 declare global {
   namespace NodeJS {
     interface ProcessEnv {
-      FISHJAM_ID?: string;
-      FISHJAM_URL?: string;
+      FISHJAM_ID: string;
       FISHJAM_TOKEN?: string;
       GEMINI_API_KEY?: string;
     }

examples/transcription/src/index.ts

@@ -3,12 +3,11 @@ import { peerController } from './controllers/peers';
 import { FishjamService } from './service/fishjam';
 import { TranscriptionService } from './service/transcription';
 
-if (!(process.env.FISHJAM_ID || process.env.FISHJAM_URL) || !process.env.FISHJAM_TOKEN || !process.env.GEMINI_API_KEY) {
+if (!process.env.FISHJAM_ID || !process.env.FISHJAM_TOKEN || !process.env.GEMINI_API_KEY) {
   throw Error('Environment variables FISHJAM_ID, FISHJAM_TOKEN and GEMINI_API_KEY are required.');
 }
 
 const fishjamConfig = {
-  fishjamUrl: process.env.FISHJAM_URL,
   fishjamId: process.env.FISHJAM_ID,
   managementToken: process.env.FISHJAM_TOKEN,
 };

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

@@ -7,7 +7,7 @@ import { FishjamAgent, TrackId } from './agent';
 
 /**
  * Client class that allows to manage Rooms and Peers for a Fishjam App.
- * It requires the Fishjam URL and management token that can be retrieved from the Fishjam Dashboard.
+ * It requires the Fishjam ID and management token that can be retrieved from the Fishjam Dashboard.
  * @category Client
  */
 export class FishjamClient {
@@ -22,7 +22,7 @@ export class FishjamClient {
    * Example usage:
    * ```
    * const fishjamClient = new FishjamClient({
-   *   fishjamUrl: fastify.config.FISHJAM_URL,
+   *   fishjamId: fastify.config.FISHJAM_ID,
    *   managementToken: fastify.config.FISHJAM_MANAGEMENT_TOKEN,
    * });
    * ```

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

@@ -30,11 +30,7 @@ export type FishjamConfig = {
    * 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;
+  fishjamId: string;
   /*
    * Management token is a secret token authorizing to perform actions on your account.
    * Never share this token with anyone.

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

@@ -10,9 +10,13 @@ export const httpToWebsocket = (httpUrl: string) => {
 };
 
 export const getFishjamUrl = (config: FishjamConfig) => {
-  if (!config.fishjamId && !config.fishjamUrl) throw new MissingFishjamIdException();
+  if (!config.fishjamId) throw new MissingFishjamIdException();
 
-  return config.fishjamUrl ?? `https://fishjam.io/api/v1/connect/${config.fishjamId}`;
+  try {
+    return new URL(config.fishjamId).href;
+  } catch {
+    return `https://fishjam.io/api/v1/connect/${config.fishjamId}`;
+  }
 };
 
 export type WithRoomId<T> = {