@flowfuse/file-server 1.14.0

package/CHANGELOG.md

@@ -0,0 +1,67 @@
+#### 1.14.0: Release
+
+
+#### 1.13.0: Release
+
+ - Bump workflows to v0.1.1 version (#90) @ppawlowski
+ - Pin reusable workflows to v0.1.0 (#89) @ppawlowski
+ - Allow config to be passed via env for testing (#88) @knolleary
+ - Add /metrics endpoint (#87) @hardillb
+ - Fix run serve (#84) @hardillb
+ - Fix doule export (#83) @hardillb
+ - Allow JSON HTTP Request logging from the FileServer (#82) @hardillb
+ - Update ff references in package.json (#80) @knolleary
+ - Change repo references in workflows after github org rename (#78) @ppawlowski
+
+#### 1.12.0: Release
+
+ - Publish nightly package to npmjs (#77) @ppawlowski
+ - Bump the semver dep (#76) @hardillb
+ - Update dependencies to clear CVEs (#75) @hardillb
+ - Pin reusable workflow to commit SHA (#74) @ppawlowski
+ - Disable scheduled package build (#73) @ppawlowski
+
+#### 1.11.0: Release
+
+ - Bump nodemon to allow other deps to be updated (#71) @hardillb
+ - First pass at variable quotas (#70) @hardillb
+ - Move to SQLite from Memory context (#68) @hardillb
+ - Add file-server container build pipeline dispatcher (#69) @ppawlowski
+ - FIX: Publish package on schedule (#65) @ppawlowski
+ - FIX: Allow publish only when changes are pushed to `main` branch (#64) @ppawlowski
+ - Allow publish only when PR is merged (#63) @ppawlowski
+ - Update dependencies (#62) @knolleary
+ - Remove defunct docs tasks (#61) @knolleary
+ - Introduce build and publish workflow (#59) @ppawlowski
+
+#### 1.10.0: Release
+
+ - Chore: Set root flag in eslint (#57) @Pezmc
+
+#### 1.9.0: Release
+
+ - Add package-lock.json (#55) @Pezmc
+
+#### 1.8.0: Release
+
+
+#### 1.7.0: Release
+
+
+#### 1.6.0: Release
+
+
+#### 1.5.0: Release
+
+
+#### 1.4.0: Release
+
+ - Add APIs to support synchronous context (#48) @Steve-Mcl
+
+#### 1.3.0: Release
+
+
+#### 1.2.0: Release
+
+ - S3 quota check (#42) @hardillb
+

package/LICENSE

@@ -0,0 +1,178 @@
+Copyright FlowForge Inc, and other contributors, https://flowforge.com/
+
+                                 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

package/README.md

@@ -0,0 +1,231 @@
+# A Basic Object Store for use with FlowFuse
+
+## Authorisation
+
+All requests should include a `Authorization` header with a Bearer token assigned by the FlowFuse platform to identify
+## End Points
+
+### File Storage
+
+- Create/Replace
+
+    **POST** */v1/files/:teamId/:projectId/[path and filename]*
+
+    Content-Type: application/octet-stream
+
+- Append
+
+    **POST** */v1/files/:teamId/:projectId/[path and filename]*
+
+    With Header `FF_MODE: append`
+
+    Content-Type: application/octet-stream
+- Read File
+
+    **GET** */v1/files/:teamId/:projectId/[path and filename]*
+
+    Content-Type: application/octet-stream
+
+- Delete File
+
+    **DELETE** */v1/files/:teamId/:projectId/[path and filename]*
+
+- Check team quota usage
+
+    **GET** */v1/quota/:teamId*
+
+    Content-Type: application/json
+
+### Context Store
+
+- Set stored values
+
+    **POST** */v1/context/:projectId/:scope*
+
+    Content-Type: application/json
+
+    Body:
+    ```json
+    [
+        { "key": "x", "value": { "foo": "bar" } },
+        { "key": "y.y", "value": 100 },
+    ]
+    ```
+
+- Get stored values
+
+    **GET** */v1/context/:projectId/:scope?key=x[&key=y.y]*
+
+    Content-Type: application/json
+
+    Response:
+    ```json
+    [
+        { "key": "x", "value": { "foo": "bar" } },
+        { "key": "y.y", "value": 100 }
+    ]
+    ```
+
+- Get keys for a scope
+
+    **GET** */v1/context/:projectId/:scope/keys*
+
+    Content-Type: application/json
+
+    Response:
+    ```json
+    [
+        "x",
+        "y"
+    ]
+    ```
+
+- Delete scope
+
+    **DELETE** */v1/context/:projectId/:scope*
+
+- Clean unused scopes from the store
+
+    **POST** */v1/context/:projectId/clean*
+
+    Content-Type: application/json
+
+    Body:
+    ```json
+    [
+        "nodeId", "flowId"
+    ]
+    ```
+
+## Configuration
+
+Configuration is read from `etc/flowforge-storage.yml`
+
+```yaml
+host: 0.0.0.0
+port: 3001
+base_url: http://flowforge:3000
+driver:
+  type: localfs
+  options:
+    root: var/root
+telemetry:
+  backend:
+    prometheus:
+      enabled: true
+```
+
+- base_url - Where to reach the core FlowForge platform
+- driver
+    - type - can be `s3`, `localfs` or `memory` (for testing)
+    - options - will vary by driver
+- telemetry
+    - backend
+         - prometheus
+             - enabled - turns on the `/metrics` endpoint to track resource usage
+
+### File Storage
+#### S3
+
+The following can be any of the options for the S3Client Contructor, see [here](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html)
+
+- options
+    - bucket - name of S3 Bucket (required)
+    - region - AWS Region
+    - endpoint - S3 ObjectStore Endpoint (if not using AWS S3)
+    - forcePathStyle: true/false
+    - credential
+        - accessKeyId - AccountID/Username
+        - secretAccessKey - SecretKey/Password
+
+```yaml
+host: '0.0.0.0'
+port: 3001
+base_url: http://forge.default
+driver:
+  type: s3
+  options:
+    bucket: flowforge-files
+    credentials:
+      accessKeyId: XXXXXXXXXXXXXXXXXXX
+      secretAccessKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+    forcePathStyle: true
+    region: us-east-1
+```
+
+#### LocalFS
+
+- options
+    - root - path to store team files, relative path will apply to FLOWFORGE_HOME
+
+#### Memory
+
+This driver is purely to make testing easier, it has no configuration
+options.
+
+### Context Storage
+
+#### Sequelize
+
+This driver can use either PostgreSQL or SQLite to hold context values.
+
+To use with PostgreSQL configure as follows:
+
+```yaml
+context:
+  type: sequelize
+  options:
+    type: postgres
+    host: 127.0.0.1
+    port: 5432
+    database: ff-context
+    username: user
+    password: password
+```
+
+To use with SQLite configure as follows:
+
+```yaml
+context:
+  type: sequelize
+  options:
+    type: sqlite
+    storage: ff-context.db
+```
+
+Where `context.options.storage` is the filename of the SQLite database, by default it will be written to 
+the `var` directory if a fully qualified path is not provided.
+
+### Environment variables
+
+- FLOWFORGE_HOME default `/opt/flowforge-file-storage`
+- PORT overrides value in config file, default 3001
+
+## Development
+
+### Testing
+
+```bash
+npm run test
+```
+
+NOTE: This will run all tests for all backends and requires a running postgres database
+
+To prepare postgres for the tests, use the following procedure (tested on Linux and WSL2 ubuntu + docker)...
+
+```bash
+docker run --rm --name postgres -e POSTGRES_PASSWORD=secret -e POSTGRES_USER=postgres -p 5432:5432 postgres:14
+```
+
+
+### Testing (without postgres)
+
+```
+npm run test:nopg
+```
+
+Alternatively, you can set env variable TEST_POSTGRES=false
+```
+export TEST_POSTGRES=false
+npm run test
+```

package/etc/flowforge-storage.local.yml

@@ -0,0 +1,22 @@
+host: '0.0.0.0'
+port: 3001
+base_url: http://localhost:3000
+driver:
+  # localfs, s3, memory
+  type: localfs
+  options:
+    root: var/root
+  # type: s3
+  # options:
+  #   bucket: test
+  #   credentials:
+  #     accessKeyId: test
+  #     secretAccessKey: password
+  #   endpoint: http://localhost:9000
+  #   forcePathStyle: true
+  #   region: eu-west-1
+context:
+  type: sequelize
+  options:
+    type: sqlite
+    storage: ff-context.db

package/etc/flowforge-storage.yml

@@ -0,0 +1,26 @@
+host: '0.0.0.0'
+port: 3001
+base_url: http://localhost:3000
+driver:
+  # localfs, s3, memory
+  type: localfs
+  options:
+    root: var/root
+  # type: s3
+  # options:
+  #   bucket: test
+  #   credentials:
+  #     accessKeyId: test
+  #     secretAccessKey: password
+  #   endpoint: http://localhost:9000
+  #   forcePathStyle: true
+  #   region: eu-west-1
+context:
+  type: sequelize
+  options:
+    type: sqlite
+    storage: ff-context.db
+# telemetry:
+#   backend:
+#     prometheus:
+#       enabled: true

package/forge/auth.js

@@ -0,0 +1,106 @@
+const fp = require('fastify-plugin')
+const got = require('got')
+
+const authCache = {}
+const ttl = 90 * 1000
+
+module.exports = fp(async function (app, opts, done) {
+    const client = got.extend({
+        prefixUrl: `${app.config.base_url}/account/check/project`,
+        headers: {
+            'user-agent': 'FlowForge Storage Server',
+            'ff-quota': true
+        },
+        timeout: {
+            request: 500
+        }
+    })
+
+    async function checkToken (projectId, token) {
+        const project = await client.get(projectId, {
+            headers: {
+                authorization: `Bearer ${token}`
+            }
+        })
+        return project.body
+    }
+
+    async function checkAuth (request, reply) {
+        if (request.url === '/metrics') {
+            return
+        }
+        try {
+            const token = getAuthToken(request)
+            const cacheOk = checkCache(token, request.params.projectId)
+            if (!cacheOk) {
+                const tokenResponse = await checkToken(request.params.projectId, token)
+                if (!tokenResponse) {
+                    throw new Error('Invalid token')
+                }
+                request.quota = tokenResponse.quota
+                // update cache
+                authCache[token] = {
+                    ttl: Date.now(),
+                    projectId: request.params.projectId,
+                    quota: tokenResponse.quota
+                }
+            } else {
+                request.quota = authCache[token].quota
+            }
+        } catch (error) {
+            // always send 401 for security reasons
+            reply.code(401).send({ code: 'unauthorized', error: 'unauthorized' })
+        }
+    }
+
+    /**
+     * Extract the token from the request.
+     * @throws {Error} if the token is not found or the authorization header is invalid
+     * @param {Object} request The request object
+     * @returns {string} The token
+     */
+    function getAuthToken (request) {
+        if (!request?.headers?.authorization) {
+            throw new Error('Missing authorization header')
+        }
+        const parts = request.headers.authorization.split(' ')
+        if (parts.length !== 2) {
+            throw new Error('Invalid authorization header')
+        }
+        if (parts[0] !== 'Bearer') {
+            throw new Error('Invalid authorization header')
+        }
+        if (!parts[1]) {
+            throw new Error('Invalid authorization header')
+        }
+        return parts[1]
+    }
+
+    /**
+     * Check if the token is in the cache and if it is still valid
+     * @param {string} token The token to check
+     * @param {string} projectId The projectId to check
+     * @returns {boolean} true if the token is valid for the projectId
+     */
+    function checkCache (token, projectId) {
+        const cacheExists = authCache[token] && authCache[token].projectId && authCache[token].ttl
+        let projectMatch = false
+        let ttlOk = false
+        if (cacheExists) {
+            const cacheEntry = authCache[token]
+            // ensure projectId matches the cached projectId
+            projectMatch = cacheEntry.projectId === projectId
+            // check cache ttl
+            ttlOk = (Date.now() - cacheEntry.ttl) < ttl
+        }
+        const result = cacheExists && projectMatch && ttlOk
+        // delete only if expired
+        if (!ttlOk && projectMatch) {
+            delete authCache[token]
+        }
+        return result
+    }
+
+    app.decorate('checkAuth', checkAuth)
+    done()
+})