All files / extensions/default/src/DicomWebDataSource retrieveThumbnail.ts

9.63% Statements 8/83
2.77% Branches 1/36
16.66% Functions 2/12
9.63% Lines 8/83

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347                                                                                                                                    739x 739x             739x 739x 783x     783x           783x     783x                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
import { HeadersInterface } from '@ohif/core/src/types/RequestHeaders';
 
export type ThumbnailContext = {
  StudyInstanceUID?: string;
  SeriesInstanceUID?: string;
  SOPInstanceUID?: string;
};
 
type ThumbnailFetchRequestResult = {
  url: string;
  endpointPath: string;
  headers: Record<string, string>;
};
 
type GetThumbnailSrcOptions = {
  signal?: AbortSignal;
  getImageSrc?: (imageId: unknown) => unknown;
};
 
type QidoClient = {
  headers: HeadersInterface;
  searchForInstances: (opts: unknown) => Promise<unknown[]>;
};
 
/**
 * The subset of the data source's `retrieve` object the thumbnail strategies
 * call back into for the directURL and bulkData-backed renderings.
 */
type RetrieveApi = {
  directURL: (params: unknown) => unknown;
  bulkDataURI: (params: unknown) => Promise<BlobPart>;
};
 
type ThumbnailConfig = {
  thumbnailRendering?: string;
  thumbnailRequestStrategy?: 'bulkDataRetrieve' | 'fetch';
  wadoRoot?: string;
};
 
type GetGetThumbnailSrcDeps = {
  thumbnailContext: ThumbnailContext;
  imageId: unknown;
  config: ThumbnailConfig;
  getAuthorizationHeader: () => HeadersInterface;
  qidoDicomWebClient: QidoClient;
  retrieve: RetrieveApi;
};
 
/**
 * Builds the `getThumbnailSrc` function for a given thumbnail context,
 * selecting the strategy from `config.thumbnailRendering` /
 * `config.thumbnailRequestStrategy`.
 *
 * Extracted from the DICOMweb data source so the thumbnail strategies live
 * apart from the data source wiring. The `retrieve` dependency provides the
 * `directURL` and `bulkDataURI` callbacks the data source used to reach via
 * `this`.
 */
