@teambit/ipc-events 1.0.667 → 1.0.669
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { ScopeMain } from '@teambit/scope';
|
|
2
|
-
import { SlotRegistry } from '@teambit/harmony';
|
|
3
|
-
import { Logger, LoggerMain } from '@teambit/logger';
|
|
1
|
+
import type { ScopeMain } from '@teambit/scope';
|
|
2
|
+
import type { SlotRegistry } from '@teambit/harmony';
|
|
3
|
+
import type { Logger, LoggerMain } from '@teambit/logger';
|
|
4
4
|
type EventName = 'onPostInstall' | 'onPostObjectsPersist' | 'onNotifySSE';
|
|
5
5
|
type GotEvent = (eventName: EventName) => Promise<void>;
|
|
6
6
|
type GotEventSlot = SlotRegistry<GotEvent>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":["_scope","data","require","_harmony","_logger","_pMapSeries","_interopRequireDefault","_cli","_path","_fsExtra","_ipcEvents","e","__esModule","default","_defineProperty","r","t","_toPropertyKey","Object","defineProperty","value","enumerable","configurable","writable","i","_toPrimitive","Symbol","toPrimitive","call","TypeError","String","Number","EVENTS_DIR","IpcEventsMain","constructor","scope","gotEventSlot","logger","registerGotEventSlot","fn","register","triggerGotEvent","eventName","info","pMapSeries","values","publishIpcEvent","filename","path","join","eventsDir","content","JSON","stringify","undefined","fs","outputFile","publishIpcOnNotifySseEvent","event","provider","loggerMain","_","createLogger","IpcEventsAspect","id","ipcEventsMain","registerOnPostObjectsPersist","debug","legacyScope","objects","clearObjectsFromCache","setStagedSnaps","exports","Slot","withType","ScopeAspect","LoggerAspect","MainRuntime","addRuntime","_default"],"sources":["ipc-events.main.runtime.ts"],"sourcesContent":["import {
|
|
1
|
+
{"version":3,"names":["_scope","data","require","_harmony","_logger","_pMapSeries","_interopRequireDefault","_cli","_path","_fsExtra","_ipcEvents","e","__esModule","default","_defineProperty","r","t","_toPropertyKey","Object","defineProperty","value","enumerable","configurable","writable","i","_toPrimitive","Symbol","toPrimitive","call","TypeError","String","Number","EVENTS_DIR","IpcEventsMain","constructor","scope","gotEventSlot","logger","registerGotEventSlot","fn","register","triggerGotEvent","eventName","info","pMapSeries","values","publishIpcEvent","filename","path","join","eventsDir","content","JSON","stringify","undefined","fs","outputFile","publishIpcOnNotifySseEvent","event","provider","loggerMain","_","createLogger","IpcEventsAspect","id","ipcEventsMain","registerOnPostObjectsPersist","debug","legacyScope","objects","clearObjectsFromCache","setStagedSnaps","exports","Slot","withType","ScopeAspect","LoggerAspect","MainRuntime","addRuntime","_default"],"sources":["ipc-events.main.runtime.ts"],"sourcesContent":["import type { ScopeMain } from '@teambit/scope';\nimport { ScopeAspect } from '@teambit/scope';\nimport type { SlotRegistry } from '@teambit/harmony';\nimport { Slot } from '@teambit/harmony';\nimport type { Logger, LoggerMain } from '@teambit/logger';\nimport { LoggerAspect } from '@teambit/logger';\nimport pMapSeries from 'p-map-series';\nimport { MainRuntime } from '@teambit/cli';\nimport path from 'path';\nimport fs from 'fs-extra';\nimport { IpcEventsAspect } from './ipc-events.aspect';\n\ntype EventName = 'onPostInstall' | 'onPostObjectsPersist' | 'onNotifySSE';\n\ntype GotEvent = (eventName: EventName) => Promise<void>;\ntype GotEventSlot = SlotRegistry<GotEvent>;\n\nconst EVENTS_DIR = 'events';\n\n/**\n * You might have several processes running in the background (for example, bit watch, bit start, or bit server).\n * When the user runs `bit install`, these processes need to be notified that the installation has completed. One reason\n * is that \"bit start\" in the workspace could remove component-issues related to missing dependencies.\n *\n * To achieve this, an event file is written to the filesystem (e.g., .bit/events/<event-name>), and each background\n * process has a file watcher monitoring these event files. When an event file is created or updated, they can act upon it.\n *\n * For instance, when the user runs bit install, the “install” aspect calls publishIpcEvent, which writes\n * `.bit/events/onPostInstall`. The \"bit start\" process (along with others) detects the file change and invokes\n * `ipcEvents.triggerGotEvent()`. Any aspect subscribed to the gotEventSlot then runs its logic. In this example, the\n * installer aspect is subscribed, so when it recognizes the onPostInstall event, it triggers its own OnPostInstall slot.\n *\n * @see ./example-diagram.md for a visual representation of the above.\n */\nexport class IpcEventsMain {\n constructor(\n private scope: ScopeMain,\n private gotEventSlot: GotEventSlot,\n private logger: Logger\n ) {}\n\n registerGotEventSlot(fn: GotEvent) {\n this.gotEventSlot.register(fn);\n }\n\n /**\n * this gets called from the watcher only.\n * as soon as the watcher finds out that a new event has been written to the filesystem, it triggers this function\n */\n async triggerGotEvent(eventName: EventName) {\n this.logger.info(`triggering got event ${eventName}`);\n await pMapSeries(this.gotEventSlot.values(), (fn) => fn(eventName));\n }\n\n /**\n * write event data into the filesystem, so then other processes, such as \"bit start\", \"bit watch\", could use the\n * watcher to get the event data.\n */\n async publishIpcEvent(eventName: EventName, data?: Record<string, any>) {\n const filename = path.join(this.eventsDir, eventName);\n const content = data ? JSON.stringify(data, undefined, 2) : '';\n await fs.outputFile(filename, content);\n }\n\n /**\n * This is helpful when all we want is to notify the watchers that a new event has been written to the filesystem.\n * It doesn't require the watchers to register to GotEventSlot. The watchers always listen to this onNotifySSE event,\n * and once they get it, they simply send a server-send-event to the clients.\n */\n async publishIpcOnNotifySseEvent(event: string, data?: Record<string, any>) {\n await this.publishIpcEvent('onNotifySSE', { event, data });\n }\n\n get eventsDir() {\n return path.join(this.scope.path, EVENTS_DIR);\n }\n\n static slots = [Slot.withType<GotEventSlot>()];\n static dependencies = [ScopeAspect, LoggerAspect];\n static runtime = MainRuntime;\n\n static async provider([scope, loggerMain]: [ScopeMain, LoggerMain], _, [gotEventSlot]: [GotEventSlot]) {\n const logger = loggerMain.createLogger(IpcEventsAspect.id);\n const ipcEventsMain = new IpcEventsMain(scope, gotEventSlot, logger);\n\n if (scope) {\n // in case commands like \"bit export\" are running from the cli, long-running processes should clear their cache.\n // otherwise, objects like \"ModelComponent\" are out-of-date and could have the wrong head and the \"state\"/\"local\" data.\n scope.registerOnPostObjectsPersist(async () => {\n await ipcEventsMain.publishIpcEvent('onPostObjectsPersist');\n });\n ipcEventsMain.registerGotEventSlot(async (eventName) => {\n if (eventName === 'onPostObjectsPersist') {\n logger.debug('got an event onPostObjectsPersist, clearing the cache and reloading staged-snaps');\n scope.legacyScope.objects.clearObjectsFromCache();\n scope.legacyScope.setStagedSnaps(); // \"bit export\" deletes the staged-snaps file, so it should be reloaded\n }\n });\n }\n\n return ipcEventsMain;\n }\n}\n\nIpcEventsAspect.addRuntime(IpcEventsMain);\n\nexport default IpcEventsMain;\n"],"mappings":";;;;;;AACA,SAAAA,OAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,MAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAE,SAAA;EAAA,MAAAF,IAAA,GAAAC,OAAA;EAAAC,QAAA,YAAAA,CAAA;IAAA,OAAAF,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAG,QAAA;EAAA,MAAAH,IAAA,GAAAC,OAAA;EAAAE,OAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAI,YAAA;EAAA,MAAAJ,IAAA,GAAAK,sBAAA,CAAAJ,OAAA;EAAAG,WAAA,YAAAA,CAAA;IAAA,OAAAJ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAM,KAAA;EAAA,MAAAN,IAAA,GAAAC,OAAA;EAAAK,IAAA,YAAAA,CAAA;IAAA,OAAAN,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAO,MAAA;EAAA,MAAAP,IAAA,GAAAK,sBAAA,CAAAJ,OAAA;EAAAM,KAAA,YAAAA,CAAA;IAAA,OAAAP,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAQ,SAAA;EAAA,MAAAR,IAAA,GAAAK,sBAAA,CAAAJ,OAAA;EAAAO,QAAA,YAAAA,CAAA;IAAA,OAAAR,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAS,WAAA;EAAA,MAAAT,IAAA,GAAAC,OAAA;EAAAQ,UAAA,YAAAA,CAAA;IAAA,OAAAT,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAAsD,SAAAK,uBAAAK,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,SAAAG,gBAAAH,CAAA,EAAAI,CAAA,EAAAC,CAAA,YAAAD,CAAA,GAAAE,cAAA,CAAAF,CAAA,MAAAJ,CAAA,GAAAO,MAAA,CAAAC,cAAA,CAAAR,CAAA,EAAAI,CAAA,IAAAK,KAAA,EAAAJ,CAAA,EAAAK,UAAA,MAAAC,YAAA,MAAAC,QAAA,UAAAZ,CAAA,CAAAI,CAAA,IAAAC,CAAA,EAAAL,CAAA;AAAA,SAAAM,eAAAD,CAAA,QAAAQ,CAAA,GAAAC,YAAA,CAAAT,CAAA,uCAAAQ,CAAA,GAAAA,CAAA,GAAAA,CAAA;AAAA,SAAAC,aAAAT,CAAA,EAAAD,CAAA,2BAAAC,CAAA,KAAAA,CAAA,SAAAA,CAAA,MAAAL,CAAA,GAAAK,CAAA,CAAAU,MAAA,CAAAC,WAAA,kBAAAhB,CAAA,QAAAa,CAAA,GAAAb,CAAA,CAAAiB,IAAA,CAAAZ,CAAA,EAAAD,CAAA,uCAAAS,CAAA,SAAAA,CAAA,YAAAK,SAAA,yEAAAd,CAAA,GAAAe,MAAA,GAAAC,MAAA,EAAAf,CAAA;AAOtD,MAAMgB,UAAU,GAAG,QAAQ;;AAE3B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,aAAa,CAAC;EACzBC,WAAWA,CACDC,KAAgB,EAChBC,YAA0B,EAC1BC,MAAc,EACtB;IAAA,KAHQF,KAAgB,GAAhBA,KAAgB;IAAA,KAChBC,YAA0B,GAA1BA,YAA0B;IAAA,KAC1BC,MAAc,GAAdA,MAAc;EACrB;EAEHC,oBAAoBA,CAACC,EAAY,EAAE;IACjC,IAAI,CAACH,YAAY,CAACI,QAAQ,CAACD,EAAE,CAAC;EAChC;;EAEA;AACF;AACA;AACA;EACE,MAAME,eAAeA,CAACC,SAAoB,EAAE;IAC1C,IAAI,CAACL,MAAM,CAACM,IAAI,CAAC,wBAAwBD,SAAS,EAAE,CAAC;IACrD,MAAM,IAAAE,qBAAU,EAAC,IAAI,CAACR,YAAY,CAACS,MAAM,CAAC,CAAC,EAAGN,EAAE,IAAKA,EAAE,CAACG,SAAS,CAAC,CAAC;EACrE;;EAEA;AACF;AACA;AACA;EACE,MAAMI,eAAeA,CAACJ,SAAoB,EAAEzC,IAA0B,EAAE;IACtE,MAAM8C,QAAQ,GAAGC,eAAI,CAACC,IAAI,CAAC,IAAI,CAACC,SAAS,EAAER,SAAS,CAAC;IACrD,MAAMS,OAAO,GAAGlD,IAAI,GAAGmD,IAAI,CAACC,SAAS,CAACpD,IAAI,EAAEqD,SAAS,EAAE,CAAC,CAAC,GAAG,EAAE;IAC9D,MAAMC,kBAAE,CAACC,UAAU,CAACT,QAAQ,EAAEI,OAAO,CAAC;EACxC;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMM,0BAA0BA,CAACC,KAAa,EAAEzD,IAA0B,EAAE;IAC1E,MAAM,IAAI,CAAC6C,eAAe,CAAC,aAAa,EAAE;MAAEY,KAAK;MAAEzD;IAAK,CAAC,CAAC;EAC5D;EAEA,IAAIiD,SAASA,CAAA,EAAG;IACd,OAAOF,eAAI,CAACC,IAAI,CAAC,IAAI,CAACd,KAAK,CAACa,IAAI,EAAEhB,UAAU,CAAC;EAC/C;EAMA,aAAa2B,QAAQA,CAAC,CAACxB,KAAK,EAAEyB,UAAU,CAA0B,EAAEC,CAAC,EAAE,CAACzB,YAAY,CAAiB,EAAE;IACrG,MAAMC,MAAM,GAAGuB,UAAU,CAACE,YAAY,CAACC,4BAAe,CAACC,EAAE,CAAC;IAC1D,MAAMC,aAAa,GAAG,IAAIhC,aAAa,CAACE,KAAK,EAAEC,YAAY,EAAEC,MAAM,CAAC;IAEpE,IAAIF,KAAK,EAAE;MACT;MACA;MACAA,KAAK,CAAC+B,4BAA4B,CAAC,YAAY;QAC7C,MAAMD,aAAa,CAACnB,eAAe,CAAC,sBAAsB,CAAC;MAC7D,CAAC,CAAC;MACFmB,aAAa,CAAC3B,oBAAoB,CAAC,MAAOI,SAAS,IAAK;QACtD,IAAIA,SAAS,KAAK,sBAAsB,EAAE;UACxCL,MAAM,CAAC8B,KAAK,CAAC,kFAAkF,CAAC;UAChGhC,KAAK,CAACiC,WAAW,CAACC,OAAO,CAACC,qBAAqB,CAAC,CAAC;UACjDnC,KAAK,CAACiC,WAAW,CAACG,cAAc,CAAC,CAAC,CAAC,CAAC;QACtC;MACF,CAAC,CAAC;IACJ;IAEA,OAAON,aAAa;EACtB;AACF;AAACO,OAAA,CAAAvC,aAAA,GAAAA,aAAA;AAAAnB,eAAA,CApEYmB,aAAa,WA2CT,CAACwC,eAAI,CAACC,QAAQ,CAAe,CAAC,CAAC;AAAA5D,eAAA,CA3CnCmB,aAAa,kBA4CF,CAAC0C,oBAAW,EAAEC,sBAAY,CAAC;AAAA9D,eAAA,CA5CtCmB,aAAa,aA6CP4C,kBAAW;AAyB9Bd,4BAAe,CAACe,UAAU,CAAC7C,aAAa,CAAC;AAAC,IAAA8C,QAAA,GAAAP,OAAA,CAAA3D,OAAA,GAE3BoB,aAAa","ignoreList":[]}
|
package/package.json
CHANGED
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@teambit/ipc-events",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.669",
|
|
4
4
|
"homepage": "https://bit.cloud/teambit/harmony/ipc-events",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"componentId": {
|
|
7
7
|
"scope": "teambit.harmony",
|
|
8
8
|
"name": "ipc-events",
|
|
9
|
-
"version": "1.0.
|
|
9
|
+
"version": "1.0.669"
|
|
10
10
|
},
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"fs-extra": "10.0.0",
|
|
13
13
|
"p-map-series": "2.1.0",
|
|
14
14
|
"@teambit/harmony": "0.4.7",
|
|
15
|
-
"@teambit/cli": "0.0.
|
|
16
|
-
"@teambit/logger": "0.0.
|
|
17
|
-
"@teambit/scope": "1.0.
|
|
15
|
+
"@teambit/cli": "0.0.1246",
|
|
16
|
+
"@teambit/logger": "0.0.1339",
|
|
17
|
+
"@teambit/scope": "1.0.669"
|
|
18
18
|
},
|
|
19
19
|
"devDependencies": {
|
|
20
20
|
"@types/fs-extra": "9.0.7",
|
|
File without changes
|