More tests and cleanup

Author: rhysyngsun

.pre-commit-config.yaml

@@ -104,7 +104,7 @@ repos:
         language: node
         types_or: [javascript, jsx, ts, tsx]
         args: []
-        exclude: "(node_modules/|.yarn/)"
+        exclude: "(node_modules/|.yarn/|load_testing/)"
         require_serial: false
         additional_dependencies:
           - eslint@8

load_testing/backend/client/v0/api.schemas.ts

@@ -4179,6 +4179,29 @@ export type TestimonialsListParams = {
 }
 
 export type VectorContentFilesSearchRetrieveParams = {
+  /**
+ * aggregations for facet counts
+
+* `key` - Key
+* `course_number` - Course Number
+* `platform` - Platform
+* `offered_by` - Offered By
+* `file_extension` - File Extension
+* `content_feature_type` - Content Feature Type
+* `run_readable_id` - Run Readable Id
+* `resource_readable_id` - Resource Readable Id
+* `run_title` - Run Title
+* `edx_module_id` - Edx Module Id
+* `content_type` - Content Type
+* `description` - Description
+* `title` - Title
+* `url` - Url
+* `file_type` - File Type
+* `summary` - Summary
+* `flashcards` - Flashcards
+* `checksum` - Checksum
+ */
+  aggregations?: VectorContentFilesSearchRetrieveAggregationsItem[]
   /**
    * Manually specify the name of the Qdrant collection to query
    * @minLength 1
@@ -4256,6 +4279,51 @@ export type VectorContentFilesSearchRetrieveParams = {
   url__isnull?: boolean | null
 }
 
+/**
+ * * `key` - Key
+ * `course_number` - Course Number
+ * `platform` - Platform
+ * `offered_by` - Offered By
+ * `file_extension` - File Extension
+ * `content_feature_type` - Content Feature Type
+ * `run_readable_id` - Run Readable Id
+ * `resource_readable_id` - Resource Readable Id
+ * `run_title` - Run Title
+ * `edx_module_id` - Edx Module Id
+ * `content_type` - Content Type
+ * `description` - Description
+ * `title` - Title
+ * `url` - Url
+ * `file_type` - File Type
+ * `summary` - Summary
+ * `flashcards` - Flashcards
+ * `checksum` - Checksum
+ */
+export type VectorContentFilesSearchRetrieveAggregationsItem =
+  (typeof VectorContentFilesSearchRetrieveAggregationsItem)[keyof typeof VectorContentFilesSearchRetrieveAggregationsItem]
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const VectorContentFilesSearchRetrieveAggregationsItem = {
+  key: "key",
+  course_number: "course_number",
+  platform: "platform",
+  offered_by: "offered_by",
+  file_extension: "file_extension",
+  content_feature_type: "content_feature_type",
+  run_readable_id: "run_readable_id",
+  resource_readable_id: "resource_readable_id",
+  run_title: "run_title",
+  edx_module_id: "edx_module_id",
+  content_type: "content_type",
+  description: "description",
+  title: "title",
+  url: "url",
+  file_type: "file_type",
+  summary: "summary",
+  flashcards: "flashcards",
+  checksum: "checksum",
+} as const
+
 export type VectorContentFilesSearchRetrieveSortby =
   (typeof VectorContentFilesSearchRetrieveSortby)[keyof typeof VectorContentFilesSearchRetrieveSortby]
 
@@ -4268,6 +4336,30 @@ export const VectorContentFilesSearchRetrieveSortby = {
 } as const
 
 export type VectorLearningResourcesSearchRetrieveParams = {
+  /**
+ * aggregations for facet counts
+
+* `readable_id` - Readable Id
+* `resource_type` - Resource Type
+* `certification` - Certification
+* `certification_type` - Certification Type
+* `professional` - Professional
+* `free` - Free
+* `course_feature` - Course Feature
+* `topic` - Topic
+* `ocw_topic` - Ocw Topic
+* `level` - Level
+* `department` - Department
+* `platform` - Platform
+* `offered_by` - Offered By
+* `delivery` - Delivery
+* `title` - Title
+* `url` - Url
+* `resource_type_group` - Resource Type Group
+* `resource_category` - Resource Category
+* `published` - Published
+ */
+  aggregations?: VectorLearningResourcesSearchRetrieveAggregationsItem[]
   /**
    * True if the learning resource offers a certificate
    * @nullable
@@ -4400,6 +4492,10 @@ export type VectorLearningResourcesSearchRetrieveParams = {
    * @nullable
    */
   professional?: boolean | null
+  /**
+   * If the resource is published. We default to True unless passed in
+   */
+  published?: boolean
   /**
    * The search text
    * @minLength 1
@@ -4447,6 +4543,53 @@ export type VectorLearningResourcesSearchRetrieveParams = {
   url__isnull?: boolean | null
 }
 
+/**
+ * * `readable_id` - Readable Id
+ * `resource_type` - Resource Type
+ * `certification` - Certification
+ * `certification_type` - Certification Type
+ * `professional` - Professional
+ * `free` - Free
+ * `course_feature` - Course Feature
+ * `topic` - Topic
+ * `ocw_topic` - Ocw Topic
+ * `level` - Level
+ * `department` - Department
+ * `platform` - Platform
+ * `offered_by` - Offered By
+ * `delivery` - Delivery
+ * `title` - Title
+ * `url` - Url
+ * `resource_type_group` - Resource Type Group
+ * `resource_category` - Resource Category
+ * `published` - Published
+ */
+export type VectorLearningResourcesSearchRetrieveAggregationsItem =
+  (typeof VectorLearningResourcesSearchRetrieveAggregationsItem)[keyof typeof VectorLearningResourcesSearchRetrieveAggregationsItem]
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const VectorLearningResourcesSearchRetrieveAggregationsItem = {
+  readable_id: "readable_id",
+  resource_type: "resource_type",
+  certification: "certification",
+  certification_type: "certification_type",
+  professional: "professional",
+  free: "free",
+  course_feature: "course_feature",
+  topic: "topic",
+  ocw_topic: "ocw_topic",
+  level: "level",
+  department: "department",
+  platform: "platform",
+  offered_by: "offered_by",
+  delivery: "delivery",
+  title: "title",
+  url: "url",
+  resource_type_group: "resource_type_group",
+  resource_category: "resource_category",
+  published: "published",
+} as const
+
 /**
  * * `micromasters` - MicroMasters Credential
  * `professional` - Professional Certificate

load_testing/backend/test.ts

@@ -7,25 +7,63 @@ import {
 
 import { Config } from "../config.ts"
 import { createV0Client, createV1Client } from "./client/client.ts"
+import { NewsEventsListParams } from "./client/v0/api.schemas.ts"
+import { FeaturedListParams } from "./client/v1/api.schemas.ts"
 
 export function configure(config: Config) {
   return function () {
     group("api", function () {
       group("v0", function () {
-        exec.vu.tags.apiVersion = "v0"
+        exec.vu.metrics.tags.apiVersion = "v0"
 
         const client = createV0Client(config)
+        let res = client.videoShortsList({ limit: 50 })
 
-        check(client.videoShortsList({ limit: 50 }), {
+        check(res, {
           "is status 200": (r) => r.response.status === 200,
           "has results": (r) => r.response.json("results").length > 0,
         })
 
-        delete exec.vu.tags.apiVersion
+        res = client.usersMeRetrieve()
+        check(res, {
+          "is status 200": (r) => r.response.status === 200,
+        })
+
+        res = client.testimonialsList({ position: 1 })
+
+        check(res, {
+          "is status 200": (r) => r.response.status === 200,
+          "has results": (r) => r.response.json("results").length > 0,
+        })
+
+        group("news", function () {
+          ;[
+            {
+              feed_type: "news",
+              sortby: "-news_date",
+            },
+            {
+              feed_type: "events",
+              sortby: "event_date",
+            },
+          ].forEach((params: NewsEventsListParams) => {
+            const res = client.newsEventsList({
+              limit: 6,
+              ...params,
+            })
+
+            check(res, {
+              "is status 200": (r) => r.response.status === 200,
+              "has results": (r) => r.response.json("results").length > 0,
+            })
+          })
+        })
+
+        delete exec.vu.metrics.tags.apiVersion
       })
 
       group("v1", function () {
-        exec.vu.tags.apiVersion = "v1"
+        exec.vu.metrics.tags.apiVersion = "v1"
 
         const client = createV1Client(config)
 
@@ -42,12 +80,43 @@ export function configure(config: Config) {
             check(client.learningResourcesRetrieve(resource.id), {
               "is status 200": (r) => r.response.status === 200,
               "matches resource id": (r) =>
-                r.response.json("id") == resource.id,
+                r.response.json("id") === resource.id,
             })
           }
+
+          ;[
+            {},
+            {
+              free: true,
+            },
+            {
+              certification: true,
+              professional: false,
+            },
+            {
+              professional: true,
+            },
+          ].forEach((params: FeaturedListParams) => {
+            const res = client.featuredList({
+              limit: 12,
+              ...params,
+            })
+
+            check(res, {
+              "is status 200": (r) => r.response.status === 200,
+              "has results": (r) => r.response.json("results").length > 0,
+            })
+          })
+        })
+
+        const res = client.topicsList({ is_toplevel: true })
+
+        check(res, {
+          "is status 200": (r) => r.response.status === 200,
+          "has results": (r) => r.response.json("results").length > 0,
         })
 
-        delete exec.vu.tags.apiVersion
+        delete exec.vu.metrics.tags.apiVersion
       })
     })
   }

load_testing/frontend/test.ts

@@ -10,7 +10,7 @@ export function configure(config: Config) {
     const carousel = await page.getByTestId("resource-carousel")
     const articlesCount = await carousel.locator("article").count()
     await check(carousel, {
-      "has 12 items": () => articlesCount == 12,
+      "has 12 items": () => articlesCount === 12,
     })
 
     await carousel
@@ -19,11 +19,37 @@ export function configure(config: Config) {
       .click()
   }
 
+  async function search(page: Page) {
+    await page.goto(`${config.frontendBaseUrl}/search?sortby=-views`)
+    await page.goto(
+      `${config.frontendBaseUrl}/search?resource_type_group=program`,
+    )
+    await page.goto(
+      `${config.frontendBaseUrl}/search?resource_type_group=learning_material`,
+    )
+  }
+
+  async function topics(page: Page) {
+    await page.goto(`${config.frontendBaseUrl}/topics`)
+  }
+
+  async function departments(page: Page) {
+    await page.goto(`${config.frontendBaseUrl}/departments`)
+  }
+
+  async function units(page: Page) {
+    await page.goto(`${config.frontendBaseUrl}/units`)
+  }
+
   return async function () {
     const page = await browser.newPage(config.browserOptions)
 
     try {
       await home(page)
+      await search(page)
+      await topics(page)
+      await departments(page)
+      await units(page)
     } finally {
       await page.close()
     }

load_testing/scripts/generate-from-openapi.sh

@@ -4,9 +4,9 @@ SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
 PARENT_DIR=$(dirname "${SCRIPT_DIR}")
 ROOT_DIR=$(dirname "${PARENT_DIR}")
 
-pushd $PARENT_DIR
+pushd $PARENT_DIR || exit 1
 
-npx openapi-to-k6 --mode split "${ROOT_DIR}/openapi/specs/v0.yaml" "${ROOT_DIR}/load_testing/api/client/v0/api.ts"
-npx openapi-to-k6 --mode split "${ROOT_DIR}/openapi/specs/v1.yaml" "${ROOT_DIR}/load_testing/api/client/v1/api.ts"
+npx openapi-to-k6 --mode split "${ROOT_DIR}/openapi/specs/v0.yaml" "${ROOT_DIR}/load_testing/backend/client/v0/api.ts"
+npx openapi-to-k6 --mode split "${ROOT_DIR}/openapi/specs/v1.yaml" "${ROOT_DIR}/load_testing/backend/client/v1/api.ts"
 
-popd
+popd || exit 1