export function getGetThumbnailSrc({
  thumbnailContext,
  imageId,
  config,
  getAuthorizationHeader,
  qidoDicomWebClient,
  retrieve,
}: GetGetThumbnailSrcDeps) {
  const thumbnailRendering = config.thumbnailRendering;
  Iif (!thumbnailRendering) {
    return function getThumbnailSrc() {
      console.warn('thumbnailRendering is not configured; returning null thumbnail src.');
      return null;
    };
  }
 
  if (thumbnailRendering === 'wadors') {
    return function getThumbnailSrc(options?: GetThumbnailSrcOptions) {
      Iif (!imageId) {
        return null;
      }
      Iif (!options?.getImageSrc) {
        return null;
      }
      // Note: options.signal (Cornerstone-backed loadImageToCanvas via getImageSrc) does
      // not currently expose an AbortSignal hook, so abort is not propagated to the
      // underlying image load. We short-circuit only if already aborted at call time.
      Iif (options?.signal?.aborted) {
        return null;
      }
      return options.getImageSrc(imageId);
    };
  }
 
  // thumbnailDirect is for plain <img src> URLs without auth headers; never use fetch here.
  // No network call happens at this layer (the <img> element loads the URL later), so
  // options.signal is not applicable here.
  Iif (thumbnailRendering === 'thumbnailDirect') {
    return function getThumbnailSrc() {
      return retrieve.directURL({
        instance: thumbnailContext,
        defaultPath: '/thumbnail',
        defaultType: 'image/jpeg',
        singlepart: true,
        tag: 'Absent',
      });
    };
  }
 
  const thumbnailRequestStrategy = config.thumbnailRequestStrategy || 'bulkDataRetrieve';
  Iif (thumbnailRequestStrategy === 'fetch') {
    return async function getThumbnailSrc(options?: { signal?: AbortSignal }) {
      return fetchThumbnailWithQidoFallbackForSeries(
        thumbnailContext,
        thumbnailRendering,
        config.wadoRoot,
        getAuthorizationHeader,
        qidoDicomWebClient,
        options?.signal
      );
    };
  }
 
  Iif (thumbnailRendering === 'thumbnail') {
    return async function getThumbnailSrc(options?: { signal?: AbortSignal }) {
      // Note: this path goes through bulkDataURI -> dicomweb-client retrieveBulkData,
      // which is XHR-based and does NOT honor AbortSignal. The underlying request will
      // run to completion server-side even if signal aborts; we only short-circuit
      // before kicking it off if already aborted.
      Iif (options?.signal?.aborted) {
        return null;
      }
      const endpoint = buildThumbnailEndpointPath(
        thumbnailContext,
        thumbnailRendering,
        new URLSearchParams({ accept: 'image/jpeg' })
      );
      const bulkDataURI = `${config.wadoRoot}${endpoint}`;
      return URL.createObjectURL(
        new Blob(
          [
            await retrieve.bulkDataURI({
              BulkDataURI: bulkDataURI.replace('wadors:', ''),
              defaultType: 'image/jpeg',
              mediaTypes: ['image/jpeg'],
              thumbnail: true,
            }),
          ],
          { type: 'image/jpeg' }
        )
      );
    };
  }
  Iif (thumbnailRendering === 'rendered') {
    return async function getThumbnailSrc(options?: { signal?: AbortSignal }) {
      // Note: this path goes through bulkDataURI -> dicomweb-client retrieveBulkData,
      // which is XHR-based and does NOT honor AbortSignal. The underlying request will
      // run to completion server-side even if signal aborts; we only short-circuit
      // before kicking it off if already aborted.
      Iif (options?.signal?.aborted) {
        return null;
      }
      const endpoint = buildThumbnailEndpointPath(
        thumbnailContext,
        thumbnailRendering,
        new URLSearchParams({ accept: 'image/jpeg' })
      );
      const bulkDataURI = `${config.wadoRoot}${endpoint}`;
      return URL.createObjectURL(
        new Blob(
          [
            await retrieve.bulkDataURI({
              BulkDataURI: bulkDataURI.replace('wadors:', ''),
              defaultType: 'image/jpeg',
              mediaTypes: ['image/jpeg'],
              thumbnail: true,
            }),
          ],
          { type: 'image/jpeg' }
        )
      );
    };
  }
 
  return function getThumbnailSrc() {
    console.warn(
      `Unsupported thumbnailRendering "${thumbnailRendering}"; returning null thumbnail src.`
    );
    return null;
  };
}
 
function buildThumbnailEndpointPath(
  thumbnailContext: ThumbnailContext,
  thumbnailRendering: string,
  queryParams?: URLSearchParams
): string {
  const { StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID } = thumbnailContext;
 
  const basePath =
    SeriesInstanceUID && SOPInstanceUID
      ? `/studies/${StudyInstanceUID}/series/${SeriesInstanceUID}/instances/${SOPInstanceUID}/${thumbnailRendering}`
      : SeriesInstanceUID
        ? `/studies/${StudyInstanceUID}/series/${SeriesInstanceUID}/${thumbnailRendering}`
        : `/studies/${StudyInstanceUID}/${thumbnailRendering}`;
 
  Iif (!queryParams) {
    return basePath;
  }
 
  const queryString = queryParams.toString();
 
  return queryString ? `${basePath}?${queryString}` : basePath;
}
 
function getThumbnailFetchRequest(
  thumbnailContext: ThumbnailContext,
  thumbnailRendering: string,
  wadoRoot: string | undefined,
  getAuthorizationHeader: () => HeadersInterface
): ThumbnailFetchRequestResult {
  const endpointPath = buildThumbnailEndpointPath(
    thumbnailContext,
    thumbnailRendering,
    // Thumbnails for some data source (e.g. dcm4chee) are pixelated by default, so we need to set the viewport to 256,256 to get a better thumbnail.
    new URLSearchParams({ viewport: '256,256' })
  );
 
  const headers: Record<string, string> = {
    ...(getAuthorizationHeader() as Record<string, string>),
    Accept: 'image/jpeg',
  };
 
  return {
    url: `${wadoRoot}${endpointPath}`,
    endpointPath,
    headers,
  };
}
 
