Jag började med denna tutorial men som författaren skriver så bör Migrations användas. Därför + migrations från sequelize manualen.

Koden finns i repot, instruktionerna här.

git clone https://github.com/jensnti/notes.git
cd notes
npm i
npx sequelize db:migrate
npm test
npm start

Första steget är att få det att funka och använda sqlite.

npm install sequelize sequelize-cli sqlite3

npx sequelize-cli init

Init gör följande enligt manualen.

• config, contains config file, which tells CLI how to connect with database
• models, contains all models for your project
• migrations, contains all migration files
• seeders, contains all seed files

Eftersom config kan innehålla passwords och annat.

.gitignore config/config.json

Redigera config/config.json

"development": {
    "dialect": "sqlite",
    "storage": "database.sqlite"
},

Har du klonat detta repo och behöver en config.

npx sequelize-cli init:config

Döp om config.json till config.js. Installera dotenv, npm i dotenv

Det går nu att använda dotenv för att dölja uppgifter i config.js vilket tar bort behovet av att .gitingore filen. Ladda bara inte upp .env filen till GitHub.

Det är viktigt att ha med require('dotenv').config(); i config.js eftersom npx sequelize kommandon inte laddar app.js.

require('dotenv').config();

module.exports = {
    development: {
        storage: 'database.sqlite',
        dialect: 'sqlite'
    },
    test: {
        storage: 'database.test.sqlite',
        dialect: 'sqlite'
    },
    production: {
        username: process.env.DB_USER || '',
        password: process.env.DB_PASSWORD || '',
        database: process.env.DB_NAME || '',
        host: process.env.DB_HOST || '',
        dialect: 'postgres'
    }
};

Notera att tag är inte jättebäst och kommer faila normalisering. Vi får fixa det senare.

npx sequelize-cli model:generate --name Note --attributes note:string,tag:string

Enligt sequelize manualen gör detta följande:

• Create a model file user in models folder
• Create a migration file with name like XXXXXXXXXXXXXX-create-user.js in migrations folder

För att migrera databasen så kör: npx sequelize db:migrate

För att skapa lite testdata kan vi använda en seeder.

Skapa seedern med:

npx sequelize-cli seed:generate --name demo-notes

Redigera filen seeders/###-demo-notes.js:

'use strict';

module.exports = {
    up: async (queryInterface, Sequelize) => {
        await queryInterface.bulkInsert(
            'Notes',
            [
                {
                    note: 'pick up some bread after work',
                    tag: 'shopping',
                    createdAt: new Date(),
                    updatedAt: new Date()
                },
                {
                    note: 'remember to write up meeting notes',
                    tag: 'work',
                    createdAt: new Date(),
                    updatedAt: new Date()
                },
                {
                    note: 'learn how to use node orm',
                    tag: 'work',
                    createdAt: new Date(),
                    updatedAt: new Date()
                }
            ],
            {}
        );
    },

    down: async (queryInterface, Sequelize) => {
        await queryInterface.bulkDelete('Notes', null, {});
    }
};

För att seeda kör sedan:

npx sequelize-cli db:seed:all

Utan fel så har vi nu en databas med data. 🎉

npm install --save nodemon

Redigera package.json startscript:

  "scripts": {
    "start": "nodemon ./bin/www"
  },

Redigera app.js:

const apiRouter = require('./routes/api-router');

app.use('/', apiRouter);

Routes fil, routes/api-router.js:

const { Note } = require('../models');

router.get('/notes', function (req, res) {
    Note.findAll().then((notes) => res.json(notes));
});

Provkör med Thunder client i vscode. Surfa till localhost:3000/notes

👍

En collection för att testa samliga routes är inkluderad i detta repo.

Kolla här och i jest manualen.

För att automatisera tester används jest och supertest. npm i --save-dev jest supertest

mkdir __tests__
touch __tests__/test.js

Skapa ett första test i test.js.

test('two plus two is four', () => {
    expect(2 + 2).toBe(4);
});

Redigera package.json och skapa ett script för att köra alla tester.

"scripts": {
    "test": "jest"
},

Kör alla test med npm run test alternativt så kör npx jest.

Notera att jest/supertest ska vara smart nog att köra på test databasen från sequelize config. Ditt nästa steg är att kolla in server.test.js filen i test mappen. Där finns samtliga tester för projektet.

Testa, här finns det arbete att göra. Fel osv.

/notes/

Response

[
  {
    "id": 1,
    "note": "pick up some bread after work",
    "tag": "shopping",
    "createdAt": "2021-10-06T07:47:45.330Z",
    "updatedAt": "2021-10-06T07:47:45.330Z"
  },
  {
    "id": 2,
    "note": "remember to write up meeting notes",
    "tag": "work",
    "createdAt": "2021-10-06T07:47:45.330Z",
    "updatedAt": "2021-10-06T07:47:45.330Z"
  }
]

Search ?tag

/notes/search?tag=shopping

Response

[
  {
    "id": 1,
    "note": "pick up some bread after work",
    "tag": "shopping",
    "createdAt": "2021-10-06T07:47:45.330Z",
    "updatedAt": "2021-10-06T07:47:45.330Z"
  }
]

Search :id

/notes/2

Response

[
  {
    "id": 2,
    "note": "remember to write up meeting notes",
    "tag": "work",
    "createdAt": "2021-10-06T07:47:45.330Z",
    "updatedAt": "2021-10-06T07:47:45.330Z"
  }
]

/notes

Payload

{
    "note": "Testing",
    "tag": "work"
}

Response

{
  "id": 5,
  "note": "Testing",
  "tag": "work",
  "updatedAt": "2021-10-06T07:56:16.289Z",
  "createdAt": "2021-10-06T07:56:16.289Z"
}

/notes/5

Payload

{
    "note": "Updates",
    "tag": "work"
}

Response

{
  "id": 5,
  "note": "Updates",
  "tag": "work",
  "createdAt": "2021-10-06T07:56:16.289Z",
  "updatedAt": "2021-10-06T07:57:06.025Z"
}

/notes/5

Response

OK