Fix test for typeahead

guardian · Jul 11, 2024 · 19d51e7 · 19d51e7
1 parent d0690b0
commit 19d51e7
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 34 deletions.
diff --git a/prosemirror-client/src/cqlInput/CqlInput.spec.ts b/prosemirror-client/src/cqlInput/CqlInput.spec.ts
@@ -10,7 +10,6 @@ import userEvent from "@testing-library/user-event";
 import {
   findByShadowTestId,
   findByShadowText,
-  prettyShadowDOM,
 } from "shadow-dom-testing-library";
 
 mock.module("../CqlService", () => ({}));

diff --git a/prosemirror-client/src/cqlInput/fixtures/TestCqlService.ts b/prosemirror-client/src/cqlInput/fixtures/TestCqlService.ts
@@ -28,10 +28,7 @@ const resultFixtures: Record<string, CqlResult> = {
 export class TestCqlService implements CqlServiceInterface {
   private abortController: AbortController | undefined;
 
-  /**
-   * @param url
-   * @param resultFixtures A map from query strings to results
-   */
+  // @ts-ignore unused var – url not relevant for test
   constructor(private url: string) {}
 
   public setUrl(url: string) {

diff --git a/src/main/scala/lang/Cql.scala b/src/main/scala/lang/Cql.scala
@@ -4,7 +4,6 @@ import scala.util.{Failure, Success, Try}
 import io.circe.generic.semiauto.*
 
 import scala.concurrent.Future
-import com.gu.contentapi.client.GuardianContentClient
 
 case class CqlResult(
     tokens: List[Token],
@@ -19,7 +18,6 @@ case class CqlResult(
 class Cql(typeahead: Typeahead):
   implicit val ec: scala.concurrent.ExecutionContext =
     scala.concurrent.ExecutionContext.global
-  val guardianContentClient = new GuardianContentClient("test")
 
   def run(program: String): Future[CqlResult] =
     val scanner = new Scanner(program)

diff --git a/src/main/scala/lang/Typeahead.scala b/src/main/scala/lang/Typeahead.scala
@@ -13,6 +13,7 @@ case class TypeaheadSuggestion(
     suggestions: Suggestions
 )
 
+
 sealed trait Suggestions
 
 case class TextSuggestion(suggestions: List[TextSuggestionOption])
@@ -32,35 +33,37 @@ type TypeaheadResolver = (String => Future[List[TextSuggestionOption]]) |
 
 type TypeaheadType = "TEXT" | "DATE"
 
-  case class TypeaheadField(
-      id: String,
-      name: String,
-      description: String,
-      resolver: TypeaheadResolver,
-      suggestionType: "TEXT" | "DATE" = "TEXT"
-  ):
-    def resolveSuggestions(str: String): Future[List[TextSuggestionOption]] =
-      resolver match {
-        case list: List[TextSuggestionOption] =>
-          Future.successful(list.filter { _.label.contains(str) })
-        case resolverFn: (String => Future[List[TextSuggestionOption]]) =>
-          resolverFn(str)
-      }
+case class TypeaheadField(
+    id: String,
+    name: String,
+    description: String,
+    resolver: TypeaheadResolver,
+    suggestionType: "TEXT" | "DATE" = "TEXT"
+):
+  def resolveSuggestions(str: String): Future[List[TextSuggestionOption]] =
+    resolver match {
+      case list: List[TextSuggestionOption] =>
+        Future.successful(list.filter { _.label.contains(str) })
+      case resolverFn: (String => Future[List[TextSuggestionOption]]) =>
+        resolverFn(str)
+    }
 
-    def toSuggestionOption: TextSuggestionOption =
-      TextSuggestionOption(name, name, description)
+  def toSuggestionOption: TextSuggestionOption =
+    TextSuggestionOption(name, id, description)
 
-class Typeahead(fieldResolvers: List[TypeaheadField], outputModifierResolvers: List[TypeaheadField]) {
+class Typeahead(
+    fieldResolvers: List[TypeaheadField],
+    outputModifierResolvers: List[TypeaheadField]
+) {
   private val typeaheadTokenResolverMap = Map(
     TokenType.QUERY_FIELD_KEY -> suggestFieldKey,
     TokenType.QUERY_OUTPUT_MODIFIER_KEY -> suggestOutputModifierKey,
     TokenType.QUERY_VALUE -> suggestFieldValue
   )
 
   private val typeaheadFieldEntries = TextSuggestion(
-    fieldResolvers.map {
-      case TypeaheadField(id, label, description, _, _) =>
-        TextSuggestionOption(label, id, description)
+    fieldResolvers.map { case TypeaheadField(id, label, description, _, _) =>
+      TextSuggestionOption(label, id, description)
     }.toList
   )
 
@@ -134,6 +137,7 @@ class Typeahead(fieldResolvers: List[TypeaheadField], outputModifierResolvers: L
             )
         }
       case QueryOutputModifier(keyToken, Some(valueToken)) =>
+
         val keySuggestion = suggestOutputModifierKey(
           keyToken.literal.getOrElse("")
         ).map { suggestion =>
@@ -182,7 +186,7 @@ class Typeahead(fieldResolvers: List[TypeaheadField], outputModifierResolvers: L
       TextSuggestion(
         outputModifierResolvers
           .filter(
-            _.name.contains(str.toLowerCase())
+            _.id.contains(str.toLowerCase())
           )
           .map(_.toSuggestionOption)
       )

diff --git a/src/test/scala/lang/TypeaheadTest.scala b/src/test/scala/lang/TypeaheadTest.scala
@@ -7,7 +7,7 @@ class TypeaheadTest extends BaseTest {
   describe("typeahead") {
     val typeaheadQueryClient = new TestTypeaheadHelpers()
     val typeahead =
-      new Typeahead(typeaheadQueryClient.fieldResolvers, List.empty)
+      new Typeahead(typeaheadQueryClient.fieldResolvers, typeaheadQueryClient.outputModifierResolvers)
 
     it("should give no typeahead where none is warranted") {
       typeahead.getSuggestions(QueryList(List.empty)).map { result =>
@@ -165,18 +165,18 @@ class TypeaheadTest extends BaseTest {
               TextSuggestion(
                 List(
                   TextSuggestionOption(
-                    "from-date",
+                    "From date",
                     "from-date",
                     "The date to search from"
                   )
                 )
               )
             ),
             TypeaheadSuggestion(
-              11,
-              11,
-              " ",
-              DateSuggestion(None, None)
+              0,
+              9,
+              ":",
+              TextSuggestion(List.empty)
             )
           )
         }