Merge pull request #12094 from CesiumGS/bing-imagery-fix

Add check for valid imagery provider structure for Bing Imagery
CesiumGS · Jul 29, 2024 · 32d0410 · 32d0410
2 parents 3cdc3e1 + 688f71e
commit 32d0410
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 4 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -17,6 +17,7 @@
 - Corrected calculation of diffuse component in image-based lighting. [#12082](https://github.com/CesiumGS/cesium/pull/12082)
 - Updated specular BRDF for image-based lighting. [#12083](https://github.com/CesiumGS/cesium/pull/12083)
 - Fixed environment map transform for image-based lighting. [#12091](https://github.com/CesiumGS/cesium/pull/12091)
+- Prevent Bing Imagery API format issues from throwing errors [#12094](https://github.com/CesiumGS/cesium/pull/12094)
 
 ### 1.119 - 2024-07-01
 

diff --git a/packages/engine/Source/Scene/BingMapsImageryProvider.js b/packages/engine/Source/Scene/BingMapsImageryProvider.js
@@ -120,7 +120,16 @@ function metadataSuccess(data, imageryProviderBuilder) {
   imageryProviderBuilder.maximumLevel = resource.zoomMax - 1;
   imageryProviderBuilder.imageUrlSubdomains = resource.imageUrlSubdomains;
   imageryProviderBuilder.imageUrlTemplate = resource.imageUrl;
-  imageryProviderBuilder.attributionList = resource.imageryProviders;
+
+  let validProviders = resource.imageryProviders;
+  if (defined(resource.imageryProviders)) {
+    // prevent issues with the imagery API from crashing the viewer when the expected properties are not there
+    // See https://github.com/CesiumGS/cesium/issues/12088
+    validProviders = resource.imageryProviders.filter((provider) =>
+      provider.coverageAreas?.some((area) => defined(area.bbox))
+    );
+  }
+  imageryProviderBuilder.attributionList = validProviders;
 }
 
 function metadataFailure(metadataResource, error, provider) {

diff --git a/packages/engine/Specs/Scene/BingMapsImageryProviderSpec.js b/packages/engine/Specs/Scene/BingMapsImageryProviderSpec.js
@@ -243,7 +243,7 @@ describe("Scene/BingMapsImageryProvider", function () {
     });
 
     //These are the same instance only if the cache has been used
-    expect(provider._attributionList).toBe(provider2._attributionList);
+    expect(provider._imageUrlSubdomains).toBe(provider2._imageUrlSubdomains);
 
     installFakeMetadataRequest(url, BingMapsStyle.AERIAL);
     installFakeImageRequest();
@@ -253,8 +253,10 @@ describe("Scene/BingMapsImageryProvider", function () {
       mapStyle: BingMapsStyle.AERIAL,
     });
 
-    // Because the road is different, a non-cached request should have happened
-    expect(provider3._attributionList).not.toBe(provider._attributionList);
+    // Because the style is different, a non-cached request should have happened
+    expect(provider3._imageUrlSubdomains).not.toBe(
+      provider._imageUrlSubdomains
+    );
   });
 
   it("fromUrl resolves with a path", async function () {