Merge pull request #743 from revisit-studies/dev

v2.2.0

Author: JackWilb

.env

@@ -9,6 +9,9 @@ VITE_FIREBASE_CONFIG='
   appId: "1:811568460432:web:995f6b4f1fc8042b5dde15"
 }
 '
-VITE_STORAGE_ENGINE="localStorage" # "firebase" or "localStorage" or your own custom storage engine
+VITE_STORAGE_ENGINE="localStorage" # "firebase" or "supabase" or "localStorage" or your own custom storage engine
 VITE_RECAPTCHAV3TOKEN="6LdjOd0lAAAAAASvFfDZFWgtbzFSS9Y3so8rHJth" # recaptcha SITE KEY
-VITE_REPO_URL="https://github.com/revisit-studies/study/tree/main/public/" # Set the url for the "view source" link on the front page
+VITE_REPO_URL="https://github.com/revisit-studies/study/tree/main/public/" # Set the url for the "view source" link on the front page
+
+VITE_SUPABASE_URL="http://localhost:8000"
+VITE_SUPABASE_ANON_KEY="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyAgCiAgICAicm9sZSI6ICJhbm9uIiwKICAgICJpc3MiOiAic3VwYWJhc2UtZGVtbyIsCiAgICAiaWF0IjogMTY0MTc2OTIwMCwKICAgICJleHAiOiAxNzk5NTM1NjAwCn0.dc_X5iR_VP_qT0zsiyj_I_OZ2T9FtRU2BBNWN8Bu4GE"

.github/workflows/deploy_website.yaml

@@ -4,15 +4,30 @@ on:
   push:
     branches:
       - main
+  workflow_dispatch:
+  pull_request:
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
     permissions:
       contents: write
+      pull-requests: write
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
+      cancel-in-progress: true
+
     steps:
+      - name: Comment on PR
+        uses: hasura/comment-progress@v2.2.0
+        if: ${{ github.ref != 'refs/heads/main' }}
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          repository: ${{ github.repository }}
+          number: ${{ github.event.number }}
+          id: deploy-preview
+          message: "Starting deployment of preview ⏳..."
+
       - uses: actions/checkout@v3
 
       - uses: actions/setup-node@v3
@@ -22,12 +37,14 @@ jobs:
 
       - run: yarn install --immutable
 
+      # If on main without env vars, build with .env file
       - name: Build with .env file
-        if: ${{ vars.VITE_STORAGE_ENGINE == '' }}
+        if: ${{ vars.VITE_STORAGE_ENGINE == '' && github.ref == 'refs/heads/main' }}
         run: yarn build
 
+      # If on main with env vars, build with github environment variables
       - name: Build with github environment variables
-        if: ${{ vars.VITE_STORAGE_ENGINE != '' }}
+        if: ${{ vars.VITE_STORAGE_ENGINE != '' && github.ref == 'refs/heads/main' }}
         run: VITE_STORAGE_ENGINE=$VITE_STORAGE_ENGINE yarn build
         env:
           VITE_STORAGE_ENGINE: ${{ vars.VITE_STORAGE_ENGINE }}
@@ -38,3 +55,29 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./dist
+
+      # If on PR, build with github environment variables
+      - name: Build with github environment variables
+        if: ${{ vars.VITE_STORAGE_ENGINE != '' && github.ref != 'refs/heads/main' }}
+        run: VITE_STORAGE_ENGINE=$VITE_STORAGE_ENGINE VITE_BASE_PATH=$VITE_BASE_PATH yarn build
+        env:
+          VITE_STORAGE_ENGINE: ${{ vars.VITE_STORAGE_ENGINE }}
+          VITE_BASE_PATH: "/study/PR${{ github.event.number }}/"
+
+      - name: Push PR deploy preview
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.ref != 'refs/heads/main' }}
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./dist
+          destination_dir: "PR${{ github.event.number }}"
+
+      - name: Update comment
+        uses: hasura/comment-progress@v2.2.0
+        if: ${{ github.ref != 'refs/heads/main' }}
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          repository: ${{ github.repository }}
+          number: ${{ github.event.number }}
+          id: deploy-preview
+          message: "A preview of ${{ github.event.after }} is uploaded and can be seen here:\n\n ✨ https://revisit.dev/study/PR${{ github.event.number }} ✨\n\nChanges may take a few minutes to propagate."

.github/workflows/pr_close.yaml

@@ -0,0 +1,30 @@
+name: delete preview on PR close
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  delete_preview:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: make empty dir
+        run: mkdir public
+
+      - name: delete folder
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./public
+          destination_dir: "PR${{ github.event.number }}"
+
+      - name: Comment on PR
+        uses: hasura/comment-progress@v2.2.0
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          repository: ${{ github.repository }}
+          number: ${{ github.event.number }}
+          id: deploy-preview
+          message: "🪓 PR closed, deleted preview."

.github/workflows/release_github.yaml

@@ -11,7 +11,7 @@ permissions:
 jobs:
   release:
     name: Release pushed tag
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     steps:
       - name: Create release
         env:

.github/workflows/vitest.yml

@@ -0,0 +1,26 @@
+name: Playwright Tests
+
+on:
+  pull_request:
+    branches:
+      - dev
+      - main
+
+jobs:
+  test:
+    name: 🧪 Unit Tests
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          cache: "yarn"
+
+      - name: Install dependencies
+        run: yarn install --immutable
+
+      - name: Run Playwright tests
+        run: yarn unittest

.gitignore

@@ -13,7 +13,6 @@ dist-ssr
 *.local
 
 # Editor directories and files
