@gitpod/gitpod-protocol 0.1.5-se-workspace-for-teams.18 → 0.1.5-se-init.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 (230) hide show
  1. package/data/gitpod-schema.json +9 -2
  2. package/lib/accounting-protocol.d.ts +0 -1
  3. package/lib/accounting-protocol.d.ts.map +1 -1
  4. package/lib/accounting-protocol.js +10 -11
  5. package/lib/accounting-protocol.js.map +1 -1
  6. package/lib/admin-protocol.d.ts +8 -2
  7. package/lib/admin-protocol.d.ts.map +1 -1
  8. package/lib/admin-protocol.js +2 -13
  9. package/lib/admin-protocol.js.map +1 -1
  10. package/lib/analytics.d.ts +1 -0
  11. package/lib/analytics.d.ts.map +1 -1
  12. package/lib/context-url.js +4 -4
  13. package/lib/context-url.js.map +1 -1
  14. package/lib/context-url.spec.js +45 -48
  15. package/lib/context-url.spec.js.map +1 -1
  16. package/lib/email-protocol.js +4 -4
  17. package/lib/email-protocol.js.map +1 -1
  18. package/lib/encryption/container-module.js +4 -4
  19. package/lib/encryption/container-module.js.map +1 -1
  20. package/lib/encryption/encryption-engine.js +19 -20
  21. package/lib/encryption/encryption-engine.js.map +1 -1
  22. package/lib/encryption/encryption-engine.spec.js +29 -36
  23. package/lib/encryption/encryption-engine.spec.js.map +1 -1
  24. package/lib/encryption/encryption-service.js +29 -43
  25. package/lib/encryption/encryption-service.js.map +1 -1
  26. package/lib/encryption/key-provider.js +25 -30
  27. package/lib/encryption/key-provider.js.map +1 -1
  28. package/lib/env.d.ts +0 -1
  29. package/lib/env.d.ts.map +1 -1
  30. package/lib/env.js +12 -14
  31. package/lib/env.js.map +1 -1
  32. package/lib/gitpod-file-parser.js +25 -41
  33. package/lib/gitpod-file-parser.js.map +1 -1
  34. package/lib/gitpod-file-parser.spec.js +116 -116
  35. package/lib/gitpod-file-parser.spec.js.map +1 -1
  36. package/lib/gitpod-service.d.ts +24 -9
  37. package/lib/gitpod-service.d.ts.map +1 -1
  38. package/lib/gitpod-service.js +149 -295
  39. package/lib/gitpod-service.js.map +1 -1
  40. package/lib/ide-protocol.d.ts +81 -0
  41. package/lib/ide-protocol.d.ts.map +1 -0
  42. package/lib/ide-protocol.js +8 -0
  43. package/lib/ide-protocol.js.map +1 -0
  44. package/lib/index.d.ts +2 -0
  45. package/lib/index.d.ts.map +1 -1
  46. package/lib/index.js +2 -0
  47. package/lib/index.js.map +1 -1
  48. package/lib/messaging/browser/connection.d.ts +3 -3
  49. package/lib/messaging/browser/connection.d.ts.map +1 -1
  50. package/lib/messaging/browser/connection.js +172 -35
  51. package/lib/messaging/browser/connection.js.map +1 -1
  52. package/lib/messaging/browser/window-connection.js +35 -55
  53. package/lib/messaging/browser/window-connection.js.map +1 -1
  54. package/lib/messaging/client-call-metrics.js +17 -18
  55. package/lib/messaging/client-call-metrics.js.map +1 -1
  56. package/lib/messaging/connection-error-handler.js +11 -23
  57. package/lib/messaging/connection-error-handler.js.map +1 -1
  58. package/lib/messaging/error.d.ts +1 -1
  59. package/lib/messaging/error.d.ts.map +1 -1
  60. package/lib/messaging/error.js +2 -2
  61. package/lib/messaging/error.js.map +1 -1
  62. package/lib/messaging/handler.d.ts +10 -0
  63. package/lib/messaging/handler.d.ts.map +1 -1
  64. package/lib/messaging/node/connection.d.ts +0 -10
  65. package/lib/messaging/node/connection.d.ts.map +1 -1
  66. package/lib/messaging/node/connection.js +11 -49
  67. package/lib/messaging/node/connection.js.map +1 -1
  68. package/lib/messaging/proxy-factory.d.ts +2 -0
  69. package/lib/messaging/proxy-factory.d.ts.map +1 -1
  70. package/lib/messaging/proxy-factory.js +73 -160
  71. package/lib/messaging/proxy-factory.js.map +1 -1
  72. package/lib/oss-allowlist.d.ts +14 -0
  73. package/lib/oss-allowlist.d.ts.map +1 -0
  74. package/lib/oss-allowlist.js +8 -0
  75. package/lib/oss-allowlist.js.map +1 -0
  76. package/lib/permission.d.ts +1 -2
  77. package/lib/permission.d.ts.map +1 -1
  78. package/lib/permission.js +12 -13
  79. package/lib/permission.js.map +1 -1
  80. package/lib/plans.d.ts +1 -1
  81. package/lib/plans.d.ts.map +1 -1
  82. package/lib/plans.js +38 -57
  83. package/lib/plans.js.map +1 -1
  84. package/lib/protocol.d.ts +11 -7
  85. package/lib/protocol.d.ts.map +1 -1
  86. package/lib/protocol.js +44 -114
  87. package/lib/protocol.js.map +1 -1
  88. package/lib/snapshot-url.d.ts +14 -0
  89. package/lib/snapshot-url.d.ts.map +1 -0
  90. package/lib/snapshot-url.js +26 -0
  91. package/lib/snapshot-url.js.map +1 -0
  92. package/lib/snapshot-url.spec.d.ts +7 -0
  93. package/lib/snapshot-url.spec.d.ts.map +1 -0
  94. package/lib/snapshot-url.spec.js +41 -0
  95. package/lib/snapshot-url.spec.js.map +1 -0
  96. package/lib/team-subscription-protocol.js +13 -13
  97. package/lib/team-subscription-protocol.js.map +1 -1
  98. package/lib/teams-projects-protocol.d.ts +11 -1
  99. package/lib/teams-projects-protocol.d.ts.map +1 -1
  100. package/lib/teams-projects-protocol.js +4 -15
  101. package/lib/teams-projects-protocol.js.map +1 -1
  102. package/lib/util/analytics.js +25 -32
  103. package/lib/util/analytics.js.map +1 -1
  104. package/lib/util/async-iterator.js +55 -133
  105. package/lib/util/async-iterator.js.map +1 -1
  106. package/lib/util/cancelable.js +17 -59
  107. package/lib/util/cancelable.js.map +1 -1
  108. package/lib/util/date-time.js +8 -8
  109. package/lib/util/date-time.js.map +1 -1
  110. package/lib/util/deferred.js +10 -12
  111. package/lib/util/deferred.js.map +1 -1
  112. package/lib/util/disposable.js +26 -39
  113. package/lib/util/disposable.js.map +1 -1
  114. package/lib/util/event.js +58 -74
  115. package/lib/util/event.js.map +1 -1
  116. package/lib/util/garbage-collected-cache.d.ts +1 -0
  117. package/lib/util/garbage-collected-cache.d.ts.map +1 -1
  118. package/lib/util/garbage-collected-cache.js +26 -46
  119. package/lib/util/garbage-collected-cache.js.map +1 -1
  120. package/lib/util/generate-workspace-id.js +11 -67
  121. package/lib/util/generate-workspace-id.js.map +1 -1
  122. package/lib/util/generate-workspace-id.spec.js +34 -79
  123. package/lib/util/generate-workspace-id.spec.js.map +1 -1
  124. package/lib/util/gitpod-cookie.d.ts +20 -0
  125. package/lib/util/gitpod-cookie.d.ts.map +1 -0
  126. package/lib/util/gitpod-cookie.js +44 -0
  127. package/lib/util/gitpod-cookie.js.map +1 -0
  128. package/lib/util/gitpod-host-url.d.ts +1 -0
  129. package/lib/util/gitpod-host-url.d.ts.map +1 -1
  130. package/lib/util/gitpod-host-url.js +96 -103
  131. package/lib/util/gitpod-host-url.js.map +1 -1
  132. package/lib/util/gitpod-host-url.spec.js +87 -135
  133. package/lib/util/gitpod-host-url.spec.js.map +1 -1
  134. package/lib/util/grpc.js +3 -3
  135. package/lib/util/grpc.js.map +1 -1
  136. package/lib/util/jaeger-client-types.d.ts +68 -0
  137. package/lib/util/jaeger-client-types.d.ts.map +1 -0
  138. package/lib/util/jaeger-client-types.js +8 -0
  139. package/lib/util/jaeger-client-types.js.map +1 -0
  140. package/lib/util/logging.d.ts +32 -32
  141. package/lib/util/logging.d.ts.map +1 -1
  142. package/lib/util/logging.js +51 -125
  143. package/lib/util/logging.js.map +1 -1
  144. package/lib/util/make-link.js +2 -2
  145. package/lib/util/make-link.js.map +1 -1
  146. package/lib/util/parse-workspace-id.d.ts +10 -0
  147. package/lib/util/parse-workspace-id.d.ts.map +1 -1
  148. package/lib/util/parse-workspace-id.js +31 -7
  149. package/lib/util/parse-workspace-id.js.map +1 -1
  150. package/lib/util/parse-workspace-id.spec.d.ts +4 -0
  151. package/lib/util/parse-workspace-id.spec.d.ts.map +1 -1
  152. package/lib/util/parse-workspace-id.spec.js +123 -84
  153. package/lib/util/parse-workspace-id.spec.js.map +1 -1
  154. package/lib/util/queue.js +16 -55
  155. package/lib/util/queue.js.map +1 -1
  156. package/lib/util/queue.spec.js +144 -288
  157. package/lib/util/queue.spec.js.map +1 -1
  158. package/lib/util/repeat.d.ts +15 -0
  159. package/lib/util/repeat.d.ts.map +1 -0
  160. package/lib/util/repeat.js +55 -0
  161. package/lib/util/repeat.js.map +1 -0
  162. package/lib/util/safe-promise.js +9 -12
  163. package/lib/util/safe-promise.js.map +1 -1
  164. package/lib/util/semaphore.js +15 -46
  165. package/lib/util/semaphore.js.map +1 -1
  166. package/lib/util/skip-if.js +6 -6
  167. package/lib/util/skip-if.js.map +1 -1
  168. package/lib/util/timeutil.js +16 -16
  169. package/lib/util/timeutil.js.map +1 -1
  170. package/lib/util/timeutil.spec.js +21 -24
  171. package/lib/util/timeutil.spec.js.map +1 -1
  172. package/lib/util/tracing.d.ts +50 -5
  173. package/lib/util/tracing.d.ts.map +1 -1
  174. package/lib/util/tracing.js +171 -63
  175. package/lib/util/tracing.js.map +1 -1
  176. package/lib/util/tracing.spec.d.ts +7 -0
  177. package/lib/util/tracing.spec.d.ts.map +1 -0
  178. package/lib/util/tracing.spec.js +121 -0
  179. package/lib/util/tracing.spec.js.map +1 -0
  180. package/lib/util/workspace-port-authentication.js +2 -2
  181. package/lib/util/workspace-port-authentication.js.map +1 -1
  182. package/lib/workspace-cluster.d.ts +11 -1
  183. package/lib/workspace-cluster.d.ts.map +1 -1
  184. package/lib/workspace-cluster.js +3 -3
  185. package/lib/workspace-cluster.js.map +1 -1
  186. package/lib/workspace-instance.d.ts +4 -2
  187. package/lib/workspace-instance.d.ts.map +1 -1
  188. package/lib/wsready.js +1 -1
  189. package/package.json +20 -12
  190. package/pkg-yarn.lock +12 -7
  191. package/src/accounting-protocol.ts +1 -3
  192. package/src/admin-protocol.ts +9 -3
  193. package/src/analytics.ts +2 -0
  194. package/src/email-protocol.ts +1 -1
  195. package/src/env.ts +0 -1
  196. package/src/gitpod-service.ts +27 -14
  197. package/src/ide-protocol.ts +92 -0
  198. package/src/index.ts +2 -0
  199. package/src/messaging/browser/connection.ts +176 -10
  200. package/src/messaging/error.ts +2 -2
  201. package/src/messaging/handler.ts +12 -0
  202. package/src/messaging/node/connection.ts +1 -45
  203. package/src/messaging/proxy-factory.ts +10 -4
  204. package/src/oss-allowlist.ts +15 -0
  205. package/src/permission.ts +0 -1
  206. package/src/protocol.ts +13 -8
  207. package/src/snapshot-url.spec.ts +25 -0
  208. package/src/snapshot-url.ts +27 -0
  209. package/src/team-subscription-protocol.ts +1 -1
  210. package/src/teams-projects-protocol.ts +14 -2
  211. package/src/util/garbage-collected-cache.ts +7 -1
  212. package/src/util/gitpod-cookie.ts +39 -0
  213. package/src/util/gitpod-host-url.ts +9 -5
  214. package/src/util/grpc.ts +3 -3
  215. package/src/util/jaeger-client-types.ts +102 -0
  216. package/src/util/logging.ts +36 -41
  217. package/src/util/parse-workspace-id.spec.ts +21 -1
  218. package/src/util/parse-workspace-id.ts +32 -6
  219. package/src/util/repeat.ts +45 -0
  220. package/src/util/tracing.spec.ts +83 -0
  221. package/src/util/tracing.ts +157 -18
  222. package/src/workspace-cluster.ts +8 -1
  223. package/src/workspace-instance.ts +12 -6
  224. package/src/wsready.ts +1 -1
  225. package/lib/util/repeater.d.ts +0 -22
  226. package/lib/util/repeater.d.ts.map +0 -1
  227. package/lib/util/repeater.js +0 -118
  228. package/lib/util/repeater.js.map +0 -1
  229. package/src/util/jaeger-client.d.ts +0 -105
  230. package/src/util/repeater.ts +0 -49
