Merge remote-tracking branch 'upstream/main' into add-auth-example-entra-id-saml

Author: josefaidt

.github/workflows/build.yml

@@ -3,6 +3,8 @@ on:
   pull_request:
     branches: [main, next-release/main]
     types: [opened, synchronize]
+env:
+  BUILD_DIR: 'client/www/next-build'
 jobs:
   build:
     name: Build
@@ -17,8 +19,14 @@ jobs:
       - name: Install Dependencies
         run: yarn
       - name: Run tests
-        run: yarn prebuild && yarn test
+        run: yarn prebuild && yarn test:unit
       - name: Run Build
         run: yarn build
         env:
           NODE_OPTIONS: --max_old_space_size=4096
+      - name: Run site
+        run: | 
+          python -m http.server 3000 -d ${{ env.BUILD_DIR }} &
+          sleep 5
+      - name: Run E2E Tests
+        run: yarn test:e2e 

.github/workflows/check_for_broken_links.yml

@@ -32,7 +32,7 @@ jobs:
           role-to-assume: arn:aws:iam::464149486631:role/github_action_read_slack_webhook_url
           aws-region: us-west-2
       - name: Read secrets from AWS Secrets Manager into environment variables
-        uses: aws-actions/aws-secretsmanager-get-secrets@ff26a0aa6bd4dd5e51326b5afb3f5f6874c958c7 # v2.0.3
+        uses: aws-actions/aws-secretsmanager-get-secrets@98c2d6bf1dd67c2575fa2bb14294aa64103d426c # v2.0.5
         with:
           secret-ids: |
             SLACK_WEBHOOK_URL

.github/workflows/scripts/validate-redirects.js

@@ -0,0 +1,58 @@
+module.exports = {
+  invalidRedirects: () => {
+    const Ajv = require('ajv');
+    const redirects = require('../../../redirects.json');
+    const ajv = new Ajv();
+
+    const schema = {
+      type: 'array',
+      items: {
+        type: 'object',
+        required: ['source', 'target', 'status'],
+        properties: {
+          source: {
+            description: 'The address the user requested.',
+            type: 'string',
+            pattern: '^/'
+          },
+          target: {
+            description:
+              'The address that actually serves the content that the user sees',
+            type: 'string',
+            pattern: '^[(https)(/)]'
+          },
+          status: {
+            description:
+              'Types include a permanent redirect (301), a temporary redirect (302), a rewrite (200), or not found (404).',
+            type: 'string',
+            pattern: '^[0-5-]+$'
+          }
+        }
+      }
+    };
+
+    const errors = [];
+    const validate = ajv.compile(schema);
+
+    const validateEntries = (redirects) => {
+      const valid = validate(redirects);
+
+      if (!valid) {
+        const error = validate.errors[0];
+        const invalidEntry =
+          JSON.stringify(redirects[error.instancePath.slice(1, -7)]);
+        const loc = error.schemaPath.slice(error.schemaPath.indexOf('properties') + 11, -8);
+        const errorMessage = '\n\n' + 'INVALID ENTRY: Please correct the error in the "' + loc +'" property of the following entry: \n' + invalidEntry + '\n' + 'ERROR MESSAGE: ' + error.message;
+        errors.push(errorMessage);
+
+        validateEntries(redirects.splice(parseInt(error.instancePath.slice(1, -7)) + 1));
+
+      } 
+    }
+    validateEntries(redirects);
+
+    return errors;
+  }
+}
+
+

.github/workflows/update_references.yml

@@ -0,0 +1,47 @@
+name: Receive repository dispatch event
+
+on:
+  # Listen to a repository dispatch event by the name of `dispatch-event`
+  repository_dispatch:
+    types: [update-references]
+  workflow_dispatch:
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+jobs:
+  create-pull-request:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+
+      - name: Setup Node.js 20
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
+        with:
+          node-version: 20.x
+
+      - name: Set github commit user
+        env:
+          GITHUB_EMAIL: ${{ vars.GH_EMAIL }}
+          GITHUB_USER: ${{ vars.GH_USER }}
+        run: |
+          git config --global user.email $GITHUB_EMAIL
+          git config --global user.name $GITHUB_USER
+
+        # Set branch name to be used as environment variable
+      - name: Set Branch Name
+        run: echo "BRANCH_NAME=$(echo update-ref-$(date +%s))" >> $GITHUB_ENV
+
+        # Create new branch, download, and commit changes to the new branch
+      - name: Create new branch
+        run: |
+          git checkout -b ${{ env.BRANCH_NAME }}
+          curl -L -o ${{ vars.REF_LOC }} ${{ vars.REMOTE_REF }}
+          node tasks/clean-references.mjs
+          git add ${{ vars.REF_LOC }} ${{ vars.CLEAN_LOC }}
+          git commit -m "updating references"
+          git push -u origin ${{ env.BRANCH_NAME }}
+
+        # Open pull request
+      - name: Create Pull Request
+        run: gh pr create -B main -H ${{ env.BRANCH_NAME }} --title 'Merge ${{ env.BRANCH_NAME }} into main' --body 'Created by Github action'

.github/workflows/validate_redirects.yml

