Merge pull request mathworks#36 from development/skondapa.feature.trigger-licensing-workflows

Feature:Integrate licensing workflows

Author: dklilley

package-lock-old.json

@@ -6,13 +6,14 @@
   "bin": "./out/index.js",
   "scripts": {
     "vscode:prepublish": "npm run package",
-    "compile": "webpack --mode development",
+    "compile": "webpack --mode development && mkdir -p ./out/licensing/static && cd src/licensing/gui && npm run build && cd ../../.. && cp -R src/licensing/gui/build/* ./out/licensing/static",
     "watch": "webpack --watch",
     "package": "webpack --mode production --devtool hidden-source-map",
     "test-compile": "tsc -p ./",
     "test-watch": "tsc -watch -p ./",
     "pretest": "npm run test-compile",
     "lint": "eslint src --ext ts",
+    "lint:fix": "eslint src --ext ts --fix",
     "test": "mocha"
   },
   "repository": {
@@ -21,10 +22,15 @@
   "author": "The MathWorks, Inc.",
   "license": "MIT",
   "devDependencies": {
+    "@types/cookie-parser": "^1.4.7",
+    "@types/express": "^4.17.21",
+    "@types/express-session": "^1.18.0",
     "@types/mocha": "^10.0.6",
+    "@types/node-fetch": "^2.6.11",
     "@types/node": "^18.7.18",
     "@types/sinon": "^17.0.3",
     "@types/which": "^2.0.1",
+    "@types/xml2js": "^0.4.14",
     "@types/yargs": "^17.0.12",
     "@typescript-eslint/eslint-plugin": "^5.36.1",
     "@typescript-eslint/parser": "^5.36.1",
@@ -42,13 +48,18 @@
     "webpack": "^5.74.0",
     "webpack-cli": "^4.10.0"
   },
-  "dependencies": {
+  "dependencies": {    
     "chokidar": "^3.5.3",
+    "cookie-parser": "^1.4.6",
+    "express": "^4.18.2",
+    "express-session": "^1.18.0",
     "faye": "^1.4.0",
+    "node-fetch": "^3.3.2",
     "vscode-languageserver": "^8.0.2",
     "vscode-languageserver-textdocument": "^1.0.7",
     "vscode-uri": "^3.0.6",
     "which": "^2.0.2",
+    "xml2js": "^0.6.2",
     "yargs": "^17.5.1"
   },
   "mocha": {

package-lock.json

@@ -1,5 +1,5 @@
 // Copyright 2024 The MathWorks, Inc.
-import { _Connection, createConnection, ProposedFeatures } from "vscode-languageserver/node"
+import { _Connection, createConnection, ProposedFeatures } from 'vscode-languageserver/node'
 
 export type Connection = _Connection
 

package.json

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

src/ClientConnection.ts

@@ -0,0 +1,92 @@
+// Copyright 2024 The MathWorks, Inc.
+
+import { promises as fs } from 'fs';
+import { findExecutableOnPath, resolveSymlink } from '../utils/FsUtils';
+import * as path from 'path';
+import * as xml2js from 'xml2js';
+import { VersionInfoXML } from './types';
+import Logger from '../logging/Logger';
+
+const VERSION_INFO_FILENAME = 'VersionInfo.xml';
+
+export const MWI_AUTH_TOKEN_NAME_FOR_HTTP = 'mwi-auth-token'
+
+export const MWI_AUTH_TOKEN_LENGTH = 32
+
+export const MWI_ENABLE_TOKEN_AUTH = true
+
+export const MWI_LICENSING_SESSION_COOKIE_NAME = 'matlab-licensing-session'
+
+let installPath: string | null = null;
+let matlabVersion: string | null = null;
+export const staticFolderPath: string = path.join(__dirname, 'licensing', 'static')
+
+/**
+ * Sets the MATLAB install path. Is called when:
+ * 1) The LSP is initialzed
+ * &
+ * 2) The installPath setting changes by its config change handler
+ * @param path - The MATLAB install path
+ */
+export function setInstallPath (path: string): void {
+    installPath = path;
+
+    // When installPath changes, update MATLAB version
+    getMatlabVersionFromInstallPath(installPath).then((version) => {
+        matlabVersion = version;
+    });
+}
+
+/**
+ * Sets the MATLAB version. This function is called to update the current
+ * MATLAB version in the application state.
+ *
+ * @param version - The MATLAB version to be set
+ */
+export function setMatlabVersion (version: string): void {
+    matlabVersion = version
+}
+
+/**
+ * Gets the MATLAB version
+ * @returns {Promise<string | null>} The MATLAB version or null if it cannot be determined
+ */
+export async function getMatlabVersion (): Promise<string | null> {
+    // If MATLAB version was already determined (either by this function or the setInstallPath function), return it directly.
+    if (matlabVersion) {
+        return matlabVersion
+    } else {
+        const matlabExecutableOnPath = await findExecutableOnPath('matlab')
+        // If there's no matlab executable on system PATH return null
+        if (!matlabExecutableOnPath) {
+            return null;
+        }
+
+        const absoluteMatlabPath = await resolveSymlink(matlabExecutableOnPath);
+        const matlabRoot = path.resolve(absoluteMatlabPath, '..', '..')
+
+        // Update matlabVersion variable before returning to avoid recomputation.
+        matlabVersion = await getMatlabVersionFromInstallPath(matlabRoot)
+        return matlabVersion
+    }
+}
+
+/**
+ * Retrieves the MATLAB version from the installation path.
+ *
+ * @param pathToMatlabRoot - The path to the MATLAB ROOT.
+ * @returns {Promise<string|null>} A promise that resolves to the MATLAB version as a string, or null if an error occurs.
+ */
+async function getMatlabVersionFromInstallPath (pathToMatlabRoot: string) {
+    const versionInfoPath = path.join(pathToMatlabRoot, VERSION_INFO_FILENAME);
+
+    try {
+        const fileContent = await fs.readFile(versionInfoPath, { encoding: 'utf-8' })
+        const xmlData = (await xml2js.parseStringPromise(fileContent)) as VersionInfoXML
+        const versionInfo = xmlData.MathWorks_version_info.release[0]
+        return versionInfo
+    } catch (error) {
+        Logger.error(`Failed to read version info file at path:${versionInfoPath} with error:${error}`)
+        return null;
+    }
+}

src/licensing/.gitignore

@@ -0,0 +1,44 @@
+// Copyright 2024 The MathWorks, Inc.
+
+export class AppError extends Error {
+    /**
+     * A Generic Parent class which inherits the Error class.
+     * This class will be inherited by other classes representing specific exceptions.
+     *
+     * @param message - Error message.
+     * @param logs - Logs associated with the error.
+     * @param stacktrace - Stacktrace associated with the error.
+     */
+    constructor(
+        message: string,
+        public readonly logs: string | null = null,
+        public readonly stacktrace: string | null = null
+    ) {
+        super(message);
+        this.name = this.constructor.name;
+    }
+}
+
+/**
+ * A Class which inherits the AppError class.
+ * This class represents any Licensing Errors (MHLM and NLM Licensing)
+ */
+export class LicensingError extends AppError {}
+
+/**
+ * A Class which inherits the Licensing class.
+ * This class represents any errors specific to MHLM Licensing.
+ */
+export class OnlineLicensingError extends LicensingError {}
+
+/**
+ * A Class which inherits the LicensingError class.
+ * This class represents errors with Entitlements in MHLM Licensing.
+ */
+export class EntitlementError extends LicensingError {}
+
+/**
+ * A Class which inherits the AppError class.
+ * This class represents token authentication errors.
+ */
+export class InvalidTokenError extends AppError {}

src/licensing/config.ts

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

src/licensing/errors.ts

@@ -0,0 +1,68 @@
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.<br />
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.<br />
+You will also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.<br />
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.<br />
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.<br />
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).
+
+### Code Splitting
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
+
+### Analyzing the Bundle Size
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
+
+### Making a Progressive Web App
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
+
+### Advanced Configuration
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
+
+### Deployment
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
+
+### `npm run build` fails to minify
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify