Προπτυχιακοί φοιτητές: Δημιουργήστε έναν διακομιστή REST API με το NodeJS

Πρέπει να εξαγάγουμε τη συνάρτηση που αντιπροσωπεύει μια λειτουργία έχοντας κατά νου ότι θα πρέπει να έχει το ίδιο όνομα με το στοιχείο operationId μέσα στο swagger.yaml διαμόρφωση.

Να είστε προσεκτικοί με την εσοχή του αρχείου swagger.yaml. Θα πρέπει να το προσέξετε γιατί αν υπάρχουν στοιχεία με κακή αναγνώριση, τότε η εφαρμογή μας δεν θα εκτελεστεί και θα εμφανιστεί ένα σφάλμα.

Ο υπέροχος κόσμος των Unit Tests.

Έχω εξαπατήσει ενώ ανέπτυζα τον διακομιστή REST API… Θα έπρεπε να είχα δοκιμάσει την εφαρμογή μου ενώ ανέπτυζα τη λειτουργικότητα 😔… Αλλά δεν είναι πολύ αργά ακόμα.

Γνωρίζω ότι ως φοιτητής αυτό είναι το χειρότερο μέρος του να είσαι προγραμματιστής, αλλά όταν εργάζεσαι σε μια εταιρεία, θα δεις ότι η δοκιμή μονάδας είναι εξαιρετικά σημαντική. Όπως γνωρίζετε, είναι πολύ χρήσιμα για τον εντοπισμό όσο το δυνατόν περισσότερων ζητημάτων κατά τη φάση ανάπτυξής μας, έχοντας κατά νου ότι αναπτύσσουμε μια εφαρμογή JavaScript. Η JavaScript είναι μια ισχυρή δυναμική γλώσσα, αλλά η επιλογή της JavaScript φέρει μεγάλη ευθύνη. Επομένως, πρέπει να φροντίσουμε για σφάλματα χρόνου εκτέλεσης και μεταγλώττισης αναπτύσσοντας χρήσιμες δοκιμές μονάδων.

Είναι καλή πρακτική να αναπτύσσουμε τις δοκιμές μονάδας την ίδια στιγμή που αναπτύσσουμε τη λειτουργικότητά μας ακολουθώντας μία από αυτές τις αρχές: TDD ή BDD.

Είμαι συνηθισμένος στο TDD ή στο Test Driven Development, οπότε θα ακολουθήσω αυτήν την αρχή. Ας υποθέσουμε ότι θέλουμε να εφαρμόσουμε μια συνάρτηση JavaScript που προσθέτει δύο αριθμούς. Αυτή είναι η ίδια η λειτουργία:

function add(a, b) {
    return a + b;
}
exports.add = add;

Είναι μια απλή συνάρτηση, το ξέρω, αλλά ας υποθέσουμε ότι δεν ξέρουμε τι να κάνουμε μέσα στη συνάρτηση. Ακολουθώντας την αρχή TDD, πρώτα πρέπει να αναπτύξω μια δοκιμή μονάδας που αποτυγχάνει. Μην δίνετε σημασία στον κώδικα τουλάχιστον προς το παρόν, γιατί θα τον εξηγήσω αργότερα.

// Im'm requiring a file that has a function exported,
// not the add function itself
const add = require("add");
describe("add test suit", () => {
   it("adds two integer numbers", () => {
      expect(add()).toEqual(0);
   });
});

Αυτό το κομμάτι του κώδικα δοκιμής μονάδας αποτυγχάνει επειδή καλώ μια συνάρτηση που δεν υπάρχει ήδη, επομένως το επόμενο βήμα είναι να αναπτύξετε τη συνάρτηση add() σε ένα αρχείο που ονομάζεται add.js που εξάγει την προαναφερθείσα συνάρτηση:

function add() {
   return 0;
}
exports.add = add;

Τώρα, η προηγούμενη δοκιμή λειτουργεί, επομένως, καθώς δεν έχω ολοκληρώσει την πραγματική συμπεριφορά της συνάρτησης (θυμηθείτε, θα πρέπει να προσθέσει δύο αριθμούς), πρέπει να ενημερώσω τη δοκιμή για να αποτύχει ξανά:

// Im'm requiring a file that has a function exported,
// not the add function itself
const add = require("add");
describe("add test suit", () => {
   it("adds two integer numbers", () => {
      const a = 1;
      const b = 2;
      expect(add(a, b)).toEqual(a + b);
   });
});

Η δοκιμή αποτυγχάνει ξανά επειδή η συνάρτηση επιστρέφει 0 και της δίνω δύο ορίσματα. Στη συνέχεια, ας ενημερώσουμε τη συνάρτηση:

function add(a, b) {
   return a + b;
}
exports.add = add;

Τέλεια, η λειτουργία ολοκληρώθηκε και η δοκιμή λειτουργεί! Έχω τη λειτουργία μου έτοιμη για περιβάλλον παραγωγής. Συνοψίζοντας, αν θέλουμε να εφαρμόσουμε το TDD πρέπει:

1. Δημιουργήστε μια δοκιμή μονάδας που αποτυγχάνει.
2. Δημιουργήστε έναν κωδικό που κάνει τη δοκιμή μονάδας να λειτουργεί.
3. Ενημερώστε τη δοκιμή μονάδας για να αποτύχει ξανά.
4. Ενημερώστε τον κωδικό για να λειτουργήσει η δοκιμή μονάδας.
5. Επαναλάβετε τα βήματα 3-4 μέχρι να ολοκληρώσουμε όλη την αναμενόμενη συμπεριφορά.

Ποιο πλαίσιο πρέπει να επιλέξω για να δοκιμάσω μια εφαρμογή NodeJS;

Υπάρχουν πολλά πλαίσια που μπορούμε να επιλέξουμε όταν αναπτύσσουμε μια εφαρμογή NodeJS. Εδώ έχουμε μερικά από τα πιο δημοφιλή:

• Jasmine: Νομίζω ότι είναι τα πιο εύκολα δοκιμαστικά πλαίσια για αρχάριους. Μπορούμε να δημιουργήσουμε δοκιμές μονάδων και ολοκλήρωσης για JavaScript και περιλαμβάνει τη λειτουργία ισχυρισμών καθώς και μια καλή δομή δοκιμών. Μπορεί να δημιουργήσει αποτελέσματα δοκιμών που πέρασαν/απέτυχαν και μπορούμε να κοροϊδέψουμε τη λειτουργικότητα χωρίς βιβλιοθήκες τρίτων. Αυτό είναι το πλαίσιο που προτιμώ.
• Mocha: Είναι παρόμοιο με το Jasmine, αλλά δεν έχω δουλέψει ποτέ με μόκα. Ρίξτε μια ματιά και μη διστάσετε να διαλέξετε ό,τι προτιμάτε.
• Jest: Έχω δουλέψει με το Jest σε μια εφαρμογή NodeJS που δημιουργήθηκε με τη χρήση TypeScript. Δεν είναι περίπλοκο, αλλά δεν λειτούργησε όπως περίμενα. Το Jest είναι ως επί το πλείστον συμβατό με το Jasmine, επομένως θα μπορούσατε να μεταφέρετε εύκολα από το Jasmine στο Jest, και υποτίθεται ότι είναι πιο ισχυρό και με καλύτερη απόδοση. Δεν είδα κανένα από αυτά τα χαρακτηριστικά.

Τι πρέπει να γνωρίζετε για τη Jasmine;

Πρώτα, πρέπει να μάθετε τι είναι μια δοκιμαστική στολή. Σκοπός του είναι να ομαδοποιήσει μεμονωμένα τεστ που σχετίζονται μεταξύ τους. Για παράδειγμα, εάν θέλουμε να δοκιμάσουμε μια τάξη με διαφορετικές μεθόδους ή ένα αρχείο με διαφορετικές συναρτήσεις, μια δοκιμαστική φόρμα θα είναι η κλάση ή το αρχείο. Στο Jasmine θα δημιουργήσουμε μια δοκιμαστική στολή χρησιμοποιώντας τη μέθοδο describe():

describe("name of your test suit", () => {});

Αυτή η μέθοδος λαμβάνει δύο ορίσματα, μια συμβολοσειρά που αντιπροσωπεύει το όνομα της δοκιμαστικής φόρμας και μια συνάρτηση επανάκλησης με τον κώδικα να εκτελείται για κάθε δοκιμαστική φόρμα. Μπορούμε να φωλιάζουμε όσες δοκιμαστικές σουίτες χρειαζόμαστε, αν και είναι καλή πρακτική να έχουμε μόνο δύο επίπεδα φωλιάς.

