@gitpod/gitpod-protocol 0.1.5-sje-installer-helm.1 → 0.1.5-sje-installer-namespace-docs.0

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 (224) hide show
  1. package/data/gitpod-schema.json +4 -0
  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.js +12 -13
  29. package/lib/env.js.map +1 -1
  30. package/lib/gitpod-file-parser.js +25 -41
  31. package/lib/gitpod-file-parser.js.map +1 -1
  32. package/lib/gitpod-file-parser.spec.js +116 -116
  33. package/lib/gitpod-file-parser.spec.js.map +1 -1
  34. package/lib/gitpod-service.d.ts +20 -8
  35. package/lib/gitpod-service.d.ts.map +1 -1
  36. package/lib/gitpod-service.js +149 -295
  37. package/lib/gitpod-service.js.map +1 -1
  38. package/lib/ide-protocol.d.ts +81 -0
  39. package/lib/ide-protocol.d.ts.map +1 -0
  40. package/lib/ide-protocol.js +8 -0
  41. package/lib/ide-protocol.js.map +1 -0
  42. package/lib/index.d.ts +2 -0
  43. package/lib/index.d.ts.map +1 -1
  44. package/lib/index.js +2 -0
  45. package/lib/index.js.map +1 -1
  46. package/lib/messaging/browser/connection.d.ts +3 -3
  47. package/lib/messaging/browser/connection.d.ts.map +1 -1
  48. package/lib/messaging/browser/connection.js +172 -35
  49. package/lib/messaging/browser/connection.js.map +1 -1
  50. package/lib/messaging/browser/window-connection.js +35 -55
  51. package/lib/messaging/browser/window-connection.js.map +1 -1
  52. package/lib/messaging/client-call-metrics.js +17 -18
  53. package/lib/messaging/client-call-metrics.js.map +1 -1
  54. package/lib/messaging/connection-error-handler.js +11 -23
  55. package/lib/messaging/connection-error-handler.js.map +1 -1
  56. package/lib/messaging/error.d.ts +1 -1
  57. package/lib/messaging/error.d.ts.map +1 -1
  58. package/lib/messaging/error.js +2 -2
  59. package/lib/messaging/error.js.map +1 -1
  60. package/lib/messaging/handler.d.ts +10 -0
  61. package/lib/messaging/handler.d.ts.map +1 -1
  62. package/lib/messaging/node/connection.d.ts +0 -10
  63. package/lib/messaging/node/connection.d.ts.map +1 -1
  64. package/lib/messaging/node/connection.js +11 -49
  65. package/lib/messaging/node/connection.js.map +1 -1
  66. package/lib/messaging/proxy-factory.d.ts +2 -0
  67. package/lib/messaging/proxy-factory.d.ts.map +1 -1
  68. package/lib/messaging/proxy-factory.js +73 -160
  69. package/lib/messaging/proxy-factory.js.map +1 -1
  70. package/lib/oss-allowlist.d.ts +14 -0
  71. package/lib/oss-allowlist.d.ts.map +1 -0
  72. package/lib/oss-allowlist.js +8 -0
  73. package/lib/oss-allowlist.js.map +1 -0
  74. package/lib/permission.js +12 -12
  75. package/lib/permission.js.map +1 -1
  76. package/lib/plans.d.ts +1 -1
  77. package/lib/plans.d.ts.map +1 -1
  78. package/lib/plans.js +38 -57
  79. package/lib/plans.js.map +1 -1
  80. package/lib/protocol.d.ts +9 -7
  81. package/lib/protocol.d.ts.map +1 -1
  82. package/lib/protocol.js +44 -114
  83. package/lib/protocol.js.map +1 -1
  84. package/lib/snapshot-url.d.ts +14 -0
  85. package/lib/snapshot-url.d.ts.map +1 -0
  86. package/lib/snapshot-url.js +26 -0
  87. package/lib/snapshot-url.js.map +1 -0
  88. package/lib/snapshot-url.spec.d.ts +7 -0
  89. package/lib/snapshot-url.spec.d.ts.map +1 -0
  90. package/lib/snapshot-url.spec.js +41 -0
  91. package/lib/snapshot-url.spec.js.map +1 -0
  92. package/lib/team-subscription-protocol.js +13 -13
  93. package/lib/team-subscription-protocol.js.map +1 -1
  94. package/lib/teams-projects-protocol.d.ts +9 -0
  95. package/lib/teams-projects-protocol.d.ts.map +1 -1
  96. package/lib/teams-projects-protocol.js +4 -15
  97. package/lib/teams-projects-protocol.js.map +1 -1
  98. package/lib/util/analytics.js +25 -32
  99. package/lib/util/analytics.js.map +1 -1
  100. package/lib/util/async-iterator.js +55 -133
  101. package/lib/util/async-iterator.js.map +1 -1
  102. package/lib/util/cancelable.js +17 -59
  103. package/lib/util/cancelable.js.map +1 -1
  104. package/lib/util/date-time.js +8 -8
  105. package/lib/util/date-time.js.map +1 -1
  106. package/lib/util/deferred.js +10 -12
  107. package/lib/util/deferred.js.map +1 -1
  108. package/lib/util/disposable.js +26 -39
  109. package/lib/util/disposable.js.map +1 -1
  110. package/lib/util/event.js +58 -74
  111. package/lib/util/event.js.map +1 -1
  112. package/lib/util/garbage-collected-cache.d.ts +1 -0
  113. package/lib/util/garbage-collected-cache.d.ts.map +1 -1
  114. package/lib/util/garbage-collected-cache.js +26 -46
  115. package/lib/util/garbage-collected-cache.js.map +1 -1
  116. package/lib/util/generate-workspace-id.js +11 -67
  117. package/lib/util/generate-workspace-id.js.map +1 -1
  118. package/lib/util/generate-workspace-id.spec.js +34 -79
  119. package/lib/util/generate-workspace-id.spec.js.map +1 -1
  120. package/lib/util/gitpod-cookie.d.ts +20 -0
  121. package/lib/util/gitpod-cookie.d.ts.map +1 -0
  122. package/lib/util/gitpod-cookie.js +44 -0
  123. package/lib/util/gitpod-cookie.js.map +1 -0
  124. package/lib/util/gitpod-host-url.d.ts +1 -0
  125. package/lib/util/gitpod-host-url.d.ts.map +1 -1
  126. package/lib/util/gitpod-host-url.js +96 -103
  127. package/lib/util/gitpod-host-url.js.map +1 -1
  128. package/lib/util/gitpod-host-url.spec.js +87 -135
  129. package/lib/util/gitpod-host-url.spec.js.map +1 -1
  130. package/lib/util/grpc.js +3 -3
  131. package/lib/util/grpc.js.map +1 -1
  132. package/lib/util/jaeger-client-types.d.ts +68 -0
  133. package/lib/util/jaeger-client-types.d.ts.map +1 -0
  134. package/lib/util/jaeger-client-types.js +8 -0
  135. package/lib/util/jaeger-client-types.js.map +1 -0
  136. package/lib/util/logging.d.ts +32 -32
  137. package/lib/util/logging.d.ts.map +1 -1
  138. package/lib/util/logging.js +50 -113
  139. package/lib/util/logging.js.map +1 -1
  140. package/lib/util/make-link.js +2 -2
  141. package/lib/util/make-link.js.map +1 -1
  142. package/lib/util/parse-workspace-id.d.ts +10 -0
  143. package/lib/util/parse-workspace-id.d.ts.map +1 -1
  144. package/lib/util/parse-workspace-id.js +31 -7
  145. package/lib/util/parse-workspace-id.js.map +1 -1
  146. package/lib/util/parse-workspace-id.spec.d.ts +4 -0
  147. package/lib/util/parse-workspace-id.spec.d.ts.map +1 -1
  148. package/lib/util/parse-workspace-id.spec.js +123 -84
  149. package/lib/util/parse-workspace-id.spec.js.map +1 -1
  150. package/lib/util/queue.js +16 -55
  151. package/lib/util/queue.js.map +1 -1
  152. package/lib/util/queue.spec.js +144 -288
  153. package/lib/util/queue.spec.js.map +1 -1
  154. package/lib/util/repeat.d.ts +15 -0
  155. package/lib/util/repeat.d.ts.map +1 -0
  156. package/lib/util/repeat.js +55 -0
  157. package/lib/util/repeat.js.map +1 -0
  158. package/lib/util/safe-promise.js +9 -12
  159. package/lib/util/safe-promise.js.map +1 -1
  160. package/lib/util/semaphore.js +15 -46
  161. package/lib/util/semaphore.js.map +1 -1
  162. package/lib/util/skip-if.js +6 -6
  163. package/lib/util/skip-if.js.map +1 -1
  164. package/lib/util/timeutil.js +16 -16
  165. package/lib/util/timeutil.js.map +1 -1
  166. package/lib/util/timeutil.spec.js +21 -24
  167. package/lib/util/timeutil.spec.js.map +1 -1
  168. package/lib/util/tracing.d.ts +50 -5
  169. package/lib/util/tracing.d.ts.map +1 -1
  170. package/lib/util/tracing.js +169 -63
  171. package/lib/util/tracing.js.map +1 -1
  172. package/lib/util/tracing.spec.d.ts +7 -0
  173. package/lib/util/tracing.spec.d.ts.map +1 -0
  174. package/lib/util/tracing.spec.js +121 -0
  175. package/lib/util/tracing.spec.js.map +1 -0
  176. package/lib/util/workspace-port-authentication.js +2 -2
  177. package/lib/util/workspace-port-authentication.js.map +1 -1
  178. package/lib/workspace-cluster.d.ts +11 -1
  179. package/lib/workspace-cluster.d.ts.map +1 -1
  180. package/lib/workspace-cluster.js +3 -3
  181. package/lib/workspace-cluster.js.map +1 -1
  182. package/lib/workspace-instance.d.ts +3 -2
  183. package/lib/workspace-instance.d.ts.map +1 -1
  184. package/lib/wsready.js +1 -1
  185. package/package.json +20 -12
  186. package/pkg-yarn.lock +12 -7
  187. package/src/accounting-protocol.ts +1 -3
  188. package/src/admin-protocol.ts +9 -3
  189. package/src/analytics.ts +2 -0
  190. package/src/email-protocol.ts +1 -1
  191. package/src/gitpod-service.ts +25 -13
  192. package/src/ide-protocol.ts +92 -0
  193. package/src/index.ts +2 -0
  194. package/src/messaging/browser/connection.ts +176 -10
  195. package/src/messaging/error.ts +2 -2
  196. package/src/messaging/handler.ts +12 -0
  197. package/src/messaging/node/connection.ts +1 -45
  198. package/src/messaging/proxy-factory.ts +10 -4
  199. package/src/oss-allowlist.ts +15 -0
  200. package/src/protocol.ts +11 -8
  201. package/src/snapshot-url.spec.ts +25 -0
  202. package/src/snapshot-url.ts +27 -0
  203. package/src/team-subscription-protocol.ts +1 -1
  204. package/src/teams-projects-protocol.ts +12 -1
  205. package/src/util/garbage-collected-cache.ts +7 -1
  206. package/src/util/gitpod-cookie.ts +39 -0
  207. package/src/util/gitpod-host-url.ts +9 -5
  208. package/src/util/grpc.ts +3 -3
  209. package/src/util/jaeger-client-types.ts +102 -0
  210. package/src/util/logging.ts +32 -32
  211. package/src/util/parse-workspace-id.spec.ts +21 -1
  212. package/src/util/parse-workspace-id.ts +32 -6
  213. package/src/util/repeat.ts +45 -0
  214. package/src/util/tracing.spec.ts +83 -0
  215. package/src/util/tracing.ts +153 -17
  216. package/src/workspace-cluster.ts +8 -1
  217. package/src/workspace-instance.ts +9 -6
  218. package/src/wsready.ts +1 -1
  219. package/lib/util/repeater.d.ts +0 -22
  220. package/lib/util/repeater.d.ts.map +0 -1
  221. package/lib/util/repeater.js +0 -118
  222. package/lib/util/repeater.js.map +0 -1
  223. package/src/util/jaeger-client.d.ts +0 -105
  224. package/src/util/repeater.ts +0 -49
