adapt-authoring-logger 0.0.1

package/.eslintignore

@@ -0,0 +1 @@
+node_modules

package/.eslintrc

@@ -0,0 +1,14 @@
+{
+  "env": {
+      "browser": false,
+      "node": true,
+      "commonjs": false,
+      "es2020": true
+  },
+  "extends": [
+      "standard"
+  ],
+  "parserOptions": {
+      "ecmaVersion": 2020
+  }
+}

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,55 @@
+name: Bug Report
+description: File a bug report
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: description
+    attributes:
+      label: What happened?
+      description: Please describe the issue
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behaviour
+      description: Tell us what should have happened
+  - type: textarea
+    id: repro-steps
+    attributes:
+      label: Steps to reproduce
+      description: Tell us how to reproduce the issue
+    validations:
+      required: true
+  - type: input
+    id: aat-version
+    attributes:
+      label: Authoring tool version
+      description: What version of the Adapt authoring tool are you running?
+    validations:
+      required: true
+  - type: input
+    id: fw-version
+    attributes:
+      label: Framework version
+      description: What version of the Adapt framework are you running?
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: What browsers are you seeing the problem on?
+      multiple: true
+      options:
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: sh

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,22 @@
+name: Feature request
+description: Request a new feature
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to request a new feature in the Adapt authoring tool! The Adapt team will consider all new feature requests, but unfortunately cannot commit to every one.
+  - type: textarea
+    id: description
+    attributes:
+      label: Feature description
+      description: Please describe your feature request
+    validations:
+      required: true
+  - type: checkboxes
+    id: contribute
+    attributes:
+      label: Can you work on this feature?
+      description: If you are able to commit your own time to work on this feature, it will greatly increase the liklihood of it being implemented by the core dev team. Otherwise, it will be triaged and prioritised alongside the core team's current priorities.
+      options:
+        - label: I can contribute

package/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

package/.github/pull_request_template.md

