appcenter-cli/src/commands/codepush/lib/legacy-codepush-service-client.ts

Command line tool for Visual Studio App Center

import * as request from "request";
import { DefaultApp } from "../../../util/profile/index";
import * as fs from "fs";

export interface PackageInfo {
  appVersion?: string;
  description?: string;
  isDisabled?: boolean;
  isMandatory?: boolean;
  label?: string;
  packageHash?: string;
  rollout?: number;
}

export type Headers = { [headerName: string]: string };

export default class LegacyCodePushServiceClient {
  private static API_VERSION: number = 2;

  constructor(private accessKey: string, private serverUrl: string, private app: DefaultApp) {
    if (!accessKey) { throw new Error("A token must be specified to execute server calls."); }
    if (!serverUrl) { throw new Error("A server url must be specified to execute server calls."); }
  }

  public release(deploymentName: string, filePath: string, updateMetadata: PackageInfo): Promise<void> {
    const appName = this.app.identifier;
    return new Promise<void>((resolve, reject) => {
        const options = {
          url: this.serverUrl + this.urlEncode(`/apps/${this.appNameParam(appName)}/deployments/${deploymentName}/release`),
          headers: {
            Accept: `application/vnd.code-push.v${LegacyCodePushServiceClient.API_VERSION}+json`,
            Authorization: `Bearer ${this.accessKey}`
          },
          formData: {
            packageInfo: JSON.stringify(updateMetadata),
            package: fs.createReadStream(filePath)
          }
        };

        request.post(options, (err, httpResponse) => {
          if (err) {
            reject(this.getErrorMessage(err, httpResponse));
            return;
          }
          if (httpResponse.statusCode === 201) {
            resolve(null as void);
          } else {
            reject({ request: request, response: httpResponse });
            return;
          }
        });
    });
  }

  // A template string tag function that URL encodes the substituted values
  private urlEncode(strings: any, ...values: string[]): string {
    let result = "";
    for (let i = 0; i < strings.length; i++) {
        result += strings[i];
        if (i < values.length) {
            result += encodeURIComponent(values[i]);
        }
    }

    return result;
  }

  // IIS and Azure web apps have this annoying behavior where %2F (URL encoded slashes) in the URL are URL decoded
  // BEFORE the requests reach node. That essentially means there's no good way to encode a "/" in the app name--
  // URL encodeing will work when running locally but when running on Azure it gets decoded before express sees it,
  // so app names with slashes don't get routed properly. See https://github.com/tjanczuk/iisnode/issues/343 (or other sites
  // that complain about the same) for some more info. I explored some IIS config based workarounds, but the previous
  // link seems to say they won't work, so I eventually gave up on that.
  // Anyway, to workaround this issue, we now allow the client to encode / characters as ~~ (two tildes, URL encoded).
  // The CLI now converts / to ~~ if / appears in an app name, before passing that as part of the URL. This code below
  // does the encoding. It's hack, but seems like the least bad option here.
  // Eventually, this service will go away & we'll all be on Max's new service. That's hosted in docker, no more IIS,
  // so this issue should go away then.
  private appNameParam(appName: string) {
    return appName.replace("/", "~~");
  }

  private getErrorMessage(error: Error, response: request.RequestResponse): string {
    return response && response.body ? response.body : error.message;
  }
}