Wire™

This repository is part of the source code of Wire. You can find more information at wire.com or by contacting [email protected].

You can find the published source code at github.com/wireapp/wire.

For licensing information, see the attached LICENSE file and the list of third-party licenses at wire.com/legal/licenses/.

If you compile the open source software that we make available from time to time to develop your own mobile, desktop or web application, and cause that application to connect to our servers for any purposes, we refer to that resulting application as an “Open Source App”. All Open Source Apps are subject to, and may only be used and/or commercialized in accordance with, the Terms of Use applicable to the Wire Application, which can be found at https://wire.com/legal/#terms. Additionally, if you choose to build an Open Source App, certain restrictions apply, as follows:

a. You agree not to change the way the Open Source App connects and interacts with our servers; b. You agree not to weaken any of the security features of the Open Source App; c. You agree not to use our servers to store data for purposes other than the intended and original functionality of the Open Source App; d. You acknowledge that you are solely responsible for any and all updates to your Open Source App.

For clarity, if you compile the open source software that we make available from time to time to develop your own mobile, desktop or web application, and do not cause that application to connect to our servers for any purposes, then that application will not be deemed an Open Source App and the foregoing will not apply to that application.

No license is granted to the Wire trademark and its associated logos, all of which will continue to be owned exclusively by Wire Swiss GmbH. Any use of the Wire trademark and/or its associated logos is expressly prohibited without the express prior written consent of Wire Swiss GmbH.

How to build the open source client

Build

Installation

1. Install Node.js
2. Install Yarn: npm install -g yarn
3. Run yarn
4. Rename .env.localhost to .env in order to run the app in a local environment

Execution

Run yarn start and Wire's web app will be available at: http://localhost:8080/auth/#login

To login with your existing Wire account use: http://localhost:8080/auth/?env=prod#login

Testing

To launch the full test suite (types check + linting + server tests + app tests), simply run

yarn test

Alternatively, you can run specific parts of the app:

yarn test:(server|types|auth|app)

Since the test suite for the app is the biggest test suite, you might want to run a single test file, in which case, you can use the --specs option:

yarn test:app --specs spec1[,spec2...]

where specN is the path to the spec to run relative to test/unit_tests and without Spec.js.

Speed up testing for files fully migrated to the module system

When a file (and all its dependencies) do not rely on any global dependency, then you can use the --nolegacy flag to run the tests on that single file.

yarn test:app --specs spec1 --nolegacy

The test should start very quickly (webpack won't have to resolve all the global dependencies).

If the test doesn't run with the nolegacy option (but runs without), it means it's depending, somehow, on, at least, one thing that should be on the global scope.

Example

If you want to run the tests for the ConversationRepository, the file containing the test is:

test/unit_tests/conversation/ConversationRepositorySpec.js

The command to run is:

yarn test:app --specs conversation/ConversationRepository

Deployment

Staging Bumps

Actions

1. Checkout commit ID which has been approved by QA team
2. Create a Git tag with the following format: YYYY-MM-DD-staging.X
3. Push the newly created tag

Example

git checkout 90fda951916f0d60a5bffce69a7267830e313391
git tag 2019-04-23-staging.0
git push origin --tags

If everything is done right, you will see a Travis CI job in the build pipeline based on the new tag:

Production Release

Actions

1. Create a branch from the verified (approved by QA team) RC build. The easiest way to do that is to use the GitHub UI and to create the branch from the staging release tag because every RC build has a staging tag:

Pro Tip: If you are not sure which is the latest commit on our RC build, you can checkout: https://wire-webapp-rc.zinfra.io/commit

2. Create a pull request from the newly created branch into our "prod" branch:

3. Create a merge commit (don't squash or rebase!) to kickoff a production release via Travis CI. If you don't want that the release goes live (because you want to park a new feature for a later deployment) you can add [skip travis] to your commit message to prevent the release build and its deployment.

Manual Deployments

Based on the Git branch, builds get deployed automatically by Travis CI. In case Travis CI is not working, a manual deployment can be triggered using yarn deploy.

A manual deployment requires the local setup of the Elastic Beanstalk Command Line Interface (EB CLI). Manual deployments are also based on branch defaults which are configured here.

Status

Translations

All Wire translations are crowdsourced via Crowdin.