Merge pull request umami-software#3392 from umami-software/dev

v2.18.0

Author: mikecao

Dockerfile

@@ -3,49 +3,50 @@ FROM node:22-alpine AS deps
 # Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
 RUN apk add --no-cache libc6-compat
 WORKDIR /app
-COPY package.json yarn.lock ./
-# Add yarn timeout to handle slow CPU when Github Actions
-RUN yarn config set network-timeout 300000
-RUN yarn install --frozen-lockfile
+COPY package.json pnpm-lock.yaml ./
+RUN npm install -g pnpm
+RUN pnpm install --frozen-lockfile
 
 # Rebuild the source code only when needed
 FROM node:22-alpine AS builder
 WORKDIR /app
 COPY --from=deps /app/node_modules ./node_modules
 COPY . .
-COPY docker/middleware.js ./src
 
 ARG DATABASE_TYPE
 ARG BASE_PATH
 
-ENV DATABASE_TYPE $DATABASE_TYPE
-ENV BASE_PATH $BASE_PATH
+ENV DATABASE_TYPE=$DATABASE_TYPE
+ENV BASE_PATH=$BASE_PATH
 
-ENV NEXT_TELEMETRY_DISABLED 1
+ENV NEXT_TELEMETRY_DISABLED=1
 
-RUN yarn build-docker
+RUN npm run build-docker
 
 # Production image, copy all the files and run next
 FROM node:22-alpine AS runner
 WORKDIR /app
 
 ARG NODE_OPTIONS
 
-ENV NODE_ENV production
-ENV NEXT_TELEMETRY_DISABLED 1
-ENV NODE_OPTIONS $NODE_OPTIONS
+ENV NODE_ENV=production
+ENV NEXT_TELEMETRY_DISABLED=1
+ENV NODE_OPTIONS=$NODE_OPTIONS
 
 RUN addgroup --system --gid 1001 nodejs
 RUN adduser --system --uid 1001 nextjs
+RUN npm install -g pnpm
 
 RUN set -x \
-    && apk add --no-cache curl \
-    && yarn add npm-run-all dotenv semver [email protected]
+    && apk add --no-cache curl
+
+# Script dependencies
+RUN pnpm add npm-run-all dotenv [email protected]
+
+# Permissions for prisma
+RUN chown -R nextjs:nodejs node_modules/.pnpm/
 
-# You only need to copy next.config.js if you are NOT using the default configuration
-COPY --from=builder /app/next.config.js .
 COPY --from=builder --chown=nextjs:nodejs /app/public ./public
-COPY --from=builder /app/package.json ./package.json
 COPY --from=builder /app/prisma ./prisma
 COPY --from=builder /app/scripts ./scripts
 
@@ -54,11 +55,14 @@ COPY --from=builder /app/scripts ./scripts
 COPY --from=builder --chown=nextjs:nodejs /app/.next/standalone ./
 COPY --from=builder --chown=nextjs:nodejs /app/.next/static ./.next/static
 
+# Custom routes
+RUN mv ./.next/routes-manifest.json ./.next/routes-manifest-orig.json
+
 USER nextjs
 
 EXPOSE 3000
 
-ENV HOSTNAME 0.0.0.0
-ENV PORT 3000
+ENV HOSTNAME=0.0.0.0
+ENV PORT=3000
 
-CMD ["yarn", "start-docker"]
+CMD ["pnpm", "start-docker"]

README.md

