8714141233

Committed 17 Apr 2024 12:06AM UTC coverage: 86.597% (-0.01%) from 86.607%

Build # 8714141233

Build Type

Pull #859

github

Committed by

pmcelhaney

Commit Message

typescript generator for security object => $.user

Pull Request Pull Request #859: support for basic auth

Run Details

892 of 990 branches covered (90.1%)

Branch coverage included in aggregate %.

58 of 62 new or added lines in 6 files covered. (93.55%)

2 existing lines in 1 file now uncovered.

2933 of 3427 relevant lines covered (85.59%)

43.49 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.74

/src/typescript-generator/operation-type-coder.js

import nodePath from "node:path";

import { CONTEXT_FILE_TOKEN } from "./context-file-token.js";
import { ParametersTypeCoder } from "./parameters-type-coder.js";
import { READ_ONLY_COMMENTS } from "./read-only-comments.js";
import { ResponsesTypeCoder } from "./responses-type-coder.js";
import { SchemaTypeCoder } from "./schema-type-coder.js";
import { TypeCoder } from "./type-coder.js";

export class OperationTypeCoder extends TypeCoder {
  constructor(requirement, requestMethod, security = []) {
    super(requirement);

    if (requestMethod === undefined) {
      throw new Error("requestMethod is required");
    }

    this.requestMethod = requestMethod;
    this.security = security;
  }

  names() {
    return super.names(`HTTP_${this.requestMethod.toUpperCase()}`);
  }

  responseTypes(script) {
    return this.requirement
      .get("responses")
      .flatMap((response, responseCode) => {
        const status =
          responseCode === "default"
            ? "number | undefined"
            : Number.parseInt(responseCode, 10);

        if (response.has("content")) {
          return response.get("content").map(
            (content, contentType) => `{  
              status: ${status}, 
              contentType?: "${contentType}",
              body?: ${new SchemaTypeCoder(content.get("schema")).write(script)}
            }`,
          );
        }

        if (response.has("schema")) {
          const produces =
            this.requirement?.get("produces")?.data ??
            this.requirement.specification.rootRequirement.get("produces").data;

          return produces
            .map(
              (contentType) => `{
            status: ${status},
            contentType?: "${contentType}",
            body?: ${new SchemaTypeCoder(response.get("schema")).write(script)}
          }`,
            )
            .join(" | ");
        }

        return `{  
          status: ${status} 
        }`;
      })

      .join(" | ");
  }

  modulePath() {
    const pathString = this.requirement.url
      .split("/")
      .at(-2)
      .replaceAll("~1", "/");

    return `${nodePath
      .join("path-types", pathString)
      .replaceAll("\\", "/")}.types.ts`;
  }

  userType() {
    if (
      this.security.some(
        ({ scheme, type }) => type.includes("http") && scheme.includes("basic"),
      )
    ) {
      return "{username?: string, password?: string}";
    }

    return "never";
  }

  // eslint-disable-next-line max-statements
  writeCode(script) {
    // eslint-disable-next-line no-param-reassign
    script.comments = READ_ONLY_COMMENTS;

    const xType = script.importSharedType("WideOperationArgument");

    script.importSharedType("OmitValueWhenNever");

    const contextTypeImportName = script.importExternalType(
      "Context",
      CONTEXT_FILE_TOKEN,
    );

    const parameters = this.requirement.get("parameters");

    const queryType = new ParametersTypeCoder(parameters, "query").write(
      script,
    );

    const pathType = new ParametersTypeCoder(parameters, "path").write(script);

    const headerType = new ParametersTypeCoder(parameters, "header").write(
      script,
    );

    const bodyRequirement = this.requirement.get("consumes")
      ? parameters
          .find((parameter) =>
            ["body", "formData"].includes(parameter.get("in").data),
          )
          .get("schema")
      : this.requirement.select("requestBody/content/application~1json/schema");

    const bodyType =
      bodyRequirement === undefined
        ? "never"
        : new SchemaTypeCoder(bodyRequirement).write(script);

    const responseType = new ResponsesTypeCoder(
      this.requirement.get("responses"),
      this.requirement.get("produces")?.data ??
        this.requirement.specification?.rootRequirement?.get("produces")?.data,
    ).write(script);

    const proxyType = '(url: string) => "COUNTERFACT_RESPONSE"';

    return `($: OmitValueWhenNever<{ query: ${queryType}, path: ${pathType}, header: ${headerType}, body: ${bodyType}, context: ${contextTypeImportName}, response: ${responseType}, x: ${xType}, proxy: ${proxyType}, user: ${this.userType()} }>) => ${this.responseTypes(
      script,
    )} | { status: 415, contentType: "text/plain", body: string } | "COUNTERFACT_RESPONSE" | { ALL_REMAINING_HEADERS_ARE_OPTIONAL: "COUNTERFACT_RESPONSE" }`;
  }
}

