Let's write an Angular 1.x app with a Caché REST backend - Part 8

Primary tabs

or "Bonus Breakage"

In our last lesson, we added a relationship between 2 persistent classes.  We are clearly going to need to start creating REST Services to expose CRUD operations for each of these classes, but before we do that, we should really finish defining our linkages.  We added code to our Widget toJSON to spool off related Accessory data, so we should really do the reciprocal and allow Accessories to return all Widgets that are compatible.

The code we can use is essentially the same as we used on the Widget side.  We will iterate over the bridging class and return the toJSON of all referenced widgets.  We are definitely sure we have a toJSON for the Widget class, so we shouldn't be expecting any errors.  We add the code to WidgetAccessory and compile, before loading our service in the REST debugger to make sure everything is spooling OK.

FRAMESTACK?!  This seems bad.  Why would adding code we have already used in the Widget class cause such a severe failure?  The issue is that we have accidently created an infinte recursive loop.  Our Widget references an Accessory which references Widgets which reference Accessories.... and so on. We need to ensure that we limit our recursion when dealing with relationships.  In most cases, we don't need deep recursion when spooling off referenced data, so the most simple solution is to parameterise toJSON with a "traverseRelationships" Boolean, and default this to False.  This allows our REST Services to return basic information about a referenced class, and for our primary Services for an object to return all data when it needs to.

 

So, we add the Boolean parameter and then enclose the relationship code in an IF statement to prevent it from running.  This should output the standard properties only when called from our service, since the default value is to prevent the output of relationships.  We will implement this on both our Widget and Accessory class.  After a compile, we load our Service again

  We've lost our accessory relationship.  As the default behaviour is to inhibit relationships now, we have to amend our REST Service code to specifically include the references, by passing in a true value to the toJSON's first parameter.

One more compile and refresh, and we have our references back without a FRAMESTACK error

 

In this lesson we:

  1. Created an infinite recursion between 2 related classes
  2. Implemented default behaviour to prevent infinite recursion
  3. Amended our REST Service code to correct output relationships from a base class

Next lesson we will:

  • Create direct REST services for Widget and Accessory
  • Implement a fromJSON to read objects sent from a client

This article is part of a multi-part series on using Angular on top of Caché REST services.  The listing of the full series can be found at the Start Here page

 


Comments

Rather than pass the traverseRelationships Boolean to the instance method toJSON(traverseRelationships) in User.Widget, could you change URL map/URL route to use a QueryString parameter? 
eg 1. http://{{SERVER}}:{{WEB_PORT}}/widgetsdirect/rest/Stephen?traverseRelationships=true
eg2.
http://{{SERVER}}:{{WEB_PORT}}/widgetsdirect/rest/Stephen?traverseRelationships=false

How do you map URL querystring parameters to the %CSP.REST class in HTTP Get Requests?