@@ -0,0 +1,32 @@
+name: Validate Redirects
+on:
+  pull_request:
+    branches: [main]
+    types: [opened, synchronize]
+env:
+  BUILD_DIR: 'client/www/next-build'
+permissions:
+  contents: read
+jobs:
+  ValidateRedirects:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+      - name: Setup Node.js 20.x
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
+        with:
+          node-version: 20.x
+      - name: Install Dependencies
+        run: yarn
+      - name: Validate redirects
+        id: redirects
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        with:
+          result-encoding: string
+          script: |
+            const { invalidRedirects } = require('./.github/workflows/scripts/validate-redirects.js');
+            return await invalidRedirects();
+      - name: Fail if any invalid redirects have been found
+        if: ${{ steps.redirects.outputs.result }}
+        run: exit 1 && echo ${{ steps.redirects.outputs.result }}

Readme.md

@@ -91,7 +91,9 @@ When linking to other pages within the docs.amplify.aws site, do not use relativ
 
 To incorporate new platform-specific content within a page, please use [Inline Filters](https://github.com/aws-amplify/docs/blob/main/Readme.md#inline-filters).
 
-When editing content that hasn't been migrated, you may see the following pattern:
+Please note: we do allow fragments in some cases where content is intended to be reused and cannot be via InlineFilters
+
+When editing content that hasn't been migrated to InlineFilters, you may see the following pattern:
 
 ```jsx
 import js from '/src/fragments/lib/datastore/js/conflict.mdx';
@@ -173,7 +175,7 @@ let mut a = String::from("a");
 Videos can be added using the `<Video />` component and referencing a path to the video file. The video should be an `.mp4` file and should exist in the `/public` directory
 
 ```jsx
-<Video src="/path/to/video.mp4" />
+<Video src="/path/to/video.mp4" description="Video - [video description]" />
 ```
 
 ## Accessibility testing

cspell.json

@@ -532,10 +532,12 @@
     "Didfinishlaunchingwithoptions",
     "displayMode",
     "displayOrder",
+    "dists",
     "DocSet",
     "DocSets",
     "Donef",
     "Dont",
+    "dotenvx",
     "downcasting",
     "dropdown",
     "dynamoDB",
@@ -593,6 +595,7 @@
     "Figma",
     "Figma's",
     "figma",
+    "fileuploader",
     "architected",
     "newsfeeds",
     "textareas",
@@ -1242,7 +1245,6 @@
     "Storage.put",
     "storagebucketname",
     "storagedemo",
-    "storagemanager",
     "storageOptions",
     "storagepath",
     "StoragePath",
@@ -1394,6 +1396,7 @@
     "validationData",
     "vanillajs",
     "varchar",
+    "vendedlogs",
     "verify.js",
     "VerifyAuthChallengeResponse",
     "VeriSign",

e2e/homepage.test.js

@@ -0,0 +1,23 @@
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { AxePuppeteer } = require('@axe-core/puppeteer');
+
+const sleep = (ms) => new Promise((res) => setTimeout(res, ms));
+
+describe('home page', () => {
+  beforeAll(async () => {
+    await page.goto(`http://localhost:3000/`);
+    await page.waitForSelector('h1');
+  });
+
+  it('should display the home page with no accessibility violations', async () => {
+    const results = await new AxePuppeteer(page).analyze();
+    expect(results.violations).toHaveLength(0);
+  });
+
+  it('should display the home page with no accessibility violations in dark mode', async () => {
+    await page.click('button[title="Dark mode"]');
+    await sleep(300);
+    const results = await new AxePuppeteer(page).analyze();
+    expect(results.violations).toHaveLength(0);
+  });
+});

e2e/jest.e2e.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  rootDir: './',
+  preset: 'jest-puppeteer',
+  testMatch: ['<rootDir>/*.test.js']
+};

jest.config.js

@@ -1,27 +1,7 @@
 module.exports = {
-  preset: './preset.js',
   rootDir: './',
-  roots: ['<rootDir>/src', '<rootDir>/tasks'],
-  testEnvironment: 'jsdom',
-  transform: {
-    '^.+\\.(ts|tsx|js|mjs)$': [
-      'babel-jest',
-      {
-        presets: ['next/babel']
-      }
-    ]
-  },
-  testPathIgnorePatterns: ['capi', '.next', 'client'],
-  setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
-  moduleNameMapper: {
-    '\\.(css|less|scss)$': '<rootDir>/src/__mocks__/styleMock.js',
-    '@docsearch/css(.*)': '<rootDir>/src/__mocks__/styleMock.js',
-    '@/components/(.*)': '<rootDir>/src/components/$1',
-    '@/constants/(.*)': '<rootDir>/src/constants/$1',
-    '@/utils/(.*)': '<rootDir>/src/utils/$1',
-    '@/data/(.*)': '<rootDir>/src/data/$1',
-    '@/directory/(.*)': '<rootDir>/src/directory/$1',
-    '@/themes/(.*)': '<rootDir>/src/themes/$1'
-  },
-  transformIgnorePatterns: ['node_modules/(?!variables/.*)']
+  projects: [
+    '<rootDir>/jest.unit.config.js',
+    '<rootDir>/e2e/jest.e2e.config.js'
+  ]
 };