Giter Club home page Giter Club logo

wire-web-ets's Introduction

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.

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

E2E Test Service

End-to-end Test Service (ETS) for Wire's test automation suite.

Usage in testing environment

First, make sure you have all dependencies installed by running:

yarn

Then run the server with:

yarn start:dev

The ETS will now be running locally and is ready to process requests.

Testing

yarn test

Running in production environment

yarn
yarn dist
yarn start

API documentation

Implementation

  1. Add endpoint description in swagger.json
  2. Add business logic in InstanceService.ts
  3. Add endpoint implementation in conversationRoutes.ts

Deployments

The following ETS deployments are reachable via Wire's VPN:

How it works

  1. Create an instance (POST /instance)
  2. Use the received instanceId to use resources like sendText

Example payload to create an instance

{
  "backend": "staging",
  "email": "[email protected]",
  "password": "secret",
  "deviceClass": "desktop",
  "name": "Some Instance Name"
}

Example payload to start a poll

{
  "buttons": ["A", "B"],
  "text": "Do you like A or B?",
  "conversationId": "b894b2e4-e862-4b55-a97e-56ea3690be20"
}

Common errors

Invalid JSON provided

{
  "code": "400",
  "error": "Payload is not valid JSON data."
}

Instance or endpoint not found

{
  "code": "404",
  "error": "<string>"
}

JSON data with missing or invalid fields provided

{
  "code": "422",
  "error": "<string>"
}

Internal server error

{
  "code": "500",
  "error": "<string>",
  "stack": "string"
}

wire-web-ets's People

Contributors

bennycode avatar dependabot-preview[bot] avatar dependabot-support avatar dependabot[bot] avatar ffflorian avatar lipis avatar mythsunwind avatar yserz avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.