ci(docs-infra): add explicit return types to methods

aio/aio-builds-setup/dockerbuild/scripts-js/lib/verify-setup/helper.ts

@@ -42,7 +42,7 @@ class Helper {
   }
 
   // Methods - Public
-  public cleanUp() {
+  public cleanUp(): void {
     while (this.cleanUpFns.length) {
       // Clean-up fns remove themselves from the list.
       this.cleanUpFns[0]();
@@ -66,7 +66,7 @@ class Helper {
     }
   }
 
-  public createDummyBuild(pr: number, sha: string, isPublic = true, force = false, legacy = false) {
+  public createDummyBuild(pr: number, sha: string, isPublic = true, force = false, legacy = false): CleanUpFn {
     const prDir = this.getPrDir(pr, isPublic);
     const shaDir = this.getShaDir(prDir, sha, legacy);
     const idxPath = path.join(shaDir, 'index.html');
@@ -101,7 +101,7 @@ class Helper {
     });
   }
 
-  public runForAllSupportedSchemes(suiteFactory: TestSuiteFactory) {
+  public runForAllSupportedSchemes(suiteFactory: TestSuiteFactory): void {
     Object.keys(this.portPerScheme).forEach(scheme => suiteFactory(scheme, this.portPerScheme[scheme]));
   }
 
@@ -137,13 +137,13 @@ class Helper {
   }
 
   public writeBuildFile(pr: number, sha: string, relFilePath: string, content: string, isPublic = true,
-                        legacy = false) {
+                        legacy = false): void {
     const shaDir = this.getShaDir(this.getPrDir(pr, isPublic), sha, legacy);
     const absFilePath = path.join(shaDir, relFilePath);
     this.writeFile(absFilePath, {content}, true);
   }
 
-  public writeFile(filePath: string, {content, size}: FileSpecs, force = false) {
+  public writeFile(filePath: string, {content, size}: FileSpecs, force = false): void {
     if (!force && fs.existsSync(filePath)) {
       throw new Error(`Refusing to overwrite existing file '${filePath}'.`);
     }
@@ -206,7 +206,18 @@ export function makeCurl(baseUrl: string) {
   };
 }
 
-export function payload(buildNum: number) {
+export interface PayloadData {
+  data: {
+    payload: {
+      build_num: number,
+      build_parameters: {
+        CIRCLE_JOB: string;
+      };
+    };
+  };
+}
+
+export function payload(buildNum: number): PayloadData {
   return {
     data: {
       payload: {

aio/aio-builds-setup/dockerbuild/scripts-js/lib/verify-setup/jasmine-custom-matchers.ts

@@ -6,7 +6,7 @@ import {computeShortSha} from '../common/utils';
 import {SHA} from './constants';
 import {helper} from './helper';
 
-function checkFile(filePath: string, remove: boolean) {
+function checkFile(filePath: string, remove: boolean): boolean {
   const exists = existsSync(filePath);
   if (exists && remove) {
     // if we expected the file to exist then we remove it to prevent leftover file errors
@@ -15,7 +15,7 @@ function checkFile(filePath: string, remove: boolean) {
   return exists;
 }
 
-function getArtifactPath(prNum: number, sha: string = SHA) {
+function getArtifactPath(prNum: number, sha: string = SHA): string {
   return `${AIO_DOWNLOADS_DIR}/${prNum}-${computeShortSha(sha)}-aio-snapshot.tgz`;
 }
 
@@ -35,8 +35,8 @@ function checkFiles(prNum: number, isPublic: boolean, sha: string, isLegacy: boo
   return { existingFiles, missingFiles };
 }
 
-class ToExistAsAFile {
-  public compare(actual: string, remove = true) {
+class ToExistAsAFile implements jasmine.CustomMatcher {
+  public compare(actual: string, remove = true): jasmine.CustomMatcherResult {
     const pass = checkFile(actual, remove);
     return {
       message: `Expected file at "${actual}" ${pass ? 'not' : ''} to exist`,
@@ -45,8 +45,8 @@ class ToExistAsAFile {
   }
 }
 
-class ToExistAsAnArtifact {
-  public compare(actual: {prNum: number, sha?: string}, remove = true) {
+class ToExistAsAnArtifact implements jasmine.CustomMatcher {
+  public compare(actual: {prNum: number, sha?: string}, remove = true): jasmine.CustomMatcherResult {
     const { prNum, sha = SHA } = actual;
     const filePath = getArtifactPath(prNum, sha);
     const pass = checkFile(filePath, remove);
@@ -57,8 +57,9 @@ class ToExistAsAnArtifact {
   }
 }
 
-class ToExistAsABuild {
-  public compare(actual: {prNum: number, isPublic?: boolean, sha?: string, isLegacy?: boolean}, remove = true) {
+class ToExistAsABuild implements jasmine.CustomMatcher {
+  public compare(actual: {prNum: number, isPublic?: boolean, sha?: string, isLegacy?: boolean}, remove = true):
+      jasmine.CustomMatcherResult  {
     const {prNum, isPublic = true, sha = SHA, isLegacy = false} = actual;
     const {missingFiles} = checkFiles(prNum, isPublic, sha, isLegacy, remove);
     return {
@@ -67,7 +68,8 @@ class ToExistAsABuild {
       pass: missingFiles.length === 0,
     };
   }
-  public negativeCompare(actual: {prNum: number, isPublic?: boolean, sha?: string, isLegacy?: boolean}) {
+  public negativeCompare(actual: {prNum: number, isPublic?: boolean, sha?: string, isLegacy?: boolean}):
+      jasmine.CustomMatcherResult  {
     const {prNum, isPublic = true, sha = SHA, isLegacy = false} = actual;
     const { existingFiles } = checkFiles(prNum, isPublic, sha, isLegacy, false);
     return {