All About Cranking Out High Quality XPages Applications. Martin Donnelly IBM Ireland

Transcription

1 All About Cranking Out High Quality XPages Applications Martin Donnelly IBM Ireland

2 Please Note IBM s statements regarding its plans, directions, and intent are subject to change or withdrawal without notice at IBM s sole discretion. Information regarding potential future products is intended to outline our general product direction and it should not be relied on in making a purchasing decision. The information mentioned regarding potential future products is not a commitment, promise, or legal obligation to deliver any material, code or functionality. Information about potential future products may not be incorporated into any contract. The development, release, and timing of any future features or functionality described for our products remains at our sole discretion Performance is based on measurements and projections using standard IBM benchmarks in a controlled environment. The actual throughput or performance that any user will experience will vary depending upon many factors, including considerations such as the amount of multiprogramming in the user s job stream, the I/O configuration, the storage configuration, and the workload processed. Therefore, no assurance can be given that an individual user will achieve results similar to those stated here. 2

3 Agenda XPages Applications Introduction 3 Testing Debugging Tuning Deployment Discussion

4 Speaker Introduction 4 Martin Donnelly - Software Architect: IBM Ireland IBM Lotus Domino XPages / IBM Lotus Domino Designer IBM Lotus Component Designer 6.0 JavaServer Faces (JSF) Tooling IBM Rational Application Developer Java Visual Editor extensions for IBM Rational Application Developer Software Developer: Iris Associates / Lotus Development IBM Lotus Domino Designer V4.6 to V6.01 IBM Lotus for Unix, LotusScript, etc. Author Mastering XPages I & II XPages Portable Command Guide

5 Agenda XPages Applications Introduction 5 Testing Debugging Tuning Deployment Discussion

6 Use Case Introducing Frank Adams Frank Adams XPages Project Manager How does Frank deliver projects on time, on budget and to a high quality standard? 6

7 XPages Today 7

8 Session Goals Examine technologies & best practices in the Testing Tuning Deployment phases Profiling & Tuning Testing Application Development Lifecycle Development 8 Deployment

9 Automated GUI Testing Does your control/application render correctly on all browsers & platforms? Does the functionality match what you expect on all browsers & platforms? Do you have a mobile interface that works across devices? Source: 9

10 Selenium Selenium is a browser automation framework Selenium IDE record & playback, auto-generates code Selenium supports tests written in Python, Ruby, Perl, PHP and Java. Latest version: Selenium v2.39 WebDriver API ChromeDriver IEDriver FirefoxDriver AndroidDriver iphonedriver (+ iwebdriver app)...and more 10 Source: Source:

11 TestNG Testing framework based on JUnit Run test suite & report the results Provides results in HTML and XML format Customisable format & layout Take screenshots upon failures TestNG Annotations, @AfterMethod Plugin for Eclipse/IBM Domino Designer

12 Combine Selenium & TestNG 1. Install TestNG plugin 2. Add Selenium jars to project build path 3. Create a Selenium test Java class 4. Create a WebDriver instance 5. Create a Selenium test method 6. Add TestNG annotation (@Test) 12

13 Combine Selenium & TestNG (ctd.) 7. Find WebElements using findelement() & Selenium By class 8. Call methods on WebElements 9. Perform assertions on expected outcomes 10. Create TestNG test suite XML file 11. Reference the Java class 12. methods 13. Run the TestNG suite 13 XPath cssselector By.cssSelector("a[id='view:_id1:link1']"); linktext By.linkText("click me"); others By.id(...), By.className(...), By.tagName(...)

14 14

15 Pitfalls and Best Practices WebDriver cannot interact with browser dialogs Selenium workarounds available. Other options - AutoIT and java.awt.robot Be careful with WebDriver & iframes webdriver.switchto().frame(string frameid); Communication between Dev & Test Developers can write automation! 15 Don't use auto-generated ids By.cssSelector("button[id='view:_id1:_id12:_id234_id56']"); Set ImplicitWait timeout value webdriver.manage().timeouts().implicitlywait(5, TimeUnit.SECONDS); User-Agent manipulation to emulate mobile device testing

