WIP of syn2mas tool

.github/dependabot.yml

@@ -59,3 +59,8 @@ updates:
  graphql-codegen:
  patterns:
  - "@graphql-codegen/*"
+
+ - package-ecosystem: "npm"
+ directory: "/tools/syn2mas/"
+ schedule:
+ interval: "weekly"

.github/workflows/build.yaml

@@ -2,8 +2,12 @@ name: Build
 on:
  push:
  branches: [ main ]
+ paths-ignore: 
+ - 'tools/**'
  pull_request:
  branches: [ main ]
+ paths-ignore: 
+ - 'tools/**'
 
 concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}

.github/workflows/ci.yaml

@@ -3,8 +3,12 @@ name: CI
 on:
  push:
  branches: [ main ]
+ paths-ignore: 
+ - 'tools/**'
  pull_request:
  branches: [ main ]
+ paths-ignore: 
+ - 'tools/**'
 
 concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}

.github/workflows/coverage.yaml

@@ -3,8 +3,12 @@ name: Coverage
 on:
  push:
  branches: [ main ]
+ paths-ignore: 
+ - 'tools/**'
  pull_request:
  branches: [ main ]
+ paths-ignore: 
+ - 'tools/**'
 
 concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}

.github/workflows/docs.yaml

@@ -3,8 +3,12 @@ name: Build and deploy the documentation
 on:
  push:
  branches: [ main ]
+ paths-ignore: 
+ - 'tools/**'
  pull_request:
  branches: [ main ]
+ paths-ignore: 
+ - 'tools/**'
 
 concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}

.github/workflows/tools.yaml

@@ -0,0 +1,50 @@
+name: CI for tools
+
+on:
+ push:
+ paths: 
+ - 'tools/**'
+ pull_request:
+ paths:
+ - 'tools/**'
+
+concurrency:
+ group: tools-${{ github.workflow }}-${{ github.ref }}
+ cancel-in-progress: true
+
+jobs:
+ syn2mas-lint:
+ name: Check syn2mas style
+ runs-on: ubuntu-latest
+
+ permissions:
+ contents: read
+
+ steps:
+ - name: Checkout the code
+ uses: actions/checkout@v3.5.3
+
+ - name: Install Node
+ uses: actions/setup-node@v3.7.0
+ with:
+ node-version-file: ./tools/syn2mas/.nvmrc
+
+ - name: Install Node dependencies
+ working-directory: ./tools/syn2mas
+ run: npm ci
+
+ - name: Lint
+ working-directory: ./tools/syn2mas
+ run: npm run lint
+
+ tests-done:
+ name: Tests done
+ if: ${{ always() }}
+ needs:
+ - syn2mas-lint
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: matrix-org/done-action@v2
+ with:
+ needs: ${{ toJSON(needs) }}

tools/syn2mas/.eslintrc.cjs

@@ -0,0 +1,22 @@
+module.exports = {
+ plugins: [
+ 'matrix-org',
+ ],
+ extends: [
+ 'plugin:matrix-org/typescript',
+ ],
+ env: {
+ browser: false,
+ node: true,
+ },
+ parser: '@typescript-eslint/parser',
+ parserOptions: {
+ project: "./tsconfig.json",
+ },
+ rules: {
+ '@typescript-eslint/no-floating-promises': 'error',
+ '@typescript-eslint/no-misused-promises': 'error',
+ '@typescript-eslint/promise-function-async': 'error',
+ '@typescript-eslint/await-thenable': 'error',
+ },
+};

tools/syn2mas/.gitignore

@@ -0,0 +1,2 @@
+node_modules
+dist

tools/syn2mas/.nvmrc

@@ -0,0 +1 @@
+18

tools/syn2mas/README.md

@@ -0,0 +1,16 @@
+# syn2mas - Synapse to Matrix Authentication Service
+
+Tool to help with the migration of a Matrix Synapse installation to the Matrix Authentication Service.
+
+The tool has two modes of operation:
+
+- Advisor mode: Analyses the Synapse configuration and reports on any issues that would prevent a successful migration.
+- Migration mode: Performs the migration of the Synapse database into the Matrix Authentication Service database.
+
+## Usage
+
+Pre-migration advisor:
+
+```sh
+npm run dev -- advisor --synapseConfigFile homeserver.yaml
+```