Allow an arbitrary server URL #5

Author: EddyVerbruggen

demo/demoapp/main-view-model.ts

@@ -3,6 +3,7 @@ import * as application from "tns-core-modules/application";
 import { Observable } from "tns-core-modules/data/observable";
 import { isIOS } from "tns-core-modules/platform";
 
+// TODO add a demo which asks the user to restart the app to update it (with a 'confirm' and nativescript-exit)
 export class HelloWorldModel extends Observable {
  private codePush: CodePush;
 
@@ -34,7 +35,8 @@ export class HelloWorldModel extends Observable {
  CodePush.sync({
  deploymentKey: isIOS ? HelloWorldModel.CODEPUSH_IOS_STAGING_KEY : HelloWorldModel.CODEPUSH_ANDROID_STAGING_KEY,
  installMode: InstallMode.ON_NEXT_RESTART, // has not effect currently, always using ON_NEXT_RESTART
- mandatoryInstallMode: InstallMode.IMMEDIATE // has not effect currently, always using ON_NEXT_RESTART
+ mandatoryInstallMode: InstallMode.IMMEDIATE, // has not effect currently, always using ON_NEXT_RESTART
+ // serverUrl: "https://www.nu.nl"
  }, (syncStatus: SyncStatus): void => {
  console.log("syncStatus: " + syncStatus);
  if (syncStatus === SyncStatus.UP_TO_DATE) {

src/TNSAcquisitionManager.ts

@@ -7,9 +7,9 @@ export class TNSAcquisitionManager {
 
  private codePushSDK: AcquisitionManager;
 
- constructor(deploymentKey: string) {
+ constructor(deploymentKey: string, serverUrl: string) {
  const config: Configuration = {
- serverUrl: "https://nativescript-codepush-server.herokuapp.com/",
+ serverUrl,
  appVersion: AppVersion.getVersionNameSync(),
  clientUniqueId: device.uuid,
  deploymentKey

src/TNSLocalPackage.ts

@@ -27,6 +27,7 @@ export class TNSLocalPackage implements ILocalPackage {
  packageHash: string;
  packageSize: number;
  failedInstall: boolean;
+ serverUrl: string;
 
  install(installSuccess: SuccessCallback<InstallMode>, errorCallback?: ErrorCallback, installOptions?: InstallOptions): void {
  let appFolderPath = fs.knownFolders.documents().path + "/app";
@@ -42,7 +43,7 @@ export class TNSLocalPackage implements ILocalPackage {
 
  const onUnzipComplete = (success: boolean, error?: string) => {
  if (!success) {
- new TNSAcquisitionManager(this.deploymentKey).reportStatusDeploy(this, "DeploymentFailed");
+ new TNSAcquisitionManager(this.deploymentKey, this.serverUrl).reportStatusDeploy(this, "DeploymentFailed");
  errorCallback && errorCallback(new Error(error));
  return;
  }

src/TNSRemotePackage.ts

@@ -13,6 +13,7 @@ export class TNSRemotePackage implements IRemotePackage {
  packageHash: string;
  packageSize: number;
  failedInstall: boolean;
+ serverUrl: string;
 
  download(downloadSuccess: SuccessCallback<ILocalPackage>, downloadError?: ErrorCallback, downloadProgress?: SuccessCallback<DownloadProgress>): void {
  getFile(this.downloadUrl).then(
@@ -28,10 +29,11 @@ export class TNSRemotePackage implements IRemotePackage {
  tnsLocalPackage.isFirstRun = false;
  // TODO (low prio) see https://github.com/Microsoft/cordova-plugin-code-push/blob/055d9e625d47d56e707d9624c9a14a37736516bb/www/remotePackage.ts#L55 (but prolly not too relevant)
  tnsLocalPackage.failedInstall = false;
+ tnsLocalPackage.serverUrl = this.serverUrl;
 
  downloadSuccess(tnsLocalPackage);
 
- new TNSAcquisitionManager(this.deploymentKey).reportStatusDownload(tnsLocalPackage);
+ new TNSAcquisitionManager(this.deploymentKey, this.serverUrl).reportStatusDownload(tnsLocalPackage);
  },
  (e: any) => {
  downloadError(new Error("Could not access local package. " + e));

src/code-push-lib.d.ts

@@ -33,6 +33,7 @@ interface IPackage {
  packageHash: string;
  packageSize: number;
  failedInstall: boolean;
+ serverUrl: string;
 }
 
 /**
@@ -324,9 +325,14 @@ interface SyncOptions extends InstallOptions {
  updateDialog?: boolean | UpdateDialogOptions;
 
  /**
- * Overrides the config.xml deployment key when checking for updates.
+ * The deployment key when checking for updates.
+ */
+ deploymentKey: string;
+
+ /**
+ * Overrides the default server URL (https://nativescript-codepush-server.herokuapp.com/).
  */
- deploymentKey?: string;
+ serverUrl?: string;
 }
 
 /**

src/code-push.ts

@@ -101,10 +101,10 @@ export class CodePush {
 
  CodePush.cleanPackagesIfNeeded();
 
- CodePush.notifyApplicationReady(options.deploymentKey);
+ CodePush.notifyApplicationReady(options.deploymentKey, options.serverUrl);
 
  syncCallback && syncCallback(SyncStatus.CHECKING_FOR_UPDATE);
- CodePush.checkForUpdate(options.deploymentKey).then(
+ CodePush.checkForUpdate(options.deploymentKey, options.serverUrl).then(
  (remotePackage?: IRemotePackage) => {
  if (!remotePackage) {
  syncCallback && syncCallback(SyncStatus.UP_TO_DATE);
@@ -173,17 +173,20 @@ export class CodePush {
  );
  }
 
- static checkForUpdate(deploymentKey: string): Promise<IRemotePackage> {
+ static checkForUpdate(deploymentKey: string, serverUrl?: string): Promise<IRemotePackage> {
  return new Promise((resolve, reject) => {
+ // by default, use our Cloud server
+ serverUrl = serverUrl || "https://nativescript-codepush-server.herokuapp.com/";
+
  const config: Configuration = {
- serverUrl: "https://nativescript-codepush-server.herokuapp.com/",
+ serverUrl,
  appVersion: AppVersion.getVersionNameSync(),
  clientUniqueId: device.uuid,
  deploymentKey
  };
 
  CodePush.getCurrentPackage(config).then((queryPackage?: IPackage) => {
- new TNSAcquisitionManager(deploymentKey).queryUpdateWithCurrentPackage(queryPackage, (error: Error, result: IRemotePackage | NativeUpdateNotification) => {
+ new TNSAcquisitionManager(deploymentKey, serverUrl).queryUpdateWithCurrentPackage(queryPackage, (error: Error, result: IRemotePackage | NativeUpdateNotification) => {
  if (error) {
  reject(error.message || error.toString());
  }
@@ -209,6 +212,7 @@ export class CodePush {
  // TODO (low prio) see https://github.com/Microsoft/cordova-plugin-code-push/blob/055d9e625d47d56e707d9624c9a14a37736516bb/www/codePush.ts#L182
  // .. or https://github.com/Microsoft/react-native-code-push/blob/2cd2ef0ca2e27a95f84579603c2d222188bb9ce5/CodePush.js#L84
  tnsRemotePackage.failedInstall = false;
+ tnsRemotePackage.serverUrl = serverUrl;
 
  resolve(tnsRemotePackage);
  });
@@ -226,7 +230,8 @@ export class CodePush {
  failedInstall: false,
  description: undefined,
  label: undefined,
- packageSize: undefined
+ packageSize: undefined,
+ serverUrl: config.serverUrl
  });
  });
  }
@@ -241,11 +246,11 @@ export class CodePush {
  TNSLocalPackage.clean();
  }
 
- static notifyApplicationReady(deploymentKey: string): void {
+ static notifyApplicationReady(deploymentKey: string, serverUrl?: string): void {
  if (CodePush.isBinaryFirstRun()) {
  // first run of a binary from the AppStore
  CodePush.markBinaryAsFirstRun();
- new TNSAcquisitionManager(deploymentKey).reportStatusDeploy(null, "DeploymentSucceeded");
+ new TNSAcquisitionManager(deploymentKey, serverUrl).reportStatusDeploy(null, "DeploymentSucceeded");
 
  } else if (!CodePush.hasPendingHash()) {
  const currentPackageHash = appSettings.getString(CodePush.CURRENT_HASH_KEY, null);
@@ -255,7 +260,7 @@ export class CodePush {
  const currentPackage: ILocalPackage = <ILocalPackage>TNSLocalPackage.getCurrentPackage();
  if (currentPackage !== null) {
  currentPackage.isFirstRun = true;
- new TNSAcquisitionManager(deploymentKey).reportStatusDeploy(currentPackage, "DeploymentSucceeded");
+ new TNSAcquisitionManager(deploymentKey, serverUrl).reportStatusDeploy(currentPackage, "DeploymentSucceeded");
  }
  }
  }