Merge branch 'main' into feat/calm-visualizer

markscott-ms · web-flow · commit 1a7d5faa2481 · 2025-11-10T10:10:07.000Z
diff --git a/.github/workflows/automated-release.yml b/.github/workflows/automated-release.yml
@@ -49,7 +49,7 @@ jobs:
           fetch-depth: 0
           token: ${{ secrets.GITHUB_TOKEN }}
 
-      - uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+      - uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
         with:
           node-version: 22
 
@@ -227,7 +227,7 @@ jobs:
           fetch-depth: 0
           token: ${{ secrets.SRB_TOKEN }}
 
-      - uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+      - uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
         with:
           node-version: 22
 
@@ -326,7 +326,7 @@ jobs:
           fetch-depth: 0
           token: ${{ secrets.GITHUB_TOKEN }}
 
-      - uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+      - uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
         with:
           node-version: 22
 
@@ -391,7 +391,7 @@ jobs:
           ref: main
 
       - name: Setup Node.js
-        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
         with:
           node-version: 22
 
diff --git a/.github/workflows/build-calm-hub-ui.yml b/.github/workflows/build-calm-hub-ui.yml
@@ -21,7 +21,7 @@ jobs:
               uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
 
             - name: Setup Node.js
-              uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+              uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
               with:
                   node-version: v22
 
diff --git a/.github/workflows/build-calm-models.yml b/.github/workflows/build-calm-models.yml
@@ -21,7 +21,7 @@ jobs:
               uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
 
             - name: Setup Node.js
-              uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+              uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
               with:
                   node-version: v22
 
diff --git a/.github/workflows/build-calm-widgets.yml b/.github/workflows/build-calm-widgets.yml
@@ -21,7 +21,7 @@ jobs:
               uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
 
             - name: Setup Node.js
-              uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+              uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
               with:
                   node-version: v22
 
diff --git a/.github/workflows/build-cli.yml b/.github/workflows/build-cli.yml
@@ -21,7 +21,7 @@ jobs:
               uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
 
             - name: Setup Node.js
-              uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+              uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
               with:
                   node-version: v22
 
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -21,7 +21,7 @@ jobs:
               uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
 
             - name: Setup Node.js
-              uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+              uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
               with:
                   node-version: v22
                   cache: npm
diff --git a/.github/workflows/build-shared.yml b/.github/workflows/build-shared.yml
@@ -21,7 +21,7 @@ jobs:
               uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
 
             - name: Setup Node.js
-              uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+              uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
               with:
                   node-version: v22
 
diff --git a/.github/workflows/build-vscode-extension.yml b/.github/workflows/build-vscode-extension.yml
@@ -28,7 +28,7 @@ jobs:
               uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
 
             - name: Setup Node.js
-              uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+              uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
               with:
                   node-version: v22
 
diff --git a/.github/workflows/cve-scanning-node.yml b/.github/workflows/cve-scanning-node.yml
@@ -35,7 +35,7 @@ jobs:
             - name: Checkout
               uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
             - name: Set up Node
-              uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+              uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
               with:
                   node-version: 22
             - name: Build project with NPM
diff --git a/.github/workflows/license-scanning-node.yml b/.github/workflows/license-scanning-node.yml
@@ -22,7 +22,7 @@ jobs:
         steps:
             - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
             - name: Use Node.js ${{ matrix.node-version }}
-              uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+              uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
               with:
                   node-version: ${{ matrix.node-version }}
             - run: npm install --omit=dev --ignore-scripts
diff --git a/.github/workflows/s3-docs-sync.yml b/.github/workflows/s3-docs-sync.yml
@@ -17,7 +17,7 @@ jobs:
             - name: Checkout repository
               uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
 
-            - uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+            - uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
               with:
                   node-version: 22
 
diff --git a/.github/workflows/validate-renovate.yml b/.github/workflows/validate-renovate.yml
@@ -27,7 +27,7 @@ jobs:
           fetch-depth: 0
         
       - name: Setup Node.js
-        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
         with:
           node-version: '22'
           cache: 'npm'
diff --git a/.github/workflows/validate-spectral.yml b/.github/workflows/validate-spectral.yml
@@ -30,7 +30,7 @@ jobs:
             - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
 
             # Run Spectral
-            - uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+            - uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
               with:
                   node-version: v22
 