1	import nodePath from "node:path";	2✔
2		2✔
3	import { CONTEXT_FILE_TOKEN } from "./context-file-token.js";	2✔
4	import { ParametersTypeCoder } from "./parameters-type-coder.js";	2✔
5	import { READ_ONLY_COMMENTS } from "./read-only-comments.js";	2✔
6	import { ResponsesTypeCoder } from "./responses-type-coder.js";	2✔
7	import { SchemaTypeCoder } from "./schema-type-coder.js";	2✔
8	import { TypeCoder } from "./type-coder.js";	2✔
9		2✔
10	export class OperationTypeCoder extends TypeCoder {	2✔
11	constructor(requirement, requestMethod, security = []) {	2✔
12	super(requirement);	64✔
13		64✔
14	if (requestMethod === undefined) {	64!
15	throw new Error("requestMethod is required");	×
16	}	×
17		64✔
18	this.requestMethod = requestMethod;	64✔
19	this.security = security;	64✔
20	}	64✔
21		2✔
22	names() {	2✔
23	return super.names(`HTTP_${this.requestMethod.toUpperCase()}`);	90✔
24	}	90✔
25		2✔
26	responseTypes(script) {	2✔
27	return this.requirement	56✔
28	.get("responses")	56✔
29	.flatMap((response, responseCode) => {	56✔
30	const status =	102✔
31	responseCode === "default"	102✔
32	? "number \| undefined"	26✔
33	: Number.parseInt(responseCode, 10);	76✔
34		102✔
35	if (response.has("content")) {	102✔
36	return response.get("content").map(	40✔
37	(content, contentType) => `{	40✔
38	status: ${status},	60✔
39	contentType?: "${contentType}",	60✔
40	body?: ${new SchemaTypeCoder(content.get("schema")).write(script)}	60✔
41	}`,	40✔
42	);	40✔
43	}	40✔
44		62✔
45	if (response.has("schema")) {	88✔
46	const produces =	16✔
47	this.requirement?.get("produces")?.data ??	16!
48	this.requirement.specification.rootRequirement.get("produces").data;	16✔
49		16✔
50	return produces	16✔
51	.map(	16✔
52	(contentType) => `{	16✔
53	status: ${status},	16✔
54	contentType?: "${contentType}",	16✔
55	body?: ${new SchemaTypeCoder(response.get("schema")).write(script)}	16✔
56	}`,	16✔
57	)	16✔
58	.join(" \| ");	16✔
59	}	16✔
60		46✔
61	return `{	46✔
62	status: ${status}	46✔
63	}`;	46✔
64	})	46✔
65		56✔
66	.join(" \| ");	56✔
67	}	56✔
68		2✔
69	modulePath() {	2✔
70	const pathString = this.requirement.url	46✔
71	.split("/")	46✔
72	.at(-2)	46✔
73	.replaceAll("~1", "/");	46✔
74		46✔
75	return `${nodePath	46✔
76	.join("path-types", pathString)	46✔
77	.replaceAll("\\", "/")}.types.ts`;	46✔
78	}	46✔
79		2✔
80	userType() {	2✔
81	if (	56✔
82	this.security.some(	56✔
83	({ scheme, type }) => type.includes("http") && scheme.includes("basic"),	56✔
84	)	56✔
85	) {	56!
NEW 86	return "{username?: string, password?: string}";	×
NEW 87	}	×
88		56✔
89	return "never";	56✔
90	}	56✔
91		2✔
92	// eslint-disable-next-line max-statements	2✔
93	writeCode(script) {	2✔
94	// eslint-disable-next-line no-param-reassign	56✔
95	script.comments = READ_ONLY_COMMENTS;	56✔
96		56✔
97	const xType = script.importSharedType("WideOperationArgument");	56✔
98		56✔
99	script.importSharedType("OmitValueWhenNever");	56✔
100		56✔
101	const contextTypeImportName = script.importExternalType(	56✔
102	"Context",	56✔
103	CONTEXT_FILE_TOKEN,	56✔
104	);	56✔
105		56✔
106	const parameters = this.requirement.get("parameters");	56✔
107		56✔
108	const queryType = new ParametersTypeCoder(parameters, "query").write(	56✔
109	script,	56✔
110	);	56✔
111		56✔
112	const pathType = new ParametersTypeCoder(parameters, "path").write(script);	56✔
113		56✔
114	const headerType = new ParametersTypeCoder(parameters, "header").write(	56✔
115	script,	56✔
116	);	56✔
117		56✔
118	const bodyRequirement = this.requirement.get("consumes")	56✔
119	? parameters	4✔
120	.find((parameter) =>	4✔
121	["body", "formData"].includes(parameter.get("in").data),	16✔
122	)	4✔
123	.get("schema")	4✔
124	: this.requirement.select("requestBody/content/application~1json/schema");	52✔
125		56✔
126	const bodyType =	56✔
127	bodyRequirement === undefined	56✔
128	? "never"	38✔
129	: new SchemaTypeCoder(bodyRequirement).write(script);	18✔
130		56✔
131	const responseType = new ResponsesTypeCoder(	56✔
132	this.requirement.get("responses"),	56✔
133	this.requirement.get("produces")?.data ??	56✔
134	this.requirement.specification?.rootRequirement?.get("produces")?.data,	48!
135	).write(script);	56✔
136		56✔
137	const proxyType = '(url: string) => "COUNTERFACT_RESPONSE"';	56✔
138		56✔
139	return `($: OmitValueWhenNever<{ query: ${queryType}, path: ${pathType}, header: ${headerType}, body: ${bodyType}, context: ${contextTypeImportName}, response: ${responseType}, x: ${xType}, proxy: ${proxyType}, user: ${this.userType()} }>) => ${this.responseTypes(	56✔
140	script,	56✔
141	)} \| { status: 415, contentType: "text/plain", body: string } \| "COUNTERFACT_RESPONSE" \| { ALL_REMAINING_HEADERS_ARE_OPTIONAL: "COUNTERFACT_RESPONSE" }`;	56✔
142	}	56✔
143	}	2✔

pmcelhaney / counterfact / 8714141233

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous