Merge branch 'master' into release50

nrkno · Mar 1, 2024 · edf9fed · edf9fed
2 parents 17cec2b + 3f6cedd
commit edf9fed
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 27 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,12 +1,17 @@
 version: 2
 updates:
-  # # Enable version updates for npm
-  # - package-ecosystem: "npm"
-  #   # Look for `package.json` and `lock` files in the `root` directory
-  #   directory: "/"
-  #   # Check the npm registry for updates every day (weekdays)
-  #   schedule:
-  #     interval: "daily"
+  # Enable version updates for npm
+  - package-ecosystem: "npm"
+    # Look for `package.json` and `lock` files in the `root` directory
+    directory: "/"
+    # Check the npm registry for updates every day (weekdays)
+    schedule:
+      interval: "daily"
+    # Only create security updates
+    open-pull-requests-limit: 0
+    # Default reviewers
+    reviewers:
+      - "@nrkno/sofieteam"
 
   - package-ecosystem: "github-actions"
     # Workflow files stored in the
@@ -16,17 +21,3 @@ updates:
       interval: "weekly"
     reviewers:
       - "@nrkno/sofie-ops"
-
-  # # Enable version updates for Docker
-  # - package-ecosystem: "docker"
-  #   directory: "/meteor"
-  #   schedule:
-  #     interval: "weekly"
-  # - package-ecosystem: "docker"
-  #   directory: "/packages/mos-gateway"
-  #   schedule:
-  #     interval: "weekly"
-  # - package-ecosystem: "docker"
-  #   directory: "/packages/playout-gateway"
-  #   schedule:
-  #     interval: "weekly"
diff --git a/.github/workflows/node.yaml b/.github/workflows/node.yaml
@@ -155,7 +155,7 @@ jobs:
       - uses: ./.github/actions/setup-meteor
         if: steps.check-build-and-push.outputs.enable == 'true'
       - name: restore node_modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         if: steps.check-build-and-push.outputs.enable == 'true'
         with:
           path: |
@@ -323,7 +323,7 @@ jobs:
           node-version-file: ".node-version"
       - name: restore node_modules
         if: steps.check-build-and-push.outputs.enable == 'true'
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: |
             packages/node_modules
@@ -427,7 +427,7 @@ jobs:
         with:
           node-version-file: ".node-version"
       - name: restore node_modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: |
             packages/node_modules
@@ -490,7 +490,7 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - name: restore node_modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: |
             packages/node_modules
@@ -530,7 +530,7 @@ jobs:
         with:
           node-version-file: ".node-version"
       - name: restore node_modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: |
             packages/node_modules

diff --git a/.github/workflows/sonar.yaml b/.github/workflows/sonar.yaml
@@ -27,7 +27,7 @@ jobs:
           node-version-file: ".node-version"
       - uses: ./.github/actions/setup-meteor
       - name: restore node_modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: |
             node_modules

diff --git a/packages/documentation/docs/for-developers/contribution-guidelines.md b/packages/documentation/docs/for-developers/contribution-guidelines.md
@@ -76,3 +76,21 @@ Also, each of the libraries has a minimum nodejs version specified in their pack
 We sometimes use the `yarn resolutions` property in `package.json` to fix security vulnerabilities in dependencies of libraries that haven't released a fix yet. If adding a new one, try to make it as specific as possible to ensure it doesn't have unintended side effects.
 
 When updating other dependencies, it is a good idea to make sure that the resolutions defined still apply and are correct.
+
+### Logging
+
+When logging, we try to adher to the following guideliness:
+
+Usage of `console.log` and `console.error` directly is discouraged (except for quick debugging locally). Instead, use one of the logger libraries (to output json logs which are easier to index).
+When logging, use one of the **log level** described below:
+
+| Level   | Description | Examples |
+| ------- | ----------- | -- |
+| `silly` | For very detailed logs (rarely used). | - |
+| `debug` | Logging of info that could be useful for developers when debugging certain issues in production. | `"payload: {>JSON<} "`<br></br>`"Reloading data X from DB"` |
+| `verbose` | Logging of common events. | `"File X updated"` |
+| `info` | Logging of significant / uncommon events.<br></br>_Note: If an event happens often or many times, use `verbose` instead._ | `"Initializing TSR..."`<br></br>`"Starting nightly cronjob..."`<br></br>`"Snapshot X restored"`<br></br>`"Not allowing removal of current playing segment 'xyz', making segment unsynced instead"`<br></br>`"PeripheralDevice X connected"`  |
+| `warn` | Used when something unexpected happened, but not necessarily due to an application bug.<br></br>These logs don't have to be acted upon directly, but could be useful to provide context to a dev/sysadmin while troubleshooting an issue. | `"PeripheralDevice X disconnected"`<br></br>`"User Error: Cannot activate Rundown (Rundown not found)" `<br></br>`"mosRoItemDelete NOT SUPPORTED"` |
+| `error` | Used when something went _wrong_, preventing something from functioning.<br></br>A logged `error` should always result in a sysadmin / developer looking into the issue.<br></br>_Note: Don't use `error` for things that are out of the app's control, such as user error._ | `"Cannot read property 'length' of undefined"`<br></br>`"Failed to save Part 'X' to DB"`|
+| `crit` | Fatal errors (rarely used) | - |
+