Merge pull request #1309 from finos/fdc3-for-web-impl

FDC3 For Web Browsers Implementation

Author: kriswest

.github/workflows/base-coverage.yml

@@ -0,0 +1,31 @@
+name: Test coverage for main branch
+
+on:
+  push:
+    branches:
+      - main
+      - fdc3-for-web-impl
+
+jobs:
+  test_and_upload_coverage:
+    runs-on: ubuntu-latest
+    name: Test and upload coverage
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.ref }}
+          fetch-depth: 1000
+
+      - name: Run tests
+        run: |
+          npm i
+          npm run test
+          npm run merge
+          npm run report
+
+      - name: Upload coverage artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-coverage-output
+          path: nyc-coverage-report

.github/workflows/coverage.yml

@@ -0,0 +1,69 @@
+name: Node.js CI Tests and Coverage
+
+# Controls when the workflow will run on any branch
+on:
+  pull_request:
+
+# Allows Coverage to be written back as a PR comment
+permissions: 
+  pull-requests: write
+
+# Define the jobs for this workflow
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+      with:
+        ref: ${{ github.event.pull_request.head.sha }}
+        fetch-depth: 1000
+
+    - name: Fetch base
+      run: git fetch origin ${{ github.event.pull_request.base.ref }} --depth=1000
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: 20.x
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Run tests
+      run: npm run test
+
+    - name: Merge Results
+      run: npm run merge
+
+    - name: Create Report
+      run: npm run report
+
+    - name: Create test summary
+      uses: test-summary/action@dist
+      with:
+        paths: "**/test-results.xml"
+        show: "fail, skip"
+        output: test-summary.md
+      if: always()
+
+    - name: PR comment with file
+      uses: thollander/actions-comment-pull-request@v3
+      with:
+        file-path: test-summary.md
+
+    - name: Download previous coverage
+      uses: dawidd6/action-download-artifact@v7
+      with:
+        workflow: base-coverage.yml
+        name: 'test-coverage-output'
+        path: base-artifacts
+        search_artifacts: true
+
+    - name: Report Coverage
+      uses: sidx1024/[email protected]
+      with:
+        coverage_file: "nyc-coverage-report/coverage-summary.json"
+        base_coverage_file: "base-artifacts/coverage-summary.json"
+

.github/workflows/cve-scanning.yml

@@ -45,10 +45,6 @@ jobs:
 
       - run: npx --yes auditjs ossi --whitelist allow-list.json
         if: success() || failure()
-
-      - run: npx --yes auditjs ossi --whitelist ../../allow-list.json
-        working-directory: toolbox/fdc3-workbench
-        if: success() || failure()
 
       - run: npx --yes auditjs ossi --whitelist ../allow-list.json
         working-directory: website

.gitignore

@@ -13,9 +13,16 @@ website/build/
 website/static/toolbox
 website/node_modules
 website/i18n/*
-website/package-lock.json
-website/.docusaurus/**
+website/.docusaurus/
+website/static/schemas/next/*
+website/static/ui
+test-results.xml
+
 
 .idea/
 *.iml
-website/.yarn
+website/.yarn
+.nyc_output
+toolbox/fdc3-for-web/fdc3-web-impl/generated/
+cucumber-report.html
+nyc-coverage-report/

.husky/pre-commit

@@ -0,0 +1,2 @@
+#!/bin/sh
+npx lint-staged

.npmrc

@@ -0,0 +1,4 @@
+# Omit the registry url which can be an organization's internal npm mirror when generating package-lock.json file
+# see: https://github.com/npm/cli/pull/4874
+# and https://docs.npmjs.com/cli/v8/using-npm/config#omit-lockfile-registry-resolved
+omit-lockfile-registry-resolved = true

.prettierignore

@@ -9,3 +9,7 @@
 website
 dist
 src/app-directory/*/target
+node_modules
+coverage
+.nyc_output
+build

.semgrepignore

@@ -2,7 +2,10 @@ website/**
 
 # Just used for build so ignoring
 s2tQuicktypeUtil.js
-schemas/api/t2sQuicktypeUtil.js
+t2sQuicktypeUtil.js
 
 # API schema set for localhost gets picked up by semgrep rule
-schemas/bridgingAsyncAPI/bridgingAsyncAPI.json 
+schemas/bridgingAsyncAPI/bridgingAsyncAPI.json
+
+# demo apps get picked up for not having integrity headers
+toolbox/fdc3-for-web/demo/src/client/apps/**

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "typescript.tsdk": "node_modules/typescript/lib"
+}

CHANGELOG.md

@@ -22,7 +22,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Added utility functions `isStandardContextType(contextType: string)`, `isStandardIntent(intent: string)`,`getPossibleContextsForIntent(intent: StandardIntent)`. ([#1139](https://github.com/finos/FDC3/pull/1139))
 * Added support for event listening outside of intent or context listnener. Added new function `addEventListener`, type `EventHandler`,  enum `FDC3EventType` and interfaces `FDC3Event` and `FDC3ChannelChangedEvent`. ([#1207](https://github.com/finos/FDC3/pull/1207))
 * Added new `CreateOrUpdateProfile` intent. ([#1359](https://github.com/finos/FDC3/pull/1359))
-* Added conformance tests into the FDC3 API documentation in the current version and backported into 2.0 and 2.1. Removed outdated 1.2 conformance tests (which are preserved in the older 2.0 and 2.1 versions). ([#1417](https://github.com/finos/FDC3/pull/1417)).
+* Added conformance tests into the FDC3 API documentation in the current version and backported into 2.0 and 2.1. Removed outdated 1.2 conformance tests (which are preserved in the older 2.0 and 2.1 versions). ([#1417](https://github.com/finos/FDC3/pull/1417))
+* Added separate `fdc3-commonjs` module for compatibility with older projects that use CommonJS. ([#1452](https://github.com/finos/FDC3/pull/1452))
+* Added testing policy to [Contributing](CONTRIBUTING) page to address ([810](https://github.com/finos/FDC3/issues/810))
+* Added the ability to control logging to the JS console from getAgent() and the DesktopAgentProxy via arguments to getAgent(). ([#1495](https://github.com/finos/FDC3/pull/1495))
+* Added the ability for a browser-based DesktopAgent to control the timeouts used in the DesktopAgentProxy when making calls to it, via properties in WCP3Handshake message. ([#1497](https://github.com/finos/FDC3/pull/1497))
+
 
 ### Changed
 
@@ -33,6 +38,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * FDC3 apps are now encouraged to instantiate their FDC3 interface (DesktopAgent) using the `getAgent()` function provided by the `@finos/fdc3` module. This will allow apps to interoperate in either traditional Preload DAs (i.e. Electron) as well as the new Browser-Resident DAs. ([#1191](https://github.com/finos/FDC3/pull/1191))
 * `ContextType` and `Intent` (`string`) types were created for use in DesktopAgent API signatures - they are unions of standardized values and `string`, enabling autocomplete/IntelliSense in IDEs when working with the FDC3 API. ([#1139](https://github.com/finos/FDC3/pull/1139))
 * SessionStorage use by `getAgent` was updated to scope the stored data by `window.name` and the app's `identityUrl`. ([#1442](https://github.com/finos/FDC3/pull/1442))
+* FDC3 Workbench updated to use `getAgent()` rather than `fdc3Ready()`
 
 ### Deprecated