WWS Extension

XStream/WWS language support brings extension access points for IntelliSense, compilation, and deployment of XStream files. The extension also provides developers with a way to manage the current flows and sites of a WWS instance.

The Bell Labs World Wide Streams (WWS) platform is a scalable and distributed infrastructure designed to efficiently process large amounts of data and media streams from geographically dispersed IoT and media sources, enabling flexible analysis in the edge-cloud continuum. WWS was conceived for easy scripting, reducing development time from months to days, and supporting easy specialization through its "Bring-your-own-Algorithm" capability. Moreover, it presents a set of tools for seamless and effortless multi-site deployment in the edge-cloud continuum. For more information, please visit worldwidestreams.io.

Components

The WWS VSC extension adds a new view in the activity bar composed by four main components:

1. Deployed Flows: List the deployed flows. It is possible to inspect a specific flow, or execute some actions like kill, restart, revive, and redeploy.

2. Deployment Sites: List all the available deployment sites in your WWS instance.

3. Flow Parameters: List all the available parameters for the currrent open XStream file. Additionally, it is possible to add new parameters, modify and/or remove existing ones.

4. Status bar: Display the current status of the WWS instance.

5. Toolbar: Actions available for XStreams files.

Setup WWS NPM Registry

Open a terminal and run the following command to set the registry https://npm.worldwidestreams.io for @xstream and @wws_public packages. This alternative registry is needed because these packages are not published on the [official](https://raw.githubusercontent.com/nokia/wws-vsc/main/ https:/registry.npmjs.org) npm registry. Use the credentials provided (check your email) for the prompted user and password.

npm login --registry=https://npm.worldwidestreams.io

After logged into https://npm.worldwidestreams.io, set the scope registry for @xstream and @wws_public.

npm config set @xstream:registry  https://npm.worldwidestreams.io/
npm config set @wws_public:registry  https://npm.worldwidestreams.io/

You can check the current npm configuration by running the following command:

npm config list

The output should include these two entries:

@wws_public:registry = "https://npm.worldwidestreams.io/" 
@xstream:registry = "https://npm.worldwidestreams.io/" 

If you encounter a connection timeout while logging in and you are connected to the NOKIA network, run the following commands to properly configure the NOKIA proxy:

npm config set proxy http://proxy-server-url:port
npm config set https-proxy http://proxy-server-url:port

Run XStreams Scripts

Step 1: Login to your WWS instance

Step 2: Declare an XStream pipeline

Step 3: Set file as a XStream

Regular Typescripts files can be manually set as XStreams files by right clicking on the file and selecting Register as XStream File option.

Alternative, you can name your XStream file with a .xs.ts extension (e.g., double.xs.ts) and they will be automatically detected by the WWS extension.

Step 3: Run XStream pipeline

Parameters can also reference .env files by using the $ prefix (e.g., $OPENAI_API_KEY) For example, you can use the following .env file to deploy a pipeline that uses OpenAI and GitLab keys.

# Environment Variables
OPENAI_API_KEY=my-open-ap-key # comment 1
GITLAB_TOKEN="my-key-with-#-special-characters" # comment 2

Step 4: Inspect the new deployed flow

AI Assistant

Bring your own AI assistant to VSCode.