Release/1.9.2

.github/workflows/test.yml → .github/workflows/ci.yml

@@ -1,23 +1,25 @@
-name: Open Pryv.io tests
+name: Open Pryv.io CI
 
-on: 
+on:
   pull_request:
     branches:
-      - master
+      - '*'
   push:
     branches:
       - master
 
 jobs:
   build:
-
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     strategy:
       matrix:
-        node-version: [16.4.1]
+        node-version: [18.16.0]
 
     steps:
+    - name: Install `just`
+      uses: extractions/setup-just@v1
+
     - name: Checkout repository with submodules
       uses: actions/checkout@v2
       with:
@@ -31,45 +33,28 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
 
-    # mainly used so that next step does not fail on "git clone git@github.com:pryv/open-pryv.io.git dest"
-    - name: Download Open Pryv.io repository in dest/
-      uses: actions/checkout@v2
-      with:
-        repository: pryv/open-pryv.io
-        path: dest
-        clean: false
-
-    # there is one private package (lib-reporting) used as npm package, so we need 
+    # there is one private package (lib-reporting) used as npm package, so we need
     # to authenticate
     - name: Login to github
       uses: webfactory/ssh-agent@v0.4.1
       with:
         ssh-private-key: ${{ secrets.TECH_PRYV_SSH_KEY }}
 
     - name: Setup opener
-      run: |
-        yarn setup
-        yarn install
+      run: just setup
 
-    - name: Generate Open Pryv.io
-      run: yarn build
+    - name: Build
+      run: just build
 
     - name: Setup Open Pryv.io
       working-directory: dest
       run: |
-        yarn setup
-        yarn release
-
-    # to remove when we remove components/previews-server
-    - name: Setup package for previews
-      working-directory: dest
-      run: sudo apt-get install graphicsmagick
-
-    - name: start MongoDB
-      working-directory: dest
-      run: yarn database
+        ./scripts/setup-dev-env
+        sudo apt-get install graphicsmagick
+        just install-stable
+        IS_CI=true ./scripts/start-mongo
 
     - name: Run tests on Open Pryv.io
       working-directory: dest
       run: |
-        IS_CI=true  yarn test
+        IS_CI=true just test all

.gitignore

@@ -8,3 +8,4 @@ nbproject/
 *.log
 # Pycharm IDE
 .idea/
+.DS_Store

.licenser.yml

@@ -0,0 +1,86 @@
+files:
+  "**/*.js":
+    header:
+      startBlock: |
+        /**
+         * @license
+      linePrefix: " * "
+      endBlock: " */"
+
+  "**/package.json":
+    json:
+      force:
+        author: "{AUTHOR_NAME} <{AUTHOR_EMAIL}> ({AUTHOR_WEB})"
+        license: "{SPDX}"
+        private: true
+      defaults:
+        homepage: "{HOMEPAGE}"
+        description: "{DESCRIPTION}"
+      sortPackage: true
+
+    siblingLicenseFile:
+      name: "LICENSE"
+      license: |
+        Copyright (C) {YEARS} {AUTHOR_NAME} {AUTHOR_WEB} 
+
+        This file is part of Open-Pryv.io and released under BSD-Clause-3 License
+
+        Redistribution and use in source and binary forms, with or without 
+        modification, are permitted provided that the following conditions are met:
+
+        1. Redistributions of source code must retain the above copyright notice, 
+          this list of conditions and the following disclaimer.
+
+        2. Redistributions in binary form must reproduce the above copyright notice, 
+          this list of conditions and the following disclaimer in the documentation 
+          and/or other materials provided with the distribution.
+
+        3. Neither the name of the copyright holder nor the names of its contributors 
+          may be used to endorse or promote products derived from this software 
+          without specific prior written permission.
+
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+        SPDX-License-Identifier: BSD-3-Clause
+
+  "**/README.md":
+    footer:
+      startBlock: "\n\n## License\n\n"
+      linePrefix: ""
+      endBlock: ""
+      license: "[{SPDX}](LICENSE)"
+
+ignore:
+- .git
+- .vscode
+- coverage
+- node_modules
+- dest
+- service-core
+- service-mail
+- service-register
+
+license: |
+  Copyright (C) {AUTHOR_NAME} {AUTHOR_WEB} 
+  This file is part of Pryv.io and released under BSD-Clause-3 License
+  Refer to LICENSE file
+
+substitutions:
+  YEARS:
+    start: 2019
+    end: CURRENT_YEAR
+  AUTHOR_NAME: "Pryv"
+  AUTHOR_EMAIL: info@pryv.com
+  AUTHOR_WEB: https://pryv.com
+  DESCRIPTION: "This package is part of Pryv.io, a Pryv software"
+  HOMEPAGE: https://pryv.com
+  SPDX: BSD-3-Clause

