SMAG Architecture — Part 2

Data Services Directory Structure - Angular: The Full Gamut

Charlie Greenman
September 16, 2020
3 min read

What are Data Services?

This is part 2 of a 5 part series. To see the first article on directory structure for @ngrx/store, feel free to click on this link!

In many application settings, an enormous part of an app’s services will be directed towards handling data directly. For instance, let’s say you have a GraphQL user query that gets a current user’s data. The service would look something like this:

import { Injectable } from '@angular/core';
import { Observable, from } from 'rxjs';
import { pluck } from 'rxjs/operators';
import { Apollo } from 'apollo-angular';
@Injectable({ providedIn: 'root' })
export class UserService {
  getUser(): Observable<User> {
    const user$ = this.apollo.query({ query: GetCurrentUser });
    return from(user$).pipe(pluck('data', 'getCurrentUser'));
  }
  constructor(private apollo: Apollo) {}
}

It’s a rough guess, but odds are that 80% of services within any Angular app, will be built, to directly work with data. These services will be used by a number of effects. In addition, (just a side note for us to keep in mind,) they will contain their own respective unit tests.


Setting the Landscape

As of Angular 6, Angular offers a metadata option called providedIn. In short, if providedIn is set to ‘root’, it allows us to bypass the need of using a module, and creates a tree-shakable version.

Therefore, the bundler will be able to tell if this service is being used in a particular module. If it is not, service will not be bundled with particular module. This allows us to be very liberal with our services and put them in a central location. Of course we would be able to do this with a module, but it make’s it more architecturally appealing without the need of using a module.


Data Services Folder/File Structure

libs
|-- px-illustrator/
|   |-- data-services/
|   |   |-- src/
|   |   |   |-- lib/
|   |   |   |   |-- services/
|   |   |   |   |   |-- user/
|   |   |   |   |   |   |-- user.service.ts
|   |   |   |   |   |   |-- user.service.spec.ts
|   |   |-- index.ts
|   |   |-- test.ts
|   |-- karma.conf,file
|   |-- README.md,file
|   |-- tsconfig.lib,file
|   |-- tsconfig.lib.json,file
|   |-- tsconfig.spec.json,file]
|   |-- tslint.json,file

Just as simple as that. We have a central location called data-services where we put the bulk of services that deal with retrieving data and returning it as an observable. If you want to be technical about it, you can create every data-service as its own lib for unit testing. However, I think this is a bit much, as services tend to not touch the DOM and run really fast as unit tests. Something to discuss based on the app’s particular architectural needs.

More articles similar to this

footer

Razroo is committed towards contributing to open source. Take the pledge towards open source by tweeting, #itaketherazroopledge to @_Razroo on twitter. One of our associates will get back to you and set you up with an open source project to work on.