@@ -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,154 @@
6
6
 
7
7
 
8
8
  import * as opentracing from 'opentracing';
9
- import { TracingConfig, initTracerFromEnv, Sampler, SamplingDecision } from 'jaeger-client';
9
+ import { TracingConfig, initTracerFromEnv } from 'jaeger-client';
10
+ import { Sampler, SamplingDecision } from './jaeger-client-types';
10
11
  import { 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): opentracing.Span {
26
+ let options: opentracing.SpanOptions | undefined = undefined;
27
+ if (parentCtx) {
28
+ options = {
29
+ childOf: parentCtx.span
30
+ };
21
31
  }
22
32
  return opentracing.globalTracer().startSpan(operation, options);
23
33
  }
24
34
 
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())];
35
+ export function childContext(operation: string, parentCtx: TraceContext): TraceContextWithSpan {
36
+ const span = startSpan(operation, parentCtx);
37
+ return { span };
38
+ }
39
+
40
+ export function setError(ctx: TraceContext, err: Error) {
41
+ if (!ctx.span) {
42
+ return;
29
43
  }
30
- return opentracing.globalTracer().startSpan(operation, options);
44
+
45
+ TraceContext.addNestedTags(ctx, {
46
+ error: {
47
+ message: err.message,
48
+ stacktrace: err.stack,
49
+ },
50
+ });
51
+ ctx.span.setTag("error", true);
52
+ }
53
+
54
+ export function setJsonRPCMetadata(ctx: TraceContext, method?: string) {
55
+ if (!ctx.span) {
56
+ return;
57
+ }
58
+
59
+ const tags: { [key: string]: any } = {
60
+ rpc: {
61
+ system: "jsonrpc",
62
+ // version,
63
+ },
64
+ };
65
+ if (method) {
66
+ tags.rpc.method = method;
67
+ }
68
+ addNestedTags(ctx, tags);
69
+ }
70
+
71
+ export function setJsonRPCError(ctx: TraceContext, method: string, err: ResponseError<any>) {
72
+ if (!ctx.span) {
73
+ return;
74
+ }
75
+ // not use setError bc this is (most likely) a working operation
76
+
77
+ setJsonRPCMetadata(ctx);
78
+ // https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/rpc.md#json-rpc
79
+ addNestedTags(ctx, {
80
+ rpc: {
81
+ jsonrpc: {
82
+ error_code: err.code,
83
+ error_message: err.message,
84
+ },
85
+ },
86
+ });
31
87
  }
