Category-based package matching. (#830)

* Proper renaming of a completely confusing function.
* Clean up the code a bit.
* Consider category as a most important criteria in the matching of packages.

Author: tecimovic

docs/api.md

@@ -791,6 +791,14 @@ NOTE: This function does NOT initialize session packages.</p>
 <dt><a href="#importSessionKeyValues">importSessionKeyValues(db, sessionId, keyValuePairs)</a></dt>
 <dd><p>Resolves with a promise that imports session key values.</p>
 </dd>
+<dt><a href="#autoLoadPackage">autoLoadPackage(db, pkg, absPath)</a> ⇒</dt>
+<dd><p>Auto-load package. If succesful it returns an object.
+Otherwise it throws an exception.</p>
+</dd>
+<dt><a href="#convertPackageResult">convertPackageResult(data)</a> ⇒</dt>
+<dd><p>Convert the array of results into a more palatable value.
+Resolves an array of { packageId:, packageType:} objects into { zclPackageId: id, templateIds: [] }</p>
+</dd>
 <dt><a href="#jsonDataLoader">jsonDataLoader(db, state, sessionId, packageMatch)</a> ⇒</dt>
 <dd><p>Given a state object, this method returns a promise that resolves
 with the succesfull writing into the database.</p>
@@ -12190,7 +12198,7 @@ Checks if type is a two-byte lengh string.
 
 - [JS API: random utilities](#module*JS API* random utilities)
   - [~checksum(data)](#module*JS API* random utilities..checksum) ⇒
-  - [~initializeSessionPackage(db, sessionId, options:, selectedZclPropertyPackage, selectedGenTemplatePackages)](#module*JS API* random utilities..initializeSessionPackage) ⇒
+  - [~ensurePackagesAndPopulateSessionOptions(db, sessionId, options:, selectedZclPropertyPackage, selectedGenTemplatePackages)](#module*JS API* random utilities..ensurePackagesAndPopulateSessionOptions) ⇒
   - [~createBackupFile(filePath)](#module*JS API* random utilities..createBackupFile)
   - [~matchFeatureLevel(featureLevel)](#module*JS API* random utilities..matchFeatureLevel)
   - [~sessionReport(db, sessionId)](#module*JS API* random utilities..sessionReport) ⇒
@@ -12222,11 +12230,12 @@ Returns the CRC of the data that is passed.
 | ----- | --------------- |
 | data  | <code>\*</code> |
 
-<a name="module_JS API_ random utilities..initializeSessionPackage"></a>
+<a name="module_JS API_ random utilities..ensurePackagesAndPopulateSessionOptions"></a>
 
-### JS API: random utilities~initializeSessionPackage(db, sessionId, options:, selectedZclPropertyPackage, selectedGenTemplatePackages) ⇒
+### JS API: random utilities~ensurePackagesAndPopulateSessionOptions(db, sessionId, options:, selectedZclPropertyPackage, selectedGenTemplatePackages) ⇒
 
-This function assigns a proper package ID to the session.
+This function assigns a proper package ID to the session if there
+are no packages present. It will also populate session options.
 
 **Kind**: inner method of [<code>JS API: random utilities</code>](#module*JS API* random utilities)  
 **Returns**: Promise that resolves with the packages array.
@@ -14208,6 +14217,36 @@ Resolves with a promise that imports session key values.
 | sessionId     | <code>\*</code> |
 | keyValuePairs | <code>\*</code> |
 
+<a name="autoLoadPackage"></a>
+
+## autoLoadPackage(db, pkg, absPath) ⇒
+
+Auto-load package. If succesful it returns an object.
+Otherwise it throws an exception.
+
+**Kind**: global function  
+**Returns**: object containing packageId and packageType.
+
+| Param   | Type            |
+| ------- | --------------- |
+| db      | <code>\*</code> |
+| pkg     | <code>\*</code> |
+| absPath | <code>\*</code> |
+
+<a name="convertPackageResult"></a>
+
+## convertPackageResult(data) ⇒
+
+Convert the array of results into a more palatable value.
+Resolves an array of { packageId:, packageType:} objects into { zclPackageId: id, templateIds: [] }
+
+**Kind**: global function  
+**Returns**: an object that contains session ids.
+
+| Param | Type            |
+| ----- | --------------- |
+| data  | <code>\*</code> |
+
 <a name="jsonDataLoader"></a>
 
 ## jsonDataLoader(db, state, sessionId, packageMatch) ⇒

src-electron/importexport/import-isc.js

@@ -651,7 +651,7 @@ async function iscDataLoader(db, state, sessionId) {
 
   // We don't have the package info inside ISC file, so we
   // do our best here.
-  await util.initializeSessionPackage(db, sessionId, {
+  await util.ensurePackagesAndPopulateSessionOptions(db, sessionId, {
     zcl: state.zclMetafile,
     template: null,
   })

src-electron/importexport/import-json.js

@@ -148,21 +148,26 @@ async function importSinglePackage(db, pkg, zapFilePath, packageMatch) {
     }
   }
 
-  // We have only one. Use it and be done
-  if (packages.length == 1) {
+  // Moving on. We have more than one package, so we have to
+  // make a smart decision.
+  //
+
+  // First narrow down to the category.
+  let categoryMatch = packages.filter((p) => p.category == pkg.category)
+  if (categoryMatch.length == 1) {
     env.logDebug(
-      `Only one package of given type ${pkg.type} present. Using it.`
+      `Only one package of given type ${pkg.type} and category ${pkg.category} present. Using it.`
     )
     return {
-      packageId: packages[0].id,
+      packageId: categoryMatch[0].id,
       packageType: pkg.type,
     }
   }
 
   // Filter to just the ones that match the version
-  packages = packages.filter((p) => p.version == pkg.version)
+  let versionMatch = packages.filter((p) => p.version == pkg.version)
   // If there isn't any abort, if there is only one, use it.
-  if (packages.length == 0) {
+  if (versionMatch.length == 0) {
     let msg = `No packages of type ${pkg.type} that match version ${pkg.version} found in the database.`
     if (pkg.type == dbEnum.packageType.genTemplatesJson) {
       // We don't throw exception for genTemplatesJson, we can survive without.
@@ -171,16 +176,18 @@ async function importSinglePackage(db, pkg, zapFilePath, packageMatch) {
     } else {
       throw new Error(msg)
     }
-  } else if (packages.length == 1) {
+  } else if (versionMatch.length == 1) {
     env.logDebug(
       `Only one package of given type ${pkg.type} and version ${pkg.version} present. Using it.`
     )
     return {
-      packageId: packages[0].id,
+      packageId: versionMatch[0].id,
       packageType: pkg.type,
     }
   }
 
+  // Neither category match, nor version match had only one version.
+
   // We now know we have more than 1 matching package. Find best bet.
   let existingPackages = packages.filter(
     (p) => fs.existsSync(p.path) && p.path === absPath
@@ -217,7 +224,13 @@ async function importSinglePackage(db, pkg, zapFilePath, packageMatch) {
   }
 }
 
-// Resolves an array of { packageId:, packageType:} objects into { zclPackageId: id, templateIds: [] }
+/**
+ * Convert the array of results into a more palatable value.
+ * Resolves an array of { packageId:, packageType:} objects into { zclPackageId: id, templateIds: [] }
+ *
+ * @param {*} data
+ * @returns an object that contains session ids.
+ */
 function convertPackageResult(data) {
   let ret = {
     zclPackageId: null,

src-electron/importexport/import.js

@@ -20,8 +20,6 @@
  * and imports it into a database.
  */
 const fsp = require('fs').promises
-const path = require('path')
-
 const importIsc = require('./import-isc.js')
 const importJson = require('./import-json.js')
 const dbApi = require('../db/db-api.js')

src-electron/main-process/startup.js

@@ -210,7 +210,7 @@ async function startConvert(argv, options) {
 
     let sessionId = importResult.sessionId
 
-    await util.initializeSessionPackage(db, sessionId, {
+    await util.ensurePackagesAndPopulateSessionOptions(db, sessionId, {
       zcl: argv.zclProperties,
       template: argv.generationTemplate,
     })
@@ -525,7 +525,11 @@ async function generateSingleFile(
   }
   options.logger(`👉 using output destination: ${output}`)
 
-  let sessPkg = await util.initializeSessionPackage(db, sessionId, options)
+  let sessPkg = await util.ensurePackagesAndPopulateSessionOptions(
+    db,
+    sessionId,
+    options
+  )
   let usedTemplatePackageId = templatePackageId
   for (let pkg of sessPkg) {
     if (pkg.type === dbEnum.packageType.genTemplatesJson) {

src-electron/rest/initialize.js

@@ -5,10 +5,10 @@ const restApi = require('../../src-shared/rest-api.js')
 const util = require('../util/util.js')
 
 /**
-  * This function returns Properties, Templates and Dirty-Sessions
-  * @param {*} db
-  * @returns Properties, Templates and Dirty-Sessions.
-  */
+ * This function returns Properties, Templates and Dirty-Sessions
+ * @param {*} db
+ * @returns Properties, Templates and Dirty-Sessions.
+ */
 module.exports.packagesAndSessions = (db) => {
   return async (req, res) => {
     const zclProperties = await queryPackage.getPackagesByType(
@@ -29,19 +29,19 @@ module.exports.packagesAndSessions = (db) => {
 }
 
 /**
-  * This function creates a new session with its packages according to selected Properties and Templates
-  * @param {*} db
-  * @param {*} options: object containing 'zcl' and 'template'
-  * @returns A success message.
-  */
+ * This function creates a new session with its packages according to selected Properties and Templates
+ * @param {*} db
+ * @param {*} options: object containing 'zcl' and 'template'
+ * @returns A success message.
+ */
 module.exports.initializeSession = (db, options) => {
   return async (req, res) => {
     let sessionUuid = req.query[restApi.param.sessionId]
     let userKey = req.session.id
     let user = await querySession.ensureUser(db, userKey)
     let sessionId = await querySession.ensureBlankSession(db, sessionUuid)
     await querySession.linkSessionToUser(db, sessionId, user.userId)
-    await util.initializeSessionPackage(
+    await util.ensurePackagesAndPopulateSessionOptions(
       db,
       sessionId,
       options,
@@ -55,10 +55,10 @@ module.exports.initializeSession = (db, options) => {
 }
 
 /**
-  * This function reloads previous session by user selected session's id
-  * @param {*} db
-  * @returns A success message.
-  */
+ * This function reloads previous session by user selected session's id
+ * @param {*} db
+ * @returns A success message.
+ */
 module.exports.loadPreviousSessions = (db) => {
   return async (req, res) => {
     let sessionUuid = req.query[restApi.param.sessionId]

src-electron/server/http-server.js

@@ -220,7 +220,7 @@ function userSessionHandler(db, options) {
         })
         .then((result) => {
           if (result.newSession) {
-            return util.initializeSessionPackage(
+            return util.ensurePackagesAndPopulateSessionOptions(
               db,
               result.sessionId,
               options,

src-electron/util/util.js

@@ -48,7 +48,8 @@ function checksum(data) {
 }
 
 /**
- * This function assigns a proper package ID to the session.
+ * This function assigns a proper package ID to the session if there
+ * are no packages present. It will also populate session options.
  *
  * @param {*} db
  * @param {*} sessionId
@@ -57,7 +58,7 @@ function checksum(data) {
  * @param {*} selectedGenTemplatePackages
  * @returns Promise that resolves with the packages array.
  */
-async function initializeSessionPackage(
+async function ensurePackagesAndPopulateSessionOptions(
   db,
   sessionId,
   options,
@@ -187,9 +188,20 @@ async function initializeSessionPackage(
     promises.push(genTemplateJsonPromise)
   }
 
-  await Promise.all(promises)
+  if (promises.length > 0) await Promise.all(promises)
 
+  // We read all the packages.
   let packages = await queryPackage.getSessionPackagesWithTypes(db, sessionId)
+
+  // Now we create promises with the queries that populate the
+  // session key/value pairs from package options.
+
+  await populateSessionPackageOptions(db, sessionId, packages)
+
+  return packages
+}
+
+async function populateSessionPackageOptions(db, sessionId, packages) {
   let p = packages.map((pkg) =>
     queryPackage
       .selectAllDefaultOptions(db, pkg.packageRef)
@@ -211,8 +223,7 @@ async function initializeSessionPackage(
       )
   )
 
-  await Promise.all(p)
-  return packages
+  return Promise.all(p)
 }
 
 /**
@@ -680,7 +691,8 @@ async function collectJsonData(jsonFile, recursiveLevel = 0) {
 
 exports.createBackupFile = createBackupFile
 exports.checksum = checksum
-exports.initializeSessionPackage = initializeSessionPackage
+exports.ensurePackagesAndPopulateSessionOptions =
+  ensurePackagesAndPopulateSessionOptions
 exports.matchFeatureLevel = matchFeatureLevel
 exports.sessionReport = sessionReport
 exports.sessionDump = sessionDump

test/gen-zigbee-1.test.js

@@ -96,7 +96,7 @@ test(
 test(
   'Initialize session packages',
   async () => {
-    let packages = await utilJs.initializeSessionPackage(
+    let packages = await utilJs.ensurePackagesAndPopulateSessionOptions(
       templateContext.db,
       templateContext.sessionId,
       {

test/query.test.js

@@ -187,7 +187,7 @@ describe('Session specific queries', () => {
       'SESSION'
     )
     sid = userSession.sessionId
-    await util.initializeSessionPackage(
+    await util.ensurePackagesAndPopulateSessionOptions(
       db,
       sid,
       {