@@ -0,0 +1,25 @@
+[//]: # (Please title your PR according to eslint commit conventions)
+[//]: # (See https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-eslint#eslint-convention for details)
+
+[//]: # (Add a link to the original issue)
+
+[//]: # (Delete as appropriate)
+### Fix
+* A sentence describing each fix
+
+### Update
+* A sentence describing each udpate
+
+### New
+* A sentence describing each new feature
+
+### Breaking
+* A sentence describing each breaking change
+
+[//]: # (List appropriate steps for testing if needed)
+### Testing
+1. Steps for testing
+
+[//]: # (Mention any other dependencies)
+
+

package/.github/workflows/labelled_prs.yml

@@ -0,0 +1,16 @@
+name: Add labelled PRs to project
+
+on:
+  pull_request:
+    types: [ labeled ]
+
+jobs:
+  add-to-project:
+    if: ${{ github.event.label.name == 'dependencies' }}
+    name: Add to main project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@v0.1.0
+        with:
+          project-url: https://github.com/orgs/adapt-security/projects/5
+          github-token: ${{ secrets.PROJECTS_SECRET }}

package/.github/workflows/new.yml

@@ -0,0 +1,19 @@
+name: Add to main project
+
+on:
+  issues:
+    types:
+      - opened
+  pull_request:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+    name: Add to main project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@v0.1.0
+        with:
+          project-url: https://github.com/orgs/adapt-security/projects/5
+          github-token: ${{ secrets.PROJECTS_SECRET }}

package/adapt-authoring.json

@@ -0,0 +1,6 @@
+{
+  "essentialType": "logger",
+  "documentation": {
+    "enable": true
+  }
+}

package/conf/config.schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "levels": {
+      "description": "Configures which log levels of log should be shown. Accepts generic levels, module-specific levels and not logic (e.g. 'debug', 'debug.core' and '!debug' respectively).",
+      "type": "array",
+      "items": { "type": "string" },
+      "default": ["error", "warn", "success", "info", "debug"]
+    },
+    "mute": {
+      "description": "Whether to mute log messages",
+      "type": ["boolean","string"],
+      "default": false
+    },
+    "dateFormat": {
+      "description": "The date format to use",
+      "type": "string",
+      "enum": ["short", "iso"],
+      "default": "iso"
+    },
+    "showTimestamp": {
+      "description": "Whether to prepend a timestamp to each log message",
+      "type": "boolean",
+      "default": true
+    }
+  }
+}

package/index.js

@@ -0,0 +1,5 @@
+/**
+ * Logging utility
+ * @namespace logger
+ */
+export { default } from './lib/LoggerModule.js'

package/lib/LoggerModule.js

@@ -0,0 +1,158 @@
+import { AbstractModule, Hook } from 'adapt-authoring-core'
+import chalk from 'chalk'
+/**
+ * Module for logging message to the console
+ * @memberof logger
+ * @extends {AbstractModule}
+ */
+class LoggerModule extends AbstractModule {
+  /**
+   * Colours an input string
+   * @param {String} str
+   * @param {String} colour
+   * @return {String}
+   */
+  static colourise (str, colour) {
+    const chalkFunc = chalk[colour]
+    return chalkFunc ? chalkFunc(str) : str
+  }
+
+  /**
+   * Returns a formatted date stamp
+   * @param {Object} config
+   * @return {String}
+   */
+  static getDateStamp (config) {
+    if (!config.timestamp) {
+      return ''
+    }
+    let str
+    if (config.dateFormat === 'iso') {
+      str = new Date().toISOString()
+    } else if (config.dateFormat === 'short') {
+      const d = new Date()
+      const m = d.getMonth() + 1
+      const s = d.getSeconds()
+      const date = `${d.getDate()}/${m < 10 ? `0${m}` : m}/${d.getFullYear().toString().slice(2)}`
+      const time = `${d.getHours()}:${d.getMinutes()}:${s < 10 ? `0${s}` : s}`
+      str = `${date}-${time}`
+    }
+    return LoggerModule.colourise(`${str} `, 'grey')
+  }
+
+  /** @override */
+  async init () {
+    await this.app.waitForModule('config')
+    /**
+     * Defines what messages are logged
+     * @type {Array}
+     */
+    this.levelsConfig = this.getConfig('levels')
+    /**
+     * Hook invoked on each message logged
+     * @type {Hook}
+     */
+    this.logHook = new Hook()
+    /**
+     * Module configuration options
+     * @type {Object}
+     */
+    this.config = {
+      levels: {
+        error: {
+          enable: this.isLevelEnabled('error'),
+          moduleOverrides: this.getModuleOverrides('error'),
+          colour: 'red'
+        },
+        warn: {
+          enable: this.isLevelEnabled('warn'),
+          moduleOverrides: this.getModuleOverrides('warn'),
+          colour: 'yellow'
+        },
+        success: {
+          enable: this.isLevelEnabled('success'),
+          moduleOverrides: this.getModuleOverrides('success'),
+          colour: 'green'
+        },
+        info: {
+          enable: this.isLevelEnabled('info'),
+          moduleOverrides: this.getModuleOverrides('info'),
+          colour: 'cyan'
+        },
+        debug: {
+          enable: this.isLevelEnabled('debug'),
+          moduleOverrides: this.getModuleOverrides('debug'),
+          colour: 'grey'
+        }
+      },
+      timestamp: this.getConfig('showTimestamp'),
+      dateFormat: this.getConfig('dateFormat'),
+      mute: this.getConfig('mute').toString() === 'true'
+    }
+    if(this.config.levels.mute) this.log('debug', 'logger', 'MUTED')
+    else this.log('debug', 'logger', 'CONFIG_LEVELS', JSON.stringify(Object.entries(this.config.levels).map(([k,v]) => `${k}::${v.enable ? 'ENABLED' : 'DISABLED'}::${v.moduleOverrides}`), null, 2))
+    // store instance on main App instance
+    this.app.logger = this
+  }
+
+  /**
+   * Determines whether a specific log level is enabled
+   * @param {String} level
+   * @return {Boolean}
+   */
+  isLevelEnabled (level) { // note explicit disable takes preference
+    return !this.levelsConfig.includes(`!${level}`) && this.levelsConfig.includes(level)
+  }
+
+  /**
+   * Returns a list of log levels with overrides, either inclusive or exclusive
+   * @param {String} level
+   * @return {Array}
+   */
+  getModuleOverrides (level) {
+    const levels = []
+    this.levelsConfig.forEach(l => {
+      const s = `${level}.`; const notS = `!${level}.`
+      if (l.indexOf(s) === 0 || l.indexOf(notS) === 0) levels.push(l)
+    })
+    return levels
+  }
+
+  /**
+   * Returns whether a message should be logged (i.e. not disabled in the config)
+   * @param {string} level Logging level
+   * @param {string} id Id of log caller
+   * @returns {boolean}
+   */
+  isLoggingEnabled (level, id) {
+    const { enable, moduleOverrides = [] } = this?.config?.levels[level] || {}
+    const isEnabled = enable || moduleOverrides.includes(`${level}.${id}`)
+    const disableOverride = moduleOverrides.includes(`!${level}.${id}`)
+    return isEnabled && !disableOverride
+  }
+
+  /**
+   * Logs a message to the console
+   * @param {String} level Severity of the message
+   * @param {String} id Identifier for the message. Helps to differentiate between other messages.
+   * @param {...*} args Arguments to be logged
+   */
+  log (level, id, ...args) {
+    if (this?.config?.mute?.toString() === 'true') {
+      return
+    }
+    if (id === AbstractModule.MODULE_READY) { // @hack for https://github.com/adaptlearning/adapt-authoring/issues/134 (better than overriding setReady)
+      id = this.name.split('-').pop()
+      args = [AbstractModule.MODULE_READY, ...args]
+    }
+    if (!this.isLoggingEnabled(level, id)) {
+      return
+    }
+    const colour = this?.config?.levels[level]?.colour
+    const logFunc = console[level] ?? console.log
+    logFunc(`${LoggerModule.getDateStamp(this.config)}${LoggerModule.colourise(level, colour)} ${LoggerModule.colourise(id, 'magenta')}`, ...args)
+    this.logHook.invoke(new Date(), level, id, ...args)
+  }
+}
+
+export default LoggerModule

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "adapt-authoring-logger",
+  "version": "0.0.1",
+  "description": "Basic logger for the Adapt authoring tool",
+  "homepage": "https://github.com/adapt-security/adapt-authoring-logger",
+  "license": "GPL-3.0",
+  "type": "module",
+  "main": "index.js",
+  "repository": "adaptlearning/adapt-authoring-logger",
+  "dependencies": {
+    "chalk": "^5.3.0"
+  },
+  "peerDependencies": {
+    "adapt-authoring-core": "github:adapt-security/adapt-authoring-core"
+  },
+  "devDependencies": {
+    "eslint": "^9.12.0",
+    "standard": "^17.1.0"
+  }
+}