Merge branch 'develop' into feat/CORL-2885-accessibility-improvements

.github/workflows/build-and-test.yml

@@ -50,56 +50,82 @@ jobs:
       -
         name: Install npm 8
         run: npm i -g [email protected] --registry=https://registry.npmjs.org
+      # -
+      #   name: npm Lockfile Version (client)
+      #   uses: mansona/npm-lockfile-version@v1
+      #   with:
+      #     entryPoint: ./client
+      #     version: 2
+      # -
+      #   name: npm Lockfile Version (common)
+      #   uses: mansona/npm-lockfile-version@v1
+      #   with:
+      #     entryPoint: ./common
+      #     version: 2
+      # -
+      #   name: npm Lockfile Version (server)
+      #   uses: mansona/npm-lockfile-version@v1
+      #   with:
+      #     entryPoint: ./server
+      #     version: 2
       -
-        name: npm Lockfile Version
-        uses: mansona/npm-lockfile-version@v1
+        name: Cache Dependencies
+        id: cache-client
+        uses: actions/cache@v3
         with:
-          version: 2
+          path: ./client/node_modules
+          key: modules-client-${{ hashFiles('package-lock.json') }}
+          restore-keys: npm-
       -
         name: Cache Dependencies
-        id: cache
+        id: cache-common
         uses: actions/cache@v3
         with:
-          path: ./node_modules
-          key: modules-${{ hashFiles('package-lock.json') }}
+          path: ./common/node_modules
+          key: modules-common-${{ hashFiles('package-lock.json') }}
+          restore-keys: npm-
+      -
+        name: Cache Dependencies
+        id: cache-server
+        uses: actions/cache@v3
+        with:
+          path: ./server/node_modules
+          key: modules-server-${{ hashFiles('package-lock.json') }}
           restore-keys: npm-
       -
         name: npm ci
-        run: npm ci
+        run: sh scripts/npm-ci.sh
       -
         name: Generate schemas and types
-        run: npm run generate
+        run: sh scripts/generate.sh
       -
         name: Lint Source Code
-        run: npm run lint
-      -
-        name: Lint Markdown
-        run: |
-          npm run doctoc
-          git diff --exit-code
+        run: sh scripts/lint.sh
       -
         name: Lint Versions
-        run: npx @coralproject/package-version-lint
+        run: |
+          cd client
+          npx @coralproject/package-version-lint
       -
         name: Run Server Unit Tests
-        run: npm run test:server -- --ci --runInBand --reporters=default --reporters=jest-junit
+        run: cd server && npm run test:server -- --ci --runInBand --reporters=default --reporters=jest-junit
       -
         name: Run Client Stream Unit Tests
-        run: npm run test:client:stream -- --ci --runInBand --reporters=default --reporters=jest-junit
+        run: cd client && npm run test:client:stream -- --ci --runInBand --reporters=default --reporters=jest-junit
       -
         name: Run Client Admin Unit Tests
-        run: npm run test:client:admin -- --ci --runInBand --reporters=default --reporters=jest-junit
+        run: cd client && npm run test:client:admin -- --ci --runInBand --reporters=default --reporters=jest-junit
       -
         name: Run Client Other Unit Tests
-        run: npm run test:client:other -- --ci --runInBand --reporters=default --reporters=jest-junit
+        run: cd client && npm run test:client:other -- --ci --runInBand --reporters=default --reporters=jest-junit
       -
         name: Build
         env:
           NODE_OPTIONS: "--max-old-space-size=8192"
-        run: npm run build
+        run: sh scripts/build.sh
       -
         name: Verify Bundle Size
-        run: ./node_modules/.bin/bundlesize --enable-github-checks
+        run: cd client && ./node_modules/.bin/bundlesize --enable-github-checks
 # Build tag push the image after a merge to develop
       -
         name: Build, Tag, Push

.github/workflows/build-test-deploy.yml

@@ -58,58 +58,81 @@ jobs:
       -
         name: Install npm 8
         run: npm i -g [email protected] --registry=https://registry.npmjs.org