src/licensing/LICENSE → LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2020 Pryv S.A. https://pryv.com
+Copyright (C) 2019–2025 Pryv https://pryv.com 
 
 This file is part of Open-Pryv.io and released under BSD-Clause-3 License
 
 Redistribution and use in source and binary forms, with or without 
 modification, are permitted provided that the following conditions are met:
 
 1. Redistributions of source code must retain the above copyright notice, 
-   this list of conditions and the following disclaimer.
+  this list of conditions and the following disclaimer.
 
 2. Redistributions in binary form must reproduce the above copyright notice, 
-   this list of conditions and the following disclaimer in the documentation 
-   and/or other materials provided with the distribution.
+  this list of conditions and the following disclaimer in the documentation 
+  and/or other materials provided with the distribution.
 
 3. Neither the name of the copyright holder nor the names of its contributors 
-   may be used to endorse or promote products derived from this software 
-   without specific prior written permission.
+  may be used to endorse or promote products derived from this software 
+  without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 

README.md

@@ -1,13 +1,13 @@
 # Pryv.io Opener
 
-Script that releases the open source version of Pryv.io.
-
+Script that releases the open-pryv.io a strip down version of service-core, service-mail and service-register.
+As of february 2025 All Pryv.io software has been open-sourced. 
 
 ## Usage
 
-1. Fetch git dependencies: `yarn setup`
-2. Fetch node dependencies: `yarn`
-3. Generate open-source release: `yarn build` this step also licenses code with: `yarn license`
+1. Fetch git dependencies: `just setup`
+2. Fetch node dependencies: `just install`
+3. Generate open-source release: `just build`
 4. Verify the release in `./dest`
 
 ### Update git dependencies
@@ -20,46 +20,19 @@ For one or more of `service-core`, `service-register`, `service-mail`:
 4. `cd ..`
 5. git add, commit and push
 
+## Publishing 
 
-## License
-
-License settings and script are located in [`licenser/`](licenser/).
-
-
-## Helpers for developpment
-
-1. In `dest/` run `yarn setup`, `yarn release`, `yarn watch`
-2. `dest/dist/components/register` or other component you need to test
-  - `pushd {your path}/dev-pryv.io-opener/ ; yarn build ; popd ; ../../node_modules/.bin/mocha  'test/**/*.test.js'`
-3. to start api-server cd to `dest` and use `cd ../ ; yarn build; cd dest; sleep 2 ; yarn api`
-  or: `cd ../ ; yarn build; cd dest; sleep 2 ; dist/components/api-server/bin/server --config ./config.yml`
-
-
-## Design
+As per 1.9.0 integrated release has been removed. Github script `release-orig.yml` has been kept for reference.
 
-### service-core
+Publish docker containers: 
+- build the containers from `dest/docker`
+- build the tarball with the confing with `build_tarball.sh`
+- publish the containers `docker push "pryvio/open-pryv.io-api:{TAG}` & `docker push "pryvio/open-pryv.io-mail:{TAG}`
+- Commit the content of `dest`
+- Publish on github: push `dest` content 
 
-Changes made on **service-core** legacy code base to make it openable
 
-#### Integration of register as a component (used if DNSLESS = true)
 