16 Selenium Grid Allows for distributed parallel test execution Central hub controls a number of nodes Hub activates tests across available nodes Nodes report results back to the hub Parallel automated testing across browsers & platforms Better & faster testing coverage 16 Source:

17 API Testing - JUnit 17 JUnit is a unit testing framework for the Java programming language Unit Tests ensure Java code is working as intended Create an Object Invoke a method Check the result Provides a mechanism to make assertions about the state of your objects AssertTrue fails if condition is false; passes otherwise AssertEquals fails if expected and actual objects are not equal And others... JUnit plugin is part of IBM Domino Designer XPages JUnit Framework is part of the XPages Extension Library zip

18 XPages JUnit Framework Provides set of extensible test cases that the XPages team have created to test the core and extension library Java controls Suite of test cases that can be applied to your library of controls Verify xsp-config files can be parsed Verify set methods correspond to property names Verify controls can be serialized And others... Utility to generate.java files from.xsp files Utilities for creating the JSF control tree and rendering HTML to the.xsp file Extendable for your own specific test needs Ideally requires some knowledge of the xsp-config file format 18

19 Jenkins Java-based Open Source Continuous Integration Tool Build software projects Test software projects Automate the automation! Monitor executions of externally-run jobs Provides web interface for configuration and monitoring Extensible write your own Jenkins plugins 19 Source:

20 Agenda XPages Applications Introduction 20 Testing Debugging Tuning Deployment Discussion

21 Debugging Topics 21 SSJS Debug Techniques Printing, Logging & Dumping SSJS Debugger Java Debugging Debugging DOJO

22 Domino Designer SSJS Debugger Domino Designer Server Side JavaScript Debug Configuration Debugging is only supported on Domino Social Edition servers and later Debugger is based on Eclipse Remote Java Connection protocol and uses JPDA/JDI 22

23 Domino Designer SSJS Debugger Debugger can be invoked from a new toolbar item Breakpoints can be set directly on inline XPages SSJS code or within SSJS Script Library 23 New 'breakpoint' keyword has been added to the SSJS syntax to allow for permanent breakpoints Breakpoints are only enabled when the server is running in debug mode Sever must be configured to run in 'debug mode' in order for debugger to work Note this implies that a port must be opened on the server, so it is not recommended to debug servers that have unprotected access to the internet! JavaEnableDebug=1 JavascriptEnableDebug=1 JavaDebugOptions=transport=dt_socket,server=y,suspend=n,address=8000

24 Debugging Server Side JavaScript! 24

