Enable optional chaining in codebase (airtasker#750)

adrian-chang · Mar 24, 2020 · 70b768d · 70b768d
1 parent 39ab2bd
commit 70b768d
Show file tree

Hide file tree

Showing 21 changed files with 48 additions and 68 deletions.
diff --git a/cli/src/commands/mock.ts b/cli/src/commands/mock.ts
@@ -49,7 +49,7 @@ export default class Mock extends Command {
       const contract = parse(args[ARG_API]);
       await runMockServer(contract, {
         port,
-        pathPrefix: pathPrefix || "",
+        pathPrefix: pathPrefix ?? "",
         ...proxyConfig,
         logger: this
       }).defer();

diff --git a/cli/src/common/infer-proxy-config.ts b/cli/src/common/infer-proxy-config.ts
@@ -7,7 +7,7 @@ export default function inferProxyConfig(
     return null;
   }
 
-  const [protocol] = proxyBaseUrl && proxyBaseUrl.split("://");
+  const [protocol] = proxyBaseUrl.split("://");
 
   if (protocol !== "http" && protocol !== "https") {
     throw new Error(

diff --git a/lib/src/generators/openapi2/openapi2.ts b/lib/src/generators/openapi2/openapi2.ts
@@ -109,8 +109,7 @@ function endpointsToPathsObject(
       )
       .join("/");
 
-    // Note: acc[pathName] || {} breaks type safety, ternary operation is type safe
-    acc[pathName] = acc[pathName] ? acc[pathName] : {};
+    acc[pathName] = acc[pathName] ?? {};
     const pathItemMethod = httpMethodToPathItemMethod(endpoint.method);
     acc[pathName][pathItemMethod] = endpointToOperationObject(
       endpoint,
@@ -173,7 +172,7 @@ function endpointRequestToParameterObjects(
 
   return parameters
     .concat(pathParameters, queryParameters, headerParameters)
-    .concat(bodyParameter || []);
+    .concat(bodyParameter ?? []);
 }
 
 function endpointResponsesToResponsesObject(
@@ -209,7 +208,7 @@ function endpointResponseToResponseObject(
   typeTable: TypeTable
 ): ResponseObject {
   const description =
-    response.description ||
+    response.description ??
     (isSpecificResponse(response)
       ? `${response.status} response`
       : "default response");

diff --git a/lib/src/generators/openapi3/openapi3.ts b/lib/src/generators/openapi3/openapi3.ts
@@ -101,8 +101,7 @@ function endpointsToPathsObject(
       )
       .join("/");
 
-    // Note: acc[pathName] || {} breaks type safety, ternary operation is type safe
-    acc[pathName] = acc[pathName] ? acc[pathName] : {};
+    acc[pathName] = acc[pathName] ?? {};
     const pathItemMethod = httpMethodToPathItemMethod(endpoint.method);
     acc[pathName][pathItemMethod] = endpointToOperationObject(
       endpoint,
@@ -119,7 +118,7 @@ function endpointToOperationObject(
   config: Config
 ): OperationObject {
   const endpointRequest = endpoint.request;
-  const endpointRequestBody = endpointRequest && endpointRequest.body;
+  const endpointRequestBody = endpointRequest?.body;
 
   return {
     tags: endpoint.tags.length > 0 ? endpoint.tags : undefined,
@@ -263,7 +262,7 @@ function endpointResponseToResponseObject(
   typeTable: TypeTable
 ): ResponseObject {
   const description =
-    response.description ||
+    response.description ??
     (isSpecificResponse(response)
       ? `${response.status} response`
       : "default response");

diff --git a/lib/src/linting/rules/has-request-payload.ts b/lib/src/linting/rules/has-request-payload.ts
@@ -16,7 +16,7 @@ export function hasRequestPayload(contract: Contract): LintingRuleViolation[] {
   contract.endpoints.forEach(endpoint => {
     switch (endpoint.method) {
       case "GET":
-        if (endpoint.request && endpoint.request.body) {
+        if (endpoint.request?.body) {
           violations.push({
             message: `Endpoint (${endpoint.name}) with HTTP method ${endpoint.method} must not contain a request body`
           });
@@ -25,7 +25,7 @@ export function hasRequestPayload(contract: Contract): LintingRuleViolation[] {
       case "POST":
       case "PATCH":
       case "PUT":
-        if (!(endpoint.request && endpoint.request.body)) {
+        if (!endpoint.request?.body) {
           violations.push({
             message: `Endpoint (${endpoint.name}) with HTTP method ${endpoint.method} must contain a request body`
           });

diff --git a/lib/src/linting/rules/no-nullable-fields-within-request-bodies.ts b/lib/src/linting/rules/no-nullable-fields-within-request-bodies.ts
@@ -16,17 +16,14 @@ export function noNullableFieldsWithinRequestBodies(
   const violations: LintingRuleViolation[] = [];
 
   contract.endpoints.forEach(endpoint => {
-    if (endpoint.request) {
-      if (endpoint.request.body) {
-        findNullableFieldViolation(
-          endpoint.request.body.type,
-          typeTable
-        ).forEach(path => {
+    if (endpoint.request?.body) {
+      findNullableFieldViolation(endpoint.request.body.type, typeTable).forEach(
+        path => {
           violations.push({
             message: `Endpoint (${endpoint.name}) request body contains a nullable field: #/${path}`
           });
-        });
-      }
+        }
+      );
     }
   });
 

diff --git a/lib/src/linting/rules/no-omittable-fields-within-response-bodies.ts b/lib/src/linting/rules/no-omittable-fields-within-response-bodies.ts
@@ -27,17 +27,16 @@ export function noOmittableFieldsWithinResponseBodies(
         );
       }
     });
-    if (endpoint.defaultResponse) {
-      if (endpoint.defaultResponse.body) {
-        findOmittableFieldViolation(
-          endpoint.defaultResponse.body.type,
-          typeTable
-        ).forEach(path => {
-          violations.push({
-            message: `Endpoint (${endpoint.name}) response (default) body contains an omittable field: #/${path}`
-          });
+
+    if (endpoint.defaultResponse?.body) {
+      findOmittableFieldViolation(
+        endpoint.defaultResponse.body.type,
+        typeTable
+      ).forEach(path => {
+        violations.push({
+          message: `Endpoint (${endpoint.name}) response (default) body contains an omittable field: #/${path}`
         });
-      }
+      });
     }
   });
 

diff --git a/lib/src/mock-server/proxy.ts b/lib/src/mock-server/proxy.ts
@@ -23,7 +23,7 @@ export function proxyRequest({
 
   const proxyRequest = requestHandler.request(proxyBaseUrl, options, res => {
     // Forward headers
-    response.writeHead(res.statusCode || response.statusCode, res.headers);
+    response.writeHead(res.statusCode ?? response.statusCode, res.headers);
     res.pipe(response);
   });
 

diff --git a/lib/src/mock-server/server.ts b/lib/src/mock-server/server.ts
@@ -53,7 +53,7 @@ export function runMockServer(
         }
 
         logger.log(`Request hit for ${endpoint.name} registered.`);
-        const response = endpoint.responses[0] || endpoint.defaultResponse;
+        const response = endpoint.responses[0] ?? endpoint.defaultResponse;
         if (!response) {
           logger.error(`No response defined for endpoint ${endpoint.name}`);
           return;

diff --git a/lib/src/parsers/contract-parser.ts b/lib/src/parsers/contract-parser.ts
@@ -57,7 +57,7 @@ export function parseContract(
 
   // Handle description
   const descriptionDoc = getJsDoc(klass);
-  const description = descriptionDoc && descriptionDoc.getDescription().trim();
+  const description = descriptionDoc?.getDescription().trim();
 
   // Handle config
   const configResult = resolveConfig(klass);
@@ -70,7 +70,7 @@ export function parseContract(
     securityHeaderProp &&
     parseSecurityHeader(securityHeaderProp, typeTable, lociTable);
   if (securityResult && securityResult.isErr()) return securityResult;
-  const security = securityResult && securityResult.unwrap();
+  const security = securityResult?.unwrap();
 
   // Add location data
   lociTable.addMorphNode(LociTable.apiClassKey(), klass);

diff --git a/lib/src/parsers/default-response-parser.ts b/lib/src/parsers/default-response-parser.ts
@@ -16,7 +16,6 @@ export function parseDefaultResponse(
   method.getDecoratorOrThrow("defaultResponse");
   const headersParam = getParamWithDecorator(method, "headers");
   const bodyParam = getParamWithDecorator(method, "body");
-  const descriptionDoc = getJsDoc(method);
 
   const headers = [];
   if (headersParam) {
@@ -34,7 +33,7 @@ export function parseDefaultResponse(
 
   return ok({
     headers,
-    description: descriptionDoc && descriptionDoc.getDescription().trim(),
+    description: getJsDoc(method)?.getDescription().trim(),
     body
   });
 }
diff --git a/lib/src/parsers/endpoint-parser.ts b/lib/src/parsers/endpoint-parser.ts
@@ -51,8 +51,7 @@ export function parseEndpoint(
   const tags = tagsResult.unwrap();
 
   // Handle jsdoc
-  const descriptionDoc = getJsDoc(klass);
-  const description = descriptionDoc && descriptionDoc.getDescription().trim();
+  const description = getJsDoc(klass)?.getDescription().trim();
 
   // Handle draft
   const draft = klass.getDecorator("draft") !== undefined;
@@ -88,9 +87,8 @@ export function parseEndpoint(
 
   // Check request path params cover the path dynamic components
   const pathParamsInPath = getDynamicPathComponents(path);
-  const pathParamsInRequest = request
-    ? request.pathParams.map(pathParam => pathParam.name)
-    : [];
+  const pathParamsInRequest =
+    request?.pathParams.map(pathParam => pathParam.name) ?? [];
 
   const exclusivePathParamsInPath = pathParamsInPath.filter(
     pathParam => !pathParamsInRequest.includes(pathParam)

diff --git a/lib/src/parsers/headers-parser.ts b/lib/src/parsers/headers-parser.ts
@@ -43,8 +43,7 @@ export function parseHeaders(
     if (typeResult.isErr()) return typeResult;
     const type = typeResult.unwrap();
 
-    const pDescription = getJsDoc(propertySignature);
-    const description = pDescription && pDescription.getDescription().trim();
+    const description = getJsDoc(propertySignature)?.getDescription().trim();
 
     const optional = propertySignature.hasQuestionToken();
 

diff --git a/lib/src/parsers/path-params-parser.ts b/lib/src/parsers/path-params-parser.ts
@@ -68,8 +68,7 @@ function extractPathParam(
   if (typeResult.isErr()) return typeResult;
   const type = typeResult.unwrap();
 
-  const pDescription = getJsDoc(propertySignature);
-  const description = pDescription && pDescription.getDescription().trim();
+  const description = getJsDoc(propertySignature)?.getDescription().trim();
 
   return ok({ name, type, description });
 }

diff --git a/lib/src/parsers/query-params-parser.ts b/lib/src/parsers/query-params-parser.ts
@@ -42,8 +42,7 @@ export function parseQueryParams(
     if (typeResult.isErr()) return typeResult;
     const type = typeResult.unwrap();
 
-    const pDescription = getJsDoc(propertySignature);
-    const description = pDescription && pDescription.getDescription().trim();
+    const description = getJsDoc(propertySignature)?.getDescription().trim();
 
     const optional = propertySignature.hasQuestionToken();
 

diff --git a/lib/src/parsers/response-parser.ts b/lib/src/parsers/response-parser.ts
@@ -29,7 +29,6 @@ export function parseResponse(
   const statusLiteral = getPropValueAsNumberOrThrow(statusProp);
   const headersParam = getParamWithDecorator(method, "headers");
   const bodyParam = getParamWithDecorator(method, "body");
-  const descriptionDoc = getJsDoc(method);
 
   const headers = [];
   if (headersParam) {
@@ -48,7 +47,7 @@ export function parseResponse(
   return ok({
     status: statusLiteral.getLiteralValue(),
     headers,
-    description: descriptionDoc && descriptionDoc.getDescription().trim(),
+    description: getJsDoc(method)?.getDescription().trim(),
     body
   });
 }
diff --git a/lib/src/parsers/security-header-parser.ts b/lib/src/parsers/security-header-parser.ts
@@ -32,8 +32,7 @@ export function parseSecurityHeader(
   const name = nameResult.unwrap();
 
   // Handle description
-  const descriptionDoc = getJsDoc(property);
-  const description = descriptionDoc && descriptionDoc.getDescription().trim();
+  const description = getJsDoc(property)?.getDescription().trim();
 
   // Handle type
   const typeResult = extractType(property, typeTable, lociTable);

diff --git a/lib/src/parsers/type-parser.ts b/lib/src/parsers/type-parser.ts
@@ -340,11 +340,9 @@ function parseObjectLiteralType(
 
     if (propTypeResult.isErr()) return propTypeResult;
 
-    const psDescription = getJsDoc(ps);
-
     const prop = {
       name: getPropertyName(ps),
-      description: psDescription && psDescription.getDescription().trim(),
+      description: getJsDoc(ps)?.getDescription().trim(),
       type: propTypeResult.unwrap(),
       optional: ps.hasQuestionToken()
     };
@@ -399,11 +397,9 @@ function parseInterfaceDeclaration(
 
     if (propTypeResult.isErr()) return propTypeResult;
 
-    const psDescription = getJsDoc(ps);
-
     const prop = {
       name: getPropertyName(ps),
-      description: psDescription && psDescription.getDescription().trim(),
+      description: getJsDoc(ps)?.getDescription().trim(),
       type: propTypeResult.unwrap(),
       optional: ps.hasQuestionToken()
     };

diff --git a/lib/src/types.ts b/lib/src/types.ts
@@ -484,7 +484,7 @@ export function inferDiscriminator(
         const current = possibleDiscriminators.get(property.name);
         possibleDiscriminators.set(
           property.name,
-          (current || []).concat({
+          (current ?? []).concat({
             value: dereferencedPropertyType.value,
             type
           })

diff --git a/lib/src/validation-server/verifications/contract-mismatcher.ts b/lib/src/validation-server/verifications/contract-mismatcher.ts
@@ -110,7 +110,7 @@ export class ContractMismatcher {
 
     // Find request header mismatches
     const requestHeaderMismatches = this.findHeaderMismatches(
-      (expectedRequest && expectedRequest.headers) || [],
+      expectedRequest?.headers ?? [],
       userInputRequest.headers,
       true
     );
@@ -183,7 +183,7 @@ export class ContractMismatcher {
 
     // Find request body mismatches
     const requestBodyMismatches = this.findBodyMismatches(
-      expectedRequest && expectedRequest.body,
+      expectedRequest?.body,
       userInputRequest.body,
       true
     );
@@ -354,8 +354,7 @@ export class ContractMismatcher {
     contractEndpoint: Endpoint,
     inputPath: string
   ): PathParamTypeDisparityMismatch[] {
-    const contractPathParams =
-      (contractEndpoint.request && contractEndpoint.request.pathParams) || [];
+    const contractPathParams = contractEndpoint.request?.pathParams ?? [];
 
     const contractPathArray = contractEndpoint.path.split("/");
     const inputPathArray = inputPath.split("?")[0].split("/");
@@ -444,7 +443,7 @@ export class ContractMismatcher {
 
     const bodyTypeMismatches = validateFn.errors.map(e => {
       return `#${e.dataPath} ${
-        e.message || "JsonSchemaValidator encountered an unexpected error"
+        e.message ?? "JsonSchemaValidator encountered an unexpected error"
       }`;
     });
 
@@ -475,10 +474,9 @@ export class ContractMismatcher {
     | UndefinedQueryParamMismatch
     | QueryParamTypeDisparityMismatch
   )[] {
-    const contractQueryParams =
-      (contractEndpoint.request && contractEndpoint.request.queryParams) || [];
+    const contractQueryParams = contractEndpoint.request?.queryParams ?? [];
 
-    const queryStringComponent = url.parse(inputPath).query || "";
+    const queryStringComponent = url.parse(inputPath).query ?? "";
 
     const inputQueryParams = qs.parse(queryStringComponent, {
       ...this.getQueryParamsArraySerializationStrategy()
@@ -582,7 +580,7 @@ export class ContractMismatcher {
       );
     });
 
-    return endpoint || null;
+    return endpoint ?? null;
   }
 }
 

diff --git a/tsconfig.json b/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     /* Basic Options */
-    "target": "esnext" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */,
+    "target": "es2019" /* Optional chaining was introduced in es2020. This project supports node >= 12. Only node >= 14 supports optional chaining. */,
     "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
     // "lib": [],                             /* Specify library files to be included in the compilation. */
     // "allowJs": true,                       /* Allow javascript files to be compiled. */