fix(perf): fixes build and deploy issues with perf studio (#5646)

* fix(perf): fixes build and deploy issues with perf studio * fix(perf): fix types/node version * fix(perf): minor readme clarifications --------- Co-authored-by: Bjørge Næss <[email protected]>
sanity-io · Feb 5, 2024 · d17f722 · d17f722
1 parent 851b62d
commit d17f722
Show file tree

Hide file tree

Showing 41 changed files with 65 additions and 41 deletions.
diff --git a/lerna.json b/lerna.json
@@ -3,7 +3,7 @@
   "useWorkspaces": true,
   "packages": [
     "dev/*",
-    "perf",
+    "perf/tests",
     "perf/studio",
     "examples/*",
     "packages/@sanity/*",

diff --git a/package.json b/package.json
@@ -4,7 +4,7 @@
   "private": true,
   "workspaces": [
     "dev/*",
-    "perf",
+    "perf/tests",
     "perf/studio",
     "examples/*",
     "packages/@sanity/*",
@@ -20,7 +20,7 @@
     "check:format": "prettier . --check",
     "check:packages": "lerna run check:package",
     "clean": "lerna run clean && rm -f package-lock.json",
-    "clean:deps": "rimraf packages/@sanity/*/node_modules packages/*/node_modules node_modules",
+    "clean:deps": "rimraf packages/@sanity/*/node_modules packages/*/node_modules node_modules perf/tests/node_modules perf/studio/node_modules",
     "check:deps-updates": "npx npm-check-updates --workspaces --root -m",
     "check:versions": "node -r esbuild-register scripts/normalizeDependencyVersions.ts",
     "depcheck": "lerna exec \"node -r esbuild-register \\$LERNA_ROOT_PATH/scripts/depcheck.ts\" --no-bail --parallel",
@@ -71,10 +71,10 @@
     "start": "yarn dev:test-studio",
     "test": "jest --forceExit",
     "test:e2e": "playwright test",
-    "perf:test": "cd perf && yarn perf:test",
-    "perf:studio": "cd perf && yarn studio",
-    "perf:studio:dev": "cd perf && yarn studio:dev",
-    "perf:codegen": "cd perf && yarn perf:codegen",
+    "perf:test": "cd perf/tests && yarn perf:test",
+    "perf:studio": "cd perf/studio && yarn preview",
+    "perf:studio:dev": "cd perf/studio && yarn dev",
+    "perf:codegen": "cd perf/tests && yarn perf:codegen",
     "tsdoc:dev": "sanity-tsdoc dev",
     "type-check": "tsc --build",
     "updated": "lerna updated",

diff --git a/perf/readme.md b/perf/readme.md
@@ -3,12 +3,12 @@
 ## Overview
 
 - **Perf Studio** - (`perf/studio`) this is the Sanity Studio that we run the test suite against (using playwright). This studio is set up to capture various cases that we want to measure performance of (e.g. a very large document)
-- **Performance Test Runner** (`perf/runner.ts`) - this is the node script that sets up the required config, identifies the set of performance tests to run, instantiates a playwright instance that navigates to the set of perf studio deployments (urls), runs each defined performance test against each deployment and compares the difference.
-- Performance test helpers - (`perf/helpers`) A set of performance test helpers that will be injected into the Performance Studio and exposed on `window.perf`.
+- **Performance Test Runner and tests** (`perf/tests`) - this includes both performance tests and the runner script that sets up the required config, identifies the set of performance tests to run, instantiates a playwright instance that navigates to the set of perf studio deployments (urls), runs each defined performance test against each deployment and compares the difference.
+- Performance test helpers - (`perf/tests/helpers`) A set of performance test helpers that will be injected into the Performance Studio and exposed on `window.perf`.
 
 ## Prerequisites
 
-Before you can run the perf tests you need to add a session token so the tests are able to log in. See .env.example on the root of this repo for more info about how to set the required `PERF_STUDIO_SANITY_WRITE_TOKEN` and `PERF_TEST_SANITY_TOKEN` environment variables.
+Before you can run the perf tests you need to add a session token so the tests are able to log in. See ./perf/tests/.env.example for more info about how to set the required `PERF_STUDIO_SANITY_WRITE_TOKEN` and `PERF_TEST_SANITY_TOKEN` environment variables.
 
 # Run the perf tests locally
 
@@ -18,11 +18,11 @@ Run the perf tests against the perf studio locally to see how it compares to the
 $ yarn perf:test
 ```
 
-This will build the perf studio and run it in preview mode locally and run each test defined in the `perf/tests`-folder against it.
+This will build the perf studio and run it in preview mode locally and run each test defined in the `perf/tests/tests`-folder against it.
 
 ## How to add a new perf test
 
-Create a new test file in `perf/tests` with the following template:
+Create a new test file in `perf/tests/tests` with the following template:
 
 ```js
 export default {

diff --git a/perf/studio/package.json b/perf/studio/package.json
@@ -10,7 +10,8 @@
     "clean": "rimraf .sanity dist",
     "dev": "sanity dev --port 3300",
     "lint": "eslint .",
-    "start": "sanity start --port 3300"
+    "start": "sanity start --port 3300",
+    "preview": "yarn build && yarn start"
   },
   "dependencies": {
     "react": "^18.2.0",

diff --git a/perf/studio/sanity.cli.ts b/perf/studio/sanity.cli.ts
@@ -1,5 +1,5 @@
 import {defineCliConfig} from 'sanity/cli'
-import {STUDIO_DATASET, STUDIO_PROJECT_ID} from '../config/constants'
+import {STUDIO_DATASET, STUDIO_PROJECT_ID} from '../tests/config/constants'
 
 export default defineCliConfig({
   api: {

diff --git a/perf/studio/sanity.config.ts b/perf/studio/sanity.config.ts
@@ -2,7 +2,7 @@
 import {defineConfig, defineDocumentFieldAction, type PluginOptions} from 'sanity'
 import {structureTool} from 'sanity/structure'
 import {useCallback} from 'react'
-import {STUDIO_DATASET, STUDIO_PROJECT_ID} from '../config/constants'
+import {STUDIO_DATASET, STUDIO_PROJECT_ID} from '../tests/config/constants'
 import {simple} from './schema/simple'
 import {deepObject} from './schema/deepObject'
 import {deepArray} from './schema/deepArray'

diff --git a/perf/.depcheckignore.json → perf/tests/.depcheckignore.json b/perf/.depcheckignore.json → perf/tests/.depcheckignore.json
diff --git a/perf/.env.example → perf/tests/.env.example b/perf/.env.example → perf/tests/.env.example
diff --git a/perf/.gitignore → perf/tests/.gitignore b/perf/.gitignore → perf/tests/.gitignore
diff --git a/perf/cli.ts → perf/tests/cli.ts b/perf/cli.ts → perf/tests/cli.ts
diff --git a/perf/codegen.ts → perf/tests/codegen.ts b/perf/codegen.ts → perf/tests/codegen.ts
diff --git a/perf/config/constants.ts → perf/tests/config/constants.ts b/perf/config/constants.ts → perf/tests/config/constants.ts
diff --git a/perf/config/envVars.ts → perf/tests/config/envVars.ts b/perf/config/envVars.ts → perf/tests/config/envVars.ts
diff --git a/perf/jest.config.cjs → perf/tests/jest.config.cjs b/perf/jest.config.cjs → perf/tests/jest.config.cjs
@@ -1,6 +1,6 @@
 'use strict'
 
-const {createJestConfig} = require('../test/config.cjs')
+const {createJestConfig} = require('../../test/config.cjs')
 
 module.exports = createJestConfig({
   // ignore performance tests

diff --git a/perf/package.json → perf/tests/package.json b/perf/package.json → perf/tests/package.json
@@ -14,20 +14,22 @@
     "studio": "yarn --cwd studio build && yarn --cwd studio start",
     "studio:dev": "SANITY_STUDIO_DATASET=dev yarn --cwd studio dev"
   },
+  "devDependencies": {
+    "@types/lodash": "^4.14.149",
+    "@types/node": "^18.15.3",
+    "esbuild": "^0.19.8",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.2.2"
+  },
   "dependencies": {
     "@playwright/test": "^1.39.0",
     "@sanity/client": "^6.12.3",
     "@sanity/uuid": "^3.0.1",
-    "@types/lodash": "^4.14.191",
-    "@types/node": "^18.15.3",
     "dotenv": "^16.0.3",
-    "esbuild": "^0.19.8",
     "execa": "^2.0.0",
     "globby": "^10.0.0",
     "lodash": "^4.17.21",
     "rxjs": "^7.8.0",
-    "sanity": "3.27.1",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "sanity": "3.27.1"
   }
 }
diff --git a/perf/perf-studio.d.ts → perf/tests/perf-studio.d.ts b/perf/perf-studio.d.ts → perf/tests/perf-studio.d.ts
diff --git a/perf/queries.ts → perf/tests/queries.ts b/perf/queries.ts → perf/tests/queries.ts
diff --git a/...nner/__tests__/parseDecoratedRefs.test.ts → ...nner/__tests__/parseDecoratedRefs.test.ts b/...nner/__tests__/parseDecoratedRefs.test.ts → ...nner/__tests__/parseDecoratedRefs.test.ts
diff --git a/perf/runner/runner.ts → perf/tests/runner/runner.ts b/perf/runner/runner.ts → perf/tests/runner/runner.ts
diff --git a/perf/runner/types.ts → perf/tests/runner/types.ts b/perf/runner/types.ts → perf/tests/runner/types.ts
diff --git a/perf/runner/utils/bundlePerfHelpers.ts → perf/tests/runner/utils/bundlePerfHelpers.ts b/perf/runner/utils/bundlePerfHelpers.ts → perf/tests/runner/utils/bundlePerfHelpers.ts
diff --git a/...runner/utils/createSanitySessionCookie.ts → ...runner/utils/createSanitySessionCookie.ts b/...runner/utils/createSanitySessionCookie.ts → ...runner/utils/createSanitySessionCookie.ts
diff --git a/perf/runner/utils/getDeviceInfo.ts → perf/tests/runner/utils/getDeviceInfo.ts b/perf/runner/utils/getDeviceInfo.ts → perf/tests/runner/utils/getDeviceInfo.ts
diff --git a/perf/runner/utils/gitUtils.ts → perf/tests/runner/utils/gitUtils.ts b/perf/runner/utils/gitUtils.ts → perf/tests/runner/utils/gitUtils.ts
diff --git a/perf/runner/utils/sanityIdIfy.ts → perf/tests/runner/utils/sanityIdIfy.ts b/perf/runner/utils/sanityIdIfy.ts → perf/tests/runner/utils/sanityIdIfy.ts
diff --git a/perf/runner/utils/testIds.ts → perf/tests/runner/utils/testIds.ts b/perf/runner/utils/testIds.ts → perf/tests/runner/utils/testIds.ts
diff --git a/perf/tests/arrayOf1kItems.test.ts → perf/tests/tests/arrayOf1kItems.test.ts b/perf/tests/arrayOf1kItems.test.ts → perf/tests/tests/arrayOf1kItems.test.ts
diff --git a/perf/tests/arrayOf1kReferenceItems.test.ts → ...sts/tests/arrayOf1kReferenceItems.test.ts b/perf/tests/arrayOf1kReferenceItems.test.ts → ...sts/tests/arrayOf1kReferenceItems.test.ts
diff --git a/perf/tests/arrayOf1kStringItems.test.ts → .../tests/tests/arrayOf1kStringItems.test.ts b/perf/tests/arrayOf1kStringItems.test.ts → .../tests/tests/arrayOf1kStringItems.test.ts
diff --git a/perf/tests/deeplyNestedObjects.test.ts → perf/tests/tests/deeplyNestedObjects.test.ts b/perf/tests/deeplyNestedObjects.test.ts → perf/tests/tests/deeplyNestedObjects.test.ts
diff --git a/perf/tests/helpers/index.ts → perf/tests/tests/helpers/index.ts b/perf/tests/helpers/index.ts → perf/tests/tests/helpers/index.ts
diff --git a/perf/tests/helpers/register.ts → perf/tests/tests/helpers/register.ts b/perf/tests/helpers/register.ts → perf/tests/tests/helpers/register.ts
diff --git a/perf/tests/helpers/typingTest.ts → perf/tests/tests/helpers/typingTest.ts b/perf/tests/helpers/typingTest.ts → perf/tests/tests/helpers/typingTest.ts
diff --git a/...tests/helpers/utils/generateParagraphs.ts → ...tests/helpers/utils/generateParagraphs.ts b/...tests/helpers/utils/generateParagraphs.ts → ...tests/helpers/utils/generateParagraphs.ts
diff --git a/perf/tests/helpers/utils/triggerEdit.ts → .../tests/tests/helpers/utils/triggerEdit.ts b/perf/tests/helpers/utils/triggerEdit.ts → .../tests/tests/helpers/utils/triggerEdit.ts
diff --git a/...sts/largeArrayEditingAnotherField.test.ts → ...sts/largeArrayEditingAnotherField.test.ts b/...sts/largeArrayEditingAnotherField.test.ts → ...sts/largeArrayEditingAnotherField.test.ts
diff --git a/perf/tests/largeDocumentEditing.test.ts → .../tests/tests/largeDocumentEditing.test.ts b/perf/tests/largeDocumentEditing.test.ts → .../tests/tests/largeDocumentEditing.test.ts
diff --git a/perf/tests/simpleTyping.test.ts → perf/tests/tests/simpleTyping.test.ts b/perf/tests/simpleTyping.test.ts → perf/tests/tests/simpleTyping.test.ts
diff --git a/perf/tsconfig.json → perf/tests/tsconfig.json b/perf/tsconfig.json → perf/tests/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../tsconfig.settings.json",
+  "extends": "../../tsconfig.settings.json",
   "include": ["./**/*"],
   "compilerOptions": {
     "esModuleInterop": true,

diff --git a/perf/tests/turbo.json b/perf/tests/turbo.json
@@ -0,0 +1,9 @@
+{
+  "$schema": "https://turbo.build/schema.json",
+  "extends": ["//"],
+  "pipeline": {
+    "build": {
+      "outputs": [".sanity/**", "dist/**"]
+    }
+  }
+}
diff --git a/yarn.lock b/yarn.lock
@@ -4010,9 +4010,9 @@
   integrity sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==
 
 "@tsconfig/node16@^1.0.2":
-  version "1.0.3"
-  resolved "https://registry.yarnpkg.com/@tsconfig/node16/-/node16-1.0.3.tgz#472eaab5f15c1ffdd7f8628bd4c4f753995ec79e"
-  integrity sha512-yOlFc+7UtL/89t2ZhjPvvB/DeAr3r+Dq58IgzsFkOAvVC6NMJXmCGjbptdXdR9qsX7pKcTL+s87FtYREi2dEEQ==
+  version "1.0.4"
+  resolved "https://registry.yarnpkg.com/@tsconfig/node16/-/node16-1.0.4.tgz#0b92dcc0cc1c81f6f306a381f28e31b1a56536e9"
+  integrity sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==
 
 "@turf/boolean-point-in-polygon@^5.1.5":
   version "5.1.5"
@@ -4304,7 +4304,7 @@
   dependencies:
     "@types/lodash" "*"
 
-"@types/lodash@*", "@types/lodash@^4.14.149", "@types/lodash@^4.14.191", "@types/lodash@^4.14.200":
+"@types/lodash@*", "@types/lodash@^4.14.149", "@types/lodash@^4.14.200":
   version "4.14.201"
   resolved "https://registry.npmjs.org/@types/lodash/-/lodash-4.14.201.tgz#76f47cb63124e806824b6c18463daf3e1d480239"
   integrity sha512-y9euML0cim1JrykNxADLfaG0FgD1g/yTHwUs/Jg9ZIU7WKj2/4IW9Lbb1WZbvck78W/lfGXFfe+u2EGfIJXdLQ==
@@ -4365,15 +4365,22 @@
   dependencies:
     "@types/node" "*"
 
-"@types/node@*", "@types/node@^18.15.3":
+"@types/node@*":
   version "18.16.3"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-18.16.3.tgz#6bda7819aae6ea0b386ebc5b24bdf602f1b42b01"
   integrity sha512-OPs5WnnT1xkCBiuQrZA4+YAV4HEJejmHneyraIaxsbev5yCEr6KMwINNFP9wQeFIw8FWcoTqF3vQsa5CDaI+8Q==
 
 "@types/node@^14.18.9":
-  version "14.18.43"
-  resolved "https://registry.yarnpkg.com/@types/node/-/node-14.18.43.tgz#679e000d9f1d914132ea295b4a1ffdf20370ec49"
-  integrity sha512-n3eFEaoem0WNwLux+k272P0+aq++5o05bA9CfiwKPdYPB5ZambWKdWoeHy7/OJiizMhzg27NLaZ6uzjLTzXceQ==
+  version "14.18.63"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-14.18.63.tgz#1788fa8da838dbb5f9ea994b834278205db6ca2b"
+  integrity sha512-fAtCfv4jJg+ExtXhvCkCqUKZ+4ok/JQk01qDKhL5BDDoS3AxKXhV5/MAVUZyQnSEd2GT92fkgZl0pz0Q0AzcIQ==
+
+"@types/node@^18.15.3":
+  version "18.19.14"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-18.19.14.tgz#1880ff1b3ac913f3877f711588e5ed227da01886"
+  integrity sha512-EnQ4Us2rmOS64nHDWr0XqAD8DsO6f3XR6lf9UIIrZQpUzPVdN/oPuEzfDWNHSyXLvoGgjuEm/sPwFGSSs35Wtg==
+  dependencies:
+    undici-types "~5.26.4"
 
 "@types/normalize-package-data@^2.4.0":
   version "2.4.1"
@@ -4961,14 +4968,14 @@ acorn-jsx@^5.3.2:
   integrity sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==
 
 acorn-walk@^8.0.2, acorn-walk@^8.1.1:
-  version "8.2.0"
-  resolved "https://registry.yarnpkg.com/acorn-walk/-/acorn-walk-8.2.0.tgz#741210f2e2426454508853a2f44d0ab83b7f69c1"
-  integrity sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA==
+  version "8.3.2"
+  resolved "https://registry.yarnpkg.com/acorn-walk/-/acorn-walk-8.3.2.tgz#7703af9415f1b6db9315d6895503862e231d34aa"
+  integrity sha512-cjkyv4OtNCIeqhHrfS81QWXoCBPExR/J62oyEqepVw8WaQeSqpW2uhuLPh1m9eWhDuOo/jUXVTlifvesOWp/4A==
 
 acorn@^8.1.0, acorn@^8.4.1, acorn@^8.8.1, acorn@^8.8.2, acorn@^8.9.0:
-  version "8.10.0"
-  resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.10.0.tgz#8be5b3907a67221a81ab23c7889c4c5526b62ec5"
-  integrity sha512-F0SAmZ8iUtS//m8DmCTA0jlh6TDKkHQyK6xc6V4KDTyZKA9dnvX9/3sRTVQrWm79glUAZbnmmNcdYwUIHWVybw==
+  version "8.11.3"
+  resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.11.3.tgz#71e0b14e13a4ec160724b38fb7b0f233b1b81d7a"
+  integrity sha512-Y9rRfJG5jcKOE0CLisYbojUjIrIEE7AGMzA/Sm4BslANhbS+cDMpgBdcPT91oJ7OuJ9hYJBx59RjbhxVnrF8Xg==
 
 add-stream@^1.0.0:
   version "1.0.0"
@@ -15508,9 +15515,9 @@ ts-api-utils@^1.0.1:
   integrity sha512-wNMeqtMz5NtwpT/UZGY5alT+VoKdSsOOP/kqHFcUW1P/VRhH2wJ48+DN2WwUliNbQ976ETwDL0Ifd2VVvgonvg==
 
 ts-node@^10.9.1:
-  version "10.9.1"
-  resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.9.1.tgz#e73de9102958af9e1f0b168a6ff320e25adcff4b"
-  integrity sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw==
+  version "10.9.2"
+  resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.9.2.tgz#70f021c9e185bccdca820e26dc413805c101c71f"
+  integrity sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==
   dependencies:
     "@cspotcode/source-map-support" "^0.8.0"
     "@tsconfig/node10" "^1.0.7"
@@ -15732,7 +15739,7 @@ typeid-js@^0.3.0:
   dependencies:
     uuidv7 "^0.4.4"
 
-typescript@^5.1.6, typescript@^5.2.2:
+typescript@^5.2.2:
   version "5.2.2"
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.2.2.tgz#5ebb5e5a5b75f085f22bc3f8460fba308310fa78"
   integrity sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w==
@@ -15775,6 +15782,11 @@ unbzip2-stream@^1.0.9:
     buffer "^5.2.1"
     through "^2.3.8"
 
+undici-types@~5.26.4:
+  version "5.26.5"
+  resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-5.26.5.tgz#bcd539893d00b56e964fd2657a4866b221a65617"
+  integrity sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==
+
 unicode-canonical-property-names-ecmascript@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.0.tgz#301acdc525631670d39f6146e0e77ff6bbdebddc"