rhoconnect 3.0.5 → 3.0.6

data/bench/prepare_bench

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
+require 'bench'
+
+def create_subdir(dir)
+  begin
+    Dir.mkdir(dir)
+  rescue
+  end
+end
+
+# 1) Extract Bench title
+title = ARGV[0]
+
+
+# 2) create result directory structure
+['bench_results', ARGV[1]].each do |dir|
+  next if dir.nil?
+  create_subdir dir
+  Dir.chdir dir
+end
+result_dir = Dir.pwd
+
+['raw_data', 'images'].each do |dir|
+  create_subdir dir
+end
+
+# 3) create meta.yml file
+meta_hash = {:x_keys => {}, :metrics => {}, :label => title}
+x_keys = ARGV[2].split() if $ARGV[1]
+x_keys ||= []
+counter = 0
+x_keys = x_keys.sort_by(&Bench.sort_natural_order)
+x_keys.each do |x_key|
+  meta_hash[:x_keys][x_key] = counter
+  counter += 1
+end
+
+meta_hash[:metrics] = {'Throughput' => 0, 'Av.Time' => 1}
+
+File.open(File.join(result_dir,'raw_data','meta.yml'), 'w') do |file|
+  file.write meta_hash.to_yaml unless meta_hash.empty?
+end

data/bench/run_bench.sh

@@ -20,8 +20,8 @@ else
   exit
 fi
 
-RHOCONNECT_HOME="$HOME/workspace/rhoconnect"
-cd $RHOCONNECT_HOME
+cd '../'
+RHOCONNECT_HOME=`pwd`
 
 echo "Pull rhoconnect code from remote repository ..." | tee -a /tmp/bench.log
 git reset --hard HEAD | tee -a /tmp/bench.log 2>&1
@@ -36,7 +36,7 @@ do
   ruby_version=$(rvm current)
   echo "Running benchmarks under $ruby_version ..." | tee -a /tmp/bench.log
   echo "" | tee -a /tmp/bench.log
-  ruby bench/bench_runner.rb $RHOCONNECT_HOME 2>&1 | tee -a /tmp/bench.log
+  ruby ./bench/bench_runner.rb $RHOCONNECT_HOME 2>&1 | tee -a /tmp/bench.log
 done
 
 

data/bench/run_blob_script.sh

@@ -1,3 +1,3 @@
 #! /bin/sh
 
-ruby bench start 'scripts/blob_cud_script.rb' 'rhoadmin' ''
+ruby bench start 'scripts/blob_cud_script.rb' 'rhoadmin' '' $*

data/bench/run_cud_script.sh

@@ -1,3 +1,3 @@
 #! /bin/sh
 
-ruby bench start 'scripts/cud_script.rb' 'rhoadmin' ''
+ruby bench start 'scripts/cud_script.rb' 'rhoadmin' '' $*

data/bench/run_query_md_script.sh

@@ -1,3 +1,3 @@
 #! /bin/sh
 
-ruby bench start 'scripts/query_md_script.rb' 'rhoadmin' ''
+ruby bench start 'scripts/query_md_script.rb' 'rhoadmin' '' $*

data/bench/run_query_only_script.sh

@@ -1,3 +1,3 @@
 #! /bin/sh
 
-ruby bench start 'scripts/query_only_script.rb' 'rhoadmin' ''
+ruby bench start 'scripts/query_only_script.rb' 'rhoadmin' '' $*

data/bench/run_query_script.sh

@@ -1,3 +1,3 @@
 #! /bin/sh
 
-ruby bench start 'scripts/query_script.rb' 'rhoadmin' ''
+ruby bench start 'scripts/query_script.rb' 'rhoadmin' '' $*

data/bench/run_test_query_script.sh