diff --git a/Governance.md b/Governance.md
@@ -0,0 +1,44 @@
+# Architecture as Code Governance Policies
+
+This document describes the governance policies of the FINOS Architecture as Code project. The project is also governed by the [Linux Foundation Antitrust Policy](https://www.linuxfoundation.org/antitrust-policy/), and the FINOS [IP Policy]( https://community.finos.org/governance-docs/IP-policy.pdf), [Code of Conduct](https://community.finos.org/docs/governance/code-of-conduct), [Collaborative Principles](https://community.finos.org/docs/governance/collaborative-principles/), and [Meeting Procedures](https://community.finos.org/docs/governance/meeting-procedures/).
+
+## Governance
+
+### Roles
+
+The project community consists of Contributors and Maintainers:
+* A **Contributor** is anyone who submits a contribution to the project. (Contributions may include code, issues, comments, documentation, media, or any combination of the above.)
+* A **Maintainer** is a Contributor who, by virtue of their contribution history, has been given write access to project repositories and may merge approved contributions.
+* The **Lead Maintainer** is the project's interface with the FINOS team and Board. They are responsible for approving [quarterly project reports](https://community.finos.org/docs/governance/#project-governing-board-reporting) and communicating on behalf of the project. The Lead Maintainer is elected by a vote of the Maintainers. 
+
+### Contribution Rules
+
+Anyone is welcome to submit a contribution to the project. The rules below apply to all contributions. (The key words "MUST", "SHALL", "SHOULD", "MAY", etc. in this document are to be interpreted as described in [IETF RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).)
+
+* All contributions MUST be submitted as pull requests, including contributions by Maintainers.
+* All pull requests SHOULD be reviewed by a Maintainer (other than the Contributor) before being merged.
+* Pull requests for non-trivial contributions SHOULD remain open for a review period sufficient to give all Maintainers a sufficient opportunity to review and comment on them.
+* After the review period, if no Maintainer has an objection to the pull request, any Maintainer MAY merge it.
+* If any Maintainer objects to a pull request, the Maintainers SHOULD try to come to consensus through discussion. If no consensus can be reached, any Maintainer MAY call for a vote on the contribution.
+
+### Maintainer Voting
+
+The Maintainers MAY hold votes only when they are unable to reach consensus on an issue. Any Maintainer MAY call a vote on a contested issue, after which Maintainers SHALL have 36 hours to register their votes. Votes SHALL take the form of "+1" (agree), "-1" (disagree), "+0" (abstain). Issues SHALL be decided by the majority of votes cast. If there is only one Maintainer, they SHALL decide any issue otherwise requiring a Maintainer vote. If a vote is tied, the Lead Maintainer MAY cast an additional tie-breaker vote.
+
+The Maintainers SHALL decide the following matters by consensus or, if necessary, a vote:
+* Contested pull requests
+* Election and removal of the Lead Maintainer
+* Election and removal of Maintainers
+
+All Maintainer votes MUST be carried out transparently, with all discussion and voting occurring in public, either:
+* in comments associated with the relevant issue or pull request, if applicable;
+* on the project mailing list or other official public communication channel; or
+* during a regular, minuted project meeting.
+
+### Maintainer Qualifications
+
+Any Contributor who has made a substantial contribution to the project MAY apply (or be nominated) to become a Maintainer. The existing Maintainers SHALL decide whether to approve the nomination according to the Maintainer Voting process above.
+
+### Changes to this Document
+
+This document MAY be amended by a vote of the Maintainers according to the Maintainer Voting process above.
diff --git a/shared/src/document-loader/calmhub-document-loader.spec.ts b/shared/src/document-loader/calmhub-document-loader.spec.ts
@@ -1,25 +1,28 @@
 import axios from 'axios';
 import AxiosMockAdapter from 'axios-mock-adapter';
 import { CalmHubDocumentLoader } from './calmhub-document-loader';
+import { SchemaDirectory } from '../schema-directory';
 
 const calmHubBaseUrl = 'http://local-calmhub';
 
 const ax = axios.create({ baseURL: calmHubBaseUrl });
 const mock = new AxiosMockAdapter(ax);
 
-mock.onGet('/calm/schemas/2025-03/meta/core.json').reply(200, {
+mock.onGet('/schemas/2025-03/meta/core.json').reply(200, {
     '$id': 'https://calm.finos.org/calm/schemas/2025-03/meta/core.json',
     'value': 'test'
 });
 
 describe('calmhub-document-loader', () => {
-    let calmHubDocumentLoader;
+    let calmHubDocumentLoader: CalmHubDocumentLoader;
+    let schemaDirectory: SchemaDirectory;
     beforeEach(() => {
         calmHubDocumentLoader = new CalmHubDocumentLoader(calmHubBaseUrl, false, ax);
+        calmHubDocumentLoader.initialise(schemaDirectory);
     });
 
     it('loads a document from CalmHub', async () => {
-        const calmHubUrl = 'https://calm.finos.org/calm/schemas/2025-03/meta/core.json';
+        const calmHubUrl = 'calm:/schemas/2025-03/meta/core.json';
         const document = await calmHubDocumentLoader.loadMissingDocument(calmHubUrl, 'schema');
         expect(document).toEqual({
             '$id': 'https://calm.finos.org/calm/schemas/2025-03/meta/core.json',
@@ -28,7 +31,13 @@ describe('calmhub-document-loader', () => {
     });
 
     it('throws an error when the document is not found', async () => {
-        const calmHubUrl = 'https://calm.finos.org/calm/schemas/2025-03/meta/nonexistent.json';
+        const calmHubUrl = 'calm:/schemas/2025-03/meta/nonexistent.json';
+
+        await expect(calmHubDocumentLoader.loadMissingDocument(calmHubUrl, 'schema')).rejects.toThrow();
+    });
+
+    it('throws an error when the protocol is not calm:', async () => {
+        const calmHubUrl = 'https://not.calmhub.com/schemas/2025-03/meta/nonexistent.json';
 
         await expect(calmHubDocumentLoader.loadMissingDocument(calmHubUrl, 'schema')).rejects.toThrow();
     });
diff --git a/shared/src/document-loader/calmhub-document-loader.ts b/shared/src/document-loader/calmhub-document-loader.ts
@@ -1,6 +1,6 @@
 import axios, { Axios } from 'axios';
 import { SchemaDirectory } from '../schema-directory';
-import { CalmDocumentType, DocumentLoader } from './document-loader';
+import { CalmDocumentType, DocumentLoader, CALM_HUB_PROTO } from './document-loader';
 import { initLogger, Logger } from '../logger';
 
 export class CalmHubDocumentLoader implements DocumentLoader {
@@ -47,6 +47,10 @@ export class CalmHubDocumentLoader implements DocumentLoader {
 
     async loadMissingDocument(documentId: string, _: CalmDocumentType): Promise<object> {
         const url = new URL(documentId);
+        const protocol = url.protocol;
+        if (protocol !== CALM_HUB_PROTO) {
+            throw new Error(`CalmHubDocumentLoader only loads documents with protocol '${CALM_HUB_PROTO}'. (Requested: ${protocol})`);
+        }
         const path = url.pathname;
 
         this.logger.debug(`Loading CALM schema from ${this.calmHubUrl}${path}`);
diff --git a/shared/src/document-loader/document-loader.spec.ts b/shared/src/document-loader/document-loader.spec.ts
@@ -33,26 +33,24 @@ describe('DocumentLoader', () => {
         vi.resetModules();
     });
 
-    it('should create a FileSystemDocumentLoader when loadMode is "filesystem"', () => {
+    it('should create a FileSystemDocumentLoader', () => {
 
         const docLoaderOpts: DocumentLoaderOptions = {
-            loadMode: 'filesystem',
             schemaDirectoryPath: 'schemas'
         };
 
-        buildDocumentLoader(docLoaderOpts, false);
+        buildDocumentLoader(docLoaderOpts);
 
         expect(mocks.fsDocLoader).toHaveBeenCalledWith([CALM_META_SCHEMA_DIRECTORY, 'schemas'], false);
     });
 
-    it('should create a CalmHubDocumentLoader when loadMode is "calmhub"', () => {
+    it('should create a CalmHubDocumentLoader when calmHubUrl is defined in loader options', () => {
 
         const docLoaderOpts: DocumentLoaderOptions = {
-            loadMode: 'calmhub',
             calmHubUrl: 'https://example.com'
         };
 
-        buildDocumentLoader(docLoaderOpts, false);
+        buildDocumentLoader(docLoaderOpts);
 
         expect(mocks.calmHubDocLoader).toHaveBeenCalledWith('https://example.com', false);
     });
diff --git a/shared/src/document-loader/document-loader.ts b/shared/src/document-loader/document-loader.ts
@@ -7,6 +7,8 @@ import { MultiStrategyDocumentLoader } from './multi-strategy-document-loader';
 
 export type CalmDocumentType = 'architecture' | 'pattern' | 'schema';
 
+export const CALM_HUB_PROTO = 'calm:';
+
 export interface DocumentLoader {
     initialise(schemaDirectory: SchemaDirectory): Promise<void>;
     loadMissingDocument(documentId: string, type: CalmDocumentType): Promise<object>;