-- Added `/reg` route in `routes/Path.js`
-- Module is loaded directly from `server.js` with `expressApp` and `applications` parameters
-
-### service-regiser
-
-Changes made on **service-core** legacy code base to make it openable
-
-This task had a very small impact on the code of register as the **node-app-opener** was able to strip out the necessary code.
-
-Note the **striping comments** in `routes/admin.js` and `routes/user.js` that are used to remove parts of the code during build process of the open version.
-
-Example:
-
-The code between `// START - CLEAN ...` and `// END - CLEAN ...` will be removed
+## License
 
-```javascript
-// START - CLEAN FOR OPENSOURCE
-const invitationToken = require('../storage/invitations');
-// END - CLEAN FOR OPENSOURCE
-```
+[BSD-3-Clause](LICENSE)

src/index.js → build/index.js

@@ -1,8 +1,14 @@
+/**
+ * @license
+ * Copyright (C) Pryv https://pryv.com
+ * This file is part of Pryv.io and released under BSD-Clause-3 License
+ * Refer to LICENSE file
+ */
 const serviceCore = require('./service-core');
 const serviceMail = require('./service-mail');
 const serviceRegister = require('./service-register');
 const root = require('./root');
-(async () => { 
+(async () => {
   await serviceCore();
   await serviceRegister();
   await serviceMail();

build/lib/json.js

@@ -0,0 +1,52 @@
+/**
+ * @license
+ * Copyright (C) Pryv https://pryv.com
+ * This file is part of Pryv.io and released under BSD-Clause-3 License
+ * Refer to LICENSE file
+ */
+const path = require('path');
+const fs = require('fs');
+
+module.exports = function (destDir) {
+  return function (task) {
+    const fileDest = path.resolve(destDir, task.target);
+    const jsonStringContent = fs.readFileSync(fileDest, { encoding: 'utf8' });
+    let dest = JSON.parse(jsonStringContent);
+    if (task.json.merge) {
+      mergeDeep(dest, task.json.merge);
+    }
+    fs.writeFileSync(fileDest, JSON.stringify(dest, null, 2));
+  };
+};
+
+/**
+ * Simple object check.
+ * @param item
+ * @returns {boolean}
+ */
+function isObject(item) {
+  return (item && typeof item === 'object' && !Array.isArray(item));
+}
+
+/**
+ * Deep merge two objects.
+ * @param target
+ * @param ...sources
+ */
+function mergeDeep(target, ...sources) {
+  if (!sources.length) return target;
+  const source = sources.shift();
+
+  if (isObject(target) && isObject(source)) {
+    for (const key in source) {
+      if (isObject(source[key])) {
+        if (!target[key]) Object.assign(target, { [key]: {} });
+        mergeDeep(target[key], source[key]);
+      } else {
+        Object.assign(target, { [key]: source[key] });
+      }
+    }
+  }
+
+  return mergeDeep(target, ...sources);
+}

src/lib/rsync.js → build/lib/rsync.js

@@ -1,25 +1,31 @@
+/**
+ * @license
+ * Copyright (C) Pryv https://pryv.com
+ * This file is part of Pryv.io and released under BSD-Clause-3 License
+ * Refer to LICENSE file
+ */
 const Rsync = require('rsync');
 const path = require('path');
 const mkdirp = require('mkdirp');
 
-module.exports = async function rsync(task, srcDir, destDir) {
+module.exports = async function rsync (task, srcDir, destDir) {
   const src = path.resolve(srcDir, task.target);
   let dest = path.resolve(destDir);
-  if (! task.rsyncUseDestDir) {
+  if (!task.rsyncUseDestDir) {
     dest = path.dirname(path.resolve(destDir, task.target));
   }
   console.log(src + ' >>>> ' + dest);
   mkdirp(dest);
   const r = new Rsync()
     .set('a')
-    //.progress()
+    // .progress()
     .source(src)
     .destination(dest);
 
   if (!task.noDelete) r.delete();
   if (task.excludes) r.exclude(task.excludes);
   if (task.patterns) r.patterns(task.patterns);
-    
+
   await new Promise((resolve, reject) => {
     r.execute(function (error, code, cmd) {
       if (error) return reject(error);
@@ -30,4 +36,4 @@ module.exports = async function rsync(task, srcDir, destDir) {
       process.stderr.write(data);
     });
   });
-}
+};