@@ -0,0 +1,30 @@
+#! /bin/sh
+
+timestamp_postfix=$(date +%Y_%m_%d_%H%M%S)
+test_label=query_bench_$timestamp_postfix
+if [ $# -gt 0 ] ; then
+    test_label=$1
+fi
+server='default'
+if [ $# -gt 1 ] ; then
+    server=$2
+fi
+
+n_iterations=10
+
+# setup the benchmark directory structure
+ruby prepare_bench $test_label query_bench_$timestamp_postfix "1 2 3 5 10"
+
+# simulate various number of simultaneous clients
+for n_threads in 1 2 3 5 10
+do
+	# simulate variaous number of data records
+	for payload in 1 5 10 50 100 250 500
+	do
+		result_filename=./bench_results/query_bench_$timestamp_postfix/raw_data/query_bench_result.$payload
+		ruby bench start 'scripts/test_query_script.rb' 'rhoadmin' '' $server $result_filename $n_threads $n_iterations $payload
+	done
+done
+
+# once benchmark is finished - process the results
+ruby ./lib/bench/bench_result_processor.rb ./bench_results/query_bench_$timestamp_postfix/raw_data ./bench_results/query_bench_$timestamp_postfix/images

data/bench/run_test_source_script.sh

@@ -0,0 +1,21 @@
+#! /bin/sh
+
+timestamp_postfix=$(date +%Y_%m_%d_%H%M%S)
+n_iterations=100
+#server='http://rhohub-mzverev-c7ca8de3.rhosync.com/api/application'
+server='default'
+
+# setup the benchmark directory structure
+ruby prepare_bench 'Rhoconnect SOURCE API benchmark' source_bench_$timestamp_postfix "1 2 5 10 15 20"
+
+# simulate various number of simultaneous clients
+for n_threads in 1 2 5 10 15 20
+do
+	result_filename=./bench_results/source_bench_$timestamp_postfix/raw_data/source_bench_result.test
+	ruby bench start 'scripts/test_source_script.rb' 'rhoadmin' '' $server $result_filename $n_threads $n_iterations
+done
+
+# once benchmark is finished - process the results
+ruby ./lib/bench/bench_result_processor.rb ./bench_results/source_bench_$timestamp_postfix/raw_data ./bench_results/source_bench_$timestamp_postfix/images
+
+

data/bench/scripts/test_query_script.rb

@@ -0,0 +1,64 @@
+include BenchHelpers
+bench_log "Runs simple login,clientcreate,clientregister,sync session and validates response"
+
+Bench.config do |config|
+  config.concurrency ||= 10
+  config.iterations  ||= 10
+  config.datasize ||= 100
+  config.main_marker = 'get-cud'
+  config.user_name = "benchuser"
+  config.password = "password"
+  config.get_test_server
+  @datasize = Bench.datasize
+  @expected = Bench.get_test_data(@datasize)
+  @all_objects = "[{\"version\":3},{\"token\":\"%s\"},{\"count\":%i},{\"progress_count\":0},{\"total_count\":%i},{\"insert\":""}]"
+  @ack_token = "[{\"version\":3},{\"token\":\"\"},{\"count\":0},{\"progress_count\":%i},{\"total_count\":%i},{}]"
+  @api_token = Bench.get_token
+  config.request_logging = false
+  
+  # if this is not a distributed run - reset the app
+  if not Bench.sync_key
+    config.reset_app
+    config.set_server_state("test_db_storage:application:#{config.user_name}",@expected)
+    config.reset_refresh_time('MockAdapter')
+  end
+end
+
+Bench.synchronize do |config|
+  break unless Bench.sync_key
+  while true
+    cur_time = Time.now.to_f
+    sync_time = Bench.get_server_value(Bench.sync_key).to_f 
+    if sync_time > 0.0 and cur_time >= sync_time
+      break
+    end
+    sleep(0.010)
+  end
+  puts " we have here #{cur_time}, #{sync_time}"   
+end
+
+Bench.test do |config,session|
+  session.post "clientlogin", "#{config.base_url}/clientlogin", :content_type => :json do
+    {:login => config.user_name, :password => config.password}.to_json
+  end
+  session.get "clientcreate", "#{config.base_url}/clientcreate"
+  client_id = JSON.parse(session.last_result.body)['client']['client_id']
+  session.client_id = client_id
+  session.post "clientregister", "#{config.base_url}/clientregister", :content_type => :json do
+    {:device_type => "Apple", :device_pin => 'somepin123', :device_port => "device_port_111", :phone_id => 'unique_phone_id',
+      :client_id => client_id}.to_json
+  end
+  
+  session.get "get-cud", "#{config.base_url}/query" do
+    {'source_name' => 'MockAdapter', 'client_id' => session.client_id, 'p_size' => @datasize}
+  end
+  token = JSON.parse(session.last_result.body)[1]['token']
+  session.get "ack-cud", "#{config.base_url}/query" do
+    { 'source_name' => 'MockAdapter', 
+      'client_id' => session.client_id,
+      'token' => token}
+  end
+  session.last_result.verify_code(200)
+  session.last_result.verify_body([{:version => 3},{:token => ''},{:count => 0},
+    {:progress_count => @datasize},{:total_count => @datasize},{}].to_json)
+end  

data/bench/scripts/test_source_script.rb

@@ -0,0 +1,27 @@
+include BenchHelpers
+bench_log "Runs admin source methods in batch"
+
+Bench.config do |config|
+  config.concurrency ||= 10
+  config.iterations  ||= 100
+  config.main_marker = 'get_adapter'
+  config.user_name = "benchuser"
+  config.password = "password"
+  config.get_test_server
+  config.reset_app
+  
+  @token = config.get_token
+  @save_adapter_url = "my/dynamic/adapter/url"
+  config.reset_refresh_time('MockAdapter')
+  config.request_logging = false
+end
+
+
+Bench.test do |config,session|
+  session.post "save_adapter", "#{config.host}/api/source/save_adapter", :content_type => :json do
+    {:api_token => @token, :attributes => {:adapter_url => @save_adapter_url}}.to_json
+  end
+  session.post "get_adapter", "#{config.host}/api/source/get_adapter", :content_type => :json do
+    {:api_token => @token}.to_json
+  end
+end  

data/bin/rhoconnect-benchmark

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+$:.unshift File.join(File.dirname(__FILE__),'..','bench','lib')
+$:.unshift File.join(File.dirname(__FILE__),'..','bench')
+require 'bench'
+
+$ARGV.unshift ''
+$ARGV.unshift 'rhoadmin'
+$ARGV.unshift 'scripts/test_comm_script.rb'
+$ARGV.unshift 'start'
+
+Bench::Cli.start

data/doc/client-objc.txt

@@ -73,6 +73,8 @@ Do the following steps to add schema files to your Copy Bundle Resources build p
 	CREATE TABLE product (
 	 "client_id" VARCHAR(255) default NULL);
 
+** NOTE: Do not use NOT NULL statement in column definitions. RhoConnect client delete object attributes by setting value to null, when all object attributes become nulls, object deleted. So objects with NOT NULL columns will not be deleted. **
+
 ## Coding a RhoConnect Client
 
 This section discusses the general steps you perform to code a RhoConnect client in Objective C, using the store example. It is not a tutorial for coding a complete Xcode application, but instead discusses the RhoConnect code that you need to create.
@@ -180,6 +182,7 @@ Here is the Store code for the login process, contained in LoginViewController.m
 		[ [RhoConnectEngine sharedInstance].syncClient loginWithUser:txtLogin.text pwd:txtPassword.text callback:@selector(loginComplete:) target:self];	
 	}
 
+
 ### Synchronize Data
 
 Call the RhoConnectClient setNotification method to call a callback method that notifies about the state of the synchronization.
@@ -210,6 +213,31 @@ Here is the Store code for the sync process, contained in WaitLoginController.m.
 			[ [RhoConnectEngine sharedInstance].syncClient clearNotification];		
 		}else if ([notify.status compare:@"error"] == 0)
 		{
+                if([notify.error_message caseInsensitiveCompare:@"unknown client"] == 0) {
+	                [[RhoConnectEngine sharedInstance].syncClient database_client_reset]; 
+	                [[RhoConnectEngine sharedInstance].syncClient setNotification: @selector(syncAllCalback:) target:self];
+	                [[RhoConnectEngine sharedInstance].syncClient syncAll];
+	            } else if( err_code == RHO_ERR_CLIENTISNOTLOGGEDIN
+	                    || err_code == RHO_ERR_UNATHORIZED) {
+    	
+	                NSLog(@"GO TO LOGIN PAGE!");
+	                // real code to trigger view transition goes here.. 
+	            }else
+	            {
+                    //This is mandatory:
+                    if([notify hasCreateErrors]) {
+                        [[RhoConnectEngine sharedInstance].syncClient onCreateError: notify @"delete"];        
+                    }
+                    //These are optional:
+                    /*
+                    if([notify hasUpdateErrors]) {
+                        [[RhoConnectEngine sharedInstance].syncClient onUpdateError: notify @"rollback"];        
+                    }
+                    if([notify hasDeleteErrors]) {
+                        [[RhoConnectEngine sharedInstance].syncClient onDeleteError: notify @"retry"];        
+                    }
+                    */
+	            }
 		}
 	}
 
