@notifiles/sdk 1.3.0 → 1.5.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@notifiles/sdk",
   "type": "module",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "",
   "author": {
     "name": "adoucoure",

package/src/lib/async/runWithConcurrency.js

@@ -0,0 +1,32 @@
+// Runs `worker` over `items` with at most `concurrency` in flight at once.
+// Every item runs to completion regardless of sibling failures; if any
+// worker throws, a single aggregate error (with an `.errors` array) is
+// thrown after all items have settled, so a failure never abandons work
+// that was already in progress.
+export default async function runWithConcurrency(items, concurrency, worker) {
+  const queue = [...items]
+  const errors = []
+
+  const lanes = Array.from(
+    { length: Math.max(1, Math.min(concurrency, queue.length)) },
+    async () => {
+      while (queue.length) {
+        const item = queue.shift()
+        try {
+          await worker(item)
+        } catch (e) {
+          console.error(e)
+          errors.push(e)
+        }
+      }
+    }
+  )
+
+  await Promise.all(lanes)
+
+  if (errors.length) {
+    const error = new Error(`[notifiles] ${errors.length} of ${items.length} item(s) failed`)
+    error.errors = errors
+    throw error
+  }
+}

package/src/lib/fs/fileLock.js

@@ -0,0 +1,11 @@
+// Serializes concurrent reads/writes to the same file path so a read can
+// never observe a write mid-truncate (e.g. multiple locale versions of a
+// template racing on the same .activity.json during a parallel sync).
+const queues = new Map()
+
+export default function withFileLock(key, fn) {
+  const previous = queues.get(key) || Promise.resolve()
+  const run = previous.catch(() => {}).then(fn)
+  queues.set(key, run.catch(() => {}))
+  return run
+}

package/src/lib/fs/importJSONAsync.js

@@ -1,5 +1,7 @@
 import fs from "fs"
+import { fileURLToPath } from "url"
 import checkFileExists from "./checkFileExists.js"
+import withFileLock from "./fileLock.js"
 
 const expandEnvPlaceholders = (value) => {
   if (typeof value === 'string') {
@@ -29,7 +31,9 @@ export default async _url => {
     return null
   }
   const fileUrl = new URL(_url, import.meta.url)
-  const parsedPackageJSON = JSON.parse(await fs.promises.readFile(fileUrl, 'utf8'))
+  const parsedPackageJSON = await withFileLock(fileURLToPath(fileUrl), async () => {
+    return JSON.parse(await fs.promises.readFile(fileUrl, 'utf8'))
+  })
   return expandEnvPlaceholders(parsedPackageJSON)
   // } catch (e) {
   //   console.log("[notifiles]", `importJSONAsync → `, e)

package/src/template/lib/activity/updateToFile.js

@@ -2,6 +2,7 @@ import fsPath from 'path'
 import fs from 'fs'
 import checkFileExists from '../../../lib/fs/checkFileExists.js'
 import importJSONAsync from '../../../lib/fs/importJSONAsync.js'
+import withFileLock from '../../../lib/fs/fileLock.js'
 
 
 export default async ({
@@ -24,7 +25,9 @@ export default async ({
       ...content,
     }
 
-    await fs.promises.writeFile(filePath, JSON.stringify(_content, null, 2))
+    await withFileLock(fsPath.resolve(filePath), () =>
+      fs.promises.writeFile(filePath, JSON.stringify(_content, null, 2))
+    )
     return true
   } catch (e) {
     console.error(e)

package/src/template/sync/lib/pushNotification.js

@@ -9,6 +9,9 @@ export default async (props) => {
 
   const { entry, settings } = props
   const { path, pushNotification, buildPaths, } = entry
+  // pushNotification is null unless the template folder has a pushnotification.txt (set in lib/entries/getAtPath.js).
+  // Every template must ship a pushnotification.txt (an empty file is fine, see templates/social/subscription/*)
+  // or this destructure throws before the existence check below ever runs.
   const { text, } = pushNotification
 
   const textPath = `${path}/pushnotification.txt`

package/src/template/sync/lib/textMessage.js

@@ -9,6 +9,9 @@ export default async (props) => {
 
   const { entry, settings } = props
   const { path, textMessage, buildPaths, } = entry
+  // textMessage is null unless the template folder has a textmessage.txt (set in lib/entries/getAtPath.js).
+  // Every template must ship a textmessage.txt (an empty file is fine, see templates/social/subscription/*)
+  // or this destructure throws before the existence check below ever runs.
   const { text, } = textMessage
 
   const textPath = `${path}/textmessage.txt`

package/src/template/update/path.js

@@ -12,6 +12,9 @@ import {
   getCachedTemplateHash,
   updateTemplateHashCache
 } from './lib/cache.js'
+import runWithConcurrency from '../../lib/async/runWithConcurrency.js'
+
+const DEFAULT_CONCURRENCY = 4
 
 export default async ({
   path,
@@ -28,13 +31,14 @@ export default async ({
   }
 
   const forceUpdate = force || settings.forceUpdate
+  const concurrency = settings.concurrency || DEFAULT_CONCURRENCY
 
-  for (var i in entries) {
-    let entry = entries[i]
+  await runWithConcurrency(entries, concurrency, async (initialEntry) => {
+    let entry = initialEntry
 
     switch (entry.manifest.status) {
       case 'pause': {
-        continue
+        return
       }
       default: break
     }
@@ -43,7 +47,7 @@ export default async ({
     const currentHash = await computeTemplateHash({ path: entry.path })
     if (!forceUpdate && cachedHash && currentHash && cachedHash === currentHash) {
       console.log(`[notifiles] Skip ${entry.slug || entry.name || entry.path}: no changes detected`)
-      continue
+      return
     }
 
     entry = (await format({ entry, settings })).entry
@@ -53,7 +57,7 @@ export default async ({
     entry = (await cloudify({ entry, settings })).entry
     entry = (await attach({ entry, settings })).entry
     if (settings.dryRun) {
-      continue
+      return
     }
     entry = (await sync({ entry, settings })).entry
 
@@ -61,7 +65,7 @@ export default async ({
     if (newHash) {
       await updateTemplateHashCache({ path: entry.path, hash: newHash })
     }
-  }
+  })
 
   return true
 }