@@ -6,7 +6,7 @@
6
6
 
7
7
  import * as chai from 'chai';
8
8
  import { suite, test } from 'mocha-typescript';
9
- import { parseWorkspaceIdFromHostname } from './parse-workspace-id';
9
+ import { matchesInstanceIdOrLegacyWorkspaceIdExactly, matchesNewWorkspaceIdExactly, parseWorkspaceIdFromHostname } from './parse-workspace-id';
10
10
  const expect = chai.expect;
11
11
 
12
12
  @suite
@@ -52,5 +52,25 @@ export class ParseWorkspaceIdTest {
52
52
  const actual = parseWorkspaceIdFromHostname("webview-3000-ca81a50f-09d7-465c-acd9-264a747d5351.ws-eu01.some.subdomain.somehost.com");
53
53
  expect(actual).to.equal("ca81a50f-09d7-465c-acd9-264a747d5351");
54
54
  }
55
+
56
+ // match - instance ID
57
+ @test public matchesInstanceIdOrLegacyWorkspaceIdExactly_positive() {
58
+ const actual = matchesInstanceIdOrLegacyWorkspaceIdExactly("b7e0eaf8-ec73-44ec-81ea-04859263b656");
59
+ expect(actual).to.be.true;
60
+ }
61
+ @test public matchesInstanceIdOrLegacyWorkspaceIdExactly_negative() {
62
+ const actual = matchesInstanceIdOrLegacyWorkspaceIdExactly("b7e0eaf8-ec73-44ec-81a-04859263b656");
63
+ expect(actual).to.be.false;
64
+ }
65
+
66
+ // match - new workspace ID
67
+ @test public matchesWorkspaceIdExactly_new_positive() {
68
+ const actual = matchesNewWorkspaceIdExactly("moccasin-ferret-155799b3");
69
+ expect(actual).to.be.true;
70
+ }
71
+ @test public matchesWorkspaceIdExactly_new_negative() {
72
+ const actual = matchesNewWorkspaceIdExactly("moccasin-ferret-15599b3");
73
+ expect(actual).to.be.false;
74
+ }
55
75
  }