32
88
 
33
- export function logError(ctx: TraceContext, err: Error) {
89
+ export function addJsonRPCParameters(ctx: TraceContext, params: { [key: string]: any }) {
34
90
  if (!ctx.span) {
35
91
  return;
36
92
  }
37
93
 
38
- ctx.span.log({
39
- "error": err.message,
40
- "stacktrace": err.stack
41
- })
42
- ctx.span.setTag("error", true)
94
+ setJsonRPCMetadata(ctx);
95
+ addNestedTags(ctx, {
96
+ rpc: {
97
+ jsonrpc: {
98
+ parameters: params,
99
+ },
100
+ },
101
+ });
102
+ }
103
+
104
+ /**
105
+ * Does what one would expect from `span.addTags`: Calls `span.addTag` for all keys in map, recursively for objects.
106
+ * Example:
107
+ * ```
108
+ * TraceContext.addNestedTags(ctx, {
109
+ * rpc: {
110
+ * system: "jsonrpc",
111
+ * jsonrpc: {
112
+ * version: "1.0",
113
+ * method: "test",
114
+ * parameters: ["abc", "def"],
115
+ * },
116
+ * },
117
+ * });
118
+ * ```
119
+ * gives
120
+ * rpc.system = "jsonrpc"
121
+ * rpc.jsonrpc.version = "1.0"
122
+ * rpc.jsonrpc.method = "test"
123
+ * rpc.jsonrpc.parameters.0 = "abc"
124
+ * rpc.jsonrpc.parameters.1 = "def"
125
+ * @param ctx
126
+ * @param keyValueMap
127
+ * @returns
128
+ */
129
+ export function addNestedTags(ctx: TraceContext, keyValueMap: { [key: string]: any }, _namespace?: string) {
130
+ if (!ctx.span) {
131
+ return;
132
+ }
133
+ const namespace = _namespace ? `${_namespace}.` : '';
134
+
135
+ try {
136
+ for (const k of Object.keys(keyValueMap)) {
137
+ const v = keyValueMap[k];
138
+ if (v instanceof Object) {
139
+ addNestedTags(ctx, v, `${namespace}${k}`);
140
+ } else {
141
+ ctx.span.setTag(`${namespace}${k}`, v);
142
+ }
143
+ }
144
+ } catch (err) {
145
+ // general resilience against odd shapes/parameters
146
+ log.error("Tracing.addNestedTags", err, { namespace });
147
+ }
148
+ }
149
+
150
+ export function setOWI(ctx: TraceContext, owi: LogContext) {
151
+ if (!ctx.span) {
152
+ return;
153
+ }
154
+ addNestedTags(ctx, {
155
+ context: owi,
156
+ });
43
157
  }
44
158
  }
