include realm URL in error response

Author: habdelra

Diff for: packages/host/app/resources/card-resource.ts

@@ -35,6 +35,7 @@ export interface CardError {
     status: number;
     title: string;
     message: string;
+    realm: string;
     meta: {
       lastKnownGoodHtml: string | null;
       scopedCssUrls: string[];
@@ -283,6 +284,7 @@ export class CardResource extends Resource<Args> {
                   status: 404,
                   title: 'Card Not Found',
                   message: `The card ${url.href} does not exist`,
+                  realm: error.responseHeaders.get('X-Boxel-Realm-Url'),
                   meta: {
                     lastKnownGoodHtml: null,
                     scopedCssUrls: [],
@@ -302,6 +304,7 @@ export class CardResource extends Resource<Args> {
                   message: `Received HTTP ${error.status} from server ${
                     error.responseText ?? ''
                   }`.trim(),
+                  realm: error.responseHeaders.get('X-Boxel-Realm-Url'),
                   meta: {
                     lastKnownGoodHtml: null,
                     scopedCssUrls: [],

Diff for: packages/host/app/resources/stack-backgrounds.ts

@@ -5,6 +5,7 @@ import { Resource } from 'ember-resources';
 
 import type { Stack } from '../components/operator-mode/interact-submode';
 import type CardService from '../services/card-service';
+import type RealmService from '../services/realm';
 
 interface Args {
   positional: [stacks: Stack[]];
@@ -13,6 +14,7 @@ interface Args {
 export class StackBackgroundsResource extends Resource<Args> {
   @tracked value: (string | undefined | null)[] = [];
   @service declare cardService: CardService;
+  @service declare realm: RealmService;
 
   get backgroundImageURLs() {
     return this.value?.map((u) => (u ? u : undefined)) ?? [];
@@ -47,7 +49,9 @@ export class StackBackgroundsResource extends Resource<Args> {
         let bottomMostStackItem = stack[0];
         await bottomMostStackItem.ready;
         if (bottomMostStackItem.cardError) {
-          return undefined;
+          await this.realm.ensureRealmMeta(bottomMostStackItem.cardError.realm);
+          return this.realm.info(bottomMostStackItem.cardError.realm)
+            ?.backgroundURL;
         }
         return (await this.cardService.getRealmInfo(bottomMostStackItem.card))
           ?.backgroundURL;

Diff for: packages/runtime-common/realm.ts

@@ -1405,6 +1405,9 @@ export class Realm {
             status: maybeError.error.errorDetail.status,
             title: maybeError.error.errorDetail.title,
             message: maybeError.error.errorDetail.detail,
+            // note that this is actually available as part of the response
+            // header too--it's just easier for clients when it is here
+            realm: this.url,
             meta: {
               lastKnownGoodHtml: maybeError.error.lastKnownGoodHtml,
               scopedCssUrls: maybeError.error.scopedCssUrls,