25 Server-Side Java Debug Options 25 Java Source code is included for all plug-ins in Social edition that originate in UP1 Development Environment setup: VERY SIMILAR TO SSJS DEBUG SETUP!! :-) Server must be started in debug mode (again be aware of open server port!) JavaEnableDebug=1 JavaDebugOptions=transport=dt_socket,server=y,suspend=n,address=8000 Install Domino Debug Plugin into Domino Designer Import Java source plug-ins into Domino Designer (refer to step #11) Set up Domino server and OSGI debug configurations

26 Client-Side JS/Dojo Debugging 26 New debug options Use case: Dojo Library deployed in an OSGi bundle on the server Developer needs to debug uncompressed version of the source files - e.g. xspclientdojo.js vs xspclientdojo.js.uncompressed.js How: Set the Use uncompressed resources option in XSP Properties editor Result: The XPages runtime will server *.uncompressed.js & *.uncompressed.css if available (from within the OSGi bundle)

27 Agenda XPages Applications Introduction 27 Testing Debugging Tuning Deployment Discussion

28 Developing for Performance The XPages Toolbox XPages based Application (The XPages Swiss Army Knife ) Runs on the Domino server or the Notes client XPagesToolbox.nsf needs to be installed on the Domino server or XPiNC client A profiler.jar file needs to be added to the JVM launch options & JVM java.policy updated Should be used regularly during development / testing cycles to: Profile CPU performance & Memory usage (per request or periodically) / Backend usage Control logging of XPages Runtime loggers View current Threads in the nhttp process Create Java Heap Dumps / XML Memory Dumps Production use only for problem resolution - sensitive data collection capabilities Available from OpenNTF.org Free open source project / Search for XPages Toolbox / Authored by Philippe Riand, IBM Full readme.pdf instructions within the project download files 28

29 Developing for Performance The XPages Toolbox XPages based Application (The XPages Swiss Army Knife ) Runs on the Domino server or the Notes client XPagesToolbox.nsf needs to be installed on the Domino server or XPiNC client A profiler.jar file needs to be added to the JVM launch options & JVM java.policy updated Should be used regularly during development / testing cycles to: Profile CPU performance & Memory usage (per request or periodically) / Backend usage Control logging of XPages Runtime loggers View current Threads in the nhttp process Create Java Heap Dumps / XML Memory Dumps Production use only for problem resolution - sensitive data collection capabilities Available from OpenNTF.org Free open source project / Search for XPages Toolbox / Authored by Philippe Riand, IBM Full readme.pdf instructions within the project download files 29

30 Developing for Performance The XPages Toolbox XPages based Application (The XPages Swiss Army Knife ) Runs on the Domino server or the Notes client XPagesToolbox.nsf needs to be installed on the Domino server or XPiNC client A profiler.jar file needs to be added to the JVM launch options & JVM java.policy updated Should be used regularly during development / testing cycles to: Profile CPU performance & Memory usage (per request or periodically) / Backend usage Control logging of XPages Runtime loggers View current Threads in the nhttp process Create Java Heap Dumps / XML Memory Dumps Production use only for problem resolution - sensitive data collection capabilities Available from OpenNTF.org Free open source project / Search for XPages Toolbox / Authored by Philippe Riand, IBM Full readme.pdf instructions within the project download files 30

31 Developing for Performance Using the XPages Toolbox Provides insight into CPU Time and Wall Time cost of a request CPU Time is the amount of time spent by the CPU actually processing XPages code (ie: burning real CPU cycles) No idle time included such as waiting on non-cpu intensive code Wall Time is the amount of time spent actually processing XPages code and any idle time Like watching the time going by on the clock on the wall 31

32 Developing for Performance Using the XPages Toolbox Provides insight into CPU Time and Wall Time cost of a request CPU Time is the amount of time spent by the CPU actually processing XPages code (ie: burning real CPU cycles) No idle time included such as waiting on non-cpu intensive code Wall Time is the amount of time spent actually processing XPages code and any idle time Like watching the time going by on the clock on the wall 32

33 Developing for Performance Using the XPages Toolbox Provides insight into CPU Time and Wall Time cost of a request CPU Time is the amount of time spent by the CPU actually processing XPages code (ie: burning real CPU cycles) No idle time included such as waiting on non-cpu intensive code Wall Time is the amount of time spent actually processing XPages code and any idle time Like watching the time going by on the clock on the wall 33

34 Developing for Performance The XPages Toolbox Key elements: Profile XPages Request using Wall and CPU Profilers... Perform CPU and Wall time intensive tasks... Analyze profiling results and identify issues in the XPages Toolbox! 34

35 Developing for Performance Using the XPages Toolbox Provide insight into custom SSJS code using Profile Blocks profile( blockidentifier, optionalinformation ){ // profile my custom code... var nd:notesdocument = document1.getdocument();... } 35

36 Developing for Performance Using the XPages Toolbox Provide insight into custom SSJS code using Profile Blocks profile( blockidentifier, optionalinformation ){ // profile my custom code... var nd:notesdocument = document1.getdocument();... profile( blockidentifier, optionalinformation ){ // profile my nested profile block... var x = nd.getitemvaluestring( x );... } } 36

37 Developing for Performance Using the XPages Toolbox Provide insight into custom Java code using Profile Block Decorator private static final ProfilerType pt = new ProfilerType("MyBlock"); public void mymethod() { if(profiler.isenabled()) { ProfilerAggregator pa = Profiler.startProfileBlock(pt, null); long starttime = Profiler.getCurrentTime(); try { _mymethod(); } finally { Profiler.endProfileBlock(pa, starttime); } } else { _mymethod(); } } private void _mymethod() { // real implementation of mymethod } 37

38 Developing for Performance Using the XPages Toolbox Provides insight into custom Java code using Profile Block Decorator private static final ProfilerType pt = new ProfilerType("MyBlock"); public void mymethod() { if(profiler.isenabled()) { ProfilerAggregator pa = Profiler.startProfileBlock(pt, null); long starttime = Profiler.getCurrentTime(); try { _mymethod(); } finally { Profiler.endProfileBlock(pa, starttime); } } else { _mymethod(); } } private void _mymethod() { // real implementation of mymethod } 38

39 Developing for Performance Using the XPages Toolbox Provides insight into custom Java code using Profile Block Decorator private static final ProfilerType pt = new ProfilerType("MyBlock"); public void mymethod() { if(profiler.isenabled()) { ProfilerAggregator pa = Profiler.startProfileBlock(pt, null); long starttime = Profiler.getCurrentTime(); try { _mymethod(); } finally { Profiler.endProfileBlock(pa, starttime); } } else { _mymethod(); } } private void _mymethod() { // real implementation of mymethod } 39

40 Developing for Performance Using the XPages Toolbox Provides insight into custom Java code using Profile Block Decorator private static final ProfilerType pt = new ProfilerType("MyBlock"); public void mymethod() { if(profiler.isenabled()) { ProfilerAggregator pa = Profiler.startProfileBlock(pt, null); long starttime = Profiler.getCurrentTime(); try { _mymethod(); } finally { Profiler.endProfileBlock(pa, starttime); } } else { _mymethod(); } } private void _mymethod() { // real implementation of mymethod } 40

41 Developing for Performance Using the XPages Toolbox Provides insight into custom Java code using Profile Block Decorator private static final ProfilerType pt = new ProfilerType("MyBlock"); public void mymethod() { if(profiler.isenabled()) { ProfilerAggregator pa = Profiler.startProfileBlock(pt, null); long starttime = Profiler.getCurrentTime(); try { _mymethod(); } finally { Profiler.endProfileBlock(pa, starttime); } } else { _mymethod(); } } private void _mymethod() { // real implementation of mymethod } 41

42 Developing for Performance Using the XPages Toolbox Non-Invasive and Supportive Leave the custom Profile Blocks in your SSJS / Java Code No negative performance impact on any application even if the XPages Toolbox is not installed on a server or XPiNC client Therefore supporting you for future profiling & maintenance tasks 42

43 Developing for Performance A Lean, Mean XPages Machine! Core things you need to leverage in order to reduce CPU processing (along with Memory usage to a lesser degree) relative to the workings of the X-RPL 43 Use Partial Refresh Use Partial Execution Use computed rendered properties with caution for hidewhen UI logic, instead prefer the loaded property under Complete Refresh Use the Dynamic Content control for advanced hidewhen UI logic under Partial Refresh See Mastering XPages, Second Edition, Chapter 20 Advanced Performance Topics, for in-depth explanation and worked examples related to the X-RPL

44 Understanding the XPages Machine A deeper look at an XPages Request Key elements: XPages Request goes in XPages Request Processing Lifecycle processes XPages Request Introspection gives us insight into execution XPages Response comes out! 44

45 Understanding the XPages Machine The XPages Request Processing Lifecycle POST = 1,2,3,4,5,6 Most typically executed for HTTP GET & POST Requests 45 GET = 1,6

46 Understanding the XPages Machine The XPages Request Processing Lifecycle Chp20Ed2.nsf is a testing harness from Mastering XPages, Second Edition, demonstrating a variety of XPages Request Processing Lifecycle use cases Introduces Lifecycle phases and advanced use cases governed by the X-RPL Uses a PhaseListener class to capture key phase entry / exit points Allowing dynamic introspection of a request See: DebugBeanPhaseListener.java faces-config.xml / index.xsp 46 46

47 Agenda XPages Applications Introduction 47 Testing Debugging Tuning Deployment Discussion

48 Deployment Considerations What is your application usage profile? Can your applications be tuned to scale and perform well for different profiles? Does the application use latest features from OpenNTF.org? Have you ever enabled XPages logging? Do you know where to find your XPages logs and know how to interpret them? Does the application need to run on the Domino Server and Notes Client? 48 Do you also need to use experimental features like Mobile, OpenNTF essentials? Can you mix and match extended and experimental features? How do you resolve issues after production applications are deployed? Few applications, many users Many applications each with a small number of users A mix of the above... If running on Notes client, is it purely for convenience of offlining web apps or Do you want a fully optimized Notes client XPages application?

49 Deployment Considerations: Application Usage Profile 49 Use Case 1: Lots of application instances based on the same template e.g. a billing template used by all company consultants for every corporate client Individual application instances per customer Potential Issues Each application includes the same design artifacts Redundancy and scalability problems Rolling out design updates is difficult due to the proliferation of NSFs Consider the Single Copy XPages Design (SCXD) Feature Create a design-only copy of your application Must be an NSF file, not an NTF Must have a unique name, not a duplicate of any application instance Only applies to XPages design elements and resources Deploy SCXD NSF to Domino server and Notes client, as needed

50 Deployment Considerations: Application Usage Profile 50 Use Case 2: Application used by many concurrent users Application needs to scale well in order to support many users Options Consider which XPages persistence options a) Keep pages in memory b) Keep pages on disk c) Keep only the current page in memory Choose the best fit for your usage profile Options b) and c) scale best Option a) is best for performance, e.g. few users using NSF Look at the Java heap size allocated to the Domino server HTTP task NOTES.INI - HTTPJVMMaxHeapSizeSet=1 - HTTPJVMMaxHeapSize=256M The Java memory allocation for the HTTP task 256MB recommended on 32bit servers 1024MB on 64bit servers

51 Deployment Considerations: Other xsp.properties options xsp.properties file contains settings to control XPages runtime behaviors Can be applied on a server-wide, per app, per page or per request basis Some other useful examples are summarized as follows: More persistence options xsp.persistence.file.maxviews, xsp.persistence.dir.xspstate Server timeouts xsp.application.timeout=30min xsp.session.timeout=30min Network Payload Management xsp.compress.mode=gzip - network files are smaller (enabled by default) xsp.resources.aggregate - means fewer requests for CSS, JS and image files Browser expiration for web resources (CSS, JS, images etc) xsp.expires.global=10days 51

52 Deployment Considerations: XPages Core, UP1 and Ext Lib Managing your XPages runtime configuration How can the XPages Upgrade Pack and Extension Library co-exist? e.g. I have deployed XPages plus the latest Extension Library How do I upgrade to UP1? - You must first uninstall the Extension Library - Then run the UP1 add-on installer Can I use OpenNTF experimental components (e.g. RDBMS) with UP1? - No at least, not all builds How do I upgrade 9.0 SE? - Uninstall the Extension Library - Run the 9.0 SE installer Can I install Upgrade Pack 1 into 853 with Fix Pack releases? I have XPages UP1, How do I upgrade 9.0 SE? Can Upgrade Packs and OpenNTF releases be interchangeable in future? 52

53 Notes/Domino 9.0 Deployment Performance Considerations 53 XPages applications can be preloaded on both Notes client and web server New Single Copy XPages Design option Combine Single Copy XPages Design with Preload for production applications Deploying a local design-only SCXD NSF means all web resources are resolved locally Form design elements required by computewithform logic resolved locally Reduced network traffic from SXCD + Preload greatly enhances XPiNC performance!!! New XPiNC RunOnServer option if Notes optimizations are not a priority

54 XPages Quality App Check List API + GUI Testing Selenium and JUnit XPages Toolbox Profile your use cases Provides detailed analysis per request on CPU, Memory, Time costs Adhere to the 10 golden rules of XPages Performance See Mastering XPages book for details Preload commonly used apps where possible Base your installation on IBM XPages 9.0.1! 54

55 Questions & Answers Contact 55

56 Technical Education IBM Press Books and ebooks 56 Three major publications from 2011 to 2013

57 Technical Education Hot off the Press - April 25, 2014!!! Mastering XPages 2nd Edition 57 Based on Notes/Domino new chapters Advanced Performance/Scalability Mobile Application Development Deep Dive on Debugging All About Application Layout Comprehensive updates to all preexisting 1st edition content Hardcover ~500 pages of new content ~1200 pages total

58 More Information Summary 58 XPages.info One Stop Shopping for XPages XPages Forum Got Questions, Need Answers? OpenNTF Open Source Community Domino Application Development Wiki XPages Blog IBM Educational Offerings

59 Danke Buíochas Gracias Grazie Obrigado Merci 59

60 Backup Slides IBM Confidential IBM Corporation