-      - name: npm Lockfile Version
-        uses: mansona/npm-lockfile-version@v1
+      # - name: npm Lockfile Version
+      #   uses: mansona/npm-lockfile-version@v1
+      #   with:
+      #     version: 2
+      -
+        name: Cache Dependencies
+        id: cache-client
+        uses: actions/cache@v3
         with:
-          version: 2
+          path: ./client/node_modules
+          key: modules-client-${{ hashFiles('package-lock.json') }}
+          restore-keys: npm-
       -
         name: Cache Dependencies
-        id: cache
+        id: cache-common
         uses: actions/cache@v3
         with:
-          path: ./node_modules
-          key: modules-${{ hashFiles('package-lock.json') }}
+          path: ./common/node_modules
+          key: modules-common-${{ hashFiles('package-lock.json') }}
+          restore-keys: npm-
+      -
+        name: Cache Dependencies
+        id: cache-server
+        uses: actions/cache@v3
+        with:
+          path: ./server/node_modules
+          key: modules-server-${{ hashFiles('package-lock.json') }}
           restore-keys: npm-
       -
         name: npm ci
-        run: npm ci
+        run: sh scripts/npm-ci.sh
       -
         name: Generate schemas and types
-        run: npm run generate
+        run: sh scripts/generate.sh
       -
         name: Lint Source Code
-        run: npm run lint
+        run: sh scripts/lint.sh
       -
         name: Lint Markdown
         run: |
+          cd client
           npm run doctoc
           git diff --exit-code
       -
         name: Lint Versions
-        run: npx @coralproject/package-version-lint
+        run: |
+          cd client
+          npx @coralproject/package-version-lint
       -
         name: Run Server Unit Tests
-        run: npm run test:server -- --ci --runInBand --reporters=default --reporters=jest-junit
+        run: cd server && npm run test:server -- --ci --runInBand --reporters=default --reporters=jest-junit
       -
         name: Run Client Stream Unit Tests
-        run: npm run test:client:stream -- --ci --runInBand --reporters=default --reporters=jest-junit
+        run: cd client && npm run test:client:stream -- --ci --runInBand --reporters=default --reporters=jest-junit
       -
         name: Run Client Admin Unit Tests
-        run: npm run test:client:admin -- --ci --runInBand --reporters=default --reporters=jest-junit
+        run: cd client && npm run test:client:admin -- --ci --runInBand --reporters=default --reporters=jest-junit
       -
         name: Run Client Other Unit Tests
-        run: npm run test:client:other -- --ci --runInBand --reporters=default --reporters=jest-junit
+        run: cd client && npm run test:client:other -- --ci --runInBand --reporters=default --reporters=jest-junit
       -
         name: Build
         env:
           NODE_OPTIONS: "--max-old-space-size=8192"
-        run: npm run build
+        run: sh scripts/build.sh
       -
         name: Verify Bundle Size
-        run: ./node_modules/.bin/bundlesize --enable-github-checks
+        run: cd client && ./node_modules/.bin/bundlesize --enable-github-checks
       -
         name: Verify Release Version
