apps/desktop/src/shared/runtime-host-identity.ts

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

export interface DesktopHostRef {
  readonly hostId: string;
}

export interface DesktopTargetScope extends DesktopHostRef {
  readonly targetEpoch: string;
}

export interface DesktopSessionRef extends DesktopHostRef {
  readonly sessionId: string;
}

export interface DesktopTargetSessionRef extends DesktopSessionRef, DesktopTargetScope {}

export function sessionCatalogRetiresSession(
  activeSessionId: string | undefined,
  refreshedSessions: readonly { readonly id: string }[],
): activeSessionId is string {
  return (
    activeSessionId !== undefined &&
    !refreshedSessions.some(({ id }) => id === activeSessionId)
  );
}

export function desktopSessionKey(ref: DesktopSessionRef): string {
  return JSON.stringify([ref.hostId, ref.sessionId]);
}

export function parseDesktopSessionKey(value: string): DesktopSessionRef {
  const parsed: unknown = JSON.parse(value);
  if (
    !Array.isArray(parsed) ||
    parsed.length !== 2 ||
    typeof parsed[0] !== 'string' ||
    !parsed[0] ||
    typeof parsed[1] !== 'string' ||
    !parsed[1]
  ) {
    throw new Error('Invalid Desktop Host Session key');
  }
  return { hostId: parsed[0], sessionId: parsed[1] };
}

export function desktopSessionResourceKey(ref: DesktopTargetSessionRef): string {
  return JSON.stringify([ref.targetEpoch, ref.hostId, ref.sessionId]);
}

export function parseDesktopSessionResourceKey(value: string): DesktopTargetSessionRef {
  const parsed: unknown = JSON.parse(value);
  if (
    !Array.isArray(parsed) ||
    parsed.length !== 3 ||
    typeof parsed[0] !== 'string' ||
    !parsed[0] ||
    typeof parsed[1] !== 'string' ||
    !parsed[1] ||
    typeof parsed[2] !== 'string' ||
    !parsed[2]
  ) {
    throw new Error('Invalid Desktop Host Session resource key');
  }
  return { targetEpoch: parsed[0], hostId: parsed[1], sessionId: parsed[2] };
}

export function requireDesktopTargetScope(
  value: unknown,
  expected?: DesktopTargetScope,
): DesktopTargetScope {
  if (
    !value ||
    typeof value !== 'object' ||
    typeof (value as { hostId?: unknown }).hostId !== 'string' ||
    !(value as { hostId: string }).hostId ||
    typeof (value as { targetEpoch?: unknown }).targetEpoch !== 'string' ||
    !(value as { targetEpoch: string }).targetEpoch
  ) {
    throw new Error('Desktop Runtime Host request is missing its Host identity');
  }
  const ref = value as DesktopTargetScope;
  if (
    expected !== undefined &&
    (ref.hostId !== expected.hostId || ref.targetEpoch !== expected.targetEpoch)
  ) {
    throw new Error('Desktop Runtime Host request belongs to a different target');
  }
  return ref;
}