@notifiles/sdk 1.3.0 → 1.4.0

package/package.json

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

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`