iModel integration

Apps/Sandcastle/gallery/iTwin Demo.html

@@ -119,17 +119,32 @@
           statusOutput.innerText = "Starting export";
 
           const start = Date.now();
+          const delay = (ms) => new Promise((res) => setTimeout(res, ms));
 
           statusOutput.innerText = "Creating Tileset";
-
-          let tileset = await Cesium.ITwinData.createTilesetFromModelId(imodelId);
-          if (!Cesium.defined(tileset)) {
-            // TODO: this is temporary, we should not have to call the Start Export route ever after
-            // auto generation is set up
-            statusOutput.innerText = "Starting export";
-            const exportId = await Cesium.ITwinPlatform.createExportForModelId(imodelId);
-            statusOutput.innerText = "Creating Tileset from export";
-            tileset = await Cesium.ITwinData.createTilesetFromExportId(exportId);
+          let tileset;
+          try {
+            tileset = await Cesium.ITwinData.createTilesetFromModelId(imodelId);
+          } catch (error) {
+            if (!error.message.includes("not completed")) {
+              throw error;
+            }
+            statusOutput.innerText = "Tileset not completed, retrying...";
+
+            const timeoutAfter = 300000;
+            // wait until the export is complete
+            while (Date.now() - start > timeoutAfter) {
+              await delay(5000);
+              try {
+                tileset = await Cesium.ITwinData.createTilesetFromModelId(imodelId);
+                break;
+              } catch (error) {
+                if (!error.message.includes("not completed")) {
+                  throw error;
+                }
+              }
+            }
+            throw new Cesium.RuntimeError("Export did not complete in time.");
           }
 
           scene.primitives.add(tileset);

packages/engine/Source/Core/ITwinPlatform.js

@@ -102,61 +102,11 @@ ITwinPlatform.apiEndpoint = new Resource({
   url: "https://api.bentley.com",
 });
 
-/**
- * Get the export object for the specified export id
- *
- * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
- *
- * @param {string} exportId
- *
- * @throws {RuntimeError} Unauthorized, bad token, wrong scopes or headers bad.
- * @throws {RuntimeError} Requested export is not available
- * @throws {RuntimeError} Too many requests
- * @throws {RuntimeError} Unknown request failure
- * TODO: remove? this is used when we're looping to wait for jobs to finish
- */
-ITwinPlatform.getExport = async function (exportId) {
-  //>>includeStart('debug', pragmas.debug);
-  Check.typeOf.string("exportId", exportId);
-  if (!defined(ITwinPlatform.defaultAccessToken)) {
-    throw new DeveloperError("Must set ITwin.defaultAccessToken first");
-  }
-  //>>includeEnd('debug')
-
-  const headers = {
-    Authorization: `Bearer ${ITwinPlatform.defaultAccessToken}`,
-    Accept: "application/vnd.bentley.itwin-platform.v1+json",
-  };
-
-  // obtain export for specified export id
-  const url = `${ITwinPlatform.apiEndpoint}mesh-export/${exportId}`;
-
-  // TODO: this request is _really_ slow, like 7 whole second alone for me
-  // Arun said this was kinda normal but to keep track of the `x-correlation-id` of any that take EXTRA long
-  const response = await fetch(url, { headers });
-  if (!response.ok) {
-    const result = await response.json();
-    if (response.status === 401) {
-      throw new RuntimeError(
-        `Unauthorized, bad token, wrong scopes or headers bad. ${result.error.details[0].code}`,
-      );
-    } else if (response.status === 404) {
-      throw new RuntimeError(`Requested export is not available ${exportId}`);
-    } else if (response.status === 429) {
-      throw new RuntimeError("Too many requests");
-    }
-    throw new RuntimeError(`Unknown request failure ${response.status}`);
-  }
-
-  /** @type {ExportResponse} */
-  const result = await response.json();
-  return result;
-};
-
 /**
  * Get the list of exports for the specified iModel at it's most current version. This will only return exports with {@link ITwinPlatform.ExportType} of <code>3DTILES</code>.
  *
  * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
+ * @private
  *
  * @param {string} iModelId iModel id
  *
@@ -185,6 +135,8 @@ ITwinPlatform.getExports = async function (iModelId) {
   const url = new URL(`${ITwinPlatform.apiEndpoint}mesh-export`);
   url.searchParams.set("iModelId", iModelId);
   url.searchParams.set("exportType", ITwinPlatform.ExportType["3DTILES"]);
+  // TODO: If we're only requesting the top 1 is there a chance it's `Invalid` instead of `Complete`
+  // and never possible to load it?
   url.searchParams.set("$top", "1");
   url.searchParams.set("client", "CesiumJS");
   /* global CESIUM_VERSION */
@@ -217,67 +169,4 @@ ITwinPlatform.getExports = async function (iModelId) {
   return result;
 };
 
-/**
- * TODO: REMOVE THIS FUNCTION! Auto generation of exports for the 3DTILES type is planned very soon
- * and will be the desired way of interacting with iModels through exports. This function is here
- * just while we continue testing during the PR process.
- * @deprecated
- */
-ITwinPlatform.createExportForModelId = async function (iModelId) {
-  //>>includeStart('debug', pragmas.debug);
-  Check.typeOf.string("iModelId", iModelId);
-  if (!defined(ITwinPlatform.defaultAccessToken)) {
-    throw new DeveloperError("Must set ITwin.defaultAccessToken first");
-  }
-  //>>includeEnd('debug')
-
-  const requestOptions = {
-    method: "POST",
-    headers: {
-      Authorization: `Bearer ${ITwinPlatform.defaultAccessToken}`,
-      Accept: "application/vnd.bentley.itwin-platform.v1+json",
-      "Content-Type": "application/json",
-    },
-    body: JSON.stringify({
-      iModelId,
-      exportType: ITwinPlatform.ExportType["3DTILES"],
-    }),
-  };
-
-  // initiate mesh export
-  const response = await fetch(
-    `${ITwinPlatform.apiEndpoint}mesh-export/`,
-    requestOptions,
-  );
-
-  if (!response.ok) {
-    const result = await response.json();
-    if (response.status === 401) {
-      console.error(
-        result.error.code,
-        result.error.message,
-        result.error.details,
-      );
-      throw new RuntimeError(
-        "Unauthorized, bad token, wrong scopes or headers bad",
-      );
-    } else if (response.status === 403) {
-      console.error(result.error.code, result.error.message);
-      throw new RuntimeError("Not allowed, forbidden");
-    } else if (response.status === 422) {
-      console.error(result.error.code, result.error.message);
-      console.error(result.error.details);
-      throw new RuntimeError("Unprocessable: Cannot create export job");
-    } else if (response.status === 429) {
-      throw new RuntimeError("Too many requests");
-    }
-
-    throw new RuntimeError(`Unknown request failure ${response.status}`);
-  }
-
-  /** @type {ExportResponse} */
-  const result = await response.json();
-  return result.export.id;
-};
-
 export default ITwinPlatform;

packages/engine/Source/Scene/ITwinData.js

@@ -5,10 +5,6 @@ import ITwinPlatform from "../Core/ITwinPlatform.js";
 import RuntimeError from "../Core/RuntimeError.js";
 import Check from "../Core/Check.js";
 
-function delay(ms) {
-  return new Promise((res) => setTimeout(res, ms));
-}
-
 /**
  * @param {Export} exportObj
  * @param {Cesium3DTileset.ConstructorOptions} [options] Object containing options to pass to an internally created {@link Cesium3DTileset}.
@@ -19,24 +15,13 @@ async function loadExport(exportObj, options) {
   Check.defined("exportObj", exportObj);
   //>>includeEnd('debug')
 
-  let status = exportObj.status;
-
   if (exportObj.request.exportType !== ITwinPlatform.ExportType["3DTILES"]) {
     throw new RuntimeError(`Wrong export type ${exportObj.request.exportType}`);
   }
-
-  const timeoutAfter = 300000;
-  const start = Date.now();
-  // wait until the export is complete
-  while (status !== ITwinPlatform.ExportStatus.Complete) {
-    await delay(5000);
-    exportObj = (await ITwinPlatform.getExport(exportObj.id)).export;
-    status = exportObj.status;
-    console.log(`Export is ${status}`);
-
-    if (Date.now() - start > timeoutAfter) {
-      throw new RuntimeError("Export did not complete in time.");
-    }
+  if (exportObj.status !== ITwinPlatform.ExportStatus.Complete) {
+    throw new RuntimeError(
+      `Export is not completed. ${exportObj.id} - ${exportObj.status}`,
+    );
   }
 
   // Convert the link to the tileset url while preserving the search paramaters
@@ -62,44 +47,25 @@ async function loadExport(exportObj, options) {
  */
 const ITwinData = {};
 
-/**
- * Creates a {@link Cesium3DTileset} instance for the given export id.
- *
- * @function
- * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
- *
- * @param {string} exportId
- * @param {Cesium3DTileset.ConstructorOptions} [options] Object containing options to pass to an internally created {@link Cesium3DTileset}.
- * @returns {Promise<Cesium3DTileset>}
- *
- * @throws {RuntimeError} Wrong export type
- * @throws {RuntimeError} Export did not complete in time.
- *
- * @example
- * TODO: example after API finalized
- * @deprecated
- */
-ITwinData.createTilesetFromExportId = async function (exportId, options) {
-  const result = await ITwinPlatform.getExport(exportId);
-  const tileset = await loadExport(result.export, options);
-  return tileset;
-};
-
 /**
  * Loads the export for the specified iModel with the export type that CesiumJS can load and returns
  * a tileset created from that export.
  *
+ * If the export is not finished processing this will throw an error. It is up to the caller
+ * to re-attempt loading at a later time
+ *
  * @example
- * TODO: example after API finalized
+ * const tileset = await Cesium.ITwinData.createTilesetFromModelId(imodelId);
+ * viewer.scene.primitives.add(tileset);
  *
  * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
  *
  * @param {string} iModelId The id of the iModel to load
  * @param {Cesium3DTileset.ConstructorOptions} [options] Object containing options to pass to an internally created {@link Cesium3DTileset}.
  * @returns {Promise<Cesium3DTileset | undefined>} Will return <code>undefined</code> if there is no export for the given iModel id
  *
- * @throws {RuntimeError} Wrong export type
- * @throws {RuntimeError} Export did not complete in time.
+ * @throws {RuntimeError} Wrong export type [type]
+ * @throws {RuntimeError} Export is not completed. [id] - [status]
  */
 ITwinData.createTilesetFromModelId = async function (iModelId, options) {
   const { exports } = await ITwinPlatform.getExports(iModelId);