-        run: npx @coralproject/package-version-lint --expect ${RC_TAG/#v}
+        run: |
+          cd client
+          npx @coralproject/package-version-lint --expect ${RC_TAG/#v}
+          cd ../server
+          npx @coralproject/package-version-lint --expect ${RC_TAG/#v}
       -
         name: Create the Pre-Tag Names
         run: |

.gitignore

@@ -1,25 +1,8 @@
-# don't include the dependancies
-node_modules
-
-# don't include any logs
-npm-debug.log*
-
-# don't include any yarn files
-yarn-error.log
-yarn.lock
-
 # don't include any OS/editor files
 .env
 .idea/
 .vs
 .docz
 .next
 *.swp
-*.DS_STORE
-
-# don't include any generated files
-dist
-*.css.d.ts
-__generated__
-persisted-queries.json
-docs/out
+*.DS_STORE

.vscode/settings.json

@@ -3,12 +3,12 @@
     "*.css": "postcss"
   },
   "files.exclude": {
-    "**/.git": true,
-    "**/.svn": true,
-    "**/.hg": true,
-    "**/CVS": true,
+    ".vs": true,
     "**/.DS_Store": true,
-    ".vs": true
+    "**/.git": false,
+    "**/.hg": true,
+    "**/.svn": true,
+    "**/CVS": true
   },
   "tslint.enable": false,
   "eslint.validate": [
@@ -54,5 +54,10 @@
   "search.exclude": {
     "package-lock.json": true
   },
-  "debug.node.autoAttach": "off"
+  "debug.node.autoAttach": "off",
+  "eslint.workingDirectories": [
+    "./client/",
+    "./server/",
+    "./common/",
+  ]
 }

Dockerfile

@@ -28,10 +28,39 @@ USER node
 RUN git config --global url."https://github.com/".insteadOf ssh://[email protected]/ && \
     git config --global url."https://".insteadOf ssh://
 
-# Install build static assets and clear caches.
-RUN npm ci && \
+# Initialize sub packages
+RUN cd config && npm ci && \
+  cd ../common && npm ci && \
+  cd ../client && npm ci && \
+  cd ../server && npm ci && \
+  cd ..
+
+# Generate schema types for common/ to use
+RUN cd server && \
+  npm run generate && \
+  cd ..
+
+# Build config, prune static assets
+RUN cd config && \
+  npm run build && \
+  cd ..
+
+# Build common, prune static assets
+RUN cd common && \
+  npm run build && \
+  cd ..
+
+# Build client, prune static assets
+RUN cd client && \
+  npm run build && \
+  npm prune --production && \
+  cd ..
+
+# Install, build server, prune static assets
+RUN cd server && \
   npm run build && \
-  npm prune --production
+  npm prune --production && \
+  cd ..
 
 # Setup the environment
 ENV NODE_ENV production
@@ -40,4 +69,4 @@ EXPOSE 5000
 
 # Run the node process directly instead of using `npm run start`:
 # SEE: https://github.com/nodejs/docker-node/blob/a2eb9f80b0fd224503ee2678867096c9e19a51c2/docs/BestPractices.md#cmd
-CMD ["node", "dist/index.js"]
+CMD ["node", "server/dist/index.js"]

README.md

@@ -47,3 +47,13 @@ If you are interested in contributing to Coral, check out our [Contributor's Gui
 ## License
 
 Coral is [Apache-2.0 licensed](LICENSE).
+
+## Versioning
+
+If you're packaging a release of Coral, there is a convenient script to update the version numbers for all the child projects in the mono-repo.
+
+The below script will run `npm version x.y.z` against all the child repositories so you don't have to manually update them by hand!
+
+```
+sh scripts/version.sh MAJOR.MINOR.VERSION // i.e. 8.5.0
+```

build.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+
+sh scripts/build.sh

client/.gitignore

@@ -0,0 +1,25 @@
+# don't include the dependancies
+node_modules
+
+# don't include any logs
+npm-debug.log*
+
+# don't include any yarn files
+yarn-error.log
+yarn.lock
+
+# don't include any OS/editor files
+.env
+.idea/
+.vs
+.docz
+.next
+*.swp
+*.DS_STORE
+
+# don't include any generated files
+dist
+*.css.d.ts
+__generated__
+persisted-queries.json
+docs/out

client/babel.config.js

@@ -0,0 +1,37 @@
+/**
+ * This is a project wide babel configuration.
+ * https://babeljs.io/docs/en/config-files#project-wide-configuration
+ */
+
+// Note: If Webpack env is set, we are building for the client.
+
+const plugins =
+  process.env.WEBPACK === "true"
+    ? [
+        "use-lodash-es",
+        "lodash",
+        [
+          "@babel/plugin-transform-runtime",
+          {
+            absoluteRuntime: true,
+            corejs: 3,
+            helpers: true,
+            regenerator: true,
+            useESModules: true,
+            version: "^7.10.3",
+          },
+        ],
+      ]
+    : [];
+
+const environment =
+  process.env.WEBPACK === "true"
+    ? { modules: false }
+    : { targets: { node: "current" }, modules: "commonjs" };
+
+module.exports = {
+  babelrcRoots: ["./src/core/client/*", "../common/src/*"],
+  plugins,
+  presets: [["@babel/env", environment]],
+  sourceType: "unambiguous",
+};

client/config/jest.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  projects: ["<rootDir>/jest/client.config.js"],
+};