56
76
  module.exports = new ParseWorkspaceIdTest()
@@ -4,6 +4,14 @@
4
4
  * See License-AGPL.txt in the project root for license information.
5
5
  */
6
6
 
7
+ const REGEX_WORKSPACE_ID = /[0-9a-z]{2,16}-[0-9a-z]{2,16}-[0-9a-z]{8}/;
8
+ const REGEX_WORKSPACE_ID_EXACT = new RegExp(`^${REGEX_WORKSPACE_ID.source}$`);
9
+ // We need to parse the workspace id precisely here to get the case '<some-str>-<port>-<wsid>.ws.' right
10
+ const REGEX_WORKSPACE_ID_FROM_HOSTNAME = new RegExp(`(${REGEX_WORKSPACE_ID.source})\.ws`);
11
+
12
+ const REGEX_WORKSPACE_ID_LEGACY = /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/;
13
+ const REGEX_WORKSPACE_ID_LEGACY_EXACT = new RegExp(`^${REGEX_WORKSPACE_ID_LEGACY.source}$`);
14
+ const REGEX_WORKSPACE_ID_LEGACY_FROM_HOSTNAME = new RegExp(`(${REGEX_WORKSPACE_ID_LEGACY.source})\.ws`);
7
15
 
8
16
  /**
9
17
  * Hostname may be of the form:
@@ -13,17 +21,35 @@
13
21
  * @param hostname The hostname the request is headed to
14
22
  */
