From 22f0307b440ddd5ac668220cb90c83e3ef5cbc88 Mon Sep 17 00:00:00 2001 From: Hugh Nimmo-Smith Date: Thu, 2 Nov 2023 10:56:40 +0000 Subject: [PATCH] Package and publish syn2mas to npm (#2023) Co-authored-by: Quentin Gliech --- .github/workflows/build.yaml | 28 ++++- tools/syn2mas/Dockerfile | 46 ++++++--- tools/syn2mas/LICENSE | 177 ++++++++++++++++++++++++++++++++ tools/syn2mas/README.md | 2 +- tools/syn2mas/package-lock.json | 7 +- tools/syn2mas/package.json | 17 ++- tools/syn2mas/src/index.ts | 1 + 7 files changed, 260 insertions(+), 18 deletions(-) create mode 100644 tools/syn2mas/LICENSE diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index cfbc9bdea..17ae526b4 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -251,6 +251,31 @@ jobs: "${{ env.IMAGE }}@${{ fromJSON(steps.bake.outputs.metadata).regular['containerimage.digest'] }}" \ "${{ env.IMAGE }}@${{ fromJSON(steps.bake.outputs.metadata).debug['containerimage.digest'] }}" \ "${{ env.IMAGE_SYN2MAS }}@${{ fromJSON(steps.bake.outputs.metadata).syn2mas['containerimage.digest'] }}" + + + syn2mas: + name: Release syn2mas on NPM + runs-on: ubuntu-latest + steps: + - name: Checkout the code + uses: actions/checkout@v4.1.0 + + - name: Install Node + uses: actions/setup-node@v3.8.1 + with: + node-version-file: ./tools/syn2mas/.nvmrc + + - name: Install Node dependencies + working-directory: ./tools/syn2mas + run: npm ci + + - name: Publish + uses: JS-DevTools/npm-publish@v3 + with: + package: ./tools/syn2mas + token: ${{ secrets.NPM_TOKEN }} + provenance: true + dry-run: ${{ !startsWith(github.ref, 'refs/tags/') }} release: @@ -260,6 +285,7 @@ jobs: needs: - build-binaries - build-image + - syn2mas steps: - name: Download the artifacts from the previous job uses: actions/download-artifact@v3 @@ -334,4 +360,4 @@ jobs: mas-cli-aarch64-macos.tar.gz mas-cli-x86_64-linux.tar.gz mas-cli-x86_64-macos.tar.gz - draft: true \ No newline at end of file + draft: true diff --git a/tools/syn2mas/Dockerfile b/tools/syn2mas/Dockerfile index c229f5957..ce27e4312 100644 --- a/tools/syn2mas/Dockerfile +++ b/tools/syn2mas/Dockerfile @@ -1,28 +1,48 @@ # Build Node.js app -FROM --platform=${BUILDPLATFORM} node:18-alpine AS builder +FROM --platform=${BUILDPLATFORM} docker.io/library/node:18-bookworm AS builder WORKDIR /syn2mas -COPY ./package.json ./package-lock.json ./ +COPY ./package.json ./package-lock.json ./tsconfig.json ./ +COPY ./src ./src RUN --network=default \ npm ci -COPY ./tsconfig.json ./ -COPY ./src ./src/ +# Install the production dependencies for each architecture we support +FROM --platform=${BUILDPLATFORM} docker.io/library/node:18-bookworm AS deps -RUN --network=none \ - npm run build - -# Put together a runtime image -FROM --platform=${BUILDPLATFORM} node:18-alpine - -WORKDIR /syn2mas +WORKDIR /deps/arm64 COPY ./package.json ./package-lock.json ./ +# Remove the "prepare" script to avoid compiling typescript +RUN sed -i '/"prepare"/d' package.json RUN --network=default \ - npm ci --omit=dev + npm ci \ + --target_arch=amd64 \ + --target_platform=linux \ + --omit=dev +WORKDIR /deps/amd64 + +COPY ./package.json ./package-lock.json ./ +# Remove the "prepare" script to avoid compiling typescript +RUN sed -i '/"prepare"/d' package.json +RUN --network=default \ + npm ci \ + --target_arch=x64 \ + --target_platform=linux \ + --omit=dev + + +# Runtime stage +FROM --platform=${TARGETPLATFORM} gcr.io/distroless/nodejs18-debian12:debug-nonroot + +WORKDIR /syn2mas +COPY ./package.json ./package-lock.json ./ COPY --from=builder /syn2mas/dist ./dist -ENTRYPOINT ["node", "dist/index.js"] +ARG TARGETARCH +COPY --from=deps /deps/${TARGETARCH}/node_modules ./node_modules + +ENTRYPOINT ["/nodejs/bin/node", "dist/index.js"] diff --git a/tools/syn2mas/LICENSE b/tools/syn2mas/LICENSE new file mode 100644 index 000000000..f433b1a53 --- /dev/null +++ b/tools/syn2mas/LICENSE @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/tools/syn2mas/README.md b/tools/syn2mas/README.md index f10d8af9a..68facd62e 100644 --- a/tools/syn2mas/README.md +++ b/tools/syn2mas/README.md @@ -12,5 +12,5 @@ The tool has two modes of operation: Pre-migration advisor: ```sh -npm run dev -- advisor --synapseConfigFile homeserver.yaml +npx @matrix-org/syn2mas --command=advisor --synapseConfigFile homeserver.yaml ``` diff --git a/tools/syn2mas/package-lock.json b/tools/syn2mas/package-lock.json index a54c4a761..ec3dd86dc 100644 --- a/tools/syn2mas/package-lock.json +++ b/tools/syn2mas/package-lock.json @@ -1,11 +1,11 @@ { - "name": "syn2mas", + "name": "@matrix-org/syn2mas", "version": "0.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "syn2mas", + "name": "@matrix-org/syn2mas", "version": "0.0.0", "license": "Apache-2.0", "dependencies": { @@ -19,6 +19,9 @@ "yaml": "^2.3.3", "zod": "^3.22.4" }, + "bin": { + "syn2mas": "dist/index.js" + }, "devDependencies": { "@tsconfig/node18": "^18.2.2", "@tsconfig/strictest": "^2.0.2", diff --git a/tools/syn2mas/package.json b/tools/syn2mas/package.json index ba4140360..154c86738 100644 --- a/tools/syn2mas/package.json +++ b/tools/syn2mas/package.json @@ -1,10 +1,25 @@ { - "name": "syn2mas", + "name": "@matrix-org/syn2mas", "version": "0.0.0", + "description": "A tool to migrate Synapse users and sessions to the Matrix Authentication Service", "license": "Apache-2.0", "author": "Matrix.org", "type": "module", + "bin": { + "syn2mas": "dist/index.js" + }, + "files": [ + "src", + "dist", + "package.json", + "LICENSE", + "README.md" + ], + "publishConfig": { + "access": "public" + }, "scripts": { + "prepare": "npm run build", "build": "tsc", "dev": "ts-node --esm src/index.ts", "lint": "npm run lint:types && npm run lint:style", diff --git a/tools/syn2mas/src/index.ts b/tools/syn2mas/src/index.ts index 62ad00fd9..e0e1b8af6 100644 --- a/tools/syn2mas/src/index.ts +++ b/tools/syn2mas/src/index.ts @@ -1,3 +1,4 @@ +#!/usr/bin/env node // Copyright 2023 The Matrix.org Foundation C.I.C. // // Licensed under the Apache License, Version 2.0 (the "License");