45
159
 
@@ -56,11 +170,16 @@ export class TracingManager {
56
170
  reporter: {
57
171
  logSpans: false
58
172
  },
59
- serviceName
173
+ serviceName,
60
174
  }
61
175
  const t = initTracerFromEnv(config, {
62
- logger: console
176
+ logger: console,
177
+ tags: {
178
+ 'service.build.commit': process.env.GITPOD_BUILD_GIT_COMMIT,
179
+ 'service.build.version': process.env.GITPOD_BUILD_VERSION,
180
+ }
63
181
  });
182
+
64
183
  if (opts) {
65
184
  if (opts.perOpSampling) {
66
185
  (t as any)._sampler = new PerOperationSampler((t as any)._sampler, opts.perOpSampling);
@@ -132,3 +251,20 @@ export class PerOperationSampler implements Sampler {
132
251
  }
133
252
  }
134
253
  }
254
+
255
+ // Augment interfaces with an leading parameter "TraceContext" on every method
256
+ type IsValidArg<T> = T extends object ? keyof T extends never ? false : true : true;
257
+ type AddTraceContext<T> =
258
+ T extends (a: infer A, b: infer B, c: infer C, d: infer D, e: infer E, f: infer F) => infer R ? (
259
+ IsValidArg<F> extends true ? (ctx: TraceContextWithSpan, a: A, b: B, c: C, d: D, e: E, f: F) => R :
260
+ IsValidArg<E> extends true ? (ctx: TraceContextWithSpan, a: A, b: B, c: C, d: D, e: E) => R :
261
+ IsValidArg<D> extends true ? (ctx: TraceContextWithSpan, a: A, b: B, c: C, d: D) => R :
262
+ IsValidArg<C> extends true ? (ctx: TraceContextWithSpan, a: A, b: B, c: C) => R :
263
+ IsValidArg<B> extends true ? (ctx: TraceContextWithSpan, a: A, b: B) => R :
264
+ IsValidArg<A> extends true ? (ctx: TraceContextWithSpan, a: A) => R :
265
+ (ctx: TraceContextWithSpan) => Promise<R>
266
+ ) : never;
267
+
268
+ export type InterfaceWithTraceContext<T> = {
269
+ [P in keyof T]: AddTraceContext<T[P]>
270
+ };
@@ -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
 
