Support providing an SDC URL via the env (#560)

This is useful when live previewing banners with a local version of SDC. Run the server with e.g.: $ SDC_URL=http://localhost:8082 sbt run
guardian · Mar 1, 2024 · b856019 · b856019
1 parent 526b229
commit b856019
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 11 deletions.
diff --git a/app/controllers/Application.scala b/app/controllers/Application.scala
@@ -5,14 +5,16 @@ import play.api.mvc._
 
 class Application(authAction: AuthAction[AnyContent],
                   components: ControllerComponents,
-                  stage: String)
+                  stage: String,
+                  sdcUrlOverride: Option[String])
     extends AbstractController(components) {
   def healthcheck = Action {
     Ok("healthy")
   }
 
   def index = authAction {
-    Ok(views.html.index(stage)).withHeaders(CACHE_CONTROL -> "no-cache")
+    Ok(views.html.index(stage, sdcUrlOverride))
+      .withHeaders(CACHE_CONTROL -> "no-cache")
   }
 
   // Handler for endpoints with a resource name in the path. The client takes care of using the name

diff --git a/app/views/index.scala.html b/app/views/index.scala.html
@@ -1,4 +1,4 @@
-@(stage: String)
+@(stage: String, sdcUrlOverride: Option[String])
 <!DOCTYPE html>
 <html>
   <head>
@@ -13,7 +13,11 @@
   <body>
     <div id="root"></div>
     <script>
-      window.guardian = { stage: "@stage"};
+      window.guardian = {};
+      window.guardian.stage = "@stage";
+      @if(sdcUrlOverride.isDefined) {
+        window.guardian.sdcUrlOverride = "@sdcUrlOverride.get";
+      }
     </script>
     <script src="@routes.Assets.at("build/app.bundle.js")"></script>
   </body>

diff --git a/app/wiring/AppComponents.scala b/app/wiring/AppComponents.scala
@@ -73,9 +73,11 @@ class AppComponents(context: Context, stage: String) extends BuiltInComponentsFr
   val dynamoBannerDesigns = new DynamoBannerDesigns(stage, dynamoClient)
   val dynamoArchivedBannerDesigns = new DynamoArchivedBannerDesigns(stage, dynamoClient)
 
+  val sdcUrlOverride: Option[String] = sys.env.get("SDC_URL")
+
   override lazy val router: Router = new Routes(
     httpErrorHandler,
-    new Application(authAction, controllerComponents, stage),
+    new Application(authAction, controllerComponents, stage, sdcUrlOverride),
     new Login(authConfig, wsClient, requiredGoogleGroups, googleGroupChecker, controllerComponents),
     new SwitchesController(authAction, controllerComponents, stage, runtime),
     new AmountsController(authAction, controllerComponents, stage, runtime),

diff --git a/public/src/hooks/useModule.ts b/public/src/hooks/useModule.ts
@@ -6,6 +6,19 @@ import { withPreviewStyles } from '../components/channelManagement/previewContai
 
 const moduleVersion = 3;
 
+const getSdcBaseUrl = (): string => {
+  // If override explicitly provided, use it
+  if (window.guardian.sdcUrlOverride) {
+    return `${window.guardian.sdcUrlOverride}/modules/v${moduleVersion}`;
+  }
+
+  // Otherwise, use the stage to determine the base URL
+  const stage = getStage();
+  return stage === 'PROD'
+    ? `https://contributions.guardianapis.com/modules/v${moduleVersion}`
+    : `https://contributions.code.dev-guardianapis.com/modules/v${moduleVersion}`;
+};
+
 /**
  * Hook for importing a remote module, for live previews.
  */
@@ -20,12 +33,7 @@ export const useModule = <T>(path: string, name: string): React.FC<T> | undefine
       emotionReactJsxRuntime,
     };
 
-    const stage = getStage();
-
-    const baseUrl =
-      stage === 'PROD'
-        ? `https://contributions.guardianapis.com/modules/v${moduleVersion}`
-        : `https://contributions.code.dev-guardianapis.com/modules/v${moduleVersion}`;
+    const baseUrl = getSdcBaseUrl();
 
     window.remoteImport(`${baseUrl}/${path}`).then(bannerModule => {
       setModule(() => withPreviewStyles(bannerModule[name]));

diff --git a/public/src/main.tsx b/public/src/main.tsx
@@ -58,6 +58,7 @@ declare global {
         emotionReact: any;
         emotionReactJsxRuntime: any;
       };
+      sdcUrlOverride: string | undefined;
     };
   }
   /* eslint-enable @typescript-eslint/no-explicit-any */