-.vscode/*
 !.vscode/extensions.json
 .idea
 .DS_Store
@@ -33,3 +32,8 @@ docsLibraries/
 
 public/__revisit-widget
 src/public/__revisit-widget
+
+supabase/volumes/*
+!supabase/volumes/db/
+supabase/volumes/db/data
+!supabase/volumes/api/

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "yaml.schemas": {
+    "./src/parser/StudyConfigSchema.json": "*.yaml"
+  }
+}

eslint.config.js

@@ -40,7 +40,7 @@ export default [{
     },
 
     parser: tsParser,
-    ecmaVersion: 2022,
+    ecmaVersion: 'latest',
     sourceType: 'module',
   },
 

libraryDocGenerator.cjs

@@ -9,6 +9,25 @@ const path = require('path');
 const generateMd = (library, libraryConfig, forDocs) => `
 # ${library}
 
+${forDocs ?
+  `import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
+  
+  <StructuredLinks
+      demoLinks={[
+        {name: "${library} Demo", url: "https://revisit.dev/study/library-${library}"}
+      ]}
+      codeLinks={[
+        {name: "${library} Code", url: "https://github.com/revisit-studies/study/tree/main/public/library-${library}"}
+      ]}
+      ${
+        (libraryConfig.doi || libraryConfig.externalLink)
+        ? `referenceLinks={[
+        ${libraryConfig.doi ? `{name: "DOI", url: "https://dx.doi.org/${libraryConfig.doi}"}` : ''}${libraryConfig.doi && libraryConfig.externalLink ? ',' : ''}
+        ${libraryConfig.externalLink ? `{name: "${library}", url: "${libraryConfig.externalLink}"}` : ''}
+      ]}`
+      : ''}
+  />` :  ''}
+
 ${!forDocs ? `This is an example study of the library \`${library}\`.` : ''}
 
 ${libraryConfig.description}
@@ -30,12 +49,15 @@ ${Object.keys(libraryConfig.components).map((component) => `- ${component}`).sor
 ${Object.keys(libraryConfig.sequences).length > 0
     ? Object.keys(libraryConfig.sequences).map((sequence) => `- ${sequence}`).sort((a, b) => a.localeCompare(b)).join('\n')
     : 'None'}
+
+${libraryConfig.additionalDescription ? `## Additional Description\n\n${libraryConfig.additionalDescription}` : ''}
 `;
 
 const librariesPath = path.join(__dirname, './public/libraries');
 const docsLibrariesPath = path.join(__dirname, './docsLibraries');
 
-const libraries = fs.readdirSync(librariesPath);
+const libraries = fs.readdirSync(librariesPath)
+  .filter(library => !library.startsWith('.') && !library.endsWith('.DS_Store'));
 
 if (!fs.existsSync(docsLibrariesPath)) {
   fs.mkdirSync(docsLibrariesPath);
@@ -60,6 +82,7 @@ libraries.forEach((library) => {
   if (fs.existsSync(exampleAssetsPath)) {
     const exampleDocsPath = path.join(exampleAssetsPath, `${library}.md`);
     fs.writeFileSync(exampleDocsPath, exampleMd);
+
     // eslint-disable-next-line no-console
     console.log(`Documentation saved to ${exampleDocsPath}`);
   }

libraryExampleStudyGenerator.cjs

@@ -15,6 +15,7 @@ const { exec } = require('child_process');
 const librariesPath = path.join(__dirname, './public/libraries');
 const publicPath = path.join(__dirname, './public');
 
+
 // Create example study config template
 const createExampleConfig = (libraryName) => ({
   $schema: 'https://raw.githubusercontent.com/revisit-studies/study/dev/src/parser/StudyConfigSchema.json',
@@ -30,7 +31,7 @@ const createExampleConfig = (libraryName) => ({
     contactEmail: '',
     logoPath: 'revisitAssets/revisitLogoSquare.svg',
     withProgressBar: true,
-    sidebar: true,
+    withSidebar: true,
   },
   importedLibraries: [libraryName],
   components: {
@@ -49,10 +50,16 @@ const createExampleConfig = (libraryName) => ({
 });
 
 // Process each library
-const libraries = fs.readdirSync(librariesPath);
+const libraries = fs.readdirSync(librariesPath)
+  .filter(library => !library.startsWith('.') && !library.endsWith('.DS_Store'));
+
 libraries.forEach((library) => {
   // Skip hidden folders and files, and libraries in skip list
-  if (library.startsWith('.')) return;
+  if (library.startsWith('.')) {
+    // eslint-disable-next-line no-console
+    console.log(`Skipping ${library} library`);
+    return;
+  }
 
   const exampleFolderName = `library-${library}`;
   const examplePath = path.join(publicPath, exampleFolderName);
@@ -69,14 +76,15 @@ libraries.forEach((library) => {
     fs.mkdirSync(assetsPath);
     // eslint-disable-next-line no-console
     console.log(`Created ${exampleFolderName}/assets directory`);
+
+    // Create config.json
+    const configPath = path.join(examplePath, 'config.json');
+    const configContent = createExampleConfig(library);
+    fs.writeFileSync(configPath, JSON.stringify(configContent, null, 2));
+    // eslint-disable-next-line no-console
+    console.log(`Created/Updated ${exampleFolderName}/config.json`);
   }
 
-  // Create config.json
-  const configPath = path.join(examplePath, 'config.json');
-  const configContent = createExampleConfig(library);
-  fs.writeFileSync(configPath, JSON.stringify(configContent, null, 2));
-  // eslint-disable-next-line no-console
-  console.log(`Created/Updated ${exampleFolderName}/config.json`);
 });
 
 // eslint-disable-next-line no-console