Η επόμενη ιδέα που πρέπει να γνωρίζετε είναι τι αντιπροσωπεύει ένα μόνο τεστ. Κάθε συνάρτηση describe() θα πρέπει να συμπληρώνεται με πολλές συναρτήσεις it(). Μια συνάρτηση it() είναι μια δοκιμή απομονωμένης μονάδας.

it("name of the isolated, standalone test", () => {});

Είναι σημαντικό να μην δημιουργείτε εξαρτήσεις μεταξύ κάθε συνάρτησης it(). Δεν πρέπει να χρησιμοποιούμε το αποτέλεσμα μιας συνάρτησης it() σε άλλες συναρτήσεις it(). Αυτό σημαίνει ότι κάθε συνάρτηση it() θα πρέπει να είναι αυτόνομη.

Άλλες λειτουργίες του Jasmine που πρέπει να έχουμε κατά νου είναι:

• beforeEach(): Αυτή η συνάρτηση είναι χρήσιμη για τη διαμόρφωση κώδικα που πρέπει να εκτελείται πριν από κάθε συνάρτηση it(). Λαμβάνει μια συνάρτηση επανάκλησης ως όρισμα.
• beforeAll(): Λειτουργεί με παρόμοιο τρόπο όπως πριν από τοEach, αλλά θα εκτελεστεί μόνο μία φορά σε κάθε describe() συνάρτηση.
• AfterEach(): Το ίδιο με το beforeEach() αλλά εκτελείται μετά από κάθε συνάρτηση it().
• AfterAll(): Θα εκτελεστεί μία φορά μετά από μια συνάρτηση describe().

Τέλος, θα πρέπει να γνωρίζουμε ποιες λειτουργίες διεκδίκησης προσφέρει το Jasmine:

• expect(actual): το πραγματικό όρισμα είναι η τιμή ενός αντικειμένου που θέλουμε να συγκρίνουμε μετά την εκτέλεση της δοκιμής.
• toBe(αναμενόμενο): αυτή η συνάρτηση συγκρίνει την πραγματική τιμή με την αναμενόμενη τιμή. Αποτυγχάνει εάν η πραγματική και η αναμενόμενη τιμή δεν είναι ίση. Αυτή η συνάρτηση απλώς συγκρίνει πρωτόγονους τύπους (αριθμούς, συμβολοσειρές, booleans…).
• toEqual(αναμενόμενο): Είναι το ίδιο με τη λειτουργία toBe() αλλά συγκρίνει αντικείμενα.

Εφαρμογή δοκιμών μονάδας στον διακομιστή REST API.

Πρώτα, πρέπει να εγκαταστήσω την εξάρτηση Jasmine:

npm install --save-dev jasmine

Όπως μπορείτε να δείτε, χρησιμοποιώ -.-save-dev ως επιλογή. Με αυτήν την επιλογή, λέω στο npm ότι πρόκειται να χρησιμοποιήσω αυτήν την εξάρτηση μόνο με σκοπό ανάπτυξης, επομένως δεν θα προστεθεί σε μια διανομή παραγωγής. Αφού εγκατασταθεί, πρέπει να δημιουργήσουμε ένα αρχείο διαμόρφωσης jasmine που ονομάζεται jasmine.json:

Για να εκτελούμε εύκολα τις δοκιμές μας, πρόκειται να διαμορφώσω μια δοκιμαστική εντολή στο αρχείο μας package.json:

Δείτε την ενότητα σενάρια. Μπορώ να εκτελέσω όλες τις δοκιμές στον φάκελο testsμε την καθορισμένη διαμόρφωση και χρειάζομαι απλώς μια εντολή:

npm test

Τέλος, μπορώ να αναπτύξω τις δοκιμές μονάδας μου. Για παράδειγμα, θα σας δείξω τη δοκιμή μονάδας του ελεγκτή home.js.

Αυτό το σενάριο είναι μια δοκιμαστική φόρμα του ελεγκτή, επομένως το πρώτο describe() αναφέρεται στο όνομα του τελικού σημείου που θέλω να δοκιμάσω και είναι το ίδιο που είχα ρυθμίσει προηγουμένως στο αρχείο swagger.yaml "/api". Αυτό το τελικό σημείο έχει απλώς μια λειτουργία λήψης, αλλά θα μπορούσε να έχει και άλλες, όπως ανάρτηση, τοποθέτηση ή διαγραφή, αυτός είναι ο λόγος για τον οποίο έχω ενσωματώσει μια άλλη συνάρτηση describe() με το όνομα της επέμβασης που δοκιμάζω.

