Merge branch 'main' into sync-case

.github/workflows/pr-commit-signatures.yml

@@ -9,10 +9,12 @@ jobs:
 
     steps:
       - name: Fetch commits
-        run: curl -s "${{ github.event.pull_request._links.commits.href }}" > commits.json
+        run: gh api "${{ github.event.pull_request._links.commits.href }}" | tee commits.json
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Filter unverified commits
-        run: jq '[.[].commit | select(.verification.verified == false)]' < commits.json > unverified-commits.json
+        run: jq '[.[].commit | select(.verification.verified == false)]' < commits.json | tee unverified-commits.json
 
       - name: List unverified commits
         run: jq '.[] | [{message, tree, author, committer, verification}]' < unverified-commits.json

.github/workflows/prod-build.yml

@@ -167,18 +167,18 @@ jobs:
           REACT_APP_MDN_PLUS_10Y_PLAN: price_1KeG02JNcmPzuWtRlrSiLTI6
 
           # Surveys.
-          REACT_APP_SURVEY_START_INTEROP_2023: 1667217600000 # (new Date("2022-10-31 12:00:00Z")).getTime()
-          REACT_APP_SURVEY_END_INTEROP_2023: 1667822400000 # (new Date("2022-11-07 12:00:00Z")).getTime()
-
-          REACT_APP_SURVEY_RATE_FROM_INTEROP_2023_CSS_HTML: 0.0
-          REACT_APP_SURVEY_RATE_TILL_INTEROP_2023_CSS_HTML: 0.10 # 10 %
-          REACT_APP_SURVEY_RATE_FROM_INTEROP_2023_API_JS: 0.10
-          REACT_APP_SURVEY_RATE_TILL_INTEROP_2023_API_JS: 0.15 # 5 %
+          REACT_APP_SURVEY_START_FIREFOX_WEB_COMPAT_2023: 1675252800000 # (new Date("2023-02-01 12:00:00Z")).getTime()
+          REACT_APP_SURVEY_END_FIREFOX_WEB_COMPAT_2023: 1675684800000 # (new Date("2023-02-06 12:00:00Z")).getTime()
+          REACT_APP_SURVEY_RATE_FROM_FIREFOX_WEB_COMPAT_2023: 0.0
+          REACT_APP_SURVEY_RATE_TILL_FIREFOX_WEB_COMPAT_2023: 0.10 # 10%
 
           # Telemetry.
           REACT_APP_GLEAN_CHANNEL: prod
           REACT_APP_GLEAN_ENABLED: true
 
+          # Newsletter
+          REACT_APP_NEWSLETTER_ENABLED: true
+
         run: |
 
           # Info about which CONTENT_* environment variables were set and to what.

.github/workflows/stage-build.yml

@@ -164,18 +164,18 @@ jobs:
           REACT_APP_MDN_PLUS_10Y_PLAN: price_1K6X8VKb9q6OnNsLFlUcEiu4
 
           # Surveys.
-          REACT_APP_SURVEY_START_INTEROP_2023: 0 # stage
-          REACT_APP_SURVEY_END_INTEROP_2023: 1667822400000 # (new Date("2022-11-07 12:00:00Z")).getTime()
-
-          REACT_APP_SURVEY_RATE_FROM_INTEROP_2023_CSS_HTML: 0.0
-          REACT_APP_SURVEY_RATE_TILL_INTEROP_2023_CSS_HTML: 0.10 # 10 %
-          REACT_APP_SURVEY_RATE_FROM_INTEROP_2023_API_JS: 0.10
-          REACT_APP_SURVEY_RATE_TILL_INTEROP_2023_API_JS: 0.15 # 5 %
+          REACT_APP_SURVEY_START_FIREFOX_WEB_COMPAT_2023: 0 # stage
+          REACT_APP_SURVEY_END_FIREFOX_WEB_COMPAT_2023: 1675771200000 # (new Date("2023-02-07 12:00:00Z")).getTime()
+          REACT_APP_SURVEY_RATE_FROM_FIREFOX_WEB_COMPAT_2023: 0.0
+          REACT_APP_SURVEY_RATE_TILL_FIREFOX_WEB_COMPAT_2023: 0.10 # 10%
 
           # Telemetry.
           REACT_APP_GLEAN_CHANNEL: stage
           REACT_APP_GLEAN_ENABLED: true
 
+          # Newsletter
+          REACT_APP_NEWSLETTER_ENABLED: true
+
         run: |
 
           # Info about which CONTENT_* environment variables were set and to what.

.github/workflows/testing.yml

@@ -23,6 +23,7 @@ jobs:
           cache: yarn
           cache-dependency-path: |
             yarn.lock
+            client/pwa/yarn.lock
             deployer/aws-lambda/content-origin-request/yarn.lock
             deployer/aws-lambda/content-origin-response/yarn.lock
             deployer/aws-lambda/tests/yarn.lock
@@ -31,6 +32,10 @@ jobs:
       - name: Install all yarn packages (ROOT)
         run: yarn --frozen-lockfile
 
+      - name: Install all yarn packages (pwa)
+        working-directory: client/pwa
+        run: yarn --frozen-lockfile
+
       - name: Install all yarn packages (aws-lambda/content-origin-request)
         working-directory: deployer/aws-lambda/content-origin-request
         run: yarn --frozen-lockfile
@@ -52,6 +57,9 @@ jobs:
       - name: Lint stylelint
         run: yarn stylelint
 