15
23
  export const parseWorkspaceIdFromHostname = function(hostname: string) {
16
- // We need to parse the workspace id precisely here to get the case '<some-str>-<port>-<wsid>.ws.' right
17
- const wsIdExpression = /([0-9a-z]{2,16}-[0-9a-z]{2,16}-[0-9a-z]{8})\.ws/g;
18
- const match = wsIdExpression.exec(hostname);
24
+ const match = REGEX_WORKSPACE_ID_FROM_HOSTNAME.exec(hostname);
19
25
  if (match && match.length >= 2) {
20
26
  return match[1];
21
27
  } else {
22
- const legacyUrlFormat = /([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})\.ws/g;
23
- const legacyMatch = legacyUrlFormat.exec(hostname);
28
+ const legacyMatch = REGEX_WORKSPACE_ID_LEGACY_FROM_HOSTNAME.exec(hostname);
24
29
  if (legacyMatch && legacyMatch.length >= 2) {
25
30
  return legacyMatch[1];
26
31
  }
27
32
  return undefined;
28
33
  }
29
- }
34
+ };
35
+
36
+ /** Equalls UUIDv4 (and REGEX_WORKSPACE_ID_LEGACY!) */
37
+ const REGEX_INSTANCE_ID = /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/;
38
+ const REGEX_INSTANCE_ID_EXACT = new RegExp(`^${REGEX_INSTANCE_ID.source}$`);
39
+
40
+ /**
41
+ * @param maybeId
42
+ * @returns
43
+ */
44
+ export const matchesInstanceIdOrLegacyWorkspaceIdExactly = function(maybeId: string): boolean {
45
+ return REGEX_INSTANCE_ID_EXACT.test(maybeId)
46
+ || REGEX_WORKSPACE_ID_LEGACY_EXACT.test(maybeId);
47
+ };
48
+
49
+ /**
50
+ * @param maybeWorkspaceId
51
+ * @returns
52
+ */
53
+ export const matchesNewWorkspaceIdExactly = function(maybeWorkspaceId: string): boolean {
54
+ return REGEX_WORKSPACE_ID_EXACT.test(maybeWorkspaceId);
55
+ };
@@ -0,0 +1,45 @@
1
+ /**
2
+ * Copyright (c) 2021 Gitpod GmbH. All rights reserved.
3
+ * Licensed under the GNU Affero General Public License (AGPL).
4
+ * See License-AGPL.txt in the project root for license information.
5
+ */
6
+
7
+ import { Disposable } from "..";
8
+ import { log } from "./logging";
9
+
10
+ /**
11
+ * This intends to be a drop-in replacement for 'setInterval' implemented with a 'setTimeout' chain
12
+ * to ensure we're not creating more timeouts than we can process.
13
+ * @param op
14
+ * @param everyMilliseconds
15
+ * @returns
16
+ */
17
+ export function repeat(op: () => Promise<void> | void, everyMilliseconds: number): Disposable {
18
+ let timer: NodeJS.Timeout | undefined = undefined;
19
+ let stopped = false;
20
+ const repeated = () => {
21
+ if (stopped) {
22
+ // in case we missed the clearTimeout i 'await'
23
+ return;
24
+ }
25
+
26
+ timer = setTimeout(async () => {
27
+ try {
28
+ await op();
29
+ } catch (err) {
30
+ // catch error here to
31
+ log.error(err);
32
+ }
33
+
34
+ repeated(); // chain ourselves - after the 'await'
35
+ }, everyMilliseconds);
36
+ };
37
+ repeated();
38
+
39
+ return Disposable.create(() => {
40
+ stopped = true;
41
+ if (timer) {
42
+ clearTimeout(timer);
43
+ }
44
+ });
45
+ }
@@ -0,0 +1,83 @@
1
+ /**
2
+ * Copyright (c) 2021 Gitpod GmbH. All rights reserved.
3
+ * Licensed under the GNU Affero General Public License (AGPL).
4
+ * See License-AGPL.txt in the project root for license information.
5
+ */
6
+
7
+ import { suite, test } from "mocha-typescript"
8
+ import * as chai from "chai"
9
+ import { TraceContext } from "./tracing";
10
+ import { MockTracer } from "opentracing";
11
+
12
+ const expect = chai.expect
13
+
14
+ @suite class TestTracing {
15
+
16
+ @test public async testTracingContext_addNestedTags() {
17
+ const tracer = new MockTracer();
18
+ const span = tracer.startSpan('testTracingContext_addNestedTags');
19
+ TraceContext.addNestedTags({ span }, {
20
+ rpc: {
21
+ system: "jsonrpc",
22
+ jsonrpc: {
23
+ version: "1.0",
24
+ method: "test",
25
+ parameters: ["abc", "def"],
26
+ },
27
+ },
28
+ });
29
+
30
+ const mockSpan = tracer.report().spans[0];
31
+ expect(mockSpan.tags()).to.deep.equal({
32
+ "rpc.system": "jsonrpc",
33
+ "rpc.jsonrpc.version": "1.0",
34
+ "rpc.jsonrpc.method": "test",
35
+ "rpc.jsonrpc.parameters.0": "abc",
36
+ "rpc.jsonrpc.parameters.1": "def",
37
+ });
38
+ }
39
+
40
+ @test public async testTracingContext_addNestedTags_null() {
41
+ const tracer = new MockTracer();
42
+ const span = tracer.startSpan('testTracingContext_addNestedTags_null');
43
+ TraceContext.addNestedTags({ span }, {
44
+ someShape: {
45
+ thisIsNull: null,
46
+ thisIsUndefined: undefined,
47
+ },
48
+ });
49
+
50
+ const mockSpan = tracer.report().spans[0];
51
+ expect(mockSpan.tags()).to.deep.equal({
52
+ "someShape.thisIsNull": null,
53
+ "someShape.thisIsUndefined": undefined,
54
+ });
55
+ }
56
+
57
+ @test public async testTracingContext_addJsonRPCParameters() {
58
+ const tracer = new MockTracer();
59
+ const span = tracer.startSpan('testTracingContext_addJsonRPCParameters');
60
+ const ctx = { span };
61
+ TraceContext.addJsonRPCParameters(ctx, {
62
+ one: "one",
63
+ two: {
64
+ name: "two",
65
+ some: "shape",
66
+ containing: "PII",
67
+ },
68
+ three: "three",
69
+ });
70
+
71
+ const mockSpan = tracer.report().spans[0];
72
+ expect(mockSpan.tags()).to.deep.equal({
73
+ "rpc.jsonrpc.parameters.one": "one",
74
+ "rpc.jsonrpc.parameters.two.containing": "PII",
75
+ "rpc.jsonrpc.parameters.two.name": "two",
76
+ "rpc.jsonrpc.parameters.two.some": "shape",
77
+ "rpc.jsonrpc.parameters.three": "three",
78
+ "rpc.system": "jsonrpc",
79
+ });
80
+ }
81
+
82
+ }
83
+ module.exports = new TestTracing()
@@ -6,40 +6,157 @@
6
6
 