Θυμηθείτε την υλοποίηση του ελεγκτή home.js. Εξάγει μια συνάρτηση που απαιτεί δύο ορίσματα, ένα αίτημα και μια απάντηση. Για να δοκιμάσω αυτήν τη συνάρτηση, πρέπει να δημιουργήσω ψεύτικα αντικείμενα αιτήματος και απόκρισης επειδή είναι αντικείμενα που δεν έχω ορίσει στον κώδικά μου. Ο τρόπος με τον οποίο μπορούμε να δημιουργήσουμε ψεύτικα ή χλευασμένα αντικείμενα στο Jasmine είναι η συνάρτηση createSpyObj(). Αυτή η συνάρτηση δημιουργεί ένα αντικείμενο με ψεύτικες συναρτήσεις που κάνουν οτιδήποτε. Δώστε προσοχή στον ελεγκτή home.js:

res.status(200).end();

Χρησιμοποιούμε το αντικείμενο απόκρισης (res) για να στείλουμε μια κατάσταση στον πελάτη και να τερματίσουμε την επικοινωνία. Όπως μπορείτε να δείτε, αλυσιδώνουμε τις κλήσεις σε μία μόνο πρόταση, και αυτό σημαίνει ότι η συνάρτηση status() επιστρέφει ένα αντικείμενο με τον ίδιο τύπο του αντικειμένου res. Αυτός είναι ο λόγος για τον οποίο δημιουργώ μια ψεύτικη κλήση στη μέθοδο status() στον κώδικα δοκιμής.

resMock.status.and.callFake(() => {
   return resMock;
});

Όταν εκτελείται η δοκιμή, πριν από κάθε συνάρτηση it() δημιουργώ μια ψεύτικη κλήση του status() λειτουργία που επιστρέφει το ίδιο το αντικείμενο resMock. Όπως είπα πριν, το createSpyObj() δημιουργεί ψεύτικες συναρτήσεις, αλλά δεν ξέρουν τι να κάνουν ή τι πρέπει να επιστρέψουν και αυτός είναι ο λόγος που δημιουργώ αυτή την ψεύτικη κλήση. Στη συνέχεια, εκτελείται ο κώδικας της συνάρτησης it(), καλώντας την εξαγόμενη συνάρτηση του ελεγκτή home.js. Θέλουμε να ελέγξουμε εάν μετά την κλήση της εξαγόμενης συνάρτησης, επιστρέφει μια απόκριση 200 ΟΚ στους πελάτες.

expect(resMock.status).toHaveBeenCalledWith(200);

Αυτό το κομμάτι κώδικα αναμένει ότι η συνάρτηση resMock.status έχει κληθεί με όρισμα ίσο με 200. Το δοκιμαστικό πέρασμα επειδή το home.js ο ελεγκτής αποκρίνεται με κατάσταση 200 OK.

Συμβουλές και κόλπα: διατηρήστε τον κωδικό σας καθαρό.

Υπάρχει πολλή τεκμηρίωση σχετικά με τον καθαρό κώδικα, επομένως θα μπορούσε να είναι ενδιαφέρον να ρίξετε μια ματιά στο Διαδίκτυο για να καταλάβετε τι είναι καθαρός κώδικας. Σε ορισμένες εταιρείες, οι προγραμματιστές ακολουθούν οδηγούς καθαρού κώδικα που παρέχονται από την ίδια την εταιρεία. Καθώς πιθανότατα είστε μαθητής, μπορείτε να ξεκινήσετε να διαβάζετε ένα ενδιαφέρον βιβλίο: The Clean Code του Robert C. Martin.

Για να μην επεκτείνουμε άσκοπα αυτή την ιστορία, εδώ έχετε μια ενδιαφέρουσα ανακεφαλαίωση.

Είναι πολύ σημαντικό να ακολουθείτε τους οδηγούς καθαρού κώδικα προκειμένου να εφαρμόσετε έναν ευανάγνωστο, διατηρήσιμο και επεκτάσιμο κώδικα. Είναι σημαντικό να μπορείτε να διαβάσετε τον δικό σας κώδικα, αλλά είναι ακόμα πιο σημαντικό να μπορούν να τον διαβάσουν και άλλοι.

Και κάπως έτσι τελειώνει αυτή η ιστορία. Εάν έχετε οποιαδήποτε αμφιβολία, παρακαλώ, μη διστάσετε να επικοινωνήσετε μαζί μου.