@@ -227,6 +255,114 @@ Here is the Store code for the sync process, contained in WaitLoginController.m.
 		}
 	}
 
+### Processing unknown-client error
+Unknown client error return by server after resetting server database, removing particular client id from database or any other cases when server cannot find client id(sync server unique id of device).
+Note that login session may still exist on server, so in this case client does not have to login again, just create new client id.
+Processing of this error contain 2 steps:
+
+* When unknown client error is come from server, client should call database_client_reset and start new sync, to register new client id.
+
+* If login session also deleted or expired on the server, then customer has to login again.
+
+Example:
+	:::cplusplus
+	
+    - (void)syncAllComplete:(RhoConnectNotify*) notify
+    {
+        NSString* status = notify.status;
+        NSString* error = notify.error_message;
+        int err_code = notify.error_code;
+        
+        NSLog(@"syncAll DONE, status: '%s' , error_msg: '%s' , error_code: %d",
+              [status cStringUsingEncoding: NSUTF8StringEncoding],
+              [error cStringUsingEncoding: NSUTF8StringEncoding],
+              err_code
+              );
+        
+	    if ( [notify.status compare:@"in_progress"] == 0) {
+            
+	    } else if ([notify.status compare:@"complete"] == 0) {
+            
+		    [[RhoConnectEngine sharedInstance].syncClient clearNotification];
+            
+	    } else if ([notify.status compare:@"error"] == 0) {
+            
+	            if([notify.error_message caseInsensitiveCompare:@"unknown client"] == 0) {
+	                [[RhoConnectEngine sharedInstance].syncClient database_client_reset]; 
+	                [[RhoConnectEngine sharedInstance].syncClient setNotification: @selector(syncAllCalback:) target:self];
+	                [[RhoConnectEngine sharedInstance].syncClient syncAll];
+	            } else if( err_code == RHO_ERR_CLIENTISNOTLOGGEDIN
+	                    || err_code == RHO_ERR_UNATHORIZED) {
+    	
+	                NSLog(@"GO TO LOGIN PAGE!");
+	                // real code to trigger view transition goes here.. 
+	            }
+	    }
+    }
+
+### Processing server errors
+* create-error: 
+has to be handled in sync callback. Otherwise sync will stop on this model. To fix create errors you should call Model.on_sync_create_error or SyncEngine.on_sync_create_error:
+
+* update-error:
+If not handled, local modifications, which were failing on server, will never sync to server again.
+So sync will work fine, but nobody will know about these changes.
+
+* delete-error:
+If not handled, local modifications, which were failing on server, will never sync to server again.
+So sync will work fine, but nobody will know about these changes.
+
+Example:
+	:::cplusplus
+	
+    - (void)syncAllCalback:(RhoConnectNotify*) notify
+    {
+        NSString* status = notify.status;
+        NSString* error = notify.error_message;
+        int err_code = notify.error_code;
+        
+        NSLog(@"syncAll DONE, status: '%s' , error_msg: '%s' , error_code: %d",
+              [status cStringUsingEncoding: NSUTF8StringEncoding],
+              [error cStringUsingEncoding: NSUTF8StringEncoding],
+              err_code
+              );
+        
+	    if ( [notify.status compare:@"in_progress"] == 0) {
+            
+	    } else if ([notify.status compare:@"complete"] == 0) {
+            
+		    [[RhoConnectEngine sharedInstance].syncClient clearNotification];
+            
+	    } else if ([notify.status compare:@"error"] == 0) {
+            
+            if([notify isUnknownClientError]) {
+                [[RhoConnectEngine sharedInstance].syncClient database_client_reset]; 
+                [[RhoConnectEngine sharedInstance].syncClient setNotification: @selector(syncAllCalback:) target:self];
+                [[RhoConnectEngine sharedInstance].syncClient syncAll];
+            } else if( err_code == RHO_ERR_CLIENTISNOTLOGGEDIN
+                || err_code == RHO_ERR_UNATHORIZED) {
+
+                NSLog(@"GO TO LOGIN PAGE!");
+                // real code to trigger view transition goes here.. 
+            }else
+            {
+                //This is mandatory:
+                if([notify hasCreateErrors]) {
+                    [[RhoConnectEngine sharedInstance].syncClient onCreateError: notify action:@"delete"];        
+                }
+                //These are optional:
+                /*
+                if([notify hasUpdateErrors]) {
+                    [[RhoConnectEngine sharedInstance].syncClient onUpdateError: notify action:@"rollback"];        
+                }
+                if([notify hasDeleteErrors]) {
+                    [[RhoConnectEngine sharedInstance].syncClient onDeleteError: notify action:@"retry"];        
+                }
+                */
+            }
+	    }
+    }
+    
 ### Search the Client Database for Models
 
 Call a RhomModel find method (find, find\_first, find\_all) to find model objects in the client database. This code sample for the find\_all method fetches all the models in the database; you can also search for models containing certain attribute data.