+      - name: Check TypeScript
+        run: yarn check:tsc
+
   test:
     runs-on: ubuntu-latest
 
@@ -73,17 +81,8 @@ jobs:
       - name: Build and start server
         id: server
         env:
-          ENV_FILE: testing/.env
+          ENV_FILE: .env.testing
         run: |
-
-          # because `yarn build:prepare` is a wrapper for `yarn build:client` and
-          # `yarn build:client` can't respect the `$ENV_FILE` environment variable,
-          # because it has to build from the `./client/` directory, we have to
-          # manually copy the `testing/.env` file into `client/` so that when
-          # `yarn build:client` runs, it gets the same environment variables
-          # as you'd get when doing `yarn build:ssr`.
-          cp testing/.env client/
-
           yarn build:prepare
           yarn build
 
@@ -98,7 +97,7 @@ jobs:
 
       - name: Basic m2h tool testing
         env:
-          ENV_FILE: testing/.env
+          ENV_FILE: .env.testing
         run: |
           yarn m2h markdown/tool/m2h --locale en-US
           diff -s testing/content/files/en-us/markdown/tool/m2h/index.html testing/content/files/en-us/markdown/tool/m2h/expected.html

README.md

@@ -1,7 +1,7 @@
 # Yari
 
 ![Testing](https://github.com/mdn/yari/workflows/Testing%20Yari/badge.svg)
-![Production Build](https://github.com/mdn/yari/workflows/Production%20Build/badge.svg)
+![Prod Build](https://github.com/mdn/yari/workflows/Prod%20Build/badge.svg)
 
 ## Quickstart
 

build/cli.ts

@@ -12,11 +12,12 @@ import { prompt } from "inquirer";
 import { Document, slugToFolder, translationsOf } from "../content";
 import { CONTENT_ROOT, CONTENT_TRANSLATED_ROOT } from "../libs/env";
 import { VALID_LOCALES } from "../libs/constants";
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
 import { renderHTML } from "../ssr/dist/main";
 import options from "./build-options";
 import { buildDocument, BuiltDocument, renderContributorsTxt } from ".";
-import { Flaws } from "../libs/types";
-import * as bcd from "@mdn/browser-compat-data/types";
+import { DocMetadata, Flaws } from "../libs/types";
 import SearchIndex from "./search-index";
 import { BUILD_OUT_ROOT } from "../libs/env";
 import { makeSitemapXML, makeSitemapIndexXML } from "./sitemaps";
@@ -35,6 +36,10 @@ export interface InteractiveDocumentBuild {
   skip: false;
 }
 
+interface GlobalMetadata {
+  [locale: string]: Array<DocMetadata>;
+}
+
 async function buildDocumentInteractive(
   documentPath,
   interactive,
@@ -116,7 +121,7 @@ async function buildDocuments(
     findAllOptions.files = new Set(files);
   }
 
-  const metadata = {};
+  const metadata: GlobalMetadata = {};
 
   const documents = Document.findAll(findAllOptions);
   const progressBar = new cliProgress.SingleBar(
@@ -161,7 +166,7 @@ async function buildDocuments(
     }
 
     const {
-      doc: { doc: builtDocument, liveSamples, fileAttachments, bcdData },
+      doc: { doc: builtDocument, liveSamples, fileAttachments },
       document,
     } = result;
 
@@ -190,27 +195,6 @@ async function buildDocuments(
         builtDocument.source.github_url.replace("/blob/", "/commits/")
       )
     );
-    for (const { url, data } of bcdData) {
-      fs.writeFileSync(
-        path.join(outPath, path.basename(url)),
-        JSON.stringify(data, (key, value) => {
-          // The BCD data object contains a bunch of data we don't need in the
-          // React component that loads the `bcd.json` file and displays it.
-          // The `.releases` block contains information about browsers (e.g
-          // release dates) and that part has already been extracted and put
-          // next to each version number where appropriate.
-          // Therefore, we strip out all "retired" releases.
-          if (key === "releases") {
-            return Object.fromEntries(
-              Object.entries(value as bcd.ReleaseStatement).filter(
-                ([, v]) => v.status !== "retired"
-              )
-            );
-          }
-          return value;
-        })
-      );
-    }
 
     for (const { id, html } of liveSamples) {
       const liveSamplePath = path.join(outPath, `_sample_.${id}.html`);
@@ -300,6 +284,18 @@ async function buildDocuments(
       JSON.stringify(meta)
     );
   }
+
+  const allBrowserCompat = new Set<string>();
+  Object.values(metadata).forEach((localeMeta) =>
+    localeMeta.forEach((doc) =>
+      doc.browserCompat?.forEach((query) => allBrowserCompat.add(query))
+    )
+  );
+  fs.writeFileSync(
+    path.join(BUILD_OUT_ROOT, "allBrowserCompat.txt"),
+    [...allBrowserCompat].join(" ")
+  );
+
   return { slugPerLocale: docPerLocale, peakHeapBytes, totalFlaws };
 }
 

build/document-utils.ts

@@ -8,7 +8,8 @@ const TRANSFORM_STRINGS = new Map(
     "CSS: Cascading Style Sheets": "CSS",
     "Graphics on the Web": "Graphics",
     "HTML elements reference": "Elements",
-    "JavaScript reference": "JavaScript",
+    "JavaScript reference": "Reference",
+    "JavaScript Guide": "Guide",
     "Structuring the web with HTML": "HTML",
     "Learn to style HTML using CSS": "CSS",
     "Web forms — Working with user data": "Forms",