@@ -148,6 +145,9 @@ export interface WorkspaceInstanceConditions {
148
145
 
149
146
  // headless_task_failed indicates that a headless workspace task failed
150
147
  headlessTaskFailed?: string;
148
+
149
+ // stopped_by_request is true if the workspace was stopped using a StopWorkspace call
150
+ stoppedByRequest?: boolean;
151
151
  }
152
152
 
153
153
  // AdmissionLevel describes who can access a workspace instance and its ports.
@@ -161,9 +161,6 @@ export interface WorkspaceInstancePort {
161
161
  // The outward-facing port number
162
162
  port: number;
163
163
 
164
- // An optional inward-facing port number. If not present we'll use port.
165
- targetPort?: number;
166
-
167
164
  // The visiblity of this port. Optional for backwards compatibility.
168
165
  visibility?: PortVisibility;
169
166
 
@@ -209,4 +206,10 @@ export interface WorkspaceInstanceConfiguration {
209
206
 
210
207
  // ideImage is the ref of the IDE image this instance uses.
211
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;
212
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"}
@@ -1,105 +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
-
7
- // Type definitions for jaeger-client
8
- // Project: https://github.com/uber/jaeger-client-node
9
- // Definitions by: Julian Steger <https://github.com/julianste>
10
- // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
11
-
12
- declare module 'jaeger-client' {
13
- import * as opentracing from "opentracing";
14
-
15
- export interface TracingConfig {
16
- serviceName?: string;
17
- disable?: boolean;
18
- sampler?: SamplerConfig;
19
- reporter?: ReporterConfig;
20
- }
21
-
22
- export interface TracingOptions {
23
- reporter?: Reporter;
24
- metrics?: MetricsFactory;
25
- logger?: Logger;
26
- tags?: any;
27
- }
28
-
29
- export interface ReporterConfig {
30
- logSpans?: boolean;
31
- agentHost?: string;
32
- agentPort?: number;
33
- flushIntervalMs?: number;
34
- }
35
-
36
- export interface SamplerConfig {
37
- type: string;
38
- param: number;
39
- host?: string;
40
- port?: number;
41
- refreshIntervalMs?: number;
42
- }
43
-
44
- export interface Logger {
45
- info(msg: string): void;
46
- error(msg: string): void;
47
- }
48
-
49
- export interface Reporter {
50
- report(span: opentracing.Span): void;
51
- close(callback?: () => void): void;
52
- setProcess(serviceName: string, tags: any): void;
53
- }
54
-
55
- export interface MetricsFactory {
56
- createCounter(name: string, tags: any): Counter;
57
- createTimer(name: string, tags: any): Timer;
58
- createGauge(name: string, tags: any): Gauge;
59
- }
60
-
61
- // Counter tracks the number of times an event has occurred
62
- export interface Counter {
63
- // Adds the given value to the counter.
64
- increment(delta: number): void;
65
- }
66
-
67
- // Timer tracks how long an operation took and also computes percentiles.
68
- export interface Timer {
69
- // Records the time passed in.
70
- record(value: number): void;
71
- }
72
-
73
- // Gauge returns instantaneous measurements of something as an int64 value
74
- export interface Gauge {
75
- // Update the gauge to the value passed in.
76
- update(value: number): void;
77
- }
78
-
79
- export function initTracer(
80
- tracingConfig: TracingConfig,
81
- tracingOptions: TracingOptions,
82
- ): opentracing.Tracer;
83
-
84
- export function initTracerFromEnv(
85
- tracingConfig: TracingConfig,
86
- tracingOptions: TracingOptions,
87
- ): opentracing.Tracer;
88
-
89
- export interface SamplingDecision {
90
- sample: boolean;
91
- retryable: boolean;
92
- tags: any;
93
- }
94
-
95
- // added by TypeFox
96
- export interface Sampler {
97
- name(): string
98
- isSampled(operation: string, tags: any): boolean;
99
- onCreateSpan(span: opentracing.Span): SamplingDecision;
100
- onSetOperationName(span: opentracing.Span, operationName: string): SamplingDecision;
101
- onSetTag(span: opentracing.Span, key: string, value: any): SamplingDecision;
102
- close(callback: () => void): void
103
- }
104
-
105
- }
@@ -1,49 +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
-
7
- import { Deferred } from "./deferred";
8
- import { log } from './logging';
9
-
10
- /**
11
- * Repeats a given function until it is stopped
12
- */
13
- export class Repeater {
14
- protected shouldRun: boolean;
15
- protected finished: Deferred<void>
16
- protected timer?: any;
17
-
18
- constructor(protected readonly fn: () => Promise<void> | void, protected readonly timeout: number) { }
19
-
20
- async start() {
21
- this.run();
22
- }
23
-
24
- async run() {
25
- this.shouldRun = true;
26
- this.finished = new Deferred<void>();
27
- while (this.shouldRun) {
28
- try {
29
- await this.fn();
30
- } catch (err) {
31
- log.error(err);
32
- }
33
- await this.sleep(this.timeout);
34
- }
35
- this.finished.resolve();
36
- }
37
-
38
- protected async sleep(timeout: number) {
39
- return new Promise(resolve => this.timer = setTimeout(resolve, timeout));
40
- }
41
-
42
- async stop() {
43
- this.shouldRun = false;
44
- if (this.timer) {
45
- clearTimeout(this.timer);
46
- }
47
- return this.finished.promise;
48
- }
49
- }