team/e2e-tests/cypress/tests/integration/channels/channel/channel_routing_spec.ts

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

import {Team} from '@mattermost/types/teams';
import {UserProfile} from '@mattermost/types/users';

// ***************************************************************
// - [#] indicates a test step (e.g. # Go to a page)
// - [*] indicates an assertion (e.g. * Check the title)
// - Use element ID when selecting an element. Create one if none.
// ***************************************************************

// Stage: @prod
// Group: @channels @channel

describe('Channel routing', () => {
    let testUser: UserProfile;
    let otherUser1: UserProfile;
    let otherUser2: UserProfile;
    let testTeam: Team;

    before(() => {
        cy.apiInitSetup().then(({team, user}) => {
            testTeam = team;
            testUser = user;

            cy.apiCreateUser({prefix: 'otherA'}).then(({user: newUser}) => {
                otherUser1 = newUser;

                cy.apiAddUserToTeam(team.id, newUser.id);
            });

            cy.apiCreateUser({prefix: 'otherB'}).then(({user: newUser}) => {
                otherUser2 = newUser;

                cy.apiAddUserToTeam(team.id, newUser.id);
            });

            // # Login as test user and go to town square
            cy.apiLogin(testUser);
            cy.visit(`/${team.name}/channels/town-square`);
        });
    });

    it('should go to town square channel view', () => {
        // * Check if the channel is loaded correctly
        cy.get('#channelHeaderTitle').should('be.visible').should('contain', 'Town Square');
    });

    it('should go to private channel view', () => {
        // # Create a private channel
        cy.apiCreateChannel(testTeam.id, 'private-channel', 'Private channel', 'P').then(({channel}) => {
            // # Go to the newly created channel
            cy.visit(`/${testTeam.name}/channels/${channel.name}`);

            // * Check you can go to the channel without problem
            cy.get('#channelHeaderTitle').should('be.visible').should('contain', 'Private channel');

            // # Remove the created channel
            cy.apiDeleteChannel(channel.id);
        });
    });

    it('should go to self direct channel using the multiple ways to go', () => {
        // # Create a self direct channel
        cy.apiCreateDirectChannel([testUser.id, testUser.id]).then(({channel: ownDMChannel}) => {
            // # Visit the channel using the channel name
            cy.visit(`/${testTeam.name}/channels/${testUser.id}__${testUser.id}`);

            // * Check you can go to the channel without problem
            cy.get('#channelHeaderTitle').should('be.visible').should('contain', `${testUser.username} (you)`);

            // # Visit the channel using the channel id
            cy.visit(`/${testTeam.name}/channels/${ownDMChannel.id}`);

            // * Check you can go to the channel without problem
            cy.get('#channelHeaderTitle').should('be.visible').should('contain', `${testUser.username} (you)`);

            // # Visit the channel using the username
            cy.visit(`/${testTeam.name}/messages/@${testUser.username}`);

            // * Check you can go to the channel without problem
            cy.get('#channelHeaderTitle').should('be.visible').should('contain', `${testUser.username} (you)`);

            // # Visit the channel using the user email
            cy.visit(`/${testTeam.name}/messages/${testUser.email}`);

            // * Check you can go to the channel without problem
            cy.get('#channelHeaderTitle').should('be.visible').should('contain', `${testUser.username} (you)`);
        });
    });

    it('should go to other user direct channel using multiple ways to go', () => {
        // # Create a direct channel between two users
        cy.apiCreateDirectChannel([testUser.id, otherUser1.id]).then(({channel: dmChannel}) => {
            // # Visit the channel using the channel name
            cy.visit(`/${testTeam.name}/channels/${testUser.id}__${otherUser1.id}`);

            // * Check you can go to the channel without problem
            cy.get('#channelHeaderTitle').should('be.visible').should('contain', otherUser1.username);

            // # Visit the channel using the channel id
            cy.visit(`/${testTeam.name}/channels/${dmChannel.id}`);

            // * Check you can go to the channel without problem
            cy.get('#channelHeaderTitle').should('be.visible').should('contain', otherUser1.username);

            // # Visit the channel using the target username
            cy.visit(`/${testTeam.name}/messages/@${otherUser1.username}`);

            // * Check you can go to the channel without problem
            cy.get('#channelHeaderTitle').should('be.visible').should('contain', otherUser1.username);

            // # Visit the channel using the target user email
            cy.visit(`/${testTeam.name}/messages/${otherUser1.email}`);

            // * Check you can go to the channel without problem
            cy.get('#channelHeaderTitle').should('be.visible').should('contain', otherUser1.username);
        });
    });

    it('should go group channel using group id', () => {
        const userGroupIds = [testUser.id, otherUser1.id, otherUser2.id];

        // # Create a group channel for 3 users
        cy.apiCreateGroupChannel(userGroupIds).then(({channel: gmChannel}) => {
            // # Visit the channel using the name using the channels route
            cy.visit(`/${testTeam.name}/channels/${gmChannel.name}`);

            // * Check you can go to the channel without problem
            const displayName = gmChannel.display_name.split(', ').filter(((username) => username !== testUser.username)).join(', ');
            cy.get('#channelHeaderTitle').should('be.visible').should('contain', displayName);

            // # Visit the channel using the name using the messages route
            cy.visit(`/${testTeam.name}/messages/${gmChannel.name}`);

            // * Check you can go to the channel without problem
            cy.get('#channelHeaderTitle').should('be.visible').should('contain', displayName);
        });
    });
});