@alwaysai/device-agent 1.3.0-1 → 1.3.1-1

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.
Files changed (115) hide show
  1. package/lib/application-control/environment-variables.d.ts +1 -0
  2. package/lib/application-control/environment-variables.d.ts.map +1 -1
  3. package/lib/application-control/environment-variables.js +22 -20
  4. package/lib/application-control/environment-variables.js.map +1 -1
  5. package/lib/application-control/environment-variables.test.js +37 -2
  6. package/lib/application-control/environment-variables.test.js.map +1 -1
  7. package/lib/application-control/install.js +1 -1
  8. package/lib/application-control/install.js.map +1 -1
  9. package/lib/cloud-connection/device-agent-cloud-connection.d.ts +4 -3
  10. package/lib/cloud-connection/device-agent-cloud-connection.d.ts.map +1 -1
  11. package/lib/cloud-connection/device-agent-cloud-connection.js +149 -113
  12. package/lib/cloud-connection/device-agent-cloud-connection.js.map +1 -1
  13. package/lib/cloud-connection/live-updates-handler.d.ts.map +1 -1
  14. package/lib/cloud-connection/live-updates-handler.js +30 -25
  15. package/lib/cloud-connection/live-updates-handler.js.map +1 -1
  16. package/lib/cloud-connection/live-updates-handler.test.js +15 -0
  17. package/lib/cloud-connection/live-updates-handler.test.js.map +1 -1
  18. package/lib/cloud-connection/messages.d.ts +1 -3
  19. package/lib/cloud-connection/messages.d.ts.map +1 -1
  20. package/lib/cloud-connection/messages.js +1 -9
  21. package/lib/cloud-connection/messages.js.map +1 -1
  22. package/lib/cloud-connection/publisher.d.ts +1 -0
  23. package/lib/cloud-connection/publisher.d.ts.map +1 -1
  24. package/lib/cloud-connection/publisher.js +3 -0
  25. package/lib/cloud-connection/publisher.js.map +1 -1
  26. package/lib/cloud-connection/shadow-handler.d.ts +12 -0
  27. package/lib/cloud-connection/shadow-handler.d.ts.map +1 -1
  28. package/lib/cloud-connection/shadow-handler.js +36 -22
  29. package/lib/cloud-connection/shadow-handler.js.map +1 -1
  30. package/lib/cloud-connection/shadow-handler.test.js +84 -40
  31. package/lib/cloud-connection/shadow-handler.test.js.map +1 -1
  32. package/lib/cloud-connection/transaction-manager.d.ts +25 -9
  33. package/lib/cloud-connection/transaction-manager.d.ts.map +1 -1
  34. package/lib/cloud-connection/transaction-manager.js +97 -28
  35. package/lib/cloud-connection/transaction-manager.js.map +1 -1
  36. package/lib/cloud-connection/transaction-manager.test.js +169 -22
  37. package/lib/cloud-connection/transaction-manager.test.js.map +1 -1
  38. package/lib/secure-tunneling/secure-tunneling.d.ts +105 -0
  39. package/lib/secure-tunneling/secure-tunneling.d.ts.map +1 -0
  40. package/lib/secure-tunneling/secure-tunneling.js +435 -0
  41. package/lib/secure-tunneling/secure-tunneling.js.map +1 -0
  42. package/lib/secure-tunneling/secure-tunneling.test.d.ts +2 -0
  43. package/lib/secure-tunneling/secure-tunneling.test.d.ts.map +1 -0
  44. package/lib/secure-tunneling/secure-tunneling.test.js +1070 -0
  45. package/lib/secure-tunneling/secure-tunneling.test.js.map +1 -0
  46. package/lib/secure-tunneling/spawner-detached.d.ts +6 -0
  47. package/lib/secure-tunneling/spawner-detached.d.ts.map +1 -0
  48. package/lib/secure-tunneling/spawner-detached.js +90 -0
  49. package/lib/secure-tunneling/spawner-detached.js.map +1 -0
  50. package/lib/subcommands/app/analytics.d.ts +10 -0
  51. package/lib/subcommands/app/analytics.d.ts.map +1 -0
  52. package/lib/subcommands/app/analytics.js +83 -0
  53. package/lib/subcommands/app/analytics.js.map +1 -0
  54. package/lib/subcommands/app/index.d.ts.map +1 -1
  55. package/lib/subcommands/app/index.js +3 -1
  56. package/lib/subcommands/app/index.js.map +1 -1
  57. package/lib/subcommands/app/models.d.ts +0 -5
  58. package/lib/subcommands/app/models.d.ts.map +1 -1
  59. package/lib/subcommands/app/models.js +11 -47
  60. package/lib/subcommands/app/models.js.map +1 -1
  61. package/lib/subcommands/app/status.d.ts +1 -0
  62. package/lib/subcommands/app/status.d.ts.map +1 -1
  63. package/lib/subcommands/app/status.js +14 -3
  64. package/lib/subcommands/app/status.js.map +1 -1
  65. package/lib/subcommands/app/version.d.ts +2 -1
  66. package/lib/subcommands/app/version.d.ts.map +1 -1
  67. package/lib/subcommands/app/version.js +16 -3
  68. package/lib/subcommands/app/version.js.map +1 -1
  69. package/lib/util/cloud-mode-ready.d.ts +1 -0
  70. package/lib/util/cloud-mode-ready.d.ts.map +1 -1
  71. package/lib/util/cloud-mode-ready.js +36 -1
  72. package/lib/util/cloud-mode-ready.js.map +1 -1
  73. package/lib/util/parsing.d.ts +2 -0
  74. package/lib/util/parsing.d.ts.map +1 -0
  75. package/lib/util/parsing.js +17 -0
  76. package/lib/util/parsing.js.map +1 -0
  77. package/package.json +4 -6
  78. package/readme.md +146 -92
  79. package/src/application-control/environment-variables.test.ts +43 -3
  80. package/src/application-control/environment-variables.ts +29 -19
  81. package/src/application-control/install.ts +1 -1
  82. package/src/cloud-connection/device-agent-cloud-connection.ts +216 -172
  83. package/src/cloud-connection/live-updates-handler.test.ts +20 -0
  84. package/src/cloud-connection/live-updates-handler.ts +45 -52
  85. package/src/cloud-connection/messages.ts +1 -14
  86. package/src/cloud-connection/publisher.ts +4 -0
  87. package/src/cloud-connection/shadow-handler.test.ts +93 -41
  88. package/src/cloud-connection/shadow-handler.ts +57 -21
  89. package/src/cloud-connection/transaction-manager.test.ts +183 -27
  90. package/src/cloud-connection/transaction-manager.ts +167 -36
  91. package/src/secure-tunneling/secure-tunneling.test.ts +1239 -0
  92. package/src/secure-tunneling/secure-tunneling.ts +606 -0
  93. package/src/secure-tunneling/spawner-detached.ts +107 -0
  94. package/src/subcommands/app/analytics.ts +99 -0
  95. package/src/subcommands/app/index.ts +4 -3
  96. package/src/subcommands/app/models.ts +13 -49
  97. package/src/subcommands/app/status.ts +20 -3
  98. package/src/subcommands/app/version.ts +19 -4
  99. package/src/util/cloud-mode-ready.ts +36 -0
  100. package/src/util/parsing.ts +11 -0
  101. package/lib/cloud-connection/cmd-status.d.ts +0 -8
  102. package/lib/cloud-connection/cmd-status.d.ts.map +0 -1
  103. package/lib/cloud-connection/cmd-status.js +0 -62
  104. package/lib/cloud-connection/cmd-status.js.map +0 -1
  105. package/lib/cloud-connection/message-builder.d.ts +0 -7
  106. package/lib/cloud-connection/message-builder.d.ts.map +0 -1
  107. package/lib/cloud-connection/message-builder.js +0 -63
  108. package/lib/cloud-connection/message-builder.js.map +0 -1
  109. package/lib/secure-tunneling/index.d.ts +0 -5
  110. package/lib/secure-tunneling/index.d.ts.map +0 -1
  111. package/lib/secure-tunneling/index.js +0 -64
  112. package/lib/secure-tunneling/index.js.map +0 -1
  113. package/src/cloud-connection/cmd-status.ts +0 -71
  114. package/src/cloud-connection/message-builder.ts +0 -117
  115. package/src/secure-tunneling/index.ts +0 -74
