From 7ce4812c479ab6d9e0ca5baeb98fc0e4250219cd Mon Sep 17 00:00:00 2001 From: Daniel Lamando Date: Wed, 18 Sep 2024 22:14:04 +0200 Subject: [PATCH] Remaining slowtypes issues in lib --- generation/codegen-mod.ts | 2 - lib/LICENSE | 201 ++++++++++++++++++++++++++++++++++++++ lib/common.ts | 11 ++- lib/tunnels.ts | 33 ++++--- 4 files changed, 228 insertions(+), 19 deletions(-) create mode 100644 lib/LICENSE diff --git a/generation/codegen-mod.ts b/generation/codegen-mod.ts index 3136d45..31a6be9 100644 --- a/generation/codegen-mod.ts +++ b/generation/codegen-mod.ts @@ -222,8 +222,6 @@ export function generateModuleTypescript(surface: SurfaceMap, api: SurfaceApi): if (isWatch) { returnSig = `ReadableStream>`; } - } else { - // returnSig = 'void'; } chunks.push(` async ${funcName}(${writeSig(args, opts, ' ')}): Promise<${returnSig}> {`); diff --git a/lib/LICENSE b/lib/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/lib/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/lib/common.ts b/lib/common.ts index 5894143..396ab7a 100644 --- a/lib/common.ts +++ b/lib/common.ts @@ -28,7 +28,10 @@ export function assertOrAddApiVersionAndKind< >(input: JSONObject | { apiVersion?: JSONValue; kind?: JSONValue; -}, expectedVersion: T, expectedKind: U, required = false) { +}, expectedVersion: T, expectedKind: U, required = false): { + apiVersion: T; + kind: U; +} { const output = { apiVersion: expectedVersion, kind: expectedKind }; // If nothing is given, we might return the expected data @@ -61,14 +64,14 @@ export function assertOrAddApiVersionAndKind< `Expected ${expected}, but was given ${given}. ${libBug}`); } -export function isStatusKind(input: JSONValue) { +export function isStatusKind(input: JSONValue): boolean { if (!input || typeof input !== 'object') return false; const res = input as ApiKind; return res.apiVersion === 'v1' && res.kind === 'Status'; } -export function identity(input: JSONValue) { +export function identity(input: JSONValue): JSONValue { return input; } @@ -237,7 +240,7 @@ export function toIntOrString(input: JSONValue): string | number { // apply-patch is an up-and-coming feature "Server-Side Apply" and not enabled by default yet. export type PatchType = 'strategic-merge' | 'json-merge' | 'json-patch' | 'apply-patch'; -export function getPatchContentType(type: PatchType) { +export function getPatchContentType(type: PatchType): string { switch (type) { case 'strategic-merge': return 'application/strategic-merge-patch+json'; case 'json-merge': return 'application/merge-patch+json'; diff --git a/lib/tunnels.ts b/lib/tunnels.ts index 4eea63e..fbd5e12 100644 --- a/lib/tunnels.ts +++ b/lib/tunnels.ts @@ -93,26 +93,26 @@ export class StdioTunnel { // Take a cue from Deno.Command which presents the streams unconditionally // but throws if they are used when not configured - get stdin() { + get stdin(): WritableStream { if (!this.#stdin) throw new TypeError("stdin was not requested"); return this.#stdin; } - get stdout() { + get stdout(): ReadableStream { if (!this.#stdout) throw new TypeError("stdout was not requested"); return this.#stdout; } - get stderr() { + get stderr(): ReadableStream { if (!this.#stderr) throw new TypeError("stderr was not requested"); return this.#stderr; } /** If tty was requested, an outbound stream for dynamically changing the TTY dimensions */ - get ttyResizeStream() { + get ttyResizeStream(): WritableStream { if (!this.#resize) throw new TypeError("tty was not requested"); return this.#resize; } /** Shorthand for injecting Ctrl-C and others when running an interactive TTY */ - async ttyWriteSignal(signal: 'INTR' | 'QUIT' | 'SUSP') { + async ttyWriteSignal(signal: 'INTR' | 'QUIT' | 'SUSP'): Promise { if (!this.#stdinWriter) throw new TypeError("tty and stdin were not requested together, cannot write signals"); switch (signal) { // via https://man7.org/linux/man-pages/man3/termios.3.html @@ -124,7 +124,7 @@ export class StdioTunnel { } /** Shorthand for writing to the tty resize stream, especially useful for setting an initial size */ - async ttySetSize(size: TerminalSize) { + async ttySetSize(size: TerminalSize): Promise { const sizeWriter = this.ttyResizeStream.getWriter(); await sizeWriter.write(size); sizeWriter.releaseLock(); @@ -132,7 +132,10 @@ export class StdioTunnel { // Based on https://github.com/denoland/deno/blob/ca9ba87d9956e3f940e0116866e19461f008390b/runtime/js/40_process.js#L282C1-L319C1 /** Buffers all data for stdout and/or stderr and returns the buffers when the remote command exits. */ - async output() { + async output(): Promise { if (this.#stdout?.locked) { throw new TypeError( "Can't collect output because stdout is locked", @@ -164,7 +167,7 @@ export class StdioTunnel { } /** Immediately disconnects the network tunnel, likely dropping any in-flight data. */ - kill() { + kill(): void { this.tunnel.stop(); } } @@ -228,11 +231,15 @@ export class PortforwardTunnel { private nextRequestId = 0; private remainingPorts = new Array; - get ready() { + get ready(): Promise { return this.tunnel.ready(); } - async connectToPort(port: number) { + async connectToPort(port: number): Promise<{ + result: Promise; + readable: ReadableStream; + writable: WritableStream; + }> { let dataIdx: number | undefined = undefined; let errorIdx: number | undefined = undefined; @@ -283,7 +290,7 @@ export class PortforwardTunnel { servePortforward(opts: Deno.ListenOptions & { targetPort: number; - }) { + }): Deno.TcpListener { const listener = Deno.listen(opts); (async () => { for await (const downstream of listener) { @@ -302,13 +309,13 @@ export class PortforwardTunnel { return listener; } - disconnect() { + disconnect(): void { this.tunnel.stop(); } } class DropPrefix extends TransformStream { - constructor(expectedPort: number) { + constructor(_expectedPort: number) { let remaining = 2; super({ transform(chunk, ctlr) {