control Show PA API switch from query param

Author: andrew-nowak

newswires/app/controllers/QueryController.scala

@@ -54,55 +54,60 @@ class QueryController(
       hasDataFormatting: Option[Boolean],
       guSourceFeeds: List[String],
       guSourceFeedsExcl: List[String]
-  ): Action[AnyContent] = apiAuthAction { request: UserRequest[AnyContent] =>
-    val baseParams = BaseRequestParams(
-      maybeFreeTextQuery = maybeFreeTextQuery,
-      keywords = keywords,
-      suppliers = suppliers,
-      categoryCode = categoryCode,
-      categoryCodeExcl = categoryCodeExcl,
-      maybeCollectionId = maybeCollectionId,
-      maybeStart = maybeStart,
-      maybeEnd = maybeEnd,
-      maybeBeforeTimeStamp = maybeBeforeTimeStamp,
-      maybeAfterTimeStamp = maybeAfterTimeStamp,
-      hasDataFormatting = hasDataFormatting,
-      guSourceFeeds = guSourceFeeds,
-      guSourceFeedsExcl = guSourceFeedsExcl
-    )
-    val searchParams =
-      SearchParams.build(request.queryString, baseParams, featureSwitchProvider)
-
-    val searchPreset = request
-      .getQueryString("preset")
-      .flatMap(SearchPresets.get)
-
-    val timeStampColumn = maybeCollectionId match {
-      case Some(id) => AddedToCollectionAtTime(id)
-      case None     => IngestedAtTime
-    }
-    val queryParams = QueryParams(
-      searchParams = searchParams,
-      searchPreset = searchPreset,
-      maybeSearchTerm = baseParams.textForHighlighting,
-      queryCursor = QueryCursor(
+  ): Action[AnyContent] = apiAuthAction {
+    implicit request: UserRequest[AnyContent] =>
+      val baseParams = BaseRequestParams(
+        maybeFreeTextQuery = maybeFreeTextQuery,
+        keywords = keywords,
+        suppliers = suppliers,
+        categoryCode = categoryCode,
+        categoryCodeExcl = categoryCodeExcl,
+        maybeCollectionId = maybeCollectionId,
+        maybeStart = maybeStart,
+        maybeEnd = maybeEnd,
         maybeBeforeTimeStamp = maybeBeforeTimeStamp,
-        maybeAfterTimeStamp = maybeAfterTimeStamp.map(NextPage(_))
-      ),
-      pageSize = 30,
-      timeStampColumn = timeStampColumn
-    )
-
-    val queryResponse = FingerpostWireEntry.query(
-      queryParams
-    )
-
-    Ok(
-      QueryResponse
-        .display(queryResponse, request.user.username, timeStampColumn)
-        .asJson
-        .spaces2
-    )
+        maybeAfterTimeStamp = maybeAfterTimeStamp,
+        hasDataFormatting = hasDataFormatting,
+        guSourceFeeds = guSourceFeeds,
+        guSourceFeedsExcl = guSourceFeedsExcl
+      )
+      val searchParams =
+        SearchParams.build(
+          request.queryString,
+          baseParams,
+          featureSwitchProvider
+        )
+
+      val searchPreset = request
+        .getQueryString("preset")
+        .flatMap(SearchPresets.get)
+
+      val timeStampColumn = maybeCollectionId match {
+        case Some(id) => AddedToCollectionAtTime(id)
+        case None     => IngestedAtTime
+      }
+      val queryParams = QueryParams(
+        searchParams = searchParams,
+        searchPreset = searchPreset,
+        maybeSearchTerm = baseParams.textForHighlighting,
+        queryCursor = QueryCursor(
+          maybeBeforeTimeStamp = maybeBeforeTimeStamp,
+          maybeAfterTimeStamp = maybeAfterTimeStamp.map(NextPage(_))
+        ),
+        pageSize = 30,
+        timeStampColumn = timeStampColumn
+      )
+
+      val queryResponse = FingerpostWireEntry.query(
+        queryParams
+      )
+
+      Ok(
+        QueryResponse
+          .display(queryResponse, request.user.username, timeStampColumn)
+          .asJson
+          .spaces2
+      )
   }
 
   def keywords(

newswires/app/controllers/ViteController.scala

@@ -75,7 +75,7 @@ class ViteController(
       val config =
         views.html.fragments.clientConfig(
           ClientConfig(
-            featureSwitchProvider.clientSideSwitchStates,
+            featureSwitchProvider.clientSideSwitchStates(request),
             stage = configuration.get[String]("stage"),
             sendTelemetryAsDev =
               devEmails.exists(request.user.email.startsWith),

newswires/app/models/SearchParams.scala

@@ -1,6 +1,7 @@
 package models
 
 import conf.SearchTerms
+import play.api.mvc.Request
 import service.FeatureSwitchProvider
 
 case class FilterParams(
@@ -33,7 +34,7 @@ object SearchParams {
       query: Map[String, Seq[String]],
       baseParams: BaseRequestParams,
       featureSwitch: FeatureSwitchProvider
-  ) = {
+  )(implicit req: Request[_]) = {
     SearchParams(
       FilterParams(
         searchTerms = baseParams.textSearchTerms,
@@ -42,7 +43,7 @@ object SearchParams {
         suppliersIncl = baseParams.suppliers,
         suppliersExcl = computeSupplierExcl(
           query,
-          featureSwitch.ShowGuSuppliers.isOn(),
+          featureSwitch.ShowGuSuppliers.isOn(req),
           baseParams.suppliers
         ),
         categoryCodesIncl = baseParams.categoryCode,
@@ -53,7 +54,7 @@ object SearchParams {
         collectionId = baseParams.maybeCollectionId,
         guSourceFeeds = baseParams.guSourceFeeds,
         guSourceFeedsExcl = computeGuSourceFeedExcl(
-          showPAAPI = featureSwitch.ShowPAAPI.isOn(),
+          showPAAPI = featureSwitch.ShowPAAPI.isOn(req),
           guSourceFeeds = baseParams.guSourceFeeds,
           guSourceFeedsExcl = baseParams.guSourceFeedsExcl
         )

newswires/app/service/FeatureSwitchProvider.scala

@@ -1,6 +1,6 @@
 package service
 
-import play.api.libs.json.{Json, OFormat}
+import play.api.mvc.Request
 
 sealed trait SwitchState
 case object On extends SwitchState
@@ -10,7 +10,7 @@ case class FeatureSwitch(
     description: String,
     exposeToClient: Boolean = false,
     private val safeState: SwitchState,
-    isOn: () => Boolean
+    isOn: Request[_] => Boolean
 )
 class FeatureSwitchProvider(stage: String) {
 
@@ -20,7 +20,7 @@ class FeatureSwitchProvider(stage: String) {
       safeState = Off,
       description = "Show suppliers from the Guardian",
       exposeToClient = true,
-      isOn = () => stage.toUpperCase() != "PROD"
+      isOn = _ => stage.toUpperCase() != "PROD"
     )
 
   val ShowPAAPI: FeatureSwitch =
@@ -29,12 +29,14 @@ class FeatureSwitchProvider(stage: String) {
       safeState = Off,
       description = "Show new PA API in the feed",
       exposeToClient = true,
-      isOn = () => stage.toUpperCase() != "PROD"
+      isOn = _.getQueryString("previewPaApi")
+        .flatMap(_.toBooleanOption)
+        .getOrElse(false)
     )
   private val switches = List(
     ShowGuSuppliers,
     ShowPAAPI
   )
-  def clientSideSwitchStates: Map[String, Boolean] =
-    switches.filter(_.exposeToClient).map(s => s.name -> s.isOn()).toMap
+  def clientSideSwitchStates(request: Request[_]): Map[String, Boolean] =
+    switches.filter(_.exposeToClient).map(s => s.name -> s.isOn(request)).toMap
 }

newswires/client/src/SearchSummary.tsx

@@ -29,6 +29,7 @@ const SearchTermBadgeLabelLookup: Record<DeselectableQueryKey, string> = {
 	categoryCode: 'Category',
 	categoryCodeExcl: '(NOT) Category',
 	hasDataFormatting: 'Has data formatting',
+	previewPaApi: 'Previewing PA API switchover',
 	keyword: 'Keyword',
 	keywordExcl: '(NOT) Keyword',
 	guSourceFeed: 'Source feed',
@@ -98,6 +99,7 @@ const Summary = ({
 		categoryCode,
 		categoryCodeExcl,
 		hasDataFormatting,
+		previewPaApi,
 		collectionId,
 	} = query;
 
@@ -121,6 +123,7 @@ const Summary = ({
 		displayGuSourceFeeds ||
 		displayExcludedGuSourceFeeds ||
 		hasDataFormatting !== undefined ||
+		previewPaApi !== undefined ||
 		collectionId !== undefined;
 
 	const isDefaultDateRange =
@@ -235,6 +238,14 @@ const Summary = ({
 					}}
 				/>
 			)}
+			{previewPaApi !== undefined && (
+				<SummaryBadge
+					keyValuePair={{
+						key: 'previewPaApi',
+						value: previewPaApi ? 'true' : 'false',
+					}}
+				/>
+			)}
 		</>
 	);
 };

newswires/client/src/queryHelpers.ts

@@ -53,6 +53,7 @@ export const queryAfterDeselection = (
 			'keywordExcl',
 			'guSourceFeed',
 			'guSourceFeedExcl',
+			'previewPaApi',
 		].includes(key)
 	) {
 		const current = query[key] as string[] | undefined;

newswires/client/src/sharedTypes.ts

@@ -165,6 +165,7 @@ export const BaseQuerySchema = z.object({
 	start: EuiDateStringSchema.optional(),
 	end: EuiDateStringSchema.optional(),
 	hasDataFormatting: z.boolean().optional(),
+	previewPaApi: z.boolean().optional(),
 });
 export type BaseQuery = z.infer<typeof BaseQuerySchema>;
 

newswires/client/src/urlState.ts

@@ -18,6 +18,7 @@ export const defaultQuery: Query = {
 	start: DEFAULT_DATE_RANGE.start,
 	end: DEFAULT_DATE_RANGE.end,
 	hasDataFormatting: undefined,
+	previewPaApi: undefined,
 	collectionId: undefined,
 };
 
@@ -70,6 +71,9 @@ function searchParamsToQuery(params: URLSearchParams): Query {
 	const hasDataFormatting = maybeStringToBooleanOrUndefined(
 		params.get('hasDataFormatting'),
 	);
+	const previewPaApi = maybeStringToBooleanOrUndefined(
+		params.get('previewPaApi'),
+	);
 	let collectionId: number | undefined = undefined;
 
 	try {
@@ -101,6 +105,7 @@ function searchParamsToQuery(params: URLSearchParams): Query {
 		start,
 		end,
 		hasDataFormatting,
+		previewPaApi,
 	};
 
 	// we're treating preset and collectionId as mutually exclusive - if both are present, preset takes precedence and collectionId is ignored

newswires/test/models/SearchParamsSpec.scala

@@ -7,6 +7,7 @@ import org.mockito.Mockito.when
 import org.scalatest.flatspec.AnyFlatSpec
 import org.scalatest.matchers.should.Matchers.convertToAnyShouldWrapper
 import org.scalatestplus.mockito.MockitoSugar.mock
+import play.api.test.FakeRequest
 import service.{FeatureSwitch, FeatureSwitchProvider, Off}
 
 class SearchParamsSpec extends AnyFlatSpec with models {
@@ -18,7 +19,7 @@ class SearchParamsSpec extends AnyFlatSpec with models {
       emptyQueryString,
       emptyBaseParams,
       featureSwitchesOn
-    ) shouldEqual emptySearchParams.copy(filters =
+    )(FakeRequest()) shouldEqual emptySearchParams.copy(filters =
       emptyFilterParams.copy(suppliersExcl = List("UNAUTHED_EMAIL_FEED"))
     )
   }
@@ -28,7 +29,7 @@ class SearchParamsSpec extends AnyFlatSpec with models {
       emptyQueryString,
       baseParams,
       featureSwitchesOn
-    )
+    )(FakeRequest())
     result.filters.searchTerms shouldEqual Some(
       ComboTerm(
         List(SearchTerm.English("query"), SearchTerm.Simple("query", Slug)),
@@ -42,7 +43,7 @@ class SearchParamsSpec extends AnyFlatSpec with models {
       Map("keywordExcl" -> Seq("a", "b")),
       emptyBaseParams,
       featureSwitchesOn
-    )
+    )(FakeRequest())
     result.filters.keywordExcl shouldEqual List("a", "b")
   }
 
@@ -64,7 +65,7 @@ class SearchParamsSpec extends AnyFlatSpec with models {
       emptyQueryString,
       baseParams,
       featureSwitchesOn
-    )
+    )(FakeRequest())
     result shouldEqual SearchParams(
       FilterParams(
         searchTerms = Some(
@@ -99,7 +100,7 @@ class SearchParamsSpec extends AnyFlatSpec with models {
         emptyQueryString,
         emptyBaseParams,
         showGuSuppliersFeatureOff
-      )
+      )(FakeRequest())
     result.filters.suppliersExcl shouldEqual List(
       "UNAUTHED_EMAIL_FEED",
       "GuReuters",
@@ -210,12 +211,12 @@ trait searchParamsMocks {
     safeState = Off,
     description = "",
     exposeToClient = true,
-    isOn = () => true
+    isOn = _ => true
   )
   when(featureSwitchesOn.ShowGuSuppliers).thenReturn(featureSwitch)
   when(featureSwitchesOn.ShowPAAPI).thenReturn(featureSwitch)
   when(showGuSuppliersFeatureOff.ShowGuSuppliers).thenReturn(
-    featureSwitch.copy(isOn = () => false)
+    featureSwitch.copy(isOn = _ => false)
   )
   when(showGuSuppliersFeatureOff.ShowPAAPI).thenReturn(
     featureSwitch
@@ -224,6 +225,6 @@ trait searchParamsMocks {
     featureSwitch
   )
   when(showPAAPIFeatureOff.ShowPAAPI).thenReturn(
-    featureSwitch.copy(isOn = () => false)
+    featureSwitch.copy(isOn = _ => false)
   )
 }