@@ -271,6 +407,9 @@ The RhoConnectClient class contains the following properties and methods to buil
  * <a href="#setObjectNotification">setObjectNotification</a>
  * <a href="#clearObjectNotification">clearObjectNotification</a>
  * <a href="#addObjectNotify">addObjectNotify</a>
+ * <a href="#onCreateError">onCreateError</a>
+ * <a href="#onUpdateError">onUpdateError</a>
+ * <a href="#onDeleteError">onDeleteError</a>
 
 ### <a id="threaded_mode"></a>threaded\_mode property
 
@@ -477,7 +616,86 @@ Sample call:
 	RhoConnectClient* sclient;
 	...
 	[sclient addObjectNotify: [[item objectForKey:@"source_id"] intValue] szObject:[item valueForKey:@"object"] ];
-    
+
+### <a id="onCreateError"></a>onCreateError
+
+Instance method. To process 'create-error' errors from server.
+
+	:::cplusplus
+    - (void) onCreateError: (RhoConnectNotify*)notify action: (NSString*)action;
+
+<table border="1">
+<tr>
+	<td><code>notify</code></td>
+	<td>RhoConnectNotify. Notification object passed to notification callback.</td>
+</tr>
+<tr>
+	<td><code>action</code></td>
+	<td>NSString. May be "delete" or "recreate": "delete" just remove object from client, "recreate" will push this object to server again at next sync.</td>
+</tr>
+</table>
+
+Sample call:
+
+	:::cplusplus
+	RhoConnectClient* sclient;
+	...
+	if ([notify hasCreateErrors])
+	    [sclient onCreateError: notify action:@"delete" ];
+
+
+### <a id="onUpdateError"></a>onUpdateError
+
+Instance method. To process 'update-error' errors from server.
+
+	:::cplusplus
+    - (void) onUpdateError: (RhoConnectNotify*)notify action: (NSString*)action;
+
+<table border="1">
+<tr>
+	<td><code>notify</code></td>
+	<td>RhoConnectNotify. Notification object passed to notification callback.</td>
+</tr>
+<tr>
+	<td><code>action</code></td>
+	<td>NSString. May be "retry" or "rollback": "retry" will push update object operation to server again at next sync, "rollback" will write rollback objects(comes from server) to client database.</td>
+</tr>
+</table>
+
+Sample call:
+
+	:::cplusplus
+	RhoConnectClient* sclient;
+	...
+	if ([notify hasUpdateErrors])
+	    [sclient onUpdateError: notify action:@"retry" ];
+
+### <a id="onDeleteError"></a>onUpdateError
+
+Instance method. To process 'delete-error' errors from server.
+
+	:::cplusplus
+    - (void) onDeleteError: (RhoConnectNotify*)notify action: (NSString*)action;
+
+<table border="1">
+<tr>
+	<td><code>notify</code></td>
+	<td>RhoConnectNotify. Notification object passed to notification callback.</td>
+</tr>
+<tr>
+	<td><code>action</code></td>
+	<td>NSString. May be "retry" - will push delete object operation to server again at next sync.</td>
+</tr>
+</table>
+
+Sample call:
+
+	:::cplusplus
+	RhoConnectClient* sclient;
+	...
+	if ([notify hasDeleteErrors])
+	    [sclient onDeleteError: notify action:@"retry" ];
+	    	        
 ## RhomModel Class API
 
 The RhomModel class contains the following properties and methods for setting and using RhomModel objects; RhomModel objects are RhoConnect models and their attributes.
@@ -751,6 +969,23 @@ Several RhoConnectClient methods return a RhoConnectNotify object. The propertie
 	<td><code>callback_params</code></td>
 	<td>@property(assign) NSString*. Callback parameters.</td>
 </tr>
+<tr>
+	<td><code>hasCreateErrors</code></td>
+	<td>(Boolean). Return true if server return create-errors.</td>
+</tr>
+<tr>
+	<td><code>hasUpdateErrors</code></td>
+	<td>(Boolean). Return true if server return update-errors.</td>
+</tr>
+<tr>
+	<td><code>hasDeleteErrors</code></td>
+	<td>(Boolean). Return true if server return delete-errors.</td>
+</tr>
+<tr>
+	<td><code>isUnknownClientError</code></td>
+	<td>(Boolean). Return true if server return unknown client error.</td>
+</tr>
+
 </table>
 
 ## RhoConnectObjectNotify Class API