async function fetchThumbnailObjectURL(
  thumbnailContext: ThumbnailContext,
  thumbnailRendering: string,
  wadoRoot: string | undefined,
  getAuthorizationHeader: () => HeadersInterface,
  signal?: AbortSignal
): Promise<string | null> {
  const fetchRequest = getThumbnailFetchRequest(
    thumbnailContext,
    thumbnailRendering,
    wadoRoot,
    getAuthorizationHeader
  );
 
  try {
    const response = await fetch(fetchRequest.url, {
      method: 'GET',
      headers: fetchRequest.headers,
      signal,
    });
 
    Iif (!response.ok) {
      console.warn(
        `thumbnail fetch failed with status ${response.status} for ${fetchRequest.endpointPath}`
      );
      return null;
    }
 
    const blob = await response.blob();
    return URL.createObjectURL(blob);
  } catch (error) {
    Iif ((error as { name?: string })?.name === 'AbortError') {
      return null;
    }
    console.warn('thumbnail fetch failed', error);
    return null;
  }
}
 
/**
 * When thumbnailRequestStrategy is fetch: try WADO GET for the given context; if it fails and the
 * context is series-level (no SOPInstanceUID), QIDO one instance and retry fetch once.
 */
async function fetchThumbnailWithQidoFallbackForSeries(
  thumbnailContext: ThumbnailContext,
  thumbnailRendering: string,
  wadoRoot: string | undefined,
  getAuthorizationHeader: () => HeadersInterface,
  qidoClient: QidoClient,
  signal?: AbortSignal
): Promise<string | null> {
  const sopInstanceUidTag = '00080018';
 
  const initialThumbnailUrl = await fetchThumbnailObjectURL(
    thumbnailContext,
    thumbnailRendering,
    wadoRoot,
    getAuthorizationHeader,
    signal
  );
  Iif (initialThumbnailUrl) {
    return initialThumbnailUrl;
  }
  Iif (signal?.aborted) {
    return null;
  }
  Iif (thumbnailContext.SOPInstanceUID) {
    return null;
  }
  Iif (!thumbnailContext.StudyInstanceUID || !thumbnailContext.SeriesInstanceUID) {
    return null;
  }
  try {
    qidoClient.headers = getAuthorizationHeader();
    // Note: qidoClient.searchForInstances is XHR-based (dicomweb-client) and does not honor
    // AbortSignal. If signal aborts mid-request the network call still completes; we just
    // short-circuit before issuing a follow-up fetch below.
    const instances = await qidoClient.searchForInstances({
      studyInstanceUID: thumbnailContext.StudyInstanceUID,
      seriesInstanceUID: thumbnailContext.SeriesInstanceUID,
      queryParams: {
        limit: 1,
        includefield: sopInstanceUidTag,
      },
    });
    Iif (signal?.aborted) {
      return null;
    }
    const firstInstance = instances?.[0] as Record<string, unknown> | undefined;
    const sopAttr = firstInstance?.[sopInstanceUidTag] as { Value?: string[] } | undefined;
    const sopValues = sopAttr?.Value;
    const SOPInstanceUID =
      Array.isArray(sopValues) && sopValues.length ? String(sopValues[0]) : undefined;
    Iif (!SOPInstanceUID) {
      return null;
    }
    return fetchThumbnailObjectURL(
      { ...thumbnailContext, SOPInstanceUID },
      thumbnailRendering,
      wadoRoot,
      getAuthorizationHeader,
      signal
    );
  } catch (error) {
    console.warn('thumbnail fetch QIDO fallback failed', error);
    return null;
  }
}