@@ -38,18 +38,12 @@ A detailed getting started guide can be found at [umami.is/docs](https://umami.i
 - A server with Node.js version 18.18 or newer
 - A database. Umami supports [MariaDB](https://www.mariadb.org/) (minimum v10.5), [MySQL](https://www.mysql.com/) (minimum v8.0) and [PostgreSQL](https://www.postgresql.org/) (minimum v12.14) databases.
 
-### Install Yarn
-
-```bash
-npm install -g yarn
-```
-
 ### Get the Source Code and Install Packages
 
 ```bash
 git clone https://github.com/umami-software/umami.git
 cd umami
-yarn install
+npm install
 ```
 
 ### Configure Umami
@@ -70,15 +64,15 @@ mysql://username:mypassword@localhost:3306/mydb
 ### Build the Application
 
 ```bash
-yarn build
+npm build
 ```
 
 *The build step will create tables in your database if you are installing for the first time. It will also create a login user with username **admin** and password **umami**.*
 
 ### Start the Application
 
 ```bash
-yarn start
+npm run start
 ```
 
 *By default, this will launch the application on `http://localhost:3000`. You will need to either [proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) requests from your web server or change the [port](https://nextjs.org/docs/api-reference/cli#production) to serve the application directly.*
@@ -113,8 +107,8 @@ To get the latest features, simply do a pull, install any new dependencies, and
 
 ```bash
 git pull
-yarn install
-yarn build
+npm install
+npm run build
 ```
 
 To update the Docker image, simply pull the new images and rebuild:

cypress.config.ts

@@ -8,5 +8,6 @@ export default defineConfig({
   env: {
     umami_user: 'admin',
     umami_password: 'umami',
+    umami_user_id: '41e2b680-648e-4b09-bcd7-3e2b10c06264',
   },
 });

cypress/e2e/api-team.cy.ts

@@ -0,0 +1,209 @@
+describe('Team API tests', () => {
+  Cypress.session.clearAllSavedSessions();
+
+  let teamId;
+  let userId;
+
+  before(() => {
+    cy.login(Cypress.env('umami_user'), Cypress.env('umami_password'));
+    cy.fixture('users').then(data => {
+      const userCreate = data.userCreate;
+      cy.request({
+        method: 'POST',
+        url: '/api/users',
+        headers: {
+          'Content-Type': 'application/json',
+          Authorization: Cypress.env('authorization'),
+        },
+        body: userCreate,
+      }).then(response => {
+        userId = response.body.id;
+        expect(response.status).to.eq(200);
+        expect(response.body).to.have.property('username', 'cypress1');
+        expect(response.body).to.have.property('role', 'user');
+      });
+    });
+  });
+
+  it('Creates a team.', () => {
+    cy.fixture('teams').then(data => {
+      const teamCreate = data.teamCreate;
+      cy.request({
+        method: 'POST',
+        url: '/api/teams',
+        headers: {
+          'Content-Type': 'application/json',
+          Authorization: Cypress.env('authorization'),
+        },
+        body: teamCreate,
+      }).then(response => {
+        teamId = response.body[0].id;
+        expect(response.status).to.eq(200);
+        expect(response.body[0]).to.have.property('name', 'cypress');
+        expect(response.body[1]).to.have.property('role', 'team-owner');
+      });
+    });
+  });
+
+  it('Gets a teams by ID.', () => {
+    cy.request({
+      method: 'GET',
+      url: `/api/teams/${teamId}`,
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: Cypress.env('authorization'),
+      },
+    }).then(response => {
+      expect(response.status).to.eq(200);
+      expect(response.body).to.have.property('id', teamId);
+    });
+  });
+
+  it('Updates a team.', () => {
+    cy.fixture('teams').then(data => {
+      const teamUpdate = data.teamUpdate;
+      cy.request({
+        method: 'POST',
+        url: `/api/teams/${teamId}`,
+        headers: {
+          'Content-Type': 'application/json',
+          Authorization: Cypress.env('authorization'),
+        },
+        body: teamUpdate,
+      }).then(response => {
+        expect(response.status).to.eq(200);
+        expect(response.body).to.have.property('id', teamId);
+        expect(response.body).to.have.property('name', 'cypressUpdate');
+      });
+    });
+  });
+
+  it('Get all users that belong to a team.', () => {
+    cy.request({
+      method: 'GET',
+      url: `/api/teams/${teamId}/users`,
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: Cypress.env('authorization'),
+      },
+    }).then(response => {
+      expect(response.status).to.eq(200);
+      expect(response.body.data[0]).to.have.property('id');
+      expect(response.body.data[0]).to.have.property('teamId');
+      expect(response.body.data[0]).to.have.property('userId');
+      expect(response.body.data[0]).to.have.property('user');
+    });
+  });
+
+  it('Get a user belonging to a team.', () => {
+    cy.request({
+      method: 'GET',
+      url: `/api/teams/${teamId}/users/${Cypress.env('umami_user_id')}`,
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: Cypress.env('authorization'),
+      },
+    }).then(response => {
+      expect(response.status).to.eq(200);
+      expect(response.body).to.have.property('teamId');
+      expect(response.body).to.have.property('userId');
+      expect(response.body).to.have.property('role');
+    });
+  });
+
+  it('Get all websites belonging to a team.', () => {
+    cy.request({
+      method: 'GET',
+      url: `/api/teams/${teamId}/websites`,
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: Cypress.env('authorization'),
+      },
+    }).then(response => {
+      expect(response.status).to.eq(200);
+      expect(response.body).to.have.property('data');
+    });
+  });
+
+  it('Add a user to a team.', () => {
+    cy.request({
+      method: 'POST',
+      url: `/api/teams/${teamId}/users`,
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: Cypress.env('authorization'),
+      },
+      body: {
+        userId,
+        role: 'team-member',
+      },
+    }).then(response => {
+      expect(response.status).to.eq(200);
+      expect(response.body).to.have.property('userId', userId);
+      expect(response.body).to.have.property('role', 'team-member');
+    });
+  });
+
+  it(`Update a user's role on a team.`, () => {
+    cy.request({
+      method: 'POST',
+      url: `/api/teams/${teamId}/users/${userId}`,
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: Cypress.env('authorization'),
+      },
+      body: {
+        role: 'team-view-only',
+      },
+    }).then(response => {
+      expect(response.status).to.eq(200);
+      expect(response.body).to.have.property('userId', userId);
+      expect(response.body).to.have.property('role', 'team-view-only');
+    });
+  });
+
+  it(`Remove a user from a team.`, () => {
+    cy.request({
+      method: 'DELETE',
+      url: `/api/teams/${teamId}/users/${userId}`,
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: Cypress.env('authorization'),
+      },
+    }).then(response => {
+      expect(response.status).to.eq(200);
+    });
+  });
+
+  it('Deletes a team.', () => {
+    cy.request({
+      method: 'DELETE',
+      url: `/api/teams/${teamId}`,
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: Cypress.env('authorization'),
+      },
+    }).then(response => {
+      expect(response.status).to.eq(200);
+      expect(response.body).to.have.property('ok', true);
+    });
+  });
+
+  // it('Gets all teams that belong to a user.', () => {
+  //   cy.request({
+  //     method: 'GET',
+  //     url: `/api/users/${userId}/teams`,
+  //     headers: {
+  //       'Content-Type': 'application/json',
+  //       Authorization: Cypress.env('authorization'),
+  //     },
+  //   }).then(response => {
+  //     expect(response.status).to.eq(200);
+  //     expect(response.body).to.have.property('data');
+  //   });
+  // });
+
+  after(() => {
+    cy.deleteUser(userId);
+  });
+});