7
7
 
8
8
  import * as opentracing from 'opentracing';
9
- import { TracingConfig, initTracerFromEnv, Sampler, SamplingDecision } from 'jaeger-client';
10
- import { initGlobalTracer } from 'opentracing';
9
+ import { TracingConfig, initTracerFromEnv } from 'jaeger-client';
10
+ import { Sampler, SamplingDecision } from './jaeger-client-types';
11
+ import { followsFrom, initGlobalTracer } from 'opentracing';
11
12
  import { injectable } from 'inversify';
13
+ import { ResponseError } from 'vscode-jsonrpc';
14
+ import { log, LogContext } from './logging';
12
15
 
13
16
  export interface TraceContext {
14
17
  span?: opentracing.Span
15
18
  }
19
+ export type TraceContextWithSpan = TraceContext & {
20
+ span: opentracing.Span
21
+ }
22
+
16
23
 
17
24
  export namespace TraceContext {
18
- export function startSpan(operation: string, ctx: TraceContext): opentracing.Span {
19
- const options: opentracing.SpanOptions = {
20
- childOf: ctx.span
25
+ export function startSpan(operation: string, parentCtx?: TraceContext, ...referencedSpans: (opentracing.Span | undefined)[]): opentracing.Span {
26
+ const options: opentracing.SpanOptions = {};
27
+ if (parentCtx) {
28
+ options.childOf = parentCtx.span;
29
+ }
30
+ if (referencedSpans) {
31
+ // note: allthough followsForm's type says it takes 'opentracing.Span | opentracing.SpanContext', it only works with SpanContext (typing mismatch)
32
+ options.references = referencedSpans.filter(s => s !== undefined).map(s => followsFrom(s!.context()));
21
33
  }
34
+
22
35
  return opentracing.globalTracer().startSpan(operation, options);
23
36
  }
24
37
 
25
- export function startAsyncSpan(operation: string, ctx: TraceContext): opentracing.Span {
26
- const options: opentracing.SpanOptions = {};
27
- if (!!ctx.span) {
28
- options.references = [opentracing.followsFrom(ctx.span.context())];
38
+ export function childContext(operation: string, parentCtx: TraceContext): TraceContextWithSpan {
39
+ const span = startSpan(operation, parentCtx);
40
+ return { span };
41
+ }
42
+
43
+ export function setError(ctx: TraceContext, err: Error) {
44
+ if (!ctx.span) {
45
+ return;
29
46
  }
30
- return opentracing.globalTracer().startSpan(operation, options);
47
+
48
+ TraceContext.addNestedTags(ctx, {
49
+ error: {
50
+ message: err.message,
51
+ stacktrace: err.stack,
52
+ },
53
+ });
54
+ ctx.span.setTag("error", true);
55
+ }
56
+
57
+ export function setJsonRPCMetadata(ctx: TraceContext, method?: string) {
58
+ if (!ctx.span) {
59
+ return;
60
+ }
61
+
62
+ const tags: { [key: string]: any } = {
63
+ rpc: {
64
+ system: "jsonrpc",
65
+ // version,
66
+ },
67
+ };
68
+ if (method) {
69
+ tags.rpc.method = method;
70
+ }
71
+ addNestedTags(ctx, tags);
72
+ }
73
+
74
+ export function setJsonRPCError(ctx: TraceContext, method: string, err: ResponseError<any>) {
75
+ if (!ctx.span) {
76
+ return;
77
+ }
78
+ // not use setError bc this is (most likely) a working operation
79
+
80
+ setJsonRPCMetadata(ctx);
81
+ // https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/rpc.md#json-rpc
82
+ addNestedTags(ctx, {
83
+ rpc: {
84
+ jsonrpc: {
85
+ error_code: err.code,
86
+ error_message: err.message,
87
+ },
88
+ },
89
+ });
31
90
  }
32
91
 
33
- export function logError(ctx: TraceContext, err: Error) {
92
+ export function addJsonRPCParameters(ctx: TraceContext, params: { [key: string]: any }) {
34
93
  if (!ctx.span) {
35
94
  return;
36
95
  }
37
96
 
38
- ctx.span.log({
39
- "error": err.message,
40
- "stacktrace": err.stack
41
- })
42
- ctx.span.setTag("error", true)
97
+ setJsonRPCMetadata(ctx);
98
+ addNestedTags(ctx, {
99
+ rpc: {
100
+ jsonrpc: {
101
+ parameters: params,
102
+ },
103
+ },
104
+ });
105
+ }
106
+
107
+ /**
108
+ * Does what one would expect from `span.addTags`: Calls `span.addTag` for all keys in map, recursively for objects.
109
+ * Example:
110
+ * ```
111
+ * TraceContext.addNestedTags(ctx, {
112
+ * rpc: {
113
+ * system: "jsonrpc",
114
+ * jsonrpc: {
115
+ * version: "1.0",
116
+ * method: "test",
117
+ * parameters: ["abc", "def"],
118
+ * },
119
+ * },
120
+ * });
121
+ * ```
122
+ * gives
123
+ * rpc.system = "jsonrpc"
124
+ * rpc.jsonrpc.version = "1.0"
125
+ * rpc.jsonrpc.method = "test"
126
+ * rpc.jsonrpc.parameters.0 = "abc"
127
+ * rpc.jsonrpc.parameters.1 = "def"
128
+ * @param ctx
129
+ * @param keyValueMap
130
+ * @returns
131
+ */
132
+ export function addNestedTags(ctx: TraceContext, keyValueMap: { [key: string]: any }, _namespace?: string) {
133
+ if (!ctx.span) {
134
+ return;
135
+ }
136
+ const namespace = _namespace ? `${_namespace}.` : '';
137
+
138
+ try {
139
+ for (const k of Object.keys(keyValueMap)) {
140
+ const v = keyValueMap[k];
141
+ if (v instanceof Object) {
142
+ addNestedTags(ctx, v, `${namespace}${k}`);
143
+ } else {
144
+ ctx.span.setTag(`${namespace}${k}`, v);
145
+ }
146
+ }
147
+ } catch (err) {
148
+ // general resilience against odd shapes/parameters
149
+ log.error("Tracing.addNestedTags", err, { namespace });
150
+ }
151
+ }
152
+
153
+ export function setOWI(ctx: TraceContext, owi: LogContext) {
154
+ if (!ctx.span) {
155
+ return;
156
+ }
157
+ addNestedTags(ctx, {
158
+ context: owi,
159
+ });
43
160
  }
44
161
  }
45
162
 
@@ -56,11 +173,16 @@ export class TracingManager {
56
173
  reporter: {
57
174
  logSpans: false
58
175
  },
59
- serviceName
176
+ serviceName,
60
177
  }
61
178
  const t = initTracerFromEnv(config, {
62
- logger: console
179
+ logger: console,
180
+ tags: {
181
+ 'service.build.commit': process.env.GITPOD_BUILD_GIT_COMMIT,
182
+ 'service.build.version': process.env.GITPOD_BUILD_VERSION,
183
+ }
63
184
  });
185
+
64
186
  if (opts) {
65
187
  if (opts.perOpSampling) {
66
188
  (t as any)._sampler = new PerOperationSampler((t as any)._sampler, opts.perOpSampling);
@@ -132,3 +254,20 @@ export class PerOperationSampler implements Sampler {
132
254
  }
133
255
  }
134
256
  }
257
+
258
+ // Augment interfaces with an leading parameter "TraceContext" on every method
259
+ type IsValidArg<T> = T extends object ? keyof T extends never ? false : true : true;
260
+ type AddTraceContext<T> =
261
+ T extends (a: infer A, b: infer B, c: infer C, d: infer D, e: infer E, f: infer F) => infer R ? (
262
+ IsValidArg<F> extends true ? (ctx: TraceContextWithSpan, a: A, b: B, c: C, d: D, e: E, f: F) => R :
263
+ IsValidArg<E> extends true ? (ctx: TraceContextWithSpan, a: A, b: B, c: C, d: D, e: E) => R :
264
+ IsValidArg<D> extends true ? (ctx: TraceContextWithSpan, a: A, b: B, c: C, d: D) => R :
265
+ IsValidArg<C> extends true ? (ctx: TraceContextWithSpan, a: A, b: B, c: C) => R :
266
+ IsValidArg<B> extends true ? (ctx: TraceContextWithSpan, a: A, b: B) => R :
267
+ IsValidArg<A> extends true ? (ctx: TraceContextWithSpan, a: A) => R :
268
+ (ctx: TraceContextWithSpan) => Promise<R>
269
+ ) : never;
270
+
271
+ export type InterfaceWithTraceContext<T> = {
272
+ [P in keyof T]: AddTraceContext<T[P]>
273
+ };
@@ -35,6 +35,9 @@ export interface WorkspaceCluster {
35
35
 
36
36
  // An optional set of constraints that limit who can start workspaces on the cluster
37
37
  admissionConstraints?: AdmissionConstraint[];
38
+
39
+ // An optional set of admission preferences that guide cluster selection
40
+ admissionPreferences?: AdmissionPreference[];
38
41
  }
39
42
 
40
43
  export type WorkspaceClusterState = "available" | "cordoned" | "draining";
@@ -52,9 +55,13 @@ export namespace TLSConfig {
52
55
  export type WorkspaceClusterWoTLS = Omit<WorkspaceCluster, "tls">;
53
56
  export type WorkspaceManagerConnectionInfo = Pick<WorkspaceCluster, "name" | "url" | "tls">;
54
57
 
55
- export type AdmissionConstraint = AdmissionConstraintFeaturePreview | AdmissionConstraintHasRole;
58
+ export type AdmissionConstraint = AdmissionConstraintFeaturePreview | AdmissionConstraintHasRole | AdmissionConstraintHasUserLevel;
56
59
  export type AdmissionConstraintFeaturePreview = { type: "has-feature-preview" };
57
60
  export type AdmissionConstraintHasRole = { type: "has-permission", permission: PermissionName };
61
+ export type AdmissionConstraintHasUserLevel = { type: "has-user-level", level: string };
62
+
63
+ export type AdmissionPreference = AdmissionPreferenceUserLevel;
64
+ export type AdmissionPreferenceUserLevel = { type: 'user-level', level: string };
58
65
 
59
66
 
60
67
  export const WorkspaceClusterDB = Symbol("WorkspaceClusterDB");
@@ -134,9 +134,6 @@ export interface WorkspaceInstanceConditions {
134
134
  // PullingImages marks if the workspace is currently pulling its images. This condition can only be set during PhaseCreating
135
135
  pullingImages?: boolean
136
136
 
137
- // ServiceExists denotes if the workspace theia-/ports- services exist. This condition will be true if either of the two services exist.
138
- serviceExists?: boolean
139
-
140
137
  // deployed marks that a workspace instance was sent/deployed at a workspace manager
141
138
  deployed?: boolean;
142
139
 
@@ -145,6 +142,12 @@ export interface WorkspaceInstanceConditions {
145
142
 
146
143
  // ISO8601 timestamp when the first user activity was registered in the frontend. Only set if the workspace is running.
147
144
  firstUserActivity?: string;
145
+
146
+ // headless_task_failed indicates that a headless workspace task failed
147
+ headlessTaskFailed?: string;
148
+
149
+ // stopped_by_request is true if the workspace was stopped using a StopWorkspace call
150
+ stoppedByRequest?: boolean;
148
151
  }
149
152
 
150
153
  // AdmissionLevel describes who can access a workspace instance and its ports.
@@ -158,9 +161,6 @@ export interface WorkspaceInstancePort {
158
161
  // The outward-facing port number
159
162
  port: number;
160
163
 
161
- // An optional inward-facing port number. If not present we'll use port.
162
- targetPort?: number;
163
-
164
164
  // The visiblity of this port. Optional for backwards compatibility.
165
165
  visibility?: PortVisibility;
166
166
 
@@ -206,4 +206,10 @@ export interface WorkspaceInstanceConfiguration {
206
206
 
207
207
  // ideImage is the ref of the IDE image this instance uses.
208
208
  ideImage: string;
209
+
210
+ // desktopIdeImage is the ref of the desktop IDE image this instance uses.
211
+ desktopIdeImage?: string
212
+
213
+ // supervisorImage is the ref of the supervisor image this instance uses.
214
+ supervisorImage?: string;
209
215
  }
package/src/wsready.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * See License-AGPL.txt in the project root for license information.
5
5
  */
6
6
 
7
- // generated using github.com/32leaves/bel on 2021-08-03 10:42:32.582603295 +0000 UTC m=+0.005734479
7
+ // generated using github.com/32leaves/bel on 2021-11-04 12:16:53.917570766 +0000 UTC m=+0.006002884
8
8
  // DO NOT MODIFY
9
9
 
10
10
  export enum WorkspaceInitSource {
@@ -1,22 +0,0 @@
1
- /**
2
- * Copyright (c) 2020 Gitpod GmbH. All rights reserved.
3
- * Licensed under the GNU Affero General Public License (AGPL).
4
- * See License-AGPL.txt in the project root for license information.
5
- */
6
- import { Deferred } from "./deferred";
7
- /**
8
- * Repeats a given function until it is stopped
9
- */
10
- export declare class Repeater {
11
- protected readonly fn: () => Promise<void> | void;
12
- protected readonly timeout: number;
13
- protected shouldRun: boolean;
14
- protected finished: Deferred<void>;
15
- protected timer?: any;
16
- constructor(fn: () => Promise<void> | void, timeout: number);
17
- start(): Promise<void>;
18
- run(): Promise<void>;
19
- protected sleep(timeout: number): Promise<unknown>;
20
- stop(): Promise<void>;
21
- }
22
- //# sourceMappingURL=repeater.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"repeater.d.ts","sourceRoot":"","sources":["../../src/util/repeater.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC;;GAEG;AACH,qBAAa,QAAQ;IAKL,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;IAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM;IAJjG,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC;IAC7B,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA;IAClC,SAAS,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC;gBAES,EAAE,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,EAAqB,OAAO,EAAE,MAAM;IAE3F,KAAK;IAIL,GAAG;cAcO,KAAK,CAAC,OAAO,EAAE,MAAM;IAI/B,IAAI;CAOb"}
@@ -1,118 +0,0 @@
1
- "use strict";
2
- /**
3
- * Copyright (c) 2020 Gitpod GmbH. All rights reserved.
4
- * Licensed under the GNU Affero General Public License (AGPL).
5
- * See License-AGPL.txt in the project root for license information.
6
- */
7
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
8
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
9
- return new (P || (P = Promise))(function (resolve, reject) {
10
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
11
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
12
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
13
- step((generator = generator.apply(thisArg, _arguments || [])).next());
14
- });
15
- };
16
- var __generator = (this && this.__generator) || function (thisArg, body) {
17
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
18
- return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
19
- function verb(n) { return function (v) { return step([n, v]); }; }
20
- function step(op) {
21
- if (f) throw new TypeError("Generator is already executing.");
22
- while (_) try {
23
- if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
24
- if (y = 0, t) op = [op[0] & 2, t.value];
25
- switch (op[0]) {
26
- case 0: case 1: t = op; break;
27
- case 4: _.label++; return { value: op[1], done: false };
28
- case 5: _.label++; y = op[1]; op = [0]; continue;
29
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
30
- default:
31
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
32
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
33
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
34
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
35
- if (t[2]) _.ops.pop();
36
- _.trys.pop(); continue;
37
- }
38
- op = body.call(thisArg, _);
39
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
40
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
41
- }
42
- };
43
- Object.defineProperty(exports, "__esModule", { value: true });
44
- exports.Repeater = void 0;
45
- var deferred_1 = require("./deferred");
46
- var logging_1 = require("./logging");
47
- /**
48
- * Repeats a given function until it is stopped
49
- */
50
- var Repeater = /** @class */ (function () {
51
- function Repeater(fn, timeout) {
52
- this.fn = fn;
53
- this.timeout = timeout;
54
- }
55
- Repeater.prototype.start = function () {
56
- return __awaiter(this, void 0, void 0, function () {
57
- return __generator(this, function (_a) {
58
- this.run();
59
- return [2 /*return*/];
60
- });
61
- });
62
- };
63
- Repeater.prototype.run = function () {
64
- return __awaiter(this, void 0, void 0, function () {
65
- var err_1;
66
- return __generator(this, function (_a) {
67
- switch (_a.label) {
68
- case 0:
69
- this.shouldRun = true;
70
- this.finished = new deferred_1.Deferred();
71
- _a.label = 1;
72
- case 1:
73
- if (!this.shouldRun) return [3 /*break*/, 7];
74
- _a.label = 2;
75
- case 2:
76
- _a.trys.push([2, 4, , 5]);
77
- return [4 /*yield*/, this.fn()];
78
- case 3:
79
- _a.sent();
80
- return [3 /*break*/, 5];
81
- case 4:
82
- err_1 = _a.sent();
83
- logging_1.log.error(err_1);
84
- return [3 /*break*/, 5];
85
- case 5: return [4 /*yield*/, this.sleep(this.timeout)];
86
- case 6:
87
- _a.sent();
88
- return [3 /*break*/, 1];
89
- case 7:
90
- this.finished.resolve();
91
- return [2 /*return*/];
92
- }
93
- });
94
- });
95
- };
96
- Repeater.prototype.sleep = function (timeout) {
97
- return __awaiter(this, void 0, void 0, function () {
98
- var _this = this;
99
- return __generator(this, function (_a) {
100
- return [2 /*return*/, new Promise(function (resolve) { return _this.timer = setTimeout(resolve, timeout); })];
101
- });
102
- });
103
- };
104
- Repeater.prototype.stop = function () {
105
- return __awaiter(this, void 0, void 0, function () {
106
- return __generator(this, function (_a) {
107
- this.shouldRun = false;
108
- if (this.timer) {
109
- clearTimeout(this.timer);
110
- }
111
- return [2 /*return*/, this.finished.promise];
112
- });
113
- });
114
- };
115
- return Repeater;
116
- }());
117
- exports.Repeater = Repeater;
118
- //# sourceMappingURL=repeater.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"repeater.js","sourceRoot":"","sources":["../../src/util/repeater.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAsC;AACtC,qCAAgC;AAEhC;;GAEG;AACH;IAKI,kBAA+B,EAA8B,EAAqB,OAAe;QAAlE,OAAE,GAAF,EAAE,CAA4B;QAAqB,YAAO,GAAP,OAAO,CAAQ;IAAI,CAAC;IAEhG,wBAAK,GAAX;;;gBACI,IAAI,CAAC,GAAG,EAAE,CAAC;;;;KACd;IAEK,sBAAG,GAAT;;;;;;wBACI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;wBACtB,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,EAAQ,CAAC;;;6BAC9B,IAAI,CAAC,SAAS;;;;wBAEb,qBAAM,IAAI,CAAC,EAAE,EAAE,EAAA;;wBAAf,SAAe,CAAC;;;;wBAEhB,aAAG,CAAC,KAAK,CAAC,KAAG,CAAC,CAAC;;4BAEnB,qBAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAA;;wBAA9B,SAA8B,CAAC;;;wBAEnC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;;;;;KAC3B;IAEe,wBAAK,GAArB,UAAsB,OAAe;;;;gBACjC,sBAAO,IAAI,OAAO,CAAC,UAAA,OAAO,IAAI,OAAA,KAAI,CAAC,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,EAAzC,CAAyC,CAAC,EAAC;;;KAC5E;IAEK,uBAAI,GAAV;;;gBACI,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;gBACvB,IAAI,IAAI,CAAC,KAAK,EAAE;oBACZ,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBAC5B;gBACD,sBAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAC;;;KAChC;IACL,eAAC;AAAD,CAAC,AApCD,IAoCC;AApCY,4BAAQ"}