@@ -1,71 +0,0 @@
1
- import { logger } from '../util/logger';
2
-
3
- type CmdStatusType = 'idle' | 'in_progress';
4
-
5
- class CmdStatus {
6
- private projectId: string;
7
- private status: CmdStatusType;
8
-
9
- constructor(projectId: string, status: CmdStatusType) {
10
- this.projectId = projectId;
11
- this.status = status;
12
- }
13
-
14
- public getProjectId() {
15
- return this.projectId;
16
- }
17
-
18
- public update(status: CmdStatusType) {
19
- this.status = status;
20
- }
21
-
22
- public getStatus(): CmdStatusType {
23
- return this.status;
24
- }
25
- }
26
-
27
- export class CmdStatusManager {
28
- private apps: { [projectId: string]: CmdStatus } = {};
29
-
30
- public async start(projectId: string) {
31
- if (!(projectId in this.apps)) {
32
- const cmdStatus = new CmdStatus(projectId, 'in_progress');
33
- this.apps[projectId] = cmdStatus;
34
- } else if (this.apps[projectId].getStatus() !== 'in_progress') {
35
- this.apps[projectId].update('in_progress');
36
- } else {
37
- logger.debug(
38
- `Ignoring start for ${projectId} since it already has a command in progress`
39
- );
40
- return;
41
- }
42
- logger.debug(`Started command for ${projectId}`);
43
- }
44
-
45
- public async stop(projectId: string) {
46
- if (
47
- !(projectId in this.apps) ||
48
- this.apps[projectId].getStatus() === 'idle'
49
- ) {
50
- throw new Error(`No ongoing command to stop for ${projectId}`);
51
- }
52
- this.apps[projectId].update('idle');
53
- logger.debug(`Stopped command for ${projectId}`);
54
- }
55
-
56
- public isCmdInProgress(projectId: string): boolean {
57
- if (!(projectId in this.apps)) {
58
- return false;
59
- }
60
- return this.apps[projectId].getStatus() === 'in_progress';
61
- }
62
-
63
- public anyCmdInProgress() {
64
- for (const projectId in this.apps) {
65
- if (this.apps[projectId].getStatus() === 'in_progress') {
66
- return true;
67
- }
68
- }
69
- return false;
70
- }
71
- }
@@ -1,117 +0,0 @@
1
- import {
2
- AppLogsMessage,
3
- AppLogsMessageType,
4
- AppLogsPayload,
5
- AppStateMessage,
6
- AppStateMessageType,
7
- AppStatePayload,
8
- BaseToClientMessage,
9
- DeviceStatsMessage,
10
- DeviceStatsMessageType,
11
- DeviceStatsPayload,
12
- SignedUrlsRequestMessage,
13
- SignedUrlsRequestMessageType,
14
- SignedUrlsRequestPayload,
15
- StatusResponseMessage,
16
- StatusResponseMessageType,
17
- StatusResponsePayload,
18
- generateTxId,
19
- getToClientTopic,
20
- keyMirrors,
21
- validateToDeviceAgentMessage
22
- } from '@alwaysai/device-agent-schemas';
23
- import { getDeviceUuid } from '../util/get-device-id';
24
-
25
- function buildBaseClientMessage(txId?: string): BaseToClientMessage {
26
- const clientId = getDeviceUuid();
27
- const baseClientMessage = {
28
- timestamp: new Date().toUTCString(),
29
- deviceId: clientId,
30
- topic: getToClientTopic(clientId),
31
- txId: txId || generateTxId()
32
- };
33
- return baseClientMessage;
34
- }
35
-
36
- // Public Message Builders
37
-
38
- // app logs
39
- export async function buildAppLogsMessage(
40
- payload: AppLogsPayload,
41
- txId?: string
42
- ): Promise<AppLogsMessage> {
43
- const baseMessage = buildBaseClientMessage(txId);
44
- const messageType: AppLogsMessageType =
45
- keyMirrors.toClientMessageType.app_logs;
46
- const message = {
47
- ...baseMessage,
48
- messageType,
49
- payload
50
- };
51
- return message;
52
- }
53
-
54
- // app state
55
- export async function buildAppStateMessage(
56
- payload: AppStatePayload,
57
- txId?: string
58
- ): Promise<AppStateMessage> {
59
- const baseMessage = buildBaseClientMessage(txId);
60
- const messageType: AppStateMessageType =
61
- keyMirrors.toClientMessageType.app_state;
62
- const message = {
63
- ...baseMessage,
64
- messageType,
65
- payload
66
- };
67
- return message;
68
- }
69
-
70
- // signed URLs
71
- export async function buildSignedUrlsRequestMessage(
72
- payload: SignedUrlsRequestPayload,
73
- txId?: string
74
- ): Promise<SignedUrlsRequestMessage> {
75
- const baseMessage = buildBaseClientMessage(txId);
76
- const messageType: SignedUrlsRequestMessageType =
77
- keyMirrors.toCloudMessageType.signed_urls_request;
78
- const message = {
79
- ...baseMessage,
80
- messageType,
81
- payload
82
- };
83
- return message;
84
- }
85
-
86
- // status response
87
- export async function buildStatusResponseMessage(
88
- payload: StatusResponsePayload,
89
- txId?: string
90
- ): Promise<StatusResponseMessage> {
91
- const baseMessage = buildBaseClientMessage(txId);
92
- const messageType: StatusResponseMessageType =
93
- keyMirrors.toClientMessageType.status_response;
94
- const message = {
95
- ...baseMessage,
96
- messageType,
97
- payload
98
- };
99
- const valid = validateToDeviceAgentMessage(message);
100
- return message;
101
- }
102
-
103
- // device stats
104
- export async function buildDeviceStatsMessage(
105
- payload: DeviceStatsPayload,
106
- txId?: string
107
- ): Promise<DeviceStatsMessage> {
108
- const messageType: DeviceStatsMessageType =
109
- keyMirrors.toClientMessageType.device_stats;
110
- const baseMessage = buildBaseClientMessage(txId);
111
- const message = {
112
- ...baseMessage,
113
- messageType,
114
- payload
115
- };
116
- return message;
117
- }
@@ -1,74 +0,0 @@
1
- import { downloadFile } from '../util/download-file';
2
- import {
3
- SECURE_TUNNEL_BIN_DIR,
4
- SECURE_TUNNEL_BIN_PATH,
5
- SECURE_TUNNEL_BIN_NAME,
6
- AWS_ROOT_CERTIFICATE_FILE_PATH
7
- } from '../util/directories';
8
- import { AAI_DIR } from 'alwaysai/lib/paths';
9
- import { JsSpawner } from 'alwaysai/lib/util';
10
- import { join } from 'path';
11
- import { logger } from '../util/logger';
12
- import { aaiArtifactsBucketUrl } from '../urls';
13
- import { getDistribution, getOsVersion, getArch } from '../util/system-info';
14
-
15
- export async function secureTunnelNotifyHandler(message: {
16
- clientAccessToken: string;
17
- region: string;
18
- }) {
19
- const { clientAccessToken, region } = message;
20
- await terminateSecureTunnelProcess();
21
- await downloadSecureTunnel();
22
- logger.info('Starting Secure Tunnel');
23
-
24
- const args = [
25
- '--destination-app',
26
- '22',
27
- '--region',
28
- region,
29
- '--capath',
30
- AWS_ROOT_CERTIFICATE_FILE_PATH,
31
- '--local-bind-address',
32
- '0.0.0.0',
33
- '-t',
34
- clientAccessToken
35
- ];
36
-
37
- await JsSpawner().run({
38
- exe: `${SECURE_TUNNEL_BIN_PATH}`,
39
- args
40
- });
41
- }
42
-
43
- async function downloadSecureTunnel() {
44
- const arch = await getArch();
45
- const linuxDistro = await getDistribution();
46
- const osVersion = await getOsVersion();
47
-
48
- const url = `${aaiArtifactsBucketUrl}/securetunnel/${linuxDistro}/${osVersion}/${arch}/${SECURE_TUNNEL_BIN_NAME}`;
49
-
50
- await JsSpawner().mkdirp(join(AAI_DIR, SECURE_TUNNEL_BIN_DIR));
51
- await downloadFile({
52
- url,
53
- path: SECURE_TUNNEL_BIN_PATH,
54
- errorMessage: `Secure Tunnel bin for ${linuxDistro} ${osVersion} ${arch} not found}`
55
- });
56
-
57
- const spawner = JsSpawner();
58
- await spawner.run({
59
- exe: 'chmod',
60
- args: ['+x', SECURE_TUNNEL_BIN_PATH]
61
- });
62
- }
63
-
64
- async function terminateSecureTunnelProcess() {
65
- const spawner = JsSpawner();
66
- try {
67
- await spawner.run({
68
- exe: 'pkill',
69
- args: [SECURE_TUNNEL_BIN_NAME]
70
- });
71
- } catch (e) {
72
- logger.debug('Proccess